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::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_usageprice;
35 use FS::cust_pkg_discount;
41 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
43 # because they load configuration by setting FS::UID::callback (see TODO)
49 # for sending cancel emails in sub cancel
52 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
54 our $upgrade = 0; #go away after setup+start dates cleaned up for old customers
58 my ( $hashref, $cache ) = @_;
59 #if ( $hashref->{'pkgpart'} ) {
60 if ( $hashref->{'pkg'} ) {
61 # #@{ $self->{'_pkgnum'} } = ();
62 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
63 # $self->{'_pkgpart'} = $subcache;
64 # #push @{ $self->{'_pkgnum'} },
65 # FS::part_pkg->new_or_cached($hashref, $subcache);
66 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
68 if ( exists $hashref->{'svcnum'} ) {
69 #@{ $self->{'_pkgnum'} } = ();
70 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
71 $self->{'_svcnum'} = $subcache;
72 #push @{ $self->{'_pkgnum'} },
73 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
79 FS::cust_pkg - Object methods for cust_pkg objects
85 $record = new FS::cust_pkg \%hash;
86 $record = new FS::cust_pkg { 'column' => 'value' };
88 $error = $record->insert;
90 $error = $new_record->replace($old_record);
92 $error = $record->delete;
94 $error = $record->check;
96 $error = $record->cancel;
98 $error = $record->suspend;
100 $error = $record->unsuspend;
102 $part_pkg = $record->part_pkg;
104 @labels = $record->labels;
106 $seconds = $record->seconds_since($timestamp);
108 #bulk cancel+order... perhaps slightly deprecated, only used by the bulk
109 # cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
110 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
111 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
115 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
116 inherits from FS::Record. The following fields are currently supported:
122 Primary key (assigned automatically for new billing items)
126 Customer (see L<FS::cust_main>)
130 Billing item definition (see L<FS::part_pkg>)
134 Optional link to package location (see L<FS::location>)
138 date package was ordered (also remains same on changes)
150 date (next bill date)
178 order taker (see L<FS::access_user>)
182 If this field is set to 1, disables the automatic
183 unsuspension of this package when using the B<unsuspendauto> config option.
187 If not set, defaults to 1
191 Date of change from previous package
201 =item change_locationnum
209 The pkgnum of the package that this package is supplemental to, if any.
213 The package link (L<FS::part_pkg_link>) that defines this supplemental
214 package, if it is one.
216 =item change_to_pkgnum
218 The pkgnum of the package this one will be "changed to" in the future
219 (on its expiration date).
223 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
224 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
225 L<Time::Local> and L<Date::Parse> for conversion functions.
233 Create a new billing item. To add the item to the database, see L<"insert">.
237 sub table { 'cust_pkg'; }
238 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
239 sub cust_unlinked_msg {
241 "WARNING: can't find cust_main.custnum ". $self->custnum.
242 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
245 =item set_initial_timers
247 If required by the package definition, sets any automatic expire, adjourn,
248 or contract_end timers to some number of months after the start date
249 (or setup date, if the package has already been setup). If the package has
250 a delayed setup fee after a period of "free days", will also set the
251 start date to the end of that period.
253 If the package has an automatic transfer rule (C<change_to_pkgnum>), then
254 this will also order the package and set its start date.
258 sub set_initial_timers {
260 my $part_pkg = $self->part_pkg;
261 my $start = $self->start_date || $self->setup || time;
263 foreach my $action ( qw(expire adjourn contract_end) ) {
264 my $months = $part_pkg->get("${action}_months");
265 if($months and !$self->get($action)) {
266 $self->set($action, $part_pkg->add_freq($start, $months) );
270 # if this package has an expire date and a change_to_pkgpart, set automatic
272 # (but don't call change_later, as that would call $self->replace, and we're
273 # probably in the middle of $self->insert right now)
274 if ( $part_pkg->expire_months and $part_pkg->change_to_pkgpart ) {
275 if ( $self->change_to_pkgnum ) {
276 # this can happen if a package is ordered on hold, scheduled for a
277 # future change _while on hold_, and then released from hold, causing
278 # the automatic transfer to schedule.
280 # what's correct behavior in that case? I think it's to disallow
281 # future-changing an on-hold package that has an automatic transfer.
282 # but if we DO get into this situation, let the manual package change
284 warn "pkgnum ".$self->pkgnum.": manual future package change blocks ".
285 "automatic transfer.\n";
287 my $change_to = FS::cust_pkg->new( {
288 start_date => $self->get('expire'),
289 pkgpart => $part_pkg->change_to_pkgpart,
290 map { $_ => $self->get($_) }
291 qw( custnum locationnum quantity refnum salesnum contract_end )
293 my $error = $change_to->insert;
295 return $error if $error;
296 $self->set('change_to_pkgnum', $change_to->pkgnum);
300 # if this package has "free days" and delayed setup fee, then
301 # set start date that many days in the future.
302 # (this should have been set in the UI, but enforce it here)
303 if ( $part_pkg->option('free_days',1)
304 && $part_pkg->option('delay_setup',1)
307 $self->start_date( $part_pkg->default_start_date );
313 =item insert [ OPTION => VALUE ... ]
315 Adds this billing item to the database ("Orders" the item). If there is an
316 error, returns the error, otherwise returns false.
318 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
319 will be used to look up the package definition and agent restrictions will be
322 If the additional field I<refnum> is defined, an FS::pkg_referral record will
323 be created and inserted. Multiple FS::pkg_referral records can be created by
324 setting I<refnum> to an array reference of refnums or a hash reference with
325 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
326 record will be created corresponding to cust_main.refnum.
328 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
329 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
330 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
331 It can be set as part of the hash when creating the object, or with the B<set>
334 The following options are available:
340 If set true, supresses actions that should only be taken for new package
341 orders. (Currently this includes: intro periods when delay_setup is on,
342 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
346 cust_pkg_option records will be created
350 a ticket will be added to this customer with this subject
354 an optional queue name for ticket additions
358 Don't check the legality of the package definition. This should be used
359 when performing a package change that doesn't change the pkgpart (i.e.
367 my( $self, %options ) = @_;
369 my $oldAutoCommit = $FS::UID::AutoCommit;
370 local $FS::UID::AutoCommit = 0;
374 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
376 my $part_pkg = $self->part_pkg;
378 if ( ! $import && ! $options{'change'} ) {
380 # set order date to now
381 $self->order_date(time) unless ($import && $self->order_date);
383 # if the package def says to start only on the first of the month:
384 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
385 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
386 $mon += 1 unless $mday == 1;
387 until ( $mon < 12 ) { $mon -= 12; $year++; }
388 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
391 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
392 # if the package was ordered on hold:
394 # - don't set the start date (it will be started manually)
395 $self->set('susp', $self->order_date);
396 $self->set('start_date', '');
398 # set expire/adjourn/contract_end timers, and free days, if appropriate
399 # and automatic package transfer, which can fail, so capture the result
400 $error = $self->set_initial_timers;
402 } # else this is a package change, and shouldn't have "new package" behavior
404 $error ||= $self->SUPER::insert($options{options} ? %{$options{options}} : ());
406 $dbh->rollback if $oldAutoCommit;
410 $self->refnum($self->cust_main->refnum) unless $self->refnum;
411 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
412 $self->process_m2m( 'link_table' => 'pkg_referral',
413 'target_table' => 'part_referral',
414 'params' => $self->refnum,
417 if ( $self->hashref->{cust_pkg_usageprice} ) {
418 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
419 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
420 my $error = $cust_pkg_usageprice->insert;
422 $dbh->rollback if $oldAutoCommit;
428 if ( $self->setup_discountnum || $self->recur_discountnum ) {
429 my $error = $self->insert_discount();
431 $dbh->rollback if $oldAutoCommit;
436 my $conf = new FS::Conf;
438 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
440 #this init stuff is still inefficient, but at least its limited to
441 # the small number (any?) folks using ticket emailing on pkg order
444 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
451 use FS::TicketSystem;
452 FS::TicketSystem->init();
454 my $q = new RT::Queue($RT::SystemUser);
455 $q->Load($options{ticket_queue}) if $options{ticket_queue};
456 my $t = new RT::Ticket($RT::SystemUser);
457 my $mime = new MIME::Entity;
458 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
459 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
460 Subject => $options{ticket_subject},
463 $t->AddLink( Type => 'MemberOf',
464 Target => 'freeside://freeside/cust_main/'. $self->custnum,
468 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
469 my $queue = new FS::queue {
470 'job' => 'FS::cust_main::queueable_print',
472 $error = $queue->insert(
473 'custnum' => $self->custnum,
474 'template' => 'welcome_letter',
478 warn "can't send welcome letter: $error";
483 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
490 This method now works but you probably shouldn't use it.
492 You don't want to delete packages, because there would then be no record
493 the customer ever purchased the package. Instead, see the cancel method and
494 hide cancelled packages.
498 # this is still used internally to abort future package changes, so it
504 # The following foreign keys to cust_pkg are not cleaned up here, and will
505 # cause package deletion to fail:
507 # cust_credit.pkgnum and commission_pkgnum (and cust_credit_void)
508 # cust_credit_bill.pkgnum
509 # cust_pay_pending.pkgnum
510 # cust_pay.pkgnum (and cust_pay_void)
511 # cust_bill_pay.pkgnum (wtf, shouldn't reference pkgnum)
512 # cust_pkg_usage.pkgnum
513 # cust_pkg.uncancel_pkgnum, change_pkgnum, main_pkgnum, and change_to_pkgnum
515 # cust_svc is handled by canceling the package before deleting it
516 # cust_pkg_option is handled via option_Common
518 my $oldAutoCommit = $FS::UID::AutoCommit;
519 local $FS::UID::AutoCommit = 0;
522 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
523 my $error = $cust_pkg_discount->delete;
525 $dbh->rollback if $oldAutoCommit;
529 #cust_bill_pkg_discount?
531 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
532 my $error = $cust_pkg_detail->delete;
534 $dbh->rollback if $oldAutoCommit;
539 foreach my $cust_pkg_reason (
541 'table' => 'cust_pkg_reason',
542 'hashref' => { 'pkgnum' => $self->pkgnum },
546 my $error = $cust_pkg_reason->delete;
548 $dbh->rollback if $oldAutoCommit;
553 foreach my $pkg_referral ( $self->pkg_referral ) {
554 my $error = $pkg_referral->delete;
556 $dbh->rollback if $oldAutoCommit;
561 my $error = $self->SUPER::delete(@_);
563 $dbh->rollback if $oldAutoCommit;
567 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
573 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
575 Replaces the OLD_RECORD with this one in the database. If there is an error,
576 returns the error, otherwise returns false.
578 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
580 Changing pkgpart may have disasterous effects. See the order subroutine.
582 setup and bill are normally updated by calling the bill method of a customer
583 object (see L<FS::cust_main>).
585 suspend is normally updated by the suspend and unsuspend methods.
587 cancel is normally updated by the cancel method (and also the order subroutine
590 Available options are:
596 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.
600 the access_user (see L<FS::access_user>) providing the reason
604 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
613 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
618 ( ref($_[0]) eq 'HASH' )
622 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
623 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
626 #return "Can't change setup once it exists!"
627 # if $old->getfield('setup') &&
628 # $old->getfield('setup') != $new->getfield('setup');
630 #some logic for bill, susp, cancel?
632 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
634 my $oldAutoCommit = $FS::UID::AutoCommit;
635 local $FS::UID::AutoCommit = 0;
638 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
639 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
640 my $error = $new->insert_reason(
641 'reason' => $options->{'reason'},
642 'date' => $new->$method,
644 'reason_otaker' => $options->{'reason_otaker'},
647 dbh->rollback if $oldAutoCommit;
648 return "Error inserting cust_pkg_reason: $error";
653 #save off and freeze RADIUS attributes for any associated svc_acct records
655 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
657 #also check for specific exports?
658 # to avoid spurious modify export events
659 @svc_acct = map { $_->svc_x }
660 grep { $_->part_svc->svcdb eq 'svc_acct' }
663 $_->snapshot foreach @svc_acct;
667 my $error = $new->export_pkg_change($old)
668 || $new->SUPER::replace( $old,
670 ? $options->{options}
674 $dbh->rollback if $oldAutoCommit;
678 #for prepaid packages,
679 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
680 foreach my $old_svc_acct ( @svc_acct ) {
681 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
683 $new_svc_acct->replace( $old_svc_acct,
684 'depend_jobnum' => $options->{depend_jobnum},
687 $dbh->rollback if $oldAutoCommit;
692 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
699 Checks all fields to make sure this is a valid billing item. If there is an
700 error, returns the error, otherwise returns false. Called by the insert and
708 if ( !$self->locationnum or $self->locationnum == -1 ) {
709 $self->set('locationnum', $self->cust_main->ship_locationnum);
713 $self->ut_numbern('pkgnum')
714 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
715 || $self->ut_numbern('pkgpart')
716 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
717 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
718 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
719 || $self->ut_numbern('quantity')
720 || $self->ut_numbern('start_date')
721 || $self->ut_numbern('setup')
722 || $self->ut_numbern('bill')
723 || $self->ut_numbern('susp')
724 || $self->ut_numbern('cancel')
725 || $self->ut_numbern('adjourn')
726 || $self->ut_numbern('resume')
727 || $self->ut_numbern('expire')
728 || $self->ut_numbern('dundate')
729 || $self->ut_flag('no_auto', [ '', 'Y' ])
730 || $self->ut_flag('waive_setup', [ '', 'Y' ])
731 || $self->ut_flag('separate_bill')
732 || $self->ut_textn('agent_pkgid')
733 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
734 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
735 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
736 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
737 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
739 return $error if $error;
741 return "A package with both start date (future start) and setup date (already started) will never bill"
742 if $self->start_date && $self->setup && ! $upgrade;
744 return "A future unsuspend date can only be set for a package with a suspend date"
745 if $self->resume and !$self->susp and !$self->adjourn;
747 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
749 if ( $self->dbdef_table->column('manual_flag') ) {
750 $self->manual_flag('') if $self->manual_flag eq ' ';
751 $self->manual_flag =~ /^([01]?)$/
752 or return "Illegal manual_flag ". $self->manual_flag;
753 $self->manual_flag($1);
761 Check the pkgpart to make sure it's allowed with the reg_code and/or
762 promo_code of the package (if present) and with the customer's agent.
763 Called from C<insert>, unless we are doing a package change that doesn't
771 # my $error = $self->ut_numbern('pkgpart'); # already done
774 if ( $self->reg_code ) {
776 unless ( grep { $self->pkgpart == $_->pkgpart }
777 map { $_->reg_code_pkg }
778 qsearchs( 'reg_code', { 'code' => $self->reg_code,
779 'agentnum' => $self->cust_main->agentnum })
781 return "Unknown registration code";
784 } elsif ( $self->promo_code ) {
787 qsearchs('part_pkg', {
788 'pkgpart' => $self->pkgpart,
789 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
791 return 'Unknown promotional code' unless $promo_part_pkg;
795 unless ( $disable_agentcheck ) {
797 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
798 return "agent ". $agent->agentnum. ':'. $agent->agent.
799 " can't purchase pkgpart ". $self->pkgpart
800 unless $agent->pkgpart_hashref->{ $self->pkgpart }
801 || $agent->agentnum == $self->part_pkg->agentnum;
804 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
805 return $error if $error;
813 =item cancel [ OPTION => VALUE ... ]
815 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
816 in this package, then cancels the package itself (sets the cancel field to
819 Available options are:
823 =item quiet - can be set true to supress email cancellation notices.
825 =item time - can be set to cancel the package based on a specific future or
826 historical date. Using time ensures that the remaining amount is calculated
827 correctly. Note however that this is an immediate cancel and just changes
828 the date. You are PROBABLY looking to expire the account instead of using
831 =item reason - can be set to a cancellation reason (see L<FS:reason>),
832 either a reasonnum of an existing reason, or passing a hashref will create
833 a new reason. The hashref should have the following keys: typenum - Reason
834 type (see L<FS::reason_type>, reason - Text of the new reason.
836 =item date - can be set to a unix style timestamp to specify when to
839 =item nobill - can be set true to skip billing if it might otherwise be done.
841 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
842 not credit it. This must be set (by change()) when changing the package
843 to a different pkgpart or location, and probably shouldn't be in any other
844 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
847 =item no_delay_cancel - prevents delay_cancel behavior
848 no matter what other options say, for use when changing packages (or any
849 other time you're really sure you want an immediate cancel)
853 If there is an error, returns the error, otherwise returns false.
857 #NOT DOCUMENTING - this should only be used when calling recursively
858 #=item delay_cancel - for internal use, to allow proper handling of
859 #supplemental packages when the main package is flagged to suspend
860 #before cancelling, probably shouldn't be used otherwise (set the
861 #corresponding package option instead)
864 my( $self, %options ) = @_;
867 # supplemental packages can now be separately canceled, though the UI
868 # shouldn't permit it
870 ## pass all suspend/cancel actions to the main package
871 ## (unless the pkglinknum has been removed, then the link is defunct and
872 ## this package can be canceled on its own)
873 #if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
874 # return $self->main_pkg->cancel(%options);
877 my $conf = new FS::Conf;
879 warn "cust_pkg::cancel called with options".
880 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
883 my $oldAutoCommit = $FS::UID::AutoCommit;
884 local $FS::UID::AutoCommit = 0;
887 my $old = $self->select_for_update;
889 if ( $old->get('cancel') || $self->get('cancel') ) {
890 dbh->rollback if $oldAutoCommit;
891 return ""; # no error
894 # XXX possibly set cancel_time to the expire date?
895 my $cancel_time = $options{'time'} || time;
896 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
897 $date = '' if ($date && $date <= $cancel_time); # complain instead?
899 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
900 if ( !$date && $self->part_pkg->option('delay_cancel',1)
901 && (($self->status eq 'active') || ($self->status eq 'suspended'))
902 && !$options{'no_delay_cancel'}
904 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
905 my $expsecs = 60*60*24*$expdays;
906 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
907 $expsecs = $expsecs - $suspfor if $suspfor;
908 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
910 $date = $cancel_time + $expsecs;
914 #race condition: usage could be ongoing until unprovisioned
915 #resolved by performing a change package instead (which unprovisions) and
917 if ( !$options{nobill} && !$date ) {
918 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
919 my $copy = $self->new({$self->hash});
921 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
923 'time' => $cancel_time );
924 warn "Error billing during cancel, custnum ".
925 #$self->cust_main->custnum. ": $error"
930 if ( $options{'reason'} ) {
931 $error = $self->insert_reason( 'reason' => $options{'reason'},
932 'action' => $date ? 'expire' : 'cancel',
933 'date' => $date ? $date : $cancel_time,
934 'reason_otaker' => $options{'reason_otaker'},
937 dbh->rollback if $oldAutoCommit;
938 return "Error inserting cust_pkg_reason: $error";
942 my %svc_cancel_opt = ();
943 $svc_cancel_opt{'date'} = $date if $date;
944 foreach my $cust_svc (
947 sort { $a->[1] <=> $b->[1] }
948 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
949 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
951 my $part_svc = $cust_svc->part_svc;
952 next if ( defined($part_svc) and $part_svc->preserve );
953 my $error = $cust_svc->cancel( %svc_cancel_opt );
956 $dbh->rollback if $oldAutoCommit;
957 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
963 # credit remaining time if appropriate
965 if ( exists($options{'unused_credit'}) ) {
966 $do_credit = $options{'unused_credit'};
969 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
972 my $error = $self->credit_remaining('cancel', $cancel_time);
974 $dbh->rollback if $oldAutoCommit;
980 my %hash = $self->hash;
982 $hash{'expire'} = $date;
984 # just to be sure these are clear
985 $hash{'adjourn'} = undef;
986 $hash{'resume'} = undef;
989 $hash{'cancel'} = $cancel_time;
991 $hash{'change_custnum'} = $options{'change_custnum'};
993 # if this is a supplemental package that's lost its part_pkg_link, and it's
994 # being canceled for real, unlink it completely
995 if ( !$date and ! $self->pkglinknum ) {
996 $hash{main_pkgnum} = '';
999 # if there is a future package change scheduled, unlink from it (like
1000 # abort_change) first, then delete it.
1001 $hash{'change_to_pkgnum'} = '';
1003 # save the package state
1004 my $new = new FS::cust_pkg ( \%hash );
1005 $error = $new->replace( $self, options => { $self->options } );
1007 if ( $self->change_to_pkgnum ) {
1008 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1009 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1012 $dbh->rollback if $oldAutoCommit;
1016 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1017 $error = $supp_pkg->cancel(%options,
1019 'date' => $date, #in case it got changed by delay_cancel
1020 'delay_cancel' => $delay_cancel,
1023 $dbh->rollback if $oldAutoCommit;
1024 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1028 if ($delay_cancel && !$options{'from_main'}) {
1029 $error = $new->suspend(
1031 'time' => $cancel_time
1036 foreach my $usage ( $self->cust_pkg_usage ) {
1037 $error = $usage->delete;
1039 $dbh->rollback if $oldAutoCommit;
1040 return "deleting usage pools: $error";
1045 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1046 return '' if $date; #no errors
1048 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
1049 if ( !$options{'quiet'} &&
1050 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
1052 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1055 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1056 $error = $msg_template->send( 'cust_main' => $self->cust_main,
1057 'object' => $self );
1059 #should this do something on errors?
1066 =item cancel_if_expired [ NOW_TIMESTAMP ]
1068 Cancels this package if its expire date has been reached.
1072 sub cancel_if_expired {
1074 my $time = shift || time;
1075 return '' unless $self->expire && $self->expire <= $time;
1076 my $error = $self->cancel;
1078 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1079 $self->custnum. ": $error";
1086 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1087 locationnum, (other fields?). Attempts to re-provision cancelled services
1088 using history information (errors at this stage are not fatal).
1090 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1092 svc_fatal: service provisioning errors are fatal
1094 svc_errors: pass an array reference, will be filled in with any provisioning errors
1096 main_pkgnum: link the package as a supplemental package of this one. For
1102 my( $self, %options ) = @_;
1104 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1105 return '' unless $self->get('cancel');
1107 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1108 return $self->main_pkg->uncancel(%options);
1115 my $oldAutoCommit = $FS::UID::AutoCommit;
1116 local $FS::UID::AutoCommit = 0;
1120 # insert the new package
1123 my $cust_pkg = new FS::cust_pkg {
1124 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1125 bill => ( $options{'bill'} || $self->get('bill') ),
1127 uncancel_pkgnum => $self->pkgnum,
1128 main_pkgnum => ($options{'main_pkgnum'} || ''),
1129 map { $_ => $self->get($_) } qw(
1130 custnum pkgpart locationnum
1132 susp adjourn resume expire start_date contract_end dundate
1133 change_date change_pkgpart change_locationnum
1134 manual_flag no_auto separate_bill quantity agent_pkgid
1135 recur_show_zero setup_show_zero
1139 my $error = $cust_pkg->insert(
1140 'change' => 1, #supresses any referral credit to a referring customer
1141 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1144 $dbh->rollback if $oldAutoCommit;
1152 #find historical services within this timeframe before the package cancel
1153 # (incompatible with "time" option to cust_pkg->cancel?)
1154 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1155 # too little? (unprovisioing export delay?)
1156 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1157 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1160 foreach my $h_cust_svc (@h_cust_svc) {
1161 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1162 #next unless $h_svc_x; #should this happen?
1163 (my $table = $h_svc_x->table) =~ s/^h_//;
1164 require "FS/$table.pm";
1165 my $class = "FS::$table";
1166 my $svc_x = $class->new( {
1167 'pkgnum' => $cust_pkg->pkgnum,
1168 'svcpart' => $h_cust_svc->svcpart,
1169 map { $_ => $h_svc_x->get($_) } fields($table)
1173 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1174 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1177 my $svc_error = $svc_x->insert;
1179 if ( $options{svc_fatal} ) {
1180 $dbh->rollback if $oldAutoCommit;
1183 # if we've failed to insert the svc_x object, svc_Common->insert
1184 # will have removed the cust_svc already. if not, then both records
1185 # were inserted but we failed for some other reason (export, most
1186 # likely). in that case, report the error and delete the records.
1187 push @svc_errors, $svc_error;
1188 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1190 # except if export_insert failed, export_delete probably won't be
1192 local $FS::svc_Common::noexport_hack = 1;
1193 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1194 if ( $cleanup_error ) { # and if THAT fails, then run away
1195 $dbh->rollback if $oldAutoCommit;
1196 return $cleanup_error;
1201 } #foreach $h_cust_svc
1203 #these are pretty rare, but should handle them
1204 # - dsl_device (mac addresses)
1205 # - phone_device (mac addresses)
1206 # - dsl_note (ikano notes)
1207 # - domain_record (i.e. restore DNS information w/domains)
1208 # - inventory_item(?) (inventory w/un-cancelling service?)
1209 # - nas (svc_broaband nas stuff)
1210 #this stuff is unused in the wild afaik
1211 # - mailinglistmember
1213 # - svc_domain.parent_svcnum?
1214 # - acct_snarf (ancient mail fetching config)
1215 # - cgp_rule (communigate)
1216 # - cust_svc_option (used by our Tron stuff)
1217 # - acct_rt_transaction (used by our time worked stuff)
1220 # also move over any services that didn't unprovision at cancellation
1223 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1224 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1225 my $error = $cust_svc->replace;
1227 $dbh->rollback if $oldAutoCommit;
1233 # Uncancel any supplemental packages, and make them supplemental to the
1237 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1239 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1241 $dbh->rollback if $oldAutoCommit;
1242 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1250 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1252 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1253 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1260 Cancels any pending expiration (sets the expire field to null).
1262 If there is an error, returns the error, otherwise returns false.
1267 my( $self, %options ) = @_;
1270 my $oldAutoCommit = $FS::UID::AutoCommit;
1271 local $FS::UID::AutoCommit = 0;
1274 my $old = $self->select_for_update;
1276 my $pkgnum = $old->pkgnum;
1277 if ( $old->get('cancel') || $self->get('cancel') ) {
1278 dbh->rollback if $oldAutoCommit;
1279 return "Can't unexpire cancelled package $pkgnum";
1280 # or at least it's pointless
1283 unless ( $old->get('expire') && $self->get('expire') ) {
1284 dbh->rollback if $oldAutoCommit;
1285 return ""; # no error
1288 my %hash = $self->hash;
1289 $hash{'expire'} = '';
1290 my $new = new FS::cust_pkg ( \%hash );
1291 $error = $new->replace( $self, options => { $self->options } );
1293 $dbh->rollback if $oldAutoCommit;
1297 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1303 =item suspend [ OPTION => VALUE ... ]
1305 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1306 package, then suspends the package itself (sets the susp field to now).
1308 Available options are:
1312 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1313 either a reasonnum of an existing reason, or passing a hashref will create
1314 a new reason. The hashref should have the following keys:
1315 - typenum - Reason type (see L<FS::reason_type>
1316 - reason - Text of the new reason.
1318 =item date - can be set to a unix style timestamp to specify when to
1321 =item time - can be set to override the current time, for calculation
1322 of final invoices or unused-time credits
1324 =item resume_date - can be set to a time when the package should be
1325 unsuspended. This may be more convenient than calling C<unsuspend()>
1328 =item from_main - allows a supplemental package to be suspended, rather
1329 than redirecting the method call to its main package. For internal use.
1331 =item from_cancel - used when suspending from the cancel method, forces
1332 this to skip everything besides basic suspension. For internal use.
1336 If there is an error, returns the error, otherwise returns false.
1341 my( $self, %options ) = @_;
1344 # supplemental packages still can't be separately suspended, but silently
1345 # exit instead of failing or passing the action to the main package (so
1346 # that the "Suspend customer" action doesn't trip over the supplemental
1349 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1353 my $oldAutoCommit = $FS::UID::AutoCommit;
1354 local $FS::UID::AutoCommit = 0;
1357 my $old = $self->select_for_update;
1359 my $pkgnum = $old->pkgnum;
1360 if ( $old->get('cancel') || $self->get('cancel') ) {
1361 dbh->rollback if $oldAutoCommit;
1362 return "Can't suspend cancelled package $pkgnum";
1365 if ( $old->get('susp') || $self->get('susp') ) {
1366 dbh->rollback if $oldAutoCommit;
1367 return ""; # no error # complain on adjourn?
1370 my $suspend_time = $options{'time'} || time;
1371 my $date = $options{date} if $options{date}; # adjourn/suspend later
1372 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1374 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1375 dbh->rollback if $oldAutoCommit;
1376 return "Package $pkgnum expires before it would be suspended.";
1379 # some false laziness with sub cancel
1380 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1381 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1382 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1383 # make the entire cust_main->bill path recognize 'suspend' and
1384 # 'cancel' separately.
1385 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1386 my $copy = $self->new({$self->hash});
1388 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1390 'time' => $suspend_time );
1391 warn "Error billing during suspend, custnum ".
1392 #$self->cust_main->custnum. ": $error"
1397 my $cust_pkg_reason;
1398 if ( $options{'reason'} ) {
1399 $error = $self->insert_reason( 'reason' => $options{'reason'},
1400 'action' => $date ? 'adjourn' : 'suspend',
1401 'date' => $date ? $date : $suspend_time,
1402 'reason_otaker' => $options{'reason_otaker'},
1405 dbh->rollback if $oldAutoCommit;
1406 return "Error inserting cust_pkg_reason: $error";
1408 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1409 'date' => $date ? $date : $suspend_time,
1410 'action' => $date ? 'A' : 'S',
1411 'pkgnum' => $self->pkgnum,
1415 # if a reasonnum was passed, get the actual reason object so we can check
1417 # (passing a reason hashref is still allowed, but it can't be used with
1418 # the fancy behavioral options.)
1421 if ($options{'reason'} =~ /^\d+$/) {
1422 $reason = FS::reason->by_key($options{'reason'});
1425 my %hash = $self->hash;
1427 $hash{'adjourn'} = $date;
1429 $hash{'susp'} = $suspend_time;
1432 my $resume_date = $options{'resume_date'} || 0;
1433 if ( $resume_date > ($date || $suspend_time) ) {
1434 $hash{'resume'} = $resume_date;
1437 $options{options} ||= {};
1439 my $new = new FS::cust_pkg ( \%hash );
1440 $error = $new->replace( $self, options => { $self->options,
1441 %{ $options{options} },
1445 $dbh->rollback if $oldAutoCommit;
1449 unless ( $date ) { # then we are suspending now
1451 unless ($options{'from_cancel'}) {
1452 # credit remaining time if appropriate
1453 # (if required by the package def, or the suspend reason)
1454 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1455 || ( defined($reason) && $reason->unused_credit );
1457 if ( $unused_credit ) {
1458 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1459 my $error = $self->credit_remaining('suspend', $suspend_time);
1461 $dbh->rollback if $oldAutoCommit;
1467 my @cust_svc = qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
1469 #attempt ordering ala cust_svc_suspend_cascade (without infinite-looping
1470 # on the circular dep case)
1471 # (this is too simple for multi-level deps, we need to use something
1472 # to resolve the DAG properly when possible)
1474 $svcpart{$_->svcpart} = 0 foreach @cust_svc;
1475 foreach my $svcpart ( keys %svcpart ) {
1476 foreach my $part_svc_link (
1477 FS::part_svc_link->by_agentnum($self->cust_main->agentnum,
1478 src_svcpart => $svcpart,
1479 link_type => 'cust_svc_suspend_cascade'
1482 $svcpart{$part_svc_link->dst_svcpart} = max(
1483 $svcpart{$part_svc_link->dst_svcpart},
1484 $svcpart{$part_svc_link->src_svcpart} + 1
1488 @cust_svc = sort { $svcpart{ $a->svcpart } <=> $svcpart{ $b->svcpart } }
1492 foreach my $cust_svc ( @cust_svc ) {
1493 $cust_svc->suspend( 'labels_arrayref' => \@labels );
1496 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1497 # and this is not a suspend-before-cancel
1498 if ( $cust_pkg_reason ) {
1499 my $reason_obj = $cust_pkg_reason->reason;
1500 if ( $reason_obj->feepart and
1501 ! $reason_obj->fee_on_unsuspend and
1502 ! $options{'from_cancel'} ) {
1504 # register the need to charge a fee, cust_main->bill will do the rest
1505 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1507 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1508 'pkgreasonnum' => $cust_pkg_reason->num,
1509 'pkgnum' => $self->pkgnum,
1510 'feepart' => $reason->feepart,
1511 'nextbill' => $reason->fee_hold,
1513 $error ||= $cust_pkg_reason_fee->insert;
1517 my $conf = new FS::Conf;
1518 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1520 my $error = send_email(
1521 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1522 #invoice_from ??? well as good as any
1523 'to' => $conf->config('suspend_email_admin'),
1524 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1526 "This is an automatic message from your Freeside installation\n",
1527 "informing you that the following customer package has been suspended:\n",
1529 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1530 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1531 ( map { "Service : $_\n" } @labels ),
1533 'custnum' => $self->custnum,
1534 'msgtype' => 'admin'
1538 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1546 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1547 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1549 $dbh->rollback if $oldAutoCommit;
1550 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1554 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1559 =item credit_remaining MODE TIME
1561 Generate a credit for this package for the time remaining in the current
1562 billing period. MODE is either "suspend" or "cancel" (determines the
1563 credit type). TIME is the time of suspension/cancellation. Both arguments
1568 # Implementation note:
1570 # If you pkgpart-change a package that has been billed, and it's set to give
1571 # credit on package change, then this method gets called and then the new
1572 # package will have no last_bill date. Therefore the customer will be credited
1573 # only once (per billing period) even if there are multiple package changes.
1575 # If you location-change a package that has been billed, this method will NOT
1576 # be called and the new package WILL have the last bill date of the old
1579 # If the new package is then canceled within the same billing cycle,
1580 # credit_remaining needs to run calc_remain on the OLD package to determine
1581 # the amount of unused time to credit.
1583 sub credit_remaining {
1584 # Add a credit for remaining service
1585 my ($self, $mode, $time) = @_;
1586 die 'credit_remaining requires suspend or cancel'
1587 unless $mode eq 'suspend' or $mode eq 'cancel';
1588 die 'no suspend/cancel time' unless $time > 0;
1590 my $conf = FS::Conf->new;
1591 my $reason_type = $conf->config($mode.'_credit_type');
1593 my $last_bill = $self->getfield('last_bill') || 0;
1594 my $next_bill = $self->getfield('bill') || 0;
1595 if ( $last_bill > 0 # the package has been billed
1596 and $next_bill > 0 # the package has a next bill date
1597 and $next_bill >= $time # which is in the future
1599 my @cust_credit_source_bill_pkg = ();
1600 my $remaining_value = 0;
1602 my $remain_pkg = $self;
1603 $remaining_value = $remain_pkg->calc_remain(
1605 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1608 # we may have to walk back past some package changes to get to the
1609 # one that actually has unused time
1610 while ( $remaining_value == 0 ) {
1611 if ( $remain_pkg->change_pkgnum ) {
1612 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1614 # the package has really never been billed
1617 $remaining_value = $remain_pkg->calc_remain(
1619 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1623 if ( $remaining_value > 0 ) {
1624 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1626 my $error = $self->cust_main->credit(
1628 'Credit for unused time on '. $self->part_pkg->pkg,
1629 'reason_type' => $reason_type,
1630 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1632 return "Error crediting customer \$$remaining_value for unused time".
1633 " on ". $self->part_pkg->pkg. ": $error"
1635 } #if $remaining_value
1636 } #if $last_bill, etc.
1640 =item unsuspend [ OPTION => VALUE ... ]
1642 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1643 package, then unsuspends the package itself (clears the susp field and the
1644 adjourn field if it is in the past). If the suspend reason includes an
1645 unsuspension package, that package will be ordered.
1647 Available options are:
1653 Can be set to a date to unsuspend the package in the future (the 'resume'
1656 =item adjust_next_bill
1658 Can be set true to adjust the next bill date forward by
1659 the amount of time the account was inactive. This was set true by default
1660 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1661 explicitly requested with this option or in the price plan.
1665 If there is an error, returns the error, otherwise returns false.
1670 my( $self, %opt ) = @_;
1673 # pass all suspend/cancel actions to the main package
1674 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1675 return $self->main_pkg->unsuspend(%opt);
1678 my $oldAutoCommit = $FS::UID::AutoCommit;
1679 local $FS::UID::AutoCommit = 0;
1682 my $old = $self->select_for_update;
1684 my $pkgnum = $old->pkgnum;
1685 if ( $old->get('cancel') || $self->get('cancel') ) {
1686 $dbh->rollback if $oldAutoCommit;
1687 return "Can't unsuspend cancelled package $pkgnum";
1690 unless ( $old->get('susp') && $self->get('susp') ) {
1691 $dbh->rollback if $oldAutoCommit;
1692 return ""; # no error # complain instead?
1695 # handle the case of setting a future unsuspend (resume) date
1696 # and do not continue to actually unsuspend the package
1697 my $date = $opt{'date'};
1698 if ( $date and $date > time ) { # return an error if $date <= time?
1700 if ( $old->get('expire') && $old->get('expire') < $date ) {
1701 $dbh->rollback if $oldAutoCommit;
1702 return "Package $pkgnum expires before it would be unsuspended.";
1705 my $new = new FS::cust_pkg { $self->hash };
1706 $new->set('resume', $date);
1707 $error = $new->replace($self, options => $self->options);
1710 $dbh->rollback if $oldAutoCommit;
1714 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1720 if (!$self->setup) {
1721 # then this package is being released from on-hold status
1722 $error = $self->set_initial_timers;
1724 $dbh->rollback if $oldAutoCommit;
1731 foreach my $cust_svc (
1732 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1734 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1736 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1737 $dbh->rollback if $oldAutoCommit;
1738 return "Illegal svcdb value in part_svc!";
1741 require "FS/$svcdb.pm";
1743 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1745 $error = $svc->unsuspend;
1747 $dbh->rollback if $oldAutoCommit;
1750 my( $label, $value ) = $cust_svc->label;
1751 push @labels, "$label: $value";
1756 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1757 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1759 my %hash = $self->hash;
1760 my $inactive = time - $hash{'susp'};
1762 my $conf = new FS::Conf;
1764 #adjust the next bill date forward
1765 # increment next bill date if certain conditions are met:
1766 # - it was due to be billed at some point
1767 # - either the global or local config says to do this
1768 my $adjust_bill = 0;
1771 && ( $hash{'bill'} || $hash{'setup'} )
1772 && ( $opt{'adjust_next_bill'}
1773 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1774 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1781 # - the package billed during suspension
1782 # - or it was ordered on hold
1783 # - or the customer was credited for the unused time
1785 if ( $self->option('suspend_bill',1)
1786 or ( $self->part_pkg->option('suspend_bill',1)
1787 and ! $self->option('no_suspend_bill',1)
1789 or $hash{'order_date'} == $hash{'susp'}
1794 if ( $adjust_bill ) {
1795 if ( $self->part_pkg->option('unused_credit_suspend')
1796 or ( ref($reason) and $reason->unused_credit ) ) {
1797 # then the customer was credited for the unused time before suspending,
1798 # so their next bill should be immediate
1799 $hash{'bill'} = time;
1801 # add the length of time suspended to the bill date
1802 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1807 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1808 $hash{'resume'} = '' if !$hash{'adjourn'};
1809 my $new = new FS::cust_pkg ( \%hash );
1810 $error = $new->replace( $self, options => { $self->options } );
1812 $dbh->rollback if $oldAutoCommit;
1819 if ( $reason->unsuspend_pkgpart ) {
1820 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
1821 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1822 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1824 my $start_date = $self->cust_main->next_bill_date
1825 if $reason->unsuspend_hold;
1828 $unsusp_pkg = FS::cust_pkg->new({
1829 'custnum' => $self->custnum,
1830 'pkgpart' => $reason->unsuspend_pkgpart,
1831 'start_date' => $start_date,
1832 'locationnum' => $self->locationnum,
1833 # discount? probably not...
1836 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1839 # new way, using fees
1840 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1841 # register the need to charge a fee, cust_main->bill will do the rest
1842 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1844 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1845 'pkgreasonnum' => $cust_pkg_reason->num,
1846 'pkgnum' => $self->pkgnum,
1847 'feepart' => $reason->feepart,
1848 'nextbill' => $reason->fee_hold,
1850 $error ||= $cust_pkg_reason_fee->insert;
1854 $dbh->rollback if $oldAutoCommit;
1859 if ( $conf->config('unsuspend_email_admin') ) {
1861 my $error = send_email(
1862 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1863 #invoice_from ??? well as good as any
1864 'to' => $conf->config('unsuspend_email_admin'),
1865 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1866 "This is an automatic message from your Freeside installation\n",
1867 "informing you that the following customer package has been unsuspended:\n",
1869 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1870 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1871 ( map { "Service : $_\n" } @labels ),
1873 "An unsuspension fee was charged: ".
1874 $unsusp_pkg->part_pkg->pkg_comment."\n"
1878 'custnum' => $self->custnum,
1879 'msgtype' => 'admin',
1883 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1889 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1890 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1892 $dbh->rollback if $oldAutoCommit;
1893 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1897 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1904 Cancels any pending suspension (sets the adjourn field to null).
1906 If there is an error, returns the error, otherwise returns false.
1911 my( $self, %options ) = @_;
1914 my $oldAutoCommit = $FS::UID::AutoCommit;
1915 local $FS::UID::AutoCommit = 0;
1918 my $old = $self->select_for_update;
1920 my $pkgnum = $old->pkgnum;
1921 if ( $old->get('cancel') || $self->get('cancel') ) {
1922 dbh->rollback if $oldAutoCommit;
1923 return "Can't unadjourn cancelled package $pkgnum";
1924 # or at least it's pointless
1927 if ( $old->get('susp') || $self->get('susp') ) {
1928 dbh->rollback if $oldAutoCommit;
1929 return "Can't unadjourn suspended package $pkgnum";
1930 # perhaps this is arbitrary
1933 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1934 dbh->rollback if $oldAutoCommit;
1935 return ""; # no error
1938 my %hash = $self->hash;
1939 $hash{'adjourn'} = '';
1940 $hash{'resume'} = '';
1941 my $new = new FS::cust_pkg ( \%hash );
1942 $error = $new->replace( $self, options => { $self->options } );
1944 $dbh->rollback if $oldAutoCommit;
1948 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1955 =item change HASHREF | OPTION => VALUE ...
1957 Changes this package: cancels it and creates a new one, with a different
1958 pkgpart or locationnum or both. All services are transferred to the new
1959 package (no change will be made if this is not possible).
1961 Options may be passed as a list of key/value pairs or as a hash reference.
1968 New locationnum, to change the location for this package.
1972 New FS::cust_location object, to create a new location and assign it
1977 New FS::cust_main object, to create a new customer and assign the new package
1982 New pkgpart (see L<FS::part_pkg>).
1986 New refnum (see L<FS::part_referral>).
1990 New quantity; if unspecified, the new package will have the same quantity
1995 "New" (existing) FS::cust_pkg object. The package's services and other
1996 attributes will be transferred to this package.
2000 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2001 susp, adjourn, cancel, expire, and contract_end) to the new package.
2003 =item unprotect_svcs
2005 Normally, change() will rollback and return an error if some services
2006 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2007 If unprotect_svcs is true, this method will transfer as many services as
2008 it can and then unconditionally cancel the old package.
2012 If specified, sets this value for the contract_end date on the new package
2013 (without regard for keep_dates or the usual date-preservation behavior.)
2014 Will throw an error if defined but false; the UI doesn't allow editing
2015 this unless it already exists, making removal impossible to undo.
2019 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2020 cust_pkg must be specified (otherwise, what's the point?)
2022 Returns either the new FS::cust_pkg object or a scalar error.
2026 my $err_or_new_cust_pkg = $old_cust_pkg->change
2030 #used by change and change_later
2031 #didn't put with documented check methods because it depends on change-specific opts
2032 #and it also possibly edits the value of opts
2036 if ( defined($opt->{'contract_end'}) ) {
2037 my $current_contract_end = $self->get('contract_end');
2038 unless ($opt->{'contract_end'}) {
2039 if ($current_contract_end) {
2040 return "Cannot remove contract end date when changing packages";
2042 #shouldn't even pass this option if there's not a current value
2043 #but can be handled gracefully if the option is empty
2044 warn "Contract end date passed unexpectedly";
2045 delete $opt->{'contract_end'};
2049 unless ($current_contract_end) {
2050 #option shouldn't be passed, throw error if it's non-empty
2051 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2057 #some false laziness w/order
2060 my $opt = ref($_[0]) ? shift : { @_ };
2062 my $conf = new FS::Conf;
2064 # handle contract_end on cust_pkg same as passed option
2065 if ( $opt->{'cust_pkg'} ) {
2066 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2067 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2070 # check contract_end, prevent adding/removing
2071 my $error = $self->_check_change($opt);
2072 return $error if $error;
2074 # Transactionize this whole mess
2075 my $oldAutoCommit = $FS::UID::AutoCommit;
2076 local $FS::UID::AutoCommit = 0;
2079 if ( $opt->{'cust_location'} ) {
2080 $error = $opt->{'cust_location'}->find_or_insert;
2082 $dbh->rollback if $oldAutoCommit;
2083 return "creating location record: $error";
2085 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2088 # Before going any further here: if the package is still in the pre-setup
2089 # state, it's safe to modify it in place. No need to charge/credit for
2090 # partial period, transfer services, transfer usage pools, copy invoice
2091 # details, or change any dates.
2092 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2093 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2094 if ( length($opt->{$_}) ) {
2095 $self->set($_, $opt->{$_});
2098 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2100 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2101 $error ||= $self->set_initial_timers;
2103 # but if contract_end was explicitly specified, that overrides all else
2104 $self->set('contract_end', $opt->{'contract_end'})
2105 if $opt->{'contract_end'};
2106 $error ||= $self->replace;
2108 $dbh->rollback if $oldAutoCommit;
2109 return "modifying package: $error";
2111 $dbh->commit if $oldAutoCommit;
2120 $hash{'setup'} = $time if $self->setup;
2122 $hash{'change_date'} = $time;
2123 $hash{"change_$_"} = $self->$_()
2124 foreach qw( pkgnum pkgpart locationnum );
2126 if ( $opt->{'cust_pkg'} ) {
2127 # treat changing to a package with a different pkgpart as a
2128 # pkgpart change (because it is)
2129 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2132 # whether to override pkgpart checking on the new package
2133 my $same_pkgpart = 1;
2134 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2138 my $unused_credit = 0;
2139 my $keep_dates = $opt->{'keep_dates'};
2141 # Special case. If the pkgpart is changing, and the customer is
2142 # going to be credited for remaining time, don't keep setup, bill,
2143 # or last_bill dates, and DO pass the flag to cancel() to credit
2145 if ( $opt->{'pkgpart'}
2146 and $opt->{'pkgpart'} != $self->pkgpart
2147 and $self->part_pkg->option('unused_credit_change', 1) ) {
2150 $hash{$_} = '' foreach qw(setup bill last_bill);
2153 if ( $keep_dates ) {
2154 foreach my $date ( qw(setup bill last_bill) ) {
2155 $hash{$date} = $self->getfield($date);
2158 # always keep the following dates
2159 foreach my $date (qw(order_date susp adjourn cancel expire resume
2160 start_date contract_end)) {
2161 $hash{$date} = $self->getfield($date);
2163 # but if contract_end was explicitly specified, that overrides all else
2164 $hash{'contract_end'} = $opt->{'contract_end'}
2165 if $opt->{'contract_end'};
2167 # allow $opt->{'locationnum'} = '' to specifically set it to null
2168 # (i.e. customer default location)
2169 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2171 # usually this doesn't matter. the two cases where it does are:
2172 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2174 # 2. (more importantly) changing a package before it's billed
2175 $hash{'waive_setup'} = $self->waive_setup;
2177 # if this package is scheduled for a future package change, preserve that
2178 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2180 my $custnum = $self->custnum;
2181 if ( $opt->{cust_main} ) {
2182 my $cust_main = $opt->{cust_main};
2183 unless ( $cust_main->custnum ) {
2184 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2186 $dbh->rollback if $oldAutoCommit;
2187 return "inserting customer record: $error";
2190 $custnum = $cust_main->custnum;
2193 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2196 if ( $opt->{'cust_pkg'} ) {
2197 # The target package already exists; update it to show that it was
2198 # changed from this package.
2199 $cust_pkg = $opt->{'cust_pkg'};
2201 # follow all the above rules for date changes, etc.
2202 foreach (keys %hash) {
2203 $cust_pkg->set($_, $hash{$_});
2205 # except those that implement the future package change behavior
2206 foreach (qw(change_to_pkgnum start_date expire)) {
2207 $cust_pkg->set($_, '');
2210 $error = $cust_pkg->replace;
2213 # Create the new package.
2214 $cust_pkg = new FS::cust_pkg {
2215 custnum => $custnum,
2216 locationnum => $opt->{'locationnum'},
2217 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2218 qw( pkgpart quantity refnum salesnum )
2222 $error = $cust_pkg->insert( 'change' => 1,
2223 'allow_pkgpart' => $same_pkgpart );
2226 $dbh->rollback if $oldAutoCommit;
2227 return "inserting new package: $error";
2230 # Transfer services and cancel old package.
2231 # Enforce service limits only if this is a pkgpart change.
2232 local $FS::cust_svc::ignore_quantity;
2233 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2234 $error = $self->transfer($cust_pkg);
2235 if ($error and $error == 0) {
2236 # $old_pkg->transfer failed.
2237 $dbh->rollback if $oldAutoCommit;
2238 return "transferring $error";
2241 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2242 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2243 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2244 if ($error and $error == 0) {
2245 # $old_pkg->transfer failed.
2246 $dbh->rollback if $oldAutoCommit;
2247 return "converting $error";
2251 # We set unprotect_svcs when executing a "future package change". It's
2252 # not a user-interactive operation, so returning an error means the
2253 # package change will just fail. Rather than have that happen, we'll
2254 # let leftover services be deleted.
2255 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2256 # Transfers were successful, but we still had services left on the old
2257 # package. We can't change the package under this circumstances, so abort.
2258 $dbh->rollback if $oldAutoCommit;
2259 return "unable to transfer all services";
2262 #reset usage if changing pkgpart
2263 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2264 if ($self->pkgpart != $cust_pkg->pkgpart) {
2265 my $part_pkg = $cust_pkg->part_pkg;
2266 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2270 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2273 $dbh->rollback if $oldAutoCommit;
2274 return "setting usage values: $error";
2277 # if NOT changing pkgpart, transfer any usage pools over
2278 foreach my $usage ($self->cust_pkg_usage) {
2279 $usage->set('pkgnum', $cust_pkg->pkgnum);
2280 $error = $usage->replace;
2282 $dbh->rollback if $oldAutoCommit;
2283 return "transferring usage pools: $error";
2288 # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2289 if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2290 my @old_cust_pkg_usageprice;
2291 if ($opt->{'cust_pkg_usageprice'}) {
2292 @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2294 @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2296 foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2297 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2298 'pkgnum' => $cust_pkg->pkgnum,
2299 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2300 'quantity' => $old_cust_pkg_usageprice->quantity,
2302 $error = $new_cust_pkg_usageprice->insert;
2304 $dbh->rollback if $oldAutoCommit;
2305 return "Error transferring usage pricing add-on: $error";
2310 # transfer discounts, if we're not changing pkgpart
2311 if ( $same_pkgpart ) {
2312 foreach my $old_discount ($self->cust_pkg_discount_active) {
2313 # don't remove the old discount, we may still need to bill that package.
2314 my $new_discount = new FS::cust_pkg_discount {
2315 'pkgnum' => $cust_pkg->pkgnum,
2316 'discountnum' => $old_discount->discountnum,
2317 'months_used' => $old_discount->months_used,
2319 $error = $new_discount->insert;
2321 $dbh->rollback if $oldAutoCommit;
2322 return "transferring discounts: $error";
2327 # transfer (copy) invoice details
2328 foreach my $detail ($self->cust_pkg_detail) {
2329 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2330 $new_detail->set('pkgdetailnum', '');
2331 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2332 $error = $new_detail->insert;
2334 $dbh->rollback if $oldAutoCommit;
2335 return "transferring package notes: $error";
2341 if ( !$opt->{'cust_pkg'} ) {
2342 # Order any supplemental packages.
2343 my $part_pkg = $cust_pkg->part_pkg;
2344 my @old_supp_pkgs = $self->supplemental_pkgs;
2345 foreach my $link ($part_pkg->supp_part_pkg_link) {
2347 foreach (@old_supp_pkgs) {
2348 if ($_->pkgpart == $link->dst_pkgpart) {
2350 $_->pkgpart(0); # so that it can't match more than once
2354 # false laziness with FS::cust_main::Packages::order_pkg
2355 my $new = FS::cust_pkg->new({
2356 pkgpart => $link->dst_pkgpart,
2357 pkglinknum => $link->pkglinknum,
2358 custnum => $custnum,
2359 main_pkgnum => $cust_pkg->pkgnum,
2360 locationnum => $cust_pkg->locationnum,
2361 start_date => $cust_pkg->start_date,
2362 order_date => $cust_pkg->order_date,
2363 expire => $cust_pkg->expire,
2364 adjourn => $cust_pkg->adjourn,
2365 contract_end => $cust_pkg->contract_end,
2366 refnum => $cust_pkg->refnum,
2367 discountnum => $cust_pkg->discountnum,
2368 waive_setup => $cust_pkg->waive_setup,
2370 if ( $old and $opt->{'keep_dates'} ) {
2371 foreach (qw(setup bill last_bill)) {
2372 $new->set($_, $old->get($_));
2375 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2378 $error ||= $old->transfer($new);
2380 if ( $error and $error > 0 ) {
2381 # no reason why this should ever fail, but still...
2382 $error = "Unable to transfer all services from supplemental package ".
2386 $dbh->rollback if $oldAutoCommit;
2389 push @new_supp_pkgs, $new;
2391 } # if !$opt->{'cust_pkg'}
2392 # because if there is one, then supplemental packages would already
2393 # have been created for it.
2395 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2397 #Don't allow billing the package (preceding period packages and/or
2398 #outstanding usage) if we are keeping dates (i.e. location changing),
2399 #because the new package will be billed for the same date range.
2400 #Supplemental packages are also canceled here.
2402 # during scheduled changes, avoid canceling the package we just
2404 $self->set('change_to_pkgnum' => '');
2406 $error = $self->cancel(
2408 unused_credit => $unused_credit,
2409 nobill => $keep_dates,
2410 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2411 no_delay_cancel => 1,
2414 $dbh->rollback if $oldAutoCommit;
2415 return "canceling old package: $error";
2418 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2420 my $error = $cust_pkg->cust_main->bill(
2421 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2424 $dbh->rollback if $oldAutoCommit;
2425 return "billing new package: $error";
2429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2435 =item change_later OPTION => VALUE...
2437 Schedule a package change for a later date. This actually orders the new
2438 package immediately, but sets its start date for a future date, and sets
2439 the current package to expire on the same date.
2441 If the package is already scheduled for a change, this can be called with
2442 'start_date' to change the scheduled date, or with pkgpart and/or
2443 locationnum to modify the package change. To cancel the scheduled change
2444 entirely, see C<abort_change>.
2452 The date for the package change. Required, and must be in the future.
2462 The pkgpart, locationnum, quantity and optional contract_end of the new
2463 package, with the same meaning as in C<change>.
2471 my $opt = ref($_[0]) ? shift : { @_ };
2473 # check contract_end, prevent adding/removing
2474 my $error = $self->_check_change($opt);
2475 return $error if $error;
2477 my $oldAutoCommit = $FS::UID::AutoCommit;
2478 local $FS::UID::AutoCommit = 0;
2481 my $cust_main = $self->cust_main;
2483 my $date = delete $opt->{'start_date'} or return 'start_date required';
2485 if ( $date <= time ) {
2486 $dbh->rollback if $oldAutoCommit;
2487 return "start_date $date is in the past";
2490 if ( $self->change_to_pkgnum ) {
2491 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2492 my $new_pkgpart = $opt->{'pkgpart'}
2493 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2494 my $new_locationnum = $opt->{'locationnum'}
2495 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2496 my $new_quantity = $opt->{'quantity'}
2497 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2498 my $new_contract_end = $opt->{'contract_end'}
2499 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2500 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2501 # it hasn't been billed yet, so in principle we could just edit
2502 # it in place (w/o a package change), but that's bad form.
2503 # So change the package according to the new options...
2504 my $err_or_pkg = $change_to->change(%$opt);
2505 if ( ref $err_or_pkg ) {
2506 # Then set that package up for a future start.
2507 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2508 $self->set('expire', $date); # in case it's different
2509 $err_or_pkg->set('start_date', $date);
2510 $err_or_pkg->set('change_date', '');
2511 $err_or_pkg->set('change_pkgnum', '');
2513 $error = $self->replace ||
2514 $err_or_pkg->replace ||
2515 #because change() might've edited existing scheduled change in place
2516 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2517 $change_to->cancel('no_delay_cancel' => 1) ||
2518 $change_to->delete);
2520 $error = $err_or_pkg;
2522 } else { # change the start date only.
2523 $self->set('expire', $date);
2524 $change_to->set('start_date', $date);
2525 $error = $self->replace || $change_to->replace;
2528 $dbh->rollback if $oldAutoCommit;
2531 $dbh->commit if $oldAutoCommit;
2534 } # if $self->change_to_pkgnum
2536 my $new_pkgpart = $opt->{'pkgpart'}
2537 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2538 my $new_locationnum = $opt->{'locationnum'}
2539 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2540 my $new_quantity = $opt->{'quantity'}
2541 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2542 my $new_contract_end = $opt->{'contract_end'}
2543 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2545 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2547 # allow $opt->{'locationnum'} = '' to specifically set it to null
2548 # (i.e. customer default location)
2549 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2551 my $new = FS::cust_pkg->new( {
2552 custnum => $self->custnum,
2553 locationnum => $opt->{'locationnum'},
2554 start_date => $date,
2555 map { $_ => ( $opt->{$_} || $self->$_() ) }
2556 qw( pkgpart quantity refnum salesnum contract_end )
2558 $error = $new->insert('change' => 1,
2559 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2561 $self->set('change_to_pkgnum', $new->pkgnum);
2562 $self->set('expire', $date);
2563 $error = $self->replace;
2566 $dbh->rollback if $oldAutoCommit;
2568 $dbh->commit if $oldAutoCommit;
2576 Cancels a future package change scheduled by C<change_later>.
2582 my $oldAutoCommit = $FS::UID::AutoCommit;
2583 local $FS::UID::AutoCommit = 0;
2585 my $pkgnum = $self->change_to_pkgnum;
2586 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2588 $self->set('change_to_pkgnum', '');
2589 $self->set('expire', '');
2590 $error = $self->replace;
2592 $error ||= $change_to->cancel || $change_to->delete;
2595 if ( $oldAutoCommit ) {
2606 =item set_quantity QUANTITY
2608 Change the package's quantity field. This is one of the few package properties
2609 that can safely be changed without canceling and reordering the package
2610 (because it doesn't affect tax eligibility). Returns an error or an
2617 $self = $self->replace_old; # just to make sure
2618 $self->quantity(shift);
2622 =item set_salesnum SALESNUM
2624 Change the package's salesnum (sales person) field. This is one of the few
2625 package properties that can safely be changed without canceling and reordering
2626 the package (because it doesn't affect tax eligibility). Returns an error or
2633 $self = $self->replace_old; # just to make sure
2634 $self->salesnum(shift);
2636 # XXX this should probably reassign any credit that's already been given
2639 =item modify_charge OPTIONS
2641 Change the properties of a one-time charge. The following properties can
2642 be changed this way:
2643 - pkg: the package description
2644 - classnum: the package class
2645 - additional: arrayref of additional invoice details to add to this package
2647 and, I<if the charge has not yet been billed>:
2648 - start_date: the date when it will be billed
2649 - amount: the setup fee to be charged
2650 - quantity: the multiplier for the setup fee
2651 - separate_bill: whether to put the charge on a separate invoice
2653 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2654 commission credits linked to this charge, they will be recalculated.
2661 my $part_pkg = $self->part_pkg;
2662 my $pkgnum = $self->pkgnum;
2665 my $oldAutoCommit = $FS::UID::AutoCommit;
2666 local $FS::UID::AutoCommit = 0;
2668 return "Can't use modify_charge except on one-time charges"
2669 unless $part_pkg->freq eq '0';
2671 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2672 $part_pkg->set('pkg', $opt{'pkg'});
2675 my %pkg_opt = $part_pkg->options;
2676 my $pkg_opt_modified = 0;
2678 $opt{'additional'} ||= [];
2681 foreach (grep /^additional/, keys %pkg_opt) {
2682 ($i) = ($_ =~ /^additional_info(\d+)$/);
2683 $old_additional[$i] = $pkg_opt{$_} if $i;
2684 delete $pkg_opt{$_};
2687 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2688 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2689 if (!exists($old_additional[$i])
2690 or $old_additional[$i] ne $opt{'additional'}->[$i])
2692 $pkg_opt_modified = 1;
2695 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2696 $pkg_opt{'additional_count'} = $i if $i > 0;
2699 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2702 $old_classnum = $part_pkg->classnum;
2703 $part_pkg->set('classnum', $opt{'classnum'});
2706 if ( !$self->get('setup') ) {
2707 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2710 if ( exists($opt{'amount'})
2711 and $part_pkg->option('setup_fee') != $opt{'amount'}
2712 and $opt{'amount'} > 0 ) {
2714 $pkg_opt{'setup_fee'} = $opt{'amount'};
2715 $pkg_opt_modified = 1;
2718 if ( exists($opt{'setup_cost'})
2719 and $part_pkg->setup_cost != $opt{'setup_cost'}
2720 and $opt{'setup_cost'} > 0 ) {
2722 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2725 if ( exists($opt{'quantity'})
2726 and $opt{'quantity'} != $self->quantity
2727 and $opt{'quantity'} > 0 ) {
2729 $self->set('quantity', $opt{'quantity'});
2732 if ( exists($opt{'start_date'})
2733 and $opt{'start_date'} != $self->start_date ) {
2735 $self->set('start_date', $opt{'start_date'});
2738 if ( exists($opt{'separate_bill'})
2739 and $opt{'separate_bill'} ne $self->separate_bill ) {
2741 $self->set('separate_bill', $opt{'separate_bill'});
2745 } # else simply ignore them; the UI shouldn't allow editing the fields
2748 if ( exists($opt{'taxclass'})
2749 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2751 $part_pkg->set('taxclass', $opt{'taxclass'});
2755 if ( $part_pkg->modified or $pkg_opt_modified ) {
2756 # can we safely modify the package def?
2757 # Yes, if it's not available for purchase, and this is the only instance
2759 if ( $part_pkg->disabled
2760 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2761 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2763 $error = $part_pkg->replace( options => \%pkg_opt );
2766 $part_pkg = $part_pkg->clone;
2767 $part_pkg->set('disabled' => 'Y');
2768 $error = $part_pkg->insert( options => \%pkg_opt );
2769 # and associate this as yet-unbilled package to the new package def
2770 $self->set('pkgpart' => $part_pkg->pkgpart);
2773 $dbh->rollback if $oldAutoCommit;
2778 if ($self->modified) { # for quantity or start_date change, or if we had
2779 # to clone the existing package def
2780 my $error = $self->replace;
2781 return $error if $error;
2783 if (defined $old_classnum) {
2784 # fix invoice grouping records
2785 my $old_catname = $old_classnum
2786 ? FS::pkg_class->by_key($old_classnum)->categoryname
2788 my $new_catname = $opt{'classnum'}
2789 ? $part_pkg->pkg_class->categoryname
2791 if ( $old_catname ne $new_catname ) {
2792 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2793 # (there should only be one...)
2794 my @display = qsearch( 'cust_bill_pkg_display', {
2795 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2796 'section' => $old_catname,
2798 foreach (@display) {
2799 $_->set('section', $new_catname);
2800 $error = $_->replace;
2802 $dbh->rollback if $oldAutoCommit;
2806 } # foreach $cust_bill_pkg
2809 if ( $opt{'adjust_commission'} ) {
2810 # fix commission credits...tricky.
2811 foreach my $cust_event ($self->cust_event) {
2812 my $part_event = $cust_event->part_event;
2813 foreach my $table (qw(sales agent)) {
2815 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2816 my $credit = qsearchs('cust_credit', {
2817 'eventnum' => $cust_event->eventnum,
2819 if ( $part_event->isa($class) ) {
2820 # Yes, this results in current commission rates being applied
2821 # retroactively to a one-time charge. For accounting purposes
2822 # there ought to be some kind of time limit on doing this.
2823 my $amount = $part_event->_calc_credit($self);
2824 if ( $credit and $credit->amount ne $amount ) {
2825 # Void the old credit.
2826 $error = $credit->void('Package class changed');
2828 $dbh->rollback if $oldAutoCommit;
2829 return "$error (adjusting commission credit)";
2832 # redo the event action to recreate the credit.
2834 eval { $part_event->do_action( $self, $cust_event ) };
2836 $dbh->rollback if $oldAutoCommit;
2839 } # if $part_event->isa($class)
2841 } # foreach $cust_event
2842 } # if $opt{'adjust_commission'}
2843 } # if defined $old_classnum
2845 $dbh->commit if $oldAutoCommit;
2852 sub process_bulk_cust_pkg {
2855 warn Dumper($param) if $DEBUG;
2857 my $old_part_pkg = qsearchs('part_pkg',
2858 { pkgpart => $param->{'old_pkgpart'} });
2859 my $new_part_pkg = qsearchs('part_pkg',
2860 { pkgpart => $param->{'new_pkgpart'} });
2861 die "Must select a new package type\n" unless $new_part_pkg;
2862 #my $keep_dates = $param->{'keep_dates'} || 0;
2863 my $keep_dates = 1; # there is no good reason to turn this off
2865 my $oldAutoCommit = $FS::UID::AutoCommit;
2866 local $FS::UID::AutoCommit = 0;
2869 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2872 foreach my $old_cust_pkg ( @cust_pkgs ) {
2874 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2875 if ( $old_cust_pkg->getfield('cancel') ) {
2876 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2877 $old_cust_pkg->pkgnum."\n"
2881 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2883 my $error = $old_cust_pkg->change(
2884 'pkgpart' => $param->{'new_pkgpart'},
2885 'keep_dates' => $keep_dates
2887 if ( !ref($error) ) { # change returns the cust_pkg on success
2889 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2892 $dbh->commit if $oldAutoCommit;
2898 Returns the last bill date, or if there is no last bill date, the setup date.
2899 Useful for billing metered services.
2905 return $self->setfield('last_bill', $_[0]) if @_;
2906 return $self->getfield('last_bill') if $self->getfield('last_bill');
2907 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2908 'edate' => $self->bill, } );
2909 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2912 =item last_cust_pkg_reason ACTION
2914 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2915 Returns false if there is no reason or the package is not currenly ACTION'd
2916 ACTION is one of adjourn, susp, cancel, or expire.
2920 sub last_cust_pkg_reason {
2921 my ( $self, $action ) = ( shift, shift );
2922 my $date = $self->get($action);
2924 'table' => 'cust_pkg_reason',
2925 'hashref' => { 'pkgnum' => $self->pkgnum,
2926 'action' => substr(uc($action), 0, 1),
2929 'order_by' => 'ORDER BY num DESC LIMIT 1',
2933 =item last_reason ACTION
2935 Returns the most recent ACTION FS::reason associated with the package.
2936 Returns false if there is no reason or the package is not currenly ACTION'd
2937 ACTION is one of adjourn, susp, cancel, or expire.
2942 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2943 $cust_pkg_reason->reason
2944 if $cust_pkg_reason;
2949 Returns the definition for this billing item, as an FS::part_pkg object (see
2956 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2957 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2958 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2963 Returns the cancelled package this package was changed from, if any.
2969 return '' unless $self->change_pkgnum;
2970 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2973 =item change_cust_main
2975 Returns the customter this package was detached to, if any.
2979 sub change_cust_main {
2981 return '' unless $self->change_custnum;
2982 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2987 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2994 $self->part_pkg->calc_setup($self, @_);
2999 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3006 $self->part_pkg->calc_recur($self, @_);
3011 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3018 $self->part_pkg->base_setup($self, @_);
3023 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3030 $self->part_pkg->base_recur($self, @_);
3035 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3042 $self->part_pkg->calc_remain($self, @_);
3047 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3054 $self->part_pkg->calc_cancel($self, @_);
3059 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3065 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3068 =item cust_pkg_detail [ DETAILTYPE ]
3070 Returns any customer package details for this package (see
3071 L<FS::cust_pkg_detail>).
3073 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3077 sub cust_pkg_detail {
3079 my %hash = ( 'pkgnum' => $self->pkgnum );
3080 $hash{detailtype} = shift if @_;
3082 'table' => 'cust_pkg_detail',
3083 'hashref' => \%hash,
3084 'order_by' => 'ORDER BY weight, pkgdetailnum',
3088 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3090 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3092 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3094 If there is an error, returns the error, otherwise returns false.
3098 sub set_cust_pkg_detail {
3099 my( $self, $detailtype, @details ) = @_;
3101 my $oldAutoCommit = $FS::UID::AutoCommit;
3102 local $FS::UID::AutoCommit = 0;
3105 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3106 my $error = $current->delete;
3108 $dbh->rollback if $oldAutoCommit;
3109 return "error removing old detail: $error";
3113 foreach my $detail ( @details ) {
3114 my $cust_pkg_detail = new FS::cust_pkg_detail {
3115 'pkgnum' => $self->pkgnum,
3116 'detailtype' => $detailtype,
3117 'detail' => $detail,
3119 my $error = $cust_pkg_detail->insert;
3121 $dbh->rollback if $oldAutoCommit;
3122 return "error adding new detail: $error";
3127 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3134 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3138 #false laziness w/cust_bill.pm
3142 'table' => 'cust_event',
3143 'addl_from' => 'JOIN part_event USING ( eventpart )',
3144 'hashref' => { 'tablenum' => $self->pkgnum },
3145 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3149 =item num_cust_event
3151 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3155 #false laziness w/cust_bill.pm
3156 sub num_cust_event {
3158 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3159 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3162 =item exists_cust_event
3164 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3168 sub exists_cust_event {
3170 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3171 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3172 $row ? $row->[0] : '';
3175 sub _from_cust_event_where {
3177 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3178 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3182 my( $self, $sql, @args ) = @_;
3183 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3184 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3188 =item part_pkg_currency_option OPTIONNAME
3190 Returns a two item list consisting of the currency of this customer, if any,
3191 and a value for the provided option. If the customer has a currency, the value
3192 is the option value the given name and the currency (see
3193 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3194 regular option value for the given name (see L<FS::part_pkg_option>).
3198 sub part_pkg_currency_option {
3199 my( $self, $optionname ) = @_;
3200 my $part_pkg = $self->part_pkg;
3201 if ( my $currency = $self->cust_main->currency ) {
3202 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3204 ('', $part_pkg->option($optionname) );
3208 =item cust_svc [ SVCPART ] (old, deprecated usage)
3210 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3212 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3214 Returns the services for this package, as FS::cust_svc objects (see
3215 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3216 spcififed, returns only the matching services.
3218 As an optimization, use the cust_svc_unsorted version if you are not displaying
3225 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3226 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3229 sub cust_svc_unsorted {
3231 @{ $self->cust_svc_unsorted_arrayref(@_) };
3234 sub cust_svc_unsorted_arrayref {
3237 return [] unless $self->num_cust_svc(@_);
3240 if ( @_ && $_[0] =~ /^\d+/ ) {
3241 $opt{svcpart} = shift;
3242 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3249 'table' => 'cust_svc',
3250 'hashref' => { 'pkgnum' => $self->pkgnum },
3252 if ( $opt{svcpart} ) {
3253 $search{hashref}->{svcpart} = $opt{'svcpart'};
3255 if ( $opt{'svcdb'} ) {
3256 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3257 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3260 [ qsearch(\%search) ];
3264 =item overlimit [ SVCPART ]
3266 Returns the services for this package which have exceeded their
3267 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3268 is specified, return only the matching services.
3274 return () unless $self->num_cust_svc(@_);
3275 grep { $_->overlimit } $self->cust_svc(@_);
3278 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3280 Returns historical services for this package created before END TIMESTAMP and
3281 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3282 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3283 I<pkg_svc.hidden> flag will be omitted.
3289 warn "$me _h_cust_svc called on $self\n"
3292 my ($end, $start, $mode) = @_;
3294 local($FS::Record::qsearch_qualify_columns) = 0;
3296 my @cust_svc = $self->_sort_cust_svc(
3297 [ qsearch( 'h_cust_svc',
3298 { 'pkgnum' => $self->pkgnum, },
3299 FS::h_cust_svc->sql_h_search(@_),
3303 if ( defined($mode) && $mode eq 'I' ) {
3304 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3305 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3311 sub _sort_cust_svc {
3312 my( $self, $arrayref ) = @_;
3315 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3317 my %pkg_svc = map { $_->svcpart => $_ }
3318 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3323 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3325 $pkg_svc ? $pkg_svc->primary_svc : '',
3326 $pkg_svc ? $pkg_svc->quantity : 0,
3333 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3335 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3337 Returns the number of services for this package. Available options are svcpart
3338 and svcdb. If either is spcififed, returns only the matching services.
3345 return $self->{'_num_cust_svc'}
3347 && exists($self->{'_num_cust_svc'})
3348 && $self->{'_num_cust_svc'} =~ /\d/;
3350 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3354 if ( @_ && $_[0] =~ /^\d+/ ) {
3355 $opt{svcpart} = shift;
3356 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3362 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3363 my $where = ' WHERE pkgnum = ? ';
3364 my @param = ($self->pkgnum);
3366 if ( $opt{'svcpart'} ) {
3367 $where .= ' AND svcpart = ? ';
3368 push @param, $opt{'svcpart'};
3370 if ( $opt{'svcdb'} ) {
3371 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3372 $where .= ' AND svcdb = ? ';
3373 push @param, $opt{'svcdb'};
3376 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3377 $sth->execute(@param) or die $sth->errstr;
3378 $sth->fetchrow_arrayref->[0];
3381 =item available_part_svc
3383 Returns a list of FS::part_svc objects representing services included in this
3384 package but not yet provisioned. Each FS::part_svc object also has an extra
3385 field, I<num_avail>, which specifies the number of available services.
3387 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3388 associated pkg_svc has the provision_hold flag set.
3392 sub available_part_svc {
3396 my $pkg_quantity = $self->quantity || 1;
3398 grep { $_->num_avail > 0 }
3400 my $part_svc = $_->part_svc;
3401 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3402 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3404 # more evil encapsulation breakage
3405 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3406 my @exports = $part_svc->part_export_did;
3407 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3412 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3413 $self->part_pkg->pkg_svc;
3416 =item part_svc [ OPTION => VALUE ... ]
3418 Returns a list of FS::part_svc objects representing provisioned and available
3419 services included in this package. Each FS::part_svc object also has the
3420 following extra fields:
3434 (services) - array reference containing the provisioned services, as cust_svc objects
3438 Accepts two options:
3442 =item summarize_size
3444 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3445 is this size or greater.
3447 =item hide_discontinued
3449 If true, will omit looking for services that are no longer avaialble in the
3457 #label -> ($cust_svc->label)[1]
3463 my $pkg_quantity = $self->quantity || 1;
3465 #XXX some sort of sort order besides numeric by svcpart...
3466 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3468 my $part_svc = $pkg_svc->part_svc;
3469 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3470 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3471 $part_svc->{'Hash'}{'num_avail'} =
3472 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3473 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3474 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3475 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3476 && $num_cust_svc >= $opt{summarize_size};
3477 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3479 } $self->part_pkg->pkg_svc;
3481 unless ( $opt{hide_discontinued} ) {
3483 push @part_svc, map {
3485 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3486 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3487 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3488 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3489 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3491 } $self->extra_part_svc;
3498 =item extra_part_svc
3500 Returns a list of FS::part_svc objects corresponding to services in this
3501 package which are still provisioned but not (any longer) available in the
3506 sub extra_part_svc {
3509 my $pkgnum = $self->pkgnum;
3510 #my $pkgpart = $self->pkgpart;
3513 # 'table' => 'part_svc',
3516 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3517 # WHERE pkg_svc.svcpart = part_svc.svcpart
3518 # AND pkg_svc.pkgpart = ?
3521 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3522 # LEFT JOIN cust_pkg USING ( pkgnum )
3523 # WHERE cust_svc.svcpart = part_svc.svcpart
3526 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3529 #seems to benchmark slightly faster... (or did?)
3531 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3532 my $pkgparts = join(',', @pkgparts);
3535 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3536 #MySQL doesn't grok DISINCT ON
3537 'select' => 'DISTINCT part_svc.*',
3538 'table' => 'part_svc',
3540 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3541 AND pkg_svc.pkgpart IN ($pkgparts)
3544 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3545 LEFT JOIN cust_pkg USING ( pkgnum )
3548 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3549 'extra_param' => [ [$self->pkgnum=>'int'] ],
3555 Returns a short status string for this package, currently:
3561 =item not yet billed
3563 =item one-time charge
3578 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3580 return 'cancelled' if $self->get('cancel');
3581 return 'on hold' if $self->susp && ! $self->setup;
3582 return 'suspended' if $self->susp;
3583 return 'not yet billed' unless $self->setup;
3584 return 'one-time charge' if $freq =~ /^(0|$)/;
3588 =item ucfirst_status
3590 Returns the status with the first character capitalized.
3594 sub ucfirst_status {
3595 ucfirst(shift->status);
3600 Class method that returns the list of possible status strings for packages
3601 (see L<the status method|/status>). For example:
3603 @statuses = FS::cust_pkg->statuses();
3607 tie my %statuscolor, 'Tie::IxHash',
3608 'on hold' => 'FF00F5', #brighter purple!
3609 'not yet billed' => '009999', #teal? cyan?
3610 'one-time charge' => '0000CC', #blue #'000000',
3611 'active' => '00CC00',
3612 'suspended' => 'FF9900',
3613 'cancelled' => 'FF0000',
3617 my $self = shift; #could be class...
3618 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3619 # # mayble split btw one-time vs. recur
3630 Returns a hex triplet color string for this package's status.
3636 $statuscolor{$self->status};
3639 =item is_status_delay_cancel
3641 Returns true if part_pkg has option delay_cancel,
3642 cust_pkg status is 'suspended' and expire is set
3643 to cancel package within the next day (or however
3644 many days are set in global config part_pkg-delay_cancel-days.
3646 Accepts option I<part_pkg-delay_cancel-days> which should be
3647 the value of the config setting, to avoid looking it up again.
3649 This is not a real status, this only meant for hacking display
3650 values, because otherwise treating the package as suspended is
3651 really the whole point of the delay_cancel option.
3655 sub is_status_delay_cancel {
3656 my ($self,%opt) = @_;
3657 if ( $self->main_pkgnum and $self->pkglinknum ) {
3658 return $self->main_pkg->is_status_delay_cancel;
3660 return 0 unless $self->part_pkg->option('delay_cancel',1);
3661 return 0 unless $self->status eq 'suspended';
3662 return 0 unless $self->expire;
3663 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3665 my $conf = new FS::Conf;
3666 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3668 my $expsecs = 60*60*24*$expdays;
3669 return 0 unless $self->expire < time + $expsecs;
3675 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3676 "pkg - comment" depending on user preference).
3682 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3683 $label = $self->pkgnum. ": $label"
3684 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3688 =item pkg_label_long
3690 Returns a long label for this package, adding the primary service's label to
3695 sub pkg_label_long {
3697 my $label = $self->pkg_label;
3698 my $cust_svc = $self->primary_cust_svc;
3699 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3705 Returns a customer-localized label for this package.
3711 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3714 =item primary_cust_svc
3716 Returns a primary service (as FS::cust_svc object) if one can be identified.
3720 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3722 sub primary_cust_svc {
3725 my @cust_svc = $self->cust_svc;
3727 return '' unless @cust_svc; #no serivces - irrelevant then
3729 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3731 # primary service as specified in the package definition
3732 # or exactly one service definition with quantity one
3733 my $svcpart = $self->part_pkg->svcpart;
3734 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3735 return $cust_svc[0] if scalar(@cust_svc) == 1;
3737 #couldn't identify one thing..
3743 Returns a list of lists, calling the label method for all services
3744 (see L<FS::cust_svc>) of this billing item.
3750 map { [ $_->label ] } $self->cust_svc;
3753 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3755 Like the labels method, but returns historical information on services that
3756 were active as of END_TIMESTAMP and (optionally) not cancelled before
3757 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3758 I<pkg_svc.hidden> flag will be omitted.
3760 Returns a list of lists, calling the label method for all (historical) services
3761 (see L<FS::h_cust_svc>) of this billing item.
3767 warn "$me _h_labels called on $self\n"
3769 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3774 Like labels, except returns a simple flat list, and shortens long
3775 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3776 identical services to one line that lists the service label and the number of
3777 individual services rather than individual items.
3782 shift->_labels_short( 'labels', @_ );
3785 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3787 Like h_labels, except returns a simple flat list, and shortens long
3788 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3789 identical services to one line that lists the service label and the number of
3790 individual services rather than individual items.
3794 sub h_labels_short {
3795 shift->_labels_short( 'h_labels', @_ );
3799 my( $self, $method ) = ( shift, shift );
3801 warn "$me _labels_short called on $self with $method method\n"
3804 my $conf = new FS::Conf;
3805 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3807 warn "$me _labels_short populating \%labels\n"
3811 #tie %labels, 'Tie::IxHash';
3812 push @{ $labels{$_->[0]} }, $_->[1]
3813 foreach $self->$method(@_);
3815 warn "$me _labels_short populating \@labels\n"
3819 foreach my $label ( keys %labels ) {
3821 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3822 my $num = scalar(@values);
3823 warn "$me _labels_short $num items for $label\n"
3826 if ( $num > $max_same_services ) {
3827 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3829 push @labels, "$label ($num)";
3831 if ( $conf->exists('cust_bill-consolidate_services') ) {
3832 warn "$me _labels_short consolidating services\n"
3834 # push @labels, "$label: ". join(', ', @values);
3836 my $detail = "$label: ";
3837 $detail .= shift(@values). ', '
3839 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3841 push @labels, $detail;
3843 warn "$me _labels_short done consolidating services\n"
3846 warn "$me _labels_short adding service data\n"
3848 push @labels, map { "$label: $_" } @values;
3859 Returns the parent customer object (see L<FS::cust_main>).
3863 Returns the balance for this specific package, when using
3864 experimental package balance.
3870 $self->cust_main->balance_pkgnum( $self->pkgnum );
3873 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3877 Returns the location object, if any (see L<FS::cust_location>).
3879 =item cust_location_or_main
3881 If this package is associated with a location, returns the locaiton (see
3882 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3884 =item location_label [ OPTION => VALUE ... ]
3886 Returns the label of the location object (see L<FS::cust_location>).
3890 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3892 =item tax_locationnum
3894 Returns the foreign key to a L<FS::cust_location> object for calculating
3895 tax on this package, as determined by the C<tax-pkg_address> and
3896 C<tax-ship_address> configuration flags.
3900 sub tax_locationnum {
3902 my $conf = FS::Conf->new;
3903 if ( $conf->exists('tax-pkg_address') ) {
3904 return $self->locationnum;
3906 elsif ( $conf->exists('tax-ship_address') ) {
3907 return $self->cust_main->ship_locationnum;
3910 return $self->cust_main->bill_locationnum;
3916 Returns the L<FS::cust_location> object for tax_locationnum.
3922 my $conf = FS::Conf->new;
3923 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3924 return FS::cust_location->by_key($self->locationnum);
3926 elsif ( $conf->exists('tax-ship_address') ) {
3927 return $self->cust_main->ship_location;
3930 return $self->cust_main->bill_location;
3934 =item seconds_since TIMESTAMP
3936 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3937 package have been online since TIMESTAMP, according to the session monitor.
3939 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3940 L<Time::Local> and L<Date::Parse> for conversion functions.
3945 my($self, $since) = @_;
3948 foreach my $cust_svc (
3949 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3951 $seconds += $cust_svc->seconds_since($since);
3958 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3960 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3961 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3964 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3965 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3971 sub seconds_since_sqlradacct {
3972 my($self, $start, $end) = @_;
3976 foreach my $cust_svc (
3978 my $part_svc = $_->part_svc;
3979 $part_svc->svcdb eq 'svc_acct'
3980 && scalar($part_svc->part_export_usage);
3983 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3990 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3992 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3993 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3997 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3998 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4003 sub attribute_since_sqlradacct {
4004 my($self, $start, $end, $attrib) = @_;
4008 foreach my $cust_svc (
4010 my $part_svc = $_->part_svc;
4011 scalar($part_svc->part_export_usage);
4014 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4026 my( $self, $value ) = @_;
4027 if ( defined($value) ) {
4028 $self->setfield('quantity', $value);
4030 $self->getfield('quantity') || 1;
4033 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4035 Transfers as many services as possible from this package to another package.
4037 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4038 object. The destination package must already exist.
4040 Services are moved only if the destination allows services with the correct
4041 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4042 this option with caution! No provision is made for export differences
4043 between the old and new service definitions. Probably only should be used
4044 when your exports for all service definitions of a given svcdb are identical.
4045 (attempt a transfer without it first, to move all possible svcpart-matching
4048 Any services that can't be moved remain in the original package.
4050 Returns an error, if there is one; otherwise, returns the number of services
4051 that couldn't be moved.
4056 my ($self, $dest_pkgnum, %opt) = @_;
4062 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4063 $dest = $dest_pkgnum;
4064 $dest_pkgnum = $dest->pkgnum;
4066 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4069 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4071 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4072 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4075 foreach my $cust_svc ($dest->cust_svc) {
4076 $target{$cust_svc->svcpart}--;
4079 my %svcpart2svcparts = ();
4080 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4081 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4082 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4083 next if exists $svcpart2svcparts{$svcpart};
4084 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4085 $svcpart2svcparts{$svcpart} = [
4087 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4089 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4090 'svcpart' => $_ } );
4092 $pkg_svc ? $pkg_svc->primary_svc : '',
4093 $pkg_svc ? $pkg_svc->quantity : 0,
4097 grep { $_ != $svcpart }
4099 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4101 warn "alternates for svcpart $svcpart: ".
4102 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4108 foreach my $cust_svc ($self->cust_svc) {
4109 my $svcnum = $cust_svc->svcnum;
4110 if($target{$cust_svc->svcpart} > 0
4111 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4112 $target{$cust_svc->svcpart}--;
4113 my $new = new FS::cust_svc { $cust_svc->hash };
4114 $new->pkgnum($dest_pkgnum);
4115 $error = $new->replace($cust_svc);
4116 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4118 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4119 warn "alternates to consider: ".
4120 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4122 my @alternate = grep {
4123 warn "considering alternate svcpart $_: ".
4124 "$target{$_} available in new package\n"
4127 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4129 warn "alternate(s) found\n" if $DEBUG;
4130 my $change_svcpart = $alternate[0];
4131 $target{$change_svcpart}--;
4132 my $new = new FS::cust_svc { $cust_svc->hash };
4133 $new->svcpart($change_svcpart);
4134 $new->pkgnum($dest_pkgnum);
4135 $error = $new->replace($cust_svc);
4143 my @label = $cust_svc->label;
4144 return "$label[0] $label[1]: $error";
4150 =item grab_svcnums SVCNUM, SVCNUM ...
4152 Change the pkgnum for the provided services to this packages. If there is an
4153 error, returns the error, otherwise returns false.
4161 my $oldAutoCommit = $FS::UID::AutoCommit;
4162 local $FS::UID::AutoCommit = 0;
4165 foreach my $svcnum (@svcnum) {
4166 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4167 $dbh->rollback if $oldAutoCommit;
4168 return "unknown svcnum $svcnum";
4170 $cust_svc->pkgnum( $self->pkgnum );
4171 my $error = $cust_svc->replace;
4173 $dbh->rollback if $oldAutoCommit;
4178 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4185 This method is deprecated. See the I<depend_jobnum> option to the insert and
4186 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4190 #looks like this is still used by the order_pkg and change_pkg methods in
4191 # ClientAPI/MyAccount, need to look into those before removing
4195 my $oldAutoCommit = $FS::UID::AutoCommit;
4196 local $FS::UID::AutoCommit = 0;
4199 foreach my $cust_svc ( $self->cust_svc ) {
4200 #false laziness w/svc_Common::insert
4201 my $svc_x = $cust_svc->svc_x;
4202 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4203 my $error = $part_export->export_insert($svc_x);
4205 $dbh->rollback if $oldAutoCommit;
4211 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4216 =item export_pkg_change OLD_CUST_PKG
4218 Calls the "pkg_change" export action for all services attached to this package.
4222 sub export_pkg_change {
4223 my( $self, $old ) = ( shift, shift );
4225 my $oldAutoCommit = $FS::UID::AutoCommit;
4226 local $FS::UID::AutoCommit = 0;
4229 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4230 my $error = $svc_x->export('pkg_change', $self, $old);
4232 $dbh->rollback if $oldAutoCommit;
4237 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4244 Associates this package with a (suspension or cancellation) reason (see
4245 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4248 Available options are:
4254 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.
4258 the access_user (see L<FS::access_user>) providing the reason
4266 the action (cancel, susp, adjourn, expire) associated with the reason
4270 If there is an error, returns the error, otherwise returns false.
4275 my ($self, %options) = @_;
4277 my $otaker = $options{reason_otaker} ||
4278 $FS::CurrentUser::CurrentUser->username;
4281 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4285 } elsif ( ref($options{'reason'}) ) {
4287 return 'Enter a new reason (or select an existing one)'
4288 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4290 my $reason = new FS::reason({
4291 'reason_type' => $options{'reason'}->{'typenum'},
4292 'reason' => $options{'reason'}->{'reason'},
4294 my $error = $reason->insert;
4295 return $error if $error;
4297 $reasonnum = $reason->reasonnum;
4300 return "Unparseable reason: ". $options{'reason'};
4303 my $cust_pkg_reason =
4304 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4305 'reasonnum' => $reasonnum,
4306 'otaker' => $otaker,
4307 'action' => substr(uc($options{'action'}),0,1),
4308 'date' => $options{'date'}
4313 $cust_pkg_reason->insert;
4316 =item insert_discount
4318 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4319 inserting a new discount on the fly (see L<FS::discount>).
4321 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4322 and if present, will create a setup discount. If the discountnum is -1,
4323 a new discount definition will be inserted using the value in
4324 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4326 If there is an error, returns the error, otherwise returns false.
4330 sub insert_discount {
4331 #my ($self, %options) = @_;
4334 foreach my $x (qw(setup recur)) {
4335 if ( my $discountnum = $self->get("${x}_discountnum") ) {
4336 my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4337 'pkgnum' => $self->pkgnum,
4338 'discountnum' => $discountnum,
4341 'end_date' => '', #XXX
4342 #for the create a new discount case
4343 'amount' => $self->get("${x}_discountnum_amount"),
4344 'percent' => $self->get("${x}_discountnum_percent"),
4345 'months' => $self->get("${x}_discountnum_months"),
4347 if ( $x eq 'setup' ) {
4348 $cust_pkg_discount->setup('Y');
4349 $cust_pkg_discount->months('');
4351 my $error = $cust_pkg_discount->insert;
4352 return $error if $error;
4359 =item set_usage USAGE_VALUE_HASHREF
4361 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4362 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4363 upbytes, downbytes, and totalbytes are appropriate keys.
4365 All svc_accts which are part of this package have their values reset.
4370 my ($self, $valueref, %opt) = @_;
4372 #only svc_acct can set_usage for now
4373 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4374 my $svc_x = $cust_svc->svc_x;
4375 $svc_x->set_usage($valueref, %opt)
4376 if $svc_x->can("set_usage");
4380 =item recharge USAGE_VALUE_HASHREF
4382 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4383 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4384 upbytes, downbytes, and totalbytes are appropriate keys.
4386 All svc_accts which are part of this package have their values incremented.
4391 my ($self, $valueref) = @_;
4393 #only svc_acct can set_usage for now
4394 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4395 my $svc_x = $cust_svc->svc_x;
4396 $svc_x->recharge($valueref)
4397 if $svc_x->can("recharge");
4401 =item apply_usageprice
4405 sub apply_usageprice {
4408 my $oldAutoCommit = $FS::UID::AutoCommit;
4409 local $FS::UID::AutoCommit = 0;
4414 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4415 $error ||= $cust_pkg_usageprice->apply;
4419 $dbh->rollback if $oldAutoCommit;
4420 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4423 $dbh->commit if $oldAutoCommit;
4429 =item cust_pkg_discount
4431 =item cust_pkg_discount_active
4435 sub cust_pkg_discount_active {
4437 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4440 =item cust_pkg_usage
4442 Returns a list of all voice usage counters attached to this package.
4444 =item apply_usage OPTIONS
4446 Takes the following options:
4447 - cdr: a call detail record (L<FS::cdr>)
4448 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4449 - minutes: the maximum number of minutes to be charged
4451 Finds available usage minutes for a call of this class, and subtracts
4452 up to that many minutes from the usage pool. If the usage pool is empty,
4453 and the C<cdr-minutes_priority> global config option is set, minutes may
4454 be taken from other calls as well. Either way, an allocation record will
4455 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4456 number of minutes of usage applied to the call.
4461 my ($self, %opt) = @_;
4462 my $cdr = $opt{cdr};
4463 my $rate_detail = $opt{rate_detail};
4464 my $minutes = $opt{minutes};
4465 my $classnum = $rate_detail->classnum;
4466 my $pkgnum = $self->pkgnum;
4467 my $custnum = $self->custnum;
4469 my $oldAutoCommit = $FS::UID::AutoCommit;
4470 local $FS::UID::AutoCommit = 0;
4473 my $order = FS::Conf->new->config('cdr-minutes_priority');
4477 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4479 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4481 my @usage_recs = qsearch({
4482 'table' => 'cust_pkg_usage',
4483 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4484 ' JOIN cust_pkg USING (pkgnum)'.
4485 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4486 'select' => 'cust_pkg_usage.*',
4487 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4488 " ( cust_pkg.custnum = $custnum AND ".
4489 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4490 $is_classnum . ' AND '.
4491 " cust_pkg_usage.minutes > 0",
4492 'order_by' => " ORDER BY priority ASC",
4495 my $orig_minutes = $minutes;
4497 while (!$error and $minutes > 0 and @usage_recs) {
4498 my $cust_pkg_usage = shift @usage_recs;
4499 $cust_pkg_usage->select_for_update;
4500 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4501 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4502 acctid => $cdr->acctid,
4503 minutes => min($cust_pkg_usage->minutes, $minutes),
4505 $cust_pkg_usage->set('minutes',
4506 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4508 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4509 $minutes -= $cdr_cust_pkg_usage->minutes;
4511 if ( $order and $minutes > 0 and !$error ) {
4512 # then try to steal minutes from another call
4514 'table' => 'cdr_cust_pkg_usage',
4515 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4516 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4517 ' JOIN cust_pkg USING (pkgnum)'.
4518 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4519 ' JOIN cdr USING (acctid)',
4520 'select' => 'cdr_cust_pkg_usage.*',
4521 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4522 " ( cust_pkg.pkgnum = $pkgnum OR ".
4523 " ( cust_pkg.custnum = $custnum AND ".
4524 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4525 " part_pkg_usage_class.classnum = $classnum",
4526 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4528 if ( $order eq 'time' ) {
4529 # find CDRs that are using minutes, but have a later startdate
4531 my $startdate = $cdr->startdate;
4532 if ($startdate !~ /^\d+$/) {
4533 die "bad cdr startdate '$startdate'";
4535 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4536 # minimize needless reshuffling
4537 $search{'order_by'} .= ', cdr.startdate DESC';
4539 # XXX may not work correctly with rate_time schedules. Could
4540 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4542 $search{'addl_from'} .=
4543 ' JOIN rate_detail'.
4544 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4545 if ( $order eq 'rate_high' ) {
4546 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4547 $rate_detail->min_charge;
4548 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4549 } elsif ( $order eq 'rate_low' ) {
4550 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4551 $rate_detail->min_charge;
4552 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4554 # this should really never happen
4555 die "invalid cdr-minutes_priority value '$order'\n";
4558 my @cdr_usage_recs = qsearch(\%search);
4560 while (!$error and @cdr_usage_recs and $minutes > 0) {
4561 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4562 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4563 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4564 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4565 $cdr_cust_pkg_usage->select_for_update;
4566 $old_cdr->select_for_update;
4567 $cust_pkg_usage->select_for_update;
4568 # in case someone else stole the usage from this CDR
4569 # while waiting for the lock...
4570 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4571 # steal the usage allocation and flag the old CDR for reprocessing
4572 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4573 # if the allocation is more minutes than we need, adjust it...
4574 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4576 $cdr_cust_pkg_usage->set('minutes', $minutes);
4577 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4578 $error = $cust_pkg_usage->replace;
4580 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4581 $error ||= $cdr_cust_pkg_usage->replace;
4582 # deduct the stolen minutes
4583 $minutes -= $cdr_cust_pkg_usage->minutes;
4585 # after all minute-stealing is done, reset the affected CDRs
4586 foreach (values %reproc_cdrs) {
4587 $error ||= $_->set_status('');
4588 # XXX or should we just call $cdr->rate right here?
4589 # it's not like we can create a loop this way, since the min_charge
4590 # or call time has to go monotonically in one direction.
4591 # we COULD get some very deep recursions going, though...
4593 } # if $order and $minutes
4596 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4598 $dbh->commit if $oldAutoCommit;
4599 return $orig_minutes - $minutes;
4603 =item supplemental_pkgs
4605 Returns a list of all packages supplemental to this one.
4609 sub supplemental_pkgs {
4611 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4616 Returns the package that this one is supplemental to, if any.
4622 if ( $self->main_pkgnum ) {
4623 return FS::cust_pkg->by_key($self->main_pkgnum);
4630 =head1 CLASS METHODS
4636 Returns an SQL expression identifying recurring packages.
4640 sub recurring_sql { "
4641 '0' != ( select freq from part_pkg
4642 where cust_pkg.pkgpart = part_pkg.pkgpart )
4647 Returns an SQL expression identifying one-time packages.
4652 '0' = ( select freq from part_pkg
4653 where cust_pkg.pkgpart = part_pkg.pkgpart )
4658 Returns an SQL expression identifying ordered packages (recurring packages not
4664 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4669 Returns an SQL expression identifying active packages.
4674 $_[0]->recurring_sql. "
4675 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4676 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4677 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4680 =item not_yet_billed_sql
4682 Returns an SQL expression identifying packages which have not yet been billed.
4686 sub not_yet_billed_sql { "
4687 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4688 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4689 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4694 Returns an SQL expression identifying inactive packages (one-time packages
4695 that are otherwise unsuspended/uncancelled).
4699 sub inactive_sql { "
4700 ". $_[0]->onetime_sql(). "
4701 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4702 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4703 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4708 Returns an SQL expression identifying on-hold packages.
4713 #$_[0]->recurring_sql(). ' AND '.
4715 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4716 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4717 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4724 Returns an SQL expression identifying suspended packages.
4728 sub suspended_sql { susp_sql(@_); }
4730 #$_[0]->recurring_sql(). ' AND '.
4732 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4733 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4734 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4741 Returns an SQL exprression identifying cancelled packages.
4745 sub cancelled_sql { cancel_sql(@_); }
4747 #$_[0]->recurring_sql(). ' AND '.
4748 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4753 Returns an SQL expression to give the package status as a string.
4759 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4760 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4761 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4762 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4763 WHEN ".onetime_sql()." THEN 'one-time charge'
4770 Returns a list of two package counts. The first is a count of packages
4771 based on the supplied criteria and the second is the count of residential
4772 packages with those same criteria. Criteria are specified as in the search
4778 my ($class, $params) = @_;
4780 my $sql_query = $class->search( $params );
4782 my $count_sql = delete($sql_query->{'count_query'});
4783 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4784 or die "couldn't parse count_sql";
4786 my $count_sth = dbh->prepare($count_sql)
4787 or die "Error preparing $count_sql: ". dbh->errstr;
4789 or die "Error executing $count_sql: ". $count_sth->errstr;
4790 my $count_arrayref = $count_sth->fetchrow_arrayref;
4792 return ( @$count_arrayref );
4796 =item tax_locationnum_sql
4798 Returns an SQL expression for the tax location for a package, based
4799 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4803 sub tax_locationnum_sql {
4804 my $conf = FS::Conf->new;
4805 if ( $conf->exists('tax-pkg_address') ) {
4806 'cust_pkg.locationnum';
4808 elsif ( $conf->exists('tax-ship_address') ) {
4809 'cust_main.ship_locationnum';
4812 'cust_main.bill_locationnum';
4818 Returns a list: the first item is an SQL fragment identifying matching
4819 packages/customers via location (taking into account shipping and package
4820 address taxation, if enabled), and subsequent items are the parameters to
4821 substitute for the placeholders in that fragment.
4826 my($class, %opt) = @_;
4827 my $ornull = $opt{'ornull'};
4829 my $conf = new FS::Conf;
4831 # '?' placeholders in _location_sql_where
4832 my $x = $ornull ? 3 : 2;
4843 if ( $conf->exists('tax-ship_address') ) {
4846 ( ( ship_last IS NULL OR ship_last = '' )
4847 AND ". _location_sql_where('cust_main', '', $ornull ). "
4849 OR ( ship_last IS NOT NULL AND ship_last != ''
4850 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4853 # AND payby != 'COMP'
4855 @main_param = ( @bill_param, @bill_param );
4859 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4860 @main_param = @bill_param;
4866 if ( $conf->exists('tax-pkg_address') ) {
4868 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4871 ( cust_pkg.locationnum IS NULL AND $main_where )
4872 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4875 @param = ( @main_param, @bill_param );
4879 $where = $main_where;
4880 @param = @main_param;
4888 #subroutine, helper for location_sql
4889 sub _location_sql_where {
4891 my $prefix = @_ ? shift : '';
4892 my $ornull = @_ ? shift : '';
4894 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4896 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4898 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4899 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4900 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4902 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4904 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4906 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4907 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4908 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4909 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4910 AND $table.${prefix}country = ?
4915 my( $self, $what ) = @_;
4917 my $what_show_zero = $what. '_show_zero';
4918 length($self->$what_show_zero())
4919 ? ($self->$what_show_zero() eq 'Y')
4920 : $self->part_pkg->$what_show_zero();
4927 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4929 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
4930 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
4932 CUSTNUM is a customer (see L<FS::cust_main>)
4934 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4935 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4938 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4939 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4940 new billing items. An error is returned if this is not possible (see
4941 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4944 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4945 newly-created cust_pkg objects.
4947 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4948 and inserted. Multiple FS::pkg_referral records can be created by
4949 setting I<refnum> to an array reference of refnums or a hash reference with
4950 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4951 record will be created corresponding to cust_main.refnum.
4956 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4958 my $conf = new FS::Conf;
4960 # Transactionize this whole mess
4961 my $oldAutoCommit = $FS::UID::AutoCommit;
4962 local $FS::UID::AutoCommit = 0;
4966 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4967 # return "Customer not found: $custnum" unless $cust_main;
4969 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4972 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4975 my $change = scalar(@old_cust_pkg) != 0;
4978 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4980 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4981 " to pkgpart ". $pkgparts->[0]. "\n"
4984 my $err_or_cust_pkg =
4985 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4986 'refnum' => $refnum,
4989 unless (ref($err_or_cust_pkg)) {
4990 $dbh->rollback if $oldAutoCommit;
4991 return $err_or_cust_pkg;
4994 push @$return_cust_pkg, $err_or_cust_pkg;
4995 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5000 # Create the new packages.
5001 foreach my $pkgpart (@$pkgparts) {
5003 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5005 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5006 pkgpart => $pkgpart,
5010 $error = $cust_pkg->insert( 'change' => $change );
5011 push @$return_cust_pkg, $cust_pkg;
5013 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5014 my $supp_pkg = FS::cust_pkg->new({
5015 custnum => $custnum,
5016 pkgpart => $link->dst_pkgpart,
5018 main_pkgnum => $cust_pkg->pkgnum,
5021 $error ||= $supp_pkg->insert( 'change' => $change );
5022 push @$return_cust_pkg, $supp_pkg;
5026 $dbh->rollback if $oldAutoCommit;
5031 # $return_cust_pkg now contains refs to all of the newly
5034 # Transfer services and cancel old packages.
5035 foreach my $old_pkg (@old_cust_pkg) {
5037 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5040 foreach my $new_pkg (@$return_cust_pkg) {
5041 $error = $old_pkg->transfer($new_pkg);
5042 if ($error and $error == 0) {
5043 # $old_pkg->transfer failed.
5044 $dbh->rollback if $oldAutoCommit;
5049 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5050 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5051 foreach my $new_pkg (@$return_cust_pkg) {
5052 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5053 if ($error and $error == 0) {
5054 # $old_pkg->transfer failed.
5055 $dbh->rollback if $oldAutoCommit;
5062 # Transfers were successful, but we went through all of the
5063 # new packages and still had services left on the old package.
5064 # We can't cancel the package under the circumstances, so abort.
5065 $dbh->rollback if $oldAutoCommit;
5066 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5068 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5074 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5078 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5080 A bulk change method to change packages for multiple customers.
5082 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5083 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5086 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5087 replace. The services (see L<FS::cust_svc>) are moved to the
5088 new billing items. An error is returned if this is not possible (see
5091 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5092 newly-created cust_pkg objects.
5097 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5099 # Transactionize this whole mess
5100 my $oldAutoCommit = $FS::UID::AutoCommit;
5101 local $FS::UID::AutoCommit = 0;
5105 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5108 while(scalar(@old_cust_pkg)) {
5110 my $custnum = $old_cust_pkg[0]->custnum;
5111 my (@remove) = map { $_->pkgnum }
5112 grep { $_->custnum == $custnum } @old_cust_pkg;
5113 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5115 my $error = order $custnum, $pkgparts, \@remove, \@return;
5117 push @errors, $error
5119 push @$return_cust_pkg, @return;
5122 if (scalar(@errors)) {
5123 $dbh->rollback if $oldAutoCommit;
5124 return join(' / ', @errors);
5127 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5131 =item forward_emails
5133 Returns a hash of svcnums and corresponding email addresses
5134 for svc_acct services that can be used as source or dest
5135 for svc_forward services provisioned in this package.
5137 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5138 service; if included, will ensure the current values of the
5139 specified service are included in the list, even if for some
5140 other reason they wouldn't be. If called as a class method
5141 with a specified service, returns only these current values.
5143 Caution: does not actually check if svc_forward services are
5144 available to be provisioned on this package.
5148 sub forward_emails {
5152 #load optional service, thoroughly validated
5153 die "Use svcnum or svc_forward, not both"
5154 if $opt{'svcnum'} && $opt{'svc_forward'};
5155 my $svc_forward = $opt{'svc_forward'};
5156 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5158 die "Specified service is not a forward service"
5159 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5160 die "Specified service not found"
5161 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5165 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5166 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5168 #add current values from specified service, if there was one
5170 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5171 my $svc_acct = $svc_forward->$method();
5172 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5176 if (ref($self) eq 'FS::cust_pkg') {
5178 #and including the rest for this customer
5179 my($u_part_svc,@u_acct_svcparts);
5180 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5181 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5184 my $custnum = $self->getfield('custnum');
5185 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5186 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5187 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5188 foreach my $acct_svcpart (@u_acct_svcparts) {
5189 foreach my $i_cust_svc (
5190 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5191 'svcpart' => $acct_svcpart } )
5193 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5194 $email{$svc_acct->svcnum} = $svc_acct->email;
5203 # Used by FS::Upgrade to migrate to a new database.
5204 sub _upgrade_data { # class method
5205 my ($class, %opts) = @_;
5206 $class->_upgrade_otaker(%opts);
5208 # RT#10139, bug resulting in contract_end being set when it shouldn't
5209 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5210 # RT#10830, bad calculation of prorate date near end of year
5211 # the date range for bill is December 2009, and we move it forward
5212 # one year if it's before the previous bill date (which it should
5214 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5215 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5216 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5217 # RT6628, add order_date to cust_pkg
5218 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5219 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5220 history_action = \'insert\') where order_date is null',
5222 foreach my $sql (@statements) {
5223 my $sth = dbh->prepare($sql);
5224 $sth->execute or die $sth->errstr;
5227 # RT31194: supplemental package links that are deleted don't clean up
5229 my @pkglinknums = qsearch({
5230 'select' => 'DISTINCT cust_pkg.pkglinknum',
5231 'table' => 'cust_pkg',
5232 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5233 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5234 AND part_pkg_link.pkglinknum IS NULL',
5236 foreach (@pkglinknums) {
5237 my $pkglinknum = $_->pkglinknum;
5238 warn "cleaning part_pkg_link #$pkglinknum\n";
5239 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5240 my $error = $part_pkg_link->remove_linked;
5241 die $error if $error;
5249 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5251 In sub order, the @pkgparts array (passed by reference) is clobbered.
5253 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5254 method to pass dates to the recur_prog expression, it should do so.
5256 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5257 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5258 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5259 configuration values. Probably need a subroutine which decides what to do
5260 based on whether or not we've fetched the user yet, rather than a hash. See
5261 FS::UID and the TODO.
5263 Now that things are transactional should the check in the insert method be
5268 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5269 L<FS::pkg_svc>, schema.html from the base documentation