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 sum);
13 use Time::Local qw( timelocal timelocal_nocheck );
15 use FS::UID qw( dbh driver_name );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_usageprice;
35 use FS::cust_pkg_discount;
41 # temporary fix; remove this once (un)suspend admin notices are cleaned up
42 use FS::Misc qw(send_email);
44 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
46 # because they load configuration by setting FS::UID::callback (see TODO)
52 # for sending cancel emails in sub cancel
55 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
57 our $upgrade = 0; #go away after setup+start dates cleaned up for old customers
59 our $cache_enabled = 0;
62 my( $self, $hashref ) = @_;
63 if ( $cache_enabled && $hashref->{'pkg'} && $hashref->{'plan'} ) {
64 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
70 my ( $hashref, $cache ) = @_;
71 # #if ( $hashref->{'pkgpart'} ) {
72 # if ( $hashref->{'pkg'} ) {
73 # # #@{ $self->{'_pkgnum'} } = ();
74 # # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
75 # # $self->{'_pkgpart'} = $subcache;
76 # # #push @{ $self->{'_pkgnum'} },
77 # # FS::part_pkg->new_or_cached($hashref, $subcache);
78 # $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
80 if ( exists $hashref->{'svcnum'} ) {
81 #@{ $self->{'_pkgnum'} } = ();
82 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
83 $self->{'_svcnum'} = $subcache;
84 #push @{ $self->{'_pkgnum'} },
85 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
91 FS::cust_pkg - Object methods for cust_pkg objects
97 $record = new FS::cust_pkg \%hash;
98 $record = new FS::cust_pkg { 'column' => 'value' };
100 $error = $record->insert;
102 $error = $new_record->replace($old_record);
104 $error = $record->delete;
106 $error = $record->check;
108 $error = $record->cancel;
110 $error = $record->suspend;
112 $error = $record->unsuspend;
114 $part_pkg = $record->part_pkg;
116 @labels = $record->labels;
118 $seconds = $record->seconds_since($timestamp);
120 #bulk cancel+order... perhaps slightly deprecated, only used by the bulk
121 # cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
122 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
123 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
127 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
128 inherits from FS::Record. The following fields are currently supported:
134 Primary key (assigned automatically for new billing items)
138 Customer (see L<FS::cust_main>)
142 Billing item definition (see L<FS::part_pkg>)
146 Optional link to package location (see L<FS::location>)
150 date package was ordered (also remains same on changes)
162 date (next bill date)
190 order taker (see L<FS::access_user>)
194 If not set, defaults to 1
198 Date of change from previous package
208 =item change_locationnum
216 The pkgnum of the package that this package is supplemental to, if any.
220 The package link (L<FS::part_pkg_link>) that defines this supplemental
221 package, if it is one.
223 =item change_to_pkgnum
225 The pkgnum of the package this one will be "changed to" in the future
226 (on its expiration date).
230 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
231 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
232 L<Time::Local> and L<Date::Parse> for conversion functions.
240 Create a new billing item. To add the item to the database, see L<"insert">.
244 sub table { 'cust_pkg'; }
245 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
246 sub cust_unlinked_msg {
248 "WARNING: can't find cust_main.custnum ". $self->custnum.
249 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
252 =item set_initial_timers
254 If required by the package definition, sets any automatic expire, adjourn,
255 or contract_end timers to some number of months after the start date
256 (or setup date, if the package has already been setup). If the package has
257 a delayed setup fee after a period of "free days", will also set the
258 start date to the end of that period.
260 If the package has an automatic transfer rule (C<change_to_pkgnum>), then
261 this will also order the package and set its start date.
265 sub set_initial_timers {
267 my $part_pkg = $self->part_pkg;
268 my $start = $self->start_date || $self->setup || time;
270 foreach my $action ( qw(expire adjourn contract_end) ) {
271 my $months = $part_pkg->get("${action}_months");
272 if($months and !$self->get($action)) {
273 $self->set($action, $part_pkg->add_freq($start, $months) );
277 # if this package has an expire date and a change_to_pkgpart, set automatic
279 # (but don't call change_later, as that would call $self->replace, and we're
280 # probably in the middle of $self->insert right now)
281 if ( $part_pkg->expire_months and $part_pkg->change_to_pkgpart ) {
282 if ( $self->change_to_pkgnum ) {
283 # this can happen if a package is ordered on hold, scheduled for a
284 # future change _while on hold_, and then released from hold, causing
285 # the automatic transfer to schedule.
287 # what's correct behavior in that case? I think it's to disallow
288 # future-changing an on-hold package that has an automatic transfer.
289 # but if we DO get into this situation, let the manual package change
291 warn "pkgnum ".$self->pkgnum.": manual future package change blocks ".
292 "automatic transfer.\n";
294 my $change_to = FS::cust_pkg->new( {
295 start_date => $self->get('expire'),
296 pkgpart => $part_pkg->change_to_pkgpart,
297 map { $_ => $self->get($_) }
298 qw( custnum locationnum quantity refnum salesnum contract_end )
300 my $error = $change_to->insert;
302 return $error if $error;
303 $self->set('change_to_pkgnum', $change_to->pkgnum);
307 # if this package has "free days" and delayed setup fee, then
308 # set start date that many days in the future.
309 # (this should have been set in the UI, but enforce it here)
310 if ( $part_pkg->option('free_days',1)
311 && $part_pkg->option('delay_setup',1)
314 $self->start_date( $part_pkg->default_start_date );
320 =item insert [ OPTION => VALUE ... ]
322 Adds this billing item to the database ("Orders" the item). If there is an
323 error, returns the error, otherwise returns false.
325 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
326 will be used to look up the package definition and agent restrictions will be
329 If the additional field I<refnum> is defined, an FS::pkg_referral record will
330 be created and inserted. Multiple FS::pkg_referral records can be created by
331 setting I<refnum> to an array reference of refnums or a hash reference with
332 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
333 record will be created corresponding to cust_main.refnum.
335 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
336 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
337 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
338 It can be set as part of the hash when creating the object, or with the B<set>
341 The following options are available:
347 If set true, supresses actions that should only be taken for new package
348 orders. (Currently this includes: intro periods when delay_setup is on,
349 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
353 cust_pkg_option records will be created
357 a ticket will be added to this customer with this subject
361 an optional queue name for ticket additions
365 Don't check the legality of the package definition. This should be used
366 when performing a package change that doesn't change the pkgpart (i.e.
374 my( $self, %options ) = @_;
376 my $oldAutoCommit = $FS::UID::AutoCommit;
377 local $FS::UID::AutoCommit = 0;
381 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
383 my $part_pkg = $self->part_pkg;
385 if ( ! $import && ! $options{'change'} ) {
387 # set order date to now
388 $self->order_date(time) unless ($import && $self->order_date);
390 # if the package def says to start only on the first of the month:
391 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
392 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
393 $mon += 1 unless $mday == 1;
394 until ( $mon < 12 ) { $mon -= 12; $year++; }
395 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
398 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
399 # if the package was ordered on hold:
401 # - don't set the start date (it will be started manually)
402 $self->set('susp', $self->order_date);
403 $self->set('start_date', '');
405 # set expire/adjourn/contract_end timers, and free days, if appropriate
406 # and automatic package transfer, which can fail, so capture the result
407 $error = $self->set_initial_timers;
409 } # else this is a package change, and shouldn't have "new package" behavior
411 $error ||= $self->SUPER::insert($options{options} ? %{$options{options}} : ());
413 $dbh->rollback if $oldAutoCommit;
417 $self->refnum($self->cust_main->refnum) unless $self->refnum;
418 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
419 $self->process_m2m( 'link_table' => 'pkg_referral',
420 'target_table' => 'part_referral',
421 'params' => $self->refnum,
424 if ( $self->hashref->{cust_pkg_usageprice} ) {
425 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
426 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
427 my $error = $cust_pkg_usageprice->insert;
429 $dbh->rollback if $oldAutoCommit;
435 if ( $self->setup_discountnum || $self->recur_discountnum ) {
436 my $error = $self->insert_discount();
438 $dbh->rollback if $oldAutoCommit;
443 my $conf = new FS::Conf;
445 if ($self->locationnum) {
447 map qsearch( 'part_export', {exportnum=>$_} ),
448 $conf->config('cust_location-exports'); #, $agentnum
450 foreach my $part_export ( @part_export ) {
451 my $error = $part_export->export_pkg_location($self); #, @$export_args);
453 $dbh->rollback if $oldAutoCommit;
454 return "exporting to ". $part_export->exporttype.
455 " (transaction rolled back): $error";
460 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
462 #this init stuff is still inefficient, but at least its limited to
463 # the small number (any?) folks using ticket emailing on pkg order
466 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
473 use FS::TicketSystem;
474 FS::TicketSystem->init();
476 my $q = new RT::Queue($RT::SystemUser);
477 $q->Load($options{ticket_queue}) if $options{ticket_queue};
478 my $t = new RT::Ticket($RT::SystemUser);
479 my $mime = new MIME::Entity;
480 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
481 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
482 Subject => $options{ticket_subject},
485 $t->AddLink( Type => 'MemberOf',
486 Target => 'freeside://freeside/cust_main/'. $self->custnum,
490 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
491 my $queue = new FS::queue {
492 'job' => 'FS::cust_main::queueable_print',
494 $error = $queue->insert(
495 'custnum' => $self->custnum,
496 'template' => 'welcome_letter',
500 warn "can't send welcome letter: $error";
505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
512 This method now works but you probably shouldn't use it.
514 You don't want to delete packages, because there would then be no record
515 the customer ever purchased the package. Instead, see the cancel method and
516 hide cancelled packages.
520 # this is still used internally to abort future package changes, so it
526 # The following foreign keys to cust_pkg are not cleaned up here, and will
527 # cause package deletion to fail:
529 # cust_credit.pkgnum and commission_pkgnum (and cust_credit_void)
530 # cust_credit_bill.pkgnum
531 # cust_pay_pending.pkgnum
532 # cust_pay.pkgnum (and cust_pay_void)
533 # cust_bill_pay.pkgnum (wtf, shouldn't reference pkgnum)
534 # cust_pkg_usage.pkgnum
535 # cust_pkg.uncancel_pkgnum, change_pkgnum, main_pkgnum, and change_to_pkgnum
536 # rt_field_charge.pkgnum
538 # cust_svc is handled by canceling the package before deleting it
539 # cust_pkg_option is handled via option_Common
541 my $oldAutoCommit = $FS::UID::AutoCommit;
542 local $FS::UID::AutoCommit = 0;
545 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
546 my $error = $cust_pkg_discount->delete;
548 $dbh->rollback if $oldAutoCommit;
552 #cust_bill_pkg_discount?
554 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
555 my $error = $cust_pkg_detail->delete;
557 $dbh->rollback if $oldAutoCommit;
562 foreach my $cust_pkg_reason (
564 'table' => 'cust_pkg_reason',
565 'hashref' => { 'pkgnum' => $self->pkgnum },
569 my $error = $cust_pkg_reason->delete;
571 $dbh->rollback if $oldAutoCommit;
576 foreach my $pkg_referral ( $self->pkg_referral ) {
577 my $error = $pkg_referral->delete;
579 $dbh->rollback if $oldAutoCommit;
584 my $error = $self->SUPER::delete(@_);
586 $dbh->rollback if $oldAutoCommit;
590 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
596 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
598 Replaces the OLD_RECORD with this one in the database. If there is an error,
599 returns the error, otherwise returns false.
601 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
603 Changing pkgpart may have disasterous effects. See the order subroutine.
605 setup and bill are normally updated by calling the bill method of a customer
606 object (see L<FS::cust_main>).
608 suspend is normally updated by the suspend and unsuspend methods.
610 cancel is normally updated by the cancel method (and also the order subroutine
613 Available options are:
619 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.
623 the access_user (see L<FS::access_user>) providing the reason
627 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
636 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
641 ( ref($_[0]) eq 'HASH' )
645 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
646 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
649 #return "Can't change setup once it exists!"
650 # if $old->getfield('setup') &&
651 # $old->getfield('setup') != $new->getfield('setup');
653 #some logic for bill, susp, cancel?
655 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
657 my $oldAutoCommit = $FS::UID::AutoCommit;
658 local $FS::UID::AutoCommit = 0;
661 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
662 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
663 my $error = $new->insert_reason(
664 'reason' => $options->{'reason'},
665 'date' => $new->$method,
667 'reason_otaker' => $options->{'reason_otaker'},
670 dbh->rollback if $oldAutoCommit;
671 return "Error inserting cust_pkg_reason: $error";
676 #save off and freeze RADIUS attributes for any associated svc_acct records
678 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
680 #also check for specific exports?
681 # to avoid spurious modify export events
682 @svc_acct = map { $_->svc_x }
683 grep { $_->part_svc->svcdb eq 'svc_acct' }
686 $_->snapshot foreach @svc_acct;
690 my $error = $new->export_pkg_change($old)
691 || $new->SUPER::replace( $old,
693 ? $options->{options}
697 $dbh->rollback if $oldAutoCommit;
701 #for prepaid packages,
702 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
703 foreach my $old_svc_acct ( @svc_acct ) {
704 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
706 $new_svc_acct->replace( $old_svc_acct,
707 'depend_jobnum' => $options->{depend_jobnum},
710 $dbh->rollback if $oldAutoCommit;
715 # also run exports if removing locationnum?
716 # doesn't seem to happen, and we don't export blank locationnum on insert...
717 if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
718 my $conf = new FS::Conf;
720 map qsearch( 'part_export', {exportnum=>$_} ),
721 $conf->config('cust_location-exports'); #, $agentnum
723 foreach my $part_export ( @part_export ) {
724 my $error = $part_export->export_pkg_location($new); #, @$export_args);
726 $dbh->rollback if $oldAutoCommit;
727 return "exporting to ". $part_export->exporttype.
728 " (transaction rolled back): $error";
733 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
740 Checks all fields to make sure this is a valid billing item. If there is an
741 error, returns the error, otherwise returns false. Called by the insert and
749 if ( !$self->locationnum or $self->locationnum == -1 ) {
750 $self->set('locationnum', $self->cust_main->ship_locationnum);
754 $self->ut_numbern('pkgnum')
755 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
756 || $self->ut_numbern('pkgpart')
757 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
758 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
759 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
760 || $self->ut_numbern('quantity')
761 || $self->ut_numbern('start_date')
762 || $self->ut_numbern('setup')
763 || $self->ut_numbern('bill')
764 || $self->ut_numbern('susp')
765 || $self->ut_numbern('cancel')
766 || $self->ut_numbern('adjourn')
767 || $self->ut_numbern('resume')
768 || $self->ut_numbern('expire')
769 || $self->ut_numbern('dundate')
770 || $self->ut_flag('no_auto', [ '', 'Y' ])
771 || $self->ut_flag('waive_setup', [ '', 'Y' ])
772 || $self->ut_flag('separate_bill')
773 || $self->ut_textn('agent_pkgid')
774 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
775 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
776 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
777 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
778 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
780 return $error if $error;
782 return "A package with both start date (future start) and setup date (already started) will never bill"
783 if $self->start_date && $self->setup && ! $upgrade;
785 return "A future unsuspend date can only be set for a package with a suspend date"
786 if $self->resume and !$self->susp and !$self->adjourn;
788 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
795 Check the pkgpart to make sure it's allowed with the reg_code and/or
796 promo_code of the package (if present) and with the customer's agent.
797 Called from C<insert>, unless we are doing a package change that doesn't
805 # my $error = $self->ut_numbern('pkgpart'); # already done
808 if ( $self->reg_code ) {
810 unless ( grep { $self->pkgpart == $_->pkgpart }
811 map { $_->reg_code_pkg }
812 qsearchs( 'reg_code', { 'code' => $self->reg_code,
813 'agentnum' => $self->cust_main->agentnum })
815 return "Unknown registration code";
818 } elsif ( $self->promo_code ) {
821 qsearchs('part_pkg', {
822 'pkgpart' => $self->pkgpart,
823 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
825 return 'Unknown promotional code' unless $promo_part_pkg;
829 unless ( $disable_agentcheck ) {
831 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
832 return "agent ". $agent->agentnum. ':'. $agent->agent.
833 " can't purchase pkgpart ". $self->pkgpart
834 unless $agent->pkgpart_hashref->{ $self->pkgpart }
835 || $agent->agentnum == $self->part_pkg->agentnum;
838 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
839 return $error if $error;
847 =item cancel [ OPTION => VALUE ... ]
849 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
850 in this package, then cancels the package itself (sets the cancel field to
853 Available options are:
857 =item quiet - can be set true to supress email cancellation notices.
859 =item time - can be set to cancel the package based on a specific future or
860 historical date. Using time ensures that the remaining amount is calculated
861 correctly. Note however that this is an immediate cancel and just changes
862 the date. You are PROBABLY looking to expire the account instead of using
865 =item reason - can be set to a cancellation reason (see L<FS:reason>),
866 either a reasonnum of an existing reason, or passing a hashref will create
867 a new reason. The hashref should have the following keys: typenum - Reason
868 type (see L<FS::reason_type>, reason - Text of the new reason.
870 =item date - can be set to a unix style timestamp to specify when to
873 =item nobill - can be set true to skip billing if it might otherwise be done.
875 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
876 not credit it. This must be set (by change()) when changing the package
877 to a different pkgpart or location, and probably shouldn't be in any other
878 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
881 =item no_delay_cancel - prevents delay_cancel behavior
882 no matter what other options say, for use when changing packages (or any
883 other time you're really sure you want an immediate cancel)
887 If there is an error, returns the error, otherwise returns false.
891 #NOT DOCUMENTING - this should only be used when calling recursively
892 #=item delay_cancel - for internal use, to allow proper handling of
893 #supplemental packages when the main package is flagged to suspend
894 #before cancelling, probably shouldn't be used otherwise (set the
895 #corresponding package option instead)
898 my( $self, %options ) = @_;
901 # supplemental packages can now be separately canceled, though the UI
902 # shouldn't permit it
904 ## pass all suspend/cancel actions to the main package
905 ## (unless the pkglinknum has been removed, then the link is defunct and
906 ## this package can be canceled on its own)
907 #if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
908 # return $self->main_pkg->cancel(%options);
911 my $conf = new FS::Conf;
913 warn "cust_pkg::cancel called with options".
914 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
917 my $oldAutoCommit = $FS::UID::AutoCommit;
918 local $FS::UID::AutoCommit = 0;
921 my $old = $self->select_for_update;
923 if ( $old->get('cancel') || $self->get('cancel') ) {
924 dbh->rollback if $oldAutoCommit;
925 return ""; # no error
928 # XXX possibly set cancel_time to the expire date?
929 my $cancel_time = $options{'time'} || time;
930 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
931 $date = '' if ($date && $date <= $cancel_time); # complain instead?
933 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
934 if ( !$date && $self->part_pkg->option('delay_cancel',1)
935 && (($self->status eq 'active') || ($self->status eq 'suspended'))
936 && !$options{'no_delay_cancel'}
938 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
939 my $expsecs = 60*60*24*$expdays;
940 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
941 $expsecs = $expsecs - $suspfor if $suspfor;
942 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
944 $date = $cancel_time + $expsecs;
948 #race condition: usage could be ongoing until unprovisioned
949 #resolved by performing a change package instead (which unprovisions) and
951 if ( !$options{nobill} && !$date ) {
952 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
953 my $copy = $self->new({$self->hash});
955 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
957 'time' => $cancel_time );
958 warn "Error billing during cancel, custnum ".
959 #$self->cust_main->custnum. ": $error"
964 if ( $options{'reason'} ) {
965 $error = $self->insert_reason( 'reason' => $options{'reason'},
966 'action' => $date ? 'expire' : 'cancel',
967 'date' => $date ? $date : $cancel_time,
968 'reason_otaker' => $options{'reason_otaker'},
971 dbh->rollback if $oldAutoCommit;
972 return "Error inserting cust_pkg_reason: $error";
976 my %svc_cancel_opt = ();
977 $svc_cancel_opt{'date'} = $date if $date;
978 foreach my $cust_svc (
981 sort { $a->[1] <=> $b->[1] }
982 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
983 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
985 my $part_svc = $cust_svc->part_svc;
986 next if ( defined($part_svc) and $part_svc->preserve );
987 my $error = $cust_svc->cancel( %svc_cancel_opt );
990 $dbh->rollback if $oldAutoCommit;
991 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
996 # if a reasonnum was passed, get the actual reason object so we can check
1000 if ($options{'reason'} =~ /^\d+$/) {
1001 $reason = FS::reason->by_key($options{'reason'});
1005 # credit remaining time if any of these are true:
1006 # - unused_credit => 1 was passed (this happens when canceling a package
1007 # for a package change when unused_credit_change is set)
1008 # - no unused_credit option, and there is a cancel reason, and the cancel
1009 # reason says to credit the package
1010 # - no unused_credit option, and the package definition says to credit the
1011 # package on cancellation
1013 if ( exists($options{'unused_credit'}) ) {
1014 $do_credit = $options{'unused_credit'};
1015 } elsif ( defined($reason) && $reason->unused_credit ) {
1018 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
1021 my $error = $self->credit_remaining('cancel', $cancel_time);
1023 $dbh->rollback if $oldAutoCommit;
1029 my %hash = $self->hash;
1031 $hash{'expire'} = $date;
1032 if ($delay_cancel) {
1033 # just to be sure these are clear
1034 $hash{'adjourn'} = undef;
1035 $hash{'resume'} = undef;
1038 $hash{'cancel'} = $cancel_time;
1040 $hash{'change_custnum'} = $options{'change_custnum'};
1042 # if this is a supplemental package that's lost its part_pkg_link, and it's
1043 # being canceled for real, unlink it completely
1044 if ( !$date and ! $self->pkglinknum ) {
1045 $hash{main_pkgnum} = '';
1048 # if there is a future package change scheduled, unlink from it (like
1049 # abort_change) first, then delete it.
1050 $hash{'change_to_pkgnum'} = '';
1052 # save the package state
1053 my $new = new FS::cust_pkg ( \%hash );
1054 $error = $new->replace( $self, options => { $self->options } );
1056 if ( $self->change_to_pkgnum ) {
1057 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1058 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1061 $dbh->rollback if $oldAutoCommit;
1065 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1066 $error = $supp_pkg->cancel(%options,
1068 'date' => $date, #in case it got changed by delay_cancel
1069 'delay_cancel' => $delay_cancel,
1072 $dbh->rollback if $oldAutoCommit;
1073 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1077 if ($delay_cancel && !$options{'from_main'}) {
1078 $error = $new->suspend(
1080 'time' => $cancel_time
1085 foreach my $usage ( $self->cust_pkg_usage ) {
1086 $error = $usage->delete;
1088 $dbh->rollback if $oldAutoCommit;
1089 return "deleting usage pools: $error";
1094 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1095 return '' if $date; #no errors
1097 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
1098 if ( !$options{'quiet'} &&
1099 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
1101 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1104 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1105 $error = $msg_template->send( 'cust_main' => $self->cust_main,
1106 'object' => $self );
1108 #should this do something on errors?
1115 =item cancel_if_expired [ NOW_TIMESTAMP ]
1117 Cancels this package if its expire date has been reached.
1121 sub cancel_if_expired {
1123 my $time = shift || time;
1124 return '' unless $self->expire && $self->expire <= $time;
1125 my $error = $self->cancel;
1127 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1128 $self->custnum. ": $error";
1133 =item uncancel_svc_x
1135 For cancelled cust_pkg, returns a list of new, uninserted FS::svc_X records
1136 for services that would be inserted by L</uncancel>. Returned objects also
1137 include the field _h_svc_x, which contains the service history object.
1139 Set pkgnum before inserting.
1141 Accepts the following options:
1143 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1144 (and only if they would otherwise be returned by this)
1148 sub uncancel_svc_x {
1149 my ($self, %opt) = @_;
1151 die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1153 #find historical services within this timeframe before the package cancel
1154 # (incompatible with "time" option to cust_pkg->cancel?)
1155 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1156 # too little? (unprovisioing export delay?)
1157 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1158 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1161 foreach my $h_cust_svc (@h_cust_svc) {
1162 next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1163 # filter out services that still exist on this package (ie preserved svcs)
1164 # but keep services that have since been provisioned on another package (for informational purposes)
1165 next if qsearchs('cust_svc',{ 'svcnum' => $h_cust_svc->svcnum, 'pkgnum' => $self->pkgnum });
1166 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1167 next unless $h_svc_x; # this probably doesn't happen, but just in case
1168 (my $table = $h_svc_x->table) =~ s/^h_//;
1169 require "FS/$table.pm";
1170 my $class = "FS::$table";
1171 my $svc_x = $class->new( {
1172 'svcpart' => $h_cust_svc->svcpart,
1173 '_h_svc_x' => $h_svc_x,
1174 map { $_ => $h_svc_x->get($_) } fields($table)
1178 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1179 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1182 #these are pretty rare, but should handle them
1183 # - dsl_device (mac addresses)
1184 # - phone_device (mac addresses)
1185 # - dsl_note (ikano notes)
1186 # - domain_record (i.e. restore DNS information w/domains)
1187 # - inventory_item(?) (inventory w/un-cancelling service?)
1188 # - nas (svc_broaband nas stuff)
1189 #this stuff is unused in the wild afaik
1190 # - mailinglistmember
1192 # - svc_domain.parent_svcnum?
1193 # - acct_snarf (ancient mail fetching config)
1194 # - cgp_rule (communigate)
1195 # - cust_svc_option (used by our Tron stuff)
1196 # - acct_rt_transaction (used by our time worked stuff)
1198 push @svc_x, $svc_x;
1203 =item uncancel_svc_summary
1205 Returns an array of hashrefs, one for each service that could
1206 potentially be reprovisioned by L</uncancel>, with the following keys:
1214 label - from history table if not currently calculable, undefined if it can't be loaded
1216 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1218 num_cust_svc - number of svcs for this svcpart, only if summarizing (see below)
1220 Cannot be run from within a transaction. Performs inserts
1221 to test the results, and then rolls back the transaction.
1222 Does not perform exports, so does not catch if export would fail.
1224 Also accepts the following options:
1226 no_test_reprovision - skip the test inserts (reprovisionable field will not exist)
1228 summarize_size - if true, returns a single summary record for svcparts with at
1229 least this many svcs, will have key num_cust_svc but not uncancel_svcnum, label or reprovisionable
1233 sub uncancel_svc_summary {
1234 my ($self, %opt) = @_;
1236 die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1237 die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1239 local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1240 local $FS::UID::AutoCommit = 0;
1242 # sort by svcpart, to check summarize_size
1243 my $uncancel_svc_x = {};
1244 foreach my $svc_x (sort { $a->{'svcpart'} <=> $b->{'svcpart'} } $self->uncancel_svc_x) {
1245 $uncancel_svc_x->{$svc_x->svcpart} = [] unless $uncancel_svc_x->{$svc_x->svcpart};
1246 push @{$uncancel_svc_x->{$svc_x->svcpart}}, $svc_x;
1250 foreach my $svcpart (keys %$uncancel_svc_x) {
1251 my @svcpart_svc_x = @{$uncancel_svc_x->{$svcpart}};
1252 if ($opt{'summarize_size'} && (@svcpart_svc_x >= $opt{'summarize_size'})) {
1253 my $svc_x = $svcpart_svc_x[0]; #grab first one for access to $part_svc
1254 my $part_svc = $svc_x->part_svc;
1256 'svcpart' => $part_svc->svcpart,
1257 'svc' => $part_svc->svc,
1258 'num_cust_svc' => scalar(@svcpart_svc_x),
1261 foreach my $svc_x (@svcpart_svc_x) {
1262 my $part_svc = $svc_x->part_svc;
1264 'svcpart' => $part_svc->svcpart,
1265 'svc' => $part_svc->svc,
1266 'uncancel_svcnum' => $svc_x->get('_h_svc_x')->svcnum,
1268 $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1270 unless ($opt{'no_test_reprovision'}) {
1271 # avoid possibly fatal errors from missing linked records
1272 eval { $insert_error = $svc_x->insert };
1273 $insert_error ||= $@;
1275 if ($opt{'no_test_reprovision'} or $insert_error) {
1276 # avoid possibly fatal errors from missing linked records
1277 eval { $out->{'label'} = $svc_x->label };
1278 eval { $out->{'label'} = $svc_x->get('_h_svc_x')->label } unless defined($out->{'label'});
1279 $out->{'reprovisionable'} = 0 unless $opt{'no_test_reprovision'};
1281 $out->{'label'} = $svc_x->label;
1282 $out->{'reprovisionable'} = 1;
1295 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1296 locationnum, (other fields?). Attempts to re-provision cancelled services
1297 using history information (errors at this stage are not fatal).
1299 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1301 svc_fatal: service provisioning errors are fatal
1303 svc_errors: pass an array reference, will be filled in with any provisioning errors
1305 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1307 main_pkgnum: link the package as a supplemental package of this one. For
1313 my( $self, %options ) = @_;
1315 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1316 return '' unless $self->get('cancel');
1318 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1319 return $self->main_pkg->uncancel(%options);
1326 my $oldAutoCommit = $FS::UID::AutoCommit;
1327 local $FS::UID::AutoCommit = 0;
1331 # insert the new package
1334 my $cust_pkg = new FS::cust_pkg {
1335 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1336 bill => ( $options{'bill'} || $self->get('bill') ),
1338 uncancel_pkgnum => $self->pkgnum,
1339 main_pkgnum => ($options{'main_pkgnum'} || ''),
1340 map { $_ => $self->get($_) } qw(
1341 custnum pkgpart locationnum
1343 susp adjourn resume expire start_date contract_end dundate
1344 change_date change_pkgpart change_locationnum
1345 no_auto separate_bill quantity agent_pkgid
1346 recur_show_zero setup_show_zero
1350 my $error = $cust_pkg->insert(
1351 'change' => 1, #supresses any referral credit to a referring customer
1352 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1355 $dbh->rollback if $oldAutoCommit;
1364 foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1366 $svc_x->pkgnum($cust_pkg->pkgnum);
1367 my $svc_error = $svc_x->insert;
1370 if ( $options{svc_fatal} ) {
1371 $dbh->rollback if $oldAutoCommit;
1374 # if we've failed to insert the svc_x object, svc_Common->insert
1375 # will have removed the cust_svc already. if not, then both records
1376 # were inserted but we failed for some other reason (export, most
1377 # likely). in that case, report the error and delete the records.
1378 push @svc_errors, $svc_error;
1379 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1381 # except if export_insert failed, export_delete probably won't be
1383 local $FS::svc_Common::noexport_hack = 1;
1384 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1385 if ( $cleanup_error ) { # and if THAT fails, then run away
1386 $dbh->rollback if $oldAutoCommit;
1387 return $cleanup_error;
1392 } #foreach uncancel_svc_x
1395 # also move over any services that didn't unprovision at cancellation
1398 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1399 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1400 my $error = $cust_svc->replace;
1402 $dbh->rollback if $oldAutoCommit;
1408 # Uncancel any supplemental packages, and make them supplemental to the
1412 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1414 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1416 $dbh->rollback if $oldAutoCommit;
1417 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1425 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1427 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1428 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1435 Cancels any pending expiration (sets the expire field to null)
1436 for this package and any supplemental packages.
1438 If there is an error, returns the error, otherwise returns false.
1446 my $oldAutoCommit = $FS::UID::AutoCommit;
1447 local $FS::UID::AutoCommit = 0;
1450 my $old = $self->select_for_update;
1452 my $pkgnum = $old->pkgnum;
1453 if ( $old->get('cancel') || $self->get('cancel') ) {
1454 dbh->rollback if $oldAutoCommit;
1455 return "Can't unexpire cancelled package $pkgnum";
1456 # or at least it's pointless
1459 unless ( $old->get('expire') && $self->get('expire') ) {
1460 dbh->rollback if $oldAutoCommit;
1461 return ""; # no error
1464 my %hash = $self->hash;
1465 $hash{'expire'} = '';
1466 my $new = new FS::cust_pkg ( \%hash );
1467 $error = $new->replace( $self, options => { $self->options } );
1469 $dbh->rollback if $oldAutoCommit;
1473 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1474 $error = $supp_pkg->unexpire;
1476 $dbh->rollback if $oldAutoCommit;
1477 return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1481 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1487 =item suspend [ OPTION => VALUE ... ]
1489 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1490 package, then suspends the package itself (sets the susp field to now).
1492 Available options are:
1496 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1497 either a reasonnum of an existing reason, or passing a hashref will create
1498 a new reason. The hashref should have the following keys:
1499 - typenum - Reason type (see L<FS::reason_type>
1500 - reason - Text of the new reason.
1502 =item date - can be set to a unix style timestamp to specify when to
1505 =item time - can be set to override the current time, for calculation
1506 of final invoices or unused-time credits
1508 =item resume_date - can be set to a time when the package should be
1509 unsuspended. This may be more convenient than calling C<unsuspend()>
1512 =item from_main - allows a supplemental package to be suspended, rather
1513 than redirecting the method call to its main package. For internal use.
1515 =item from_cancel - used when suspending from the cancel method, forces
1516 this to skip everything besides basic suspension. For internal use.
1520 If there is an error, returns the error, otherwise returns false.
1525 my( $self, %options ) = @_;
1528 # supplemental packages still can't be separately suspended, but silently
1529 # exit instead of failing or passing the action to the main package (so
1530 # that the "Suspend customer" action doesn't trip over the supplemental
1533 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1537 my $oldAutoCommit = $FS::UID::AutoCommit;
1538 local $FS::UID::AutoCommit = 0;
1541 my $old = $self->select_for_update;
1543 my $pkgnum = $old->pkgnum;
1544 if ( $old->get('cancel') || $self->get('cancel') ) {
1545 dbh->rollback if $oldAutoCommit;
1546 return "Can't suspend cancelled package $pkgnum";
1549 if ( $old->get('susp') || $self->get('susp') ) {
1550 dbh->rollback if $oldAutoCommit;
1551 return ""; # no error # complain on adjourn?
1554 my $suspend_time = $options{'time'} || time;
1555 my $date = $options{date} if $options{date}; # adjourn/suspend later
1556 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1558 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1559 dbh->rollback if $oldAutoCommit;
1560 return "Package $pkgnum expires before it would be suspended.";
1563 # some false laziness with sub cancel
1564 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1565 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1566 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1567 # make the entire cust_main->bill path recognize 'suspend' and
1568 # 'cancel' separately.
1569 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1570 my $copy = $self->new({$self->hash});
1572 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1574 'time' => $suspend_time );
1575 warn "Error billing during suspend, custnum ".
1576 #$self->cust_main->custnum. ": $error"
1581 my $cust_pkg_reason;
1582 if ( $options{'reason'} ) {
1583 $error = $self->insert_reason( 'reason' => $options{'reason'},
1584 'action' => $date ? 'adjourn' : 'suspend',
1585 'date' => $date ? $date : $suspend_time,
1586 'reason_otaker' => $options{'reason_otaker'},
1589 dbh->rollback if $oldAutoCommit;
1590 return "Error inserting cust_pkg_reason: $error";
1592 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1593 'date' => $date ? $date : $suspend_time,
1594 'action' => $date ? 'A' : 'S',
1595 'pkgnum' => $self->pkgnum,
1599 # if a reasonnum was passed, get the actual reason object so we can check
1601 # (passing a reason hashref is still allowed, but it can't be used with
1602 # the fancy behavioral options.)
1605 if ($options{'reason'} =~ /^\d+$/) {
1606 $reason = FS::reason->by_key($options{'reason'});
1609 my %hash = $self->hash;
1611 $hash{'adjourn'} = $date;
1613 $hash{'susp'} = $suspend_time;
1616 my $resume_date = $options{'resume_date'} || 0;
1617 if ( $resume_date > ($date || $suspend_time) ) {
1618 $hash{'resume'} = $resume_date;
1621 $options{options} ||= {};
1623 my $new = new FS::cust_pkg ( \%hash );
1624 $error = $new->replace( $self, options => { $self->options,
1625 %{ $options{options} },
1629 $dbh->rollback if $oldAutoCommit;
1633 unless ( $date ) { # then we are suspending now
1635 unless ($options{'from_cancel'}) {
1636 # credit remaining time if appropriate
1637 # (if required by the package def, or the suspend reason)
1638 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1639 || ( defined($reason) && $reason->unused_credit );
1641 if ( $unused_credit ) {
1642 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1643 my $error = $self->credit_remaining('suspend', $suspend_time);
1645 $dbh->rollback if $oldAutoCommit;
1651 my @cust_svc = qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
1653 #attempt ordering ala cust_svc_suspend_cascade (without infinite-looping
1654 # on the circular dep case)
1655 # (this is too simple for multi-level deps, we need to use something
1656 # to resolve the DAG properly when possible)
1658 $svcpart{$_->svcpart} = 0 foreach @cust_svc;
1659 foreach my $svcpart ( keys %svcpart ) {
1660 foreach my $part_svc_link (
1661 FS::part_svc_link->by_agentnum($self->cust_main->agentnum,
1662 src_svcpart => $svcpart,
1663 link_type => 'cust_svc_suspend_cascade'
1666 $svcpart{$part_svc_link->dst_svcpart} = max(
1667 $svcpart{$part_svc_link->dst_svcpart},
1668 $svcpart{$part_svc_link->src_svcpart} + 1
1672 @cust_svc = sort { $svcpart{ $a->svcpart } <=> $svcpart{ $b->svcpart } }
1676 foreach my $cust_svc ( @cust_svc ) {
1677 $cust_svc->suspend( 'labels_arrayref' => \@labels );
1680 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1681 # and this is not a suspend-before-cancel
1682 if ( $cust_pkg_reason ) {
1683 my $reason_obj = $cust_pkg_reason->reason;
1684 if ( $reason_obj->feepart and
1685 ! $reason_obj->fee_on_unsuspend and
1686 ! $options{'from_cancel'} ) {
1688 # register the need to charge a fee, cust_main->bill will do the rest
1689 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1691 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1692 'pkgreasonnum' => $cust_pkg_reason->num,
1693 'pkgnum' => $self->pkgnum,
1694 'feepart' => $reason->feepart,
1695 'nextbill' => $reason->fee_hold,
1697 $error ||= $cust_pkg_reason_fee->insert;
1701 my $conf = new FS::Conf;
1702 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1704 my $error = send_email(
1705 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1706 #invoice_from ??? well as good as any
1707 'to' => $conf->config('suspend_email_admin'),
1708 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1710 "This is an automatic message from your Freeside installation\n",
1711 "informing you that the following customer package has been suspended:\n",
1713 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1714 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1715 ( map { "Service : $_\n" } @labels ),
1717 'custnum' => $self->custnum,
1718 'msgtype' => 'admin'
1722 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1730 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1731 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1733 $dbh->rollback if $oldAutoCommit;
1734 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1738 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1743 =item credit_remaining MODE TIME
1745 Generate a credit for this package for the time remaining in the current
1746 billing period. MODE is either "suspend" or "cancel" (determines the
1747 credit type). TIME is the time of suspension/cancellation. Both arguments
1752 # Implementation note:
1754 # If you pkgpart-change a package that has been billed, and it's set to give
1755 # credit on package change, then this method gets called and then the new
1756 # package will have no last_bill date. Therefore the customer will be credited
1757 # only once (per billing period) even if there are multiple package changes.
1759 # If you location-change a package that has been billed, this method will NOT
1760 # be called and the new package WILL have the last bill date of the old
1763 # If the new package is then canceled within the same billing cycle,
1764 # credit_remaining needs to run calc_remain on the OLD package to determine
1765 # the amount of unused time to credit.
1767 sub credit_remaining {
1768 # Add a credit for remaining service
1769 my ($self, $mode, $time) = @_;
1770 die 'credit_remaining requires suspend or cancel'
1771 unless $mode eq 'suspend' or $mode eq 'cancel';
1772 die 'no suspend/cancel time' unless $time > 0;
1774 my $conf = FS::Conf->new;
1775 my $reason_type = $conf->config($mode.'_credit_type');
1779 my $remain_pkg = $self;
1780 my (@billpkgnums, @amounts, @setuprecurs);
1782 # we may have to walk back past some package changes to get to the
1783 # one that actually has unused time. loop until that happens, or we
1784 # reach the first package in the chain.
1786 my $last_bill = $remain_pkg->get('last_bill') || 0;
1787 my $next_bill = $remain_pkg->get('bill') || 0;
1788 if ( $last_bill > 0 # the package has been billed
1789 and $next_bill > 0 # the package has a next bill date
1790 and $next_bill >= $time # which is in the future
1793 # Find actual charges for the period ending on or after the cancel
1795 my @charges = qsearch('cust_bill_pkg', {
1796 pkgnum => $remain_pkg->pkgnum,
1797 edate => {op => '>=', value => $time},
1798 recur => {op => '>' , value => 0},
1801 foreach my $cust_bill_pkg (@charges) {
1802 # hack to deal with the weird behavior of edate on package
1804 my $edate = $cust_bill_pkg->edate;
1805 if ( $self->recur_temporality eq 'preceding' ) {
1806 $edate = $self->add_freq($cust_bill_pkg->sdate);
1809 # this will also get any package charges that are _entirely_ after
1810 # the cancellation date (can happen with advance billing). in that
1811 # case, use the entire recurring charge:
1812 my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
1814 # but if the cancellation happens during the interval, prorate it:
1815 # (XXX obey prorate_round_day here?)
1816 if ( $cust_bill_pkg->sdate < $time ) {
1818 ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
1821 $amount = sprintf('%.2f', $amount);
1823 push @billpkgnums, $cust_bill_pkg->billpkgnum;
1824 push @amounts, $amount;
1825 push @setuprecurs, 'recur';
1827 warn "Crediting for $amount on package ".$remain_pkg->pkgnum."\n"
1835 if ( my $changed_from_pkgnum = $remain_pkg->change_pkgnum ) {
1836 $remain_pkg = FS::cust_pkg->by_key($changed_from_pkgnum);
1838 # the package has really never been billed
1843 # keep traditional behavior here.
1845 my $reason = FS::reason->new_or_existing(
1846 reason => 'Credit for unused time on '. $self->part_pkg->pkg,
1847 type => $reason_type,
1851 return "failed to set credit reason: $@";
1854 my $error = FS::cust_credit->credit_lineitems(
1855 'billpkgnums' => \@billpkgnums,
1856 'setuprecurs' => \@setuprecurs,
1857 'amounts' => \@amounts,
1858 'custnum' => $self->custnum,
1860 'reasonnum' => $reason->reasonnum,
1867 =item unsuspend [ OPTION => VALUE ... ]
1869 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1870 package, then unsuspends the package itself (clears the susp field and the
1871 adjourn field if it is in the past). If the suspend reason includes an
1872 unsuspension package, that package will be ordered.
1874 Available options are:
1880 Can be set to a date to unsuspend the package in the future (the 'resume'
1883 =item adjust_next_bill
1885 Can be set true to adjust the next bill date forward by
1886 the amount of time the account was inactive. This was set true by default
1887 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1888 explicitly requested with this option or in the price plan.
1892 If there is an error, returns the error, otherwise returns false.
1897 my( $self, %opt ) = @_;
1900 # pass all suspend/cancel actions to the main package
1901 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1902 return $self->main_pkg->unsuspend(%opt);
1905 my $oldAutoCommit = $FS::UID::AutoCommit;
1906 local $FS::UID::AutoCommit = 0;
1909 my $old = $self->select_for_update;
1911 my $pkgnum = $old->pkgnum;
1912 if ( $old->get('cancel') || $self->get('cancel') ) {
1913 $dbh->rollback if $oldAutoCommit;
1914 return "Can't unsuspend cancelled package $pkgnum";
1917 unless ( $old->get('susp') && $self->get('susp') ) {
1918 $dbh->rollback if $oldAutoCommit;
1919 return ""; # no error # complain instead?
1922 # handle the case of setting a future unsuspend (resume) date
1923 # and do not continue to actually unsuspend the package
1924 my $date = $opt{'date'};
1925 if ( $date and $date > time ) { # return an error if $date <= time?
1927 if ( $old->get('expire') && $old->get('expire') < $date ) {
1928 $dbh->rollback if $oldAutoCommit;
1929 return "Package $pkgnum expires before it would be unsuspended.";
1932 my $new = new FS::cust_pkg { $self->hash };
1933 $new->set('resume', $date);
1934 $error = $new->replace($self, options => $self->options);
1937 $dbh->rollback if $oldAutoCommit;
1941 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1947 if (!$self->setup) {
1948 # then this package is being released from on-hold status
1949 $error = $self->set_initial_timers;
1951 $dbh->rollback if $oldAutoCommit;
1958 foreach my $cust_svc (
1959 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1961 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1963 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1964 $dbh->rollback if $oldAutoCommit;
1965 return "Illegal svcdb value in part_svc!";
1968 require "FS/$svcdb.pm";
1970 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1972 $error = $svc->unsuspend;
1974 $dbh->rollback if $oldAutoCommit;
1977 my( $label, $value ) = $cust_svc->label;
1978 push @labels, "$label: $value";
1983 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1984 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1986 my %hash = $self->hash;
1987 my $inactive = time - $hash{'susp'};
1989 my $conf = new FS::Conf;
1991 #adjust the next bill date forward
1992 # increment next bill date if certain conditions are met:
1993 # - it was due to be billed at some point
1994 # - either the global or local config says to do this
1995 my $adjust_bill = 0;
1998 && ( $hash{'bill'} || $hash{'setup'} )
1999 && ( $opt{'adjust_next_bill'}
2000 || $conf->exists('unsuspend-always_adjust_next_bill_date')
2001 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
2008 # - the package billed during suspension
2009 # - or it was ordered on hold
2010 # - or the customer was credited for the unused time
2012 if ( $self->option('suspend_bill',1)
2013 or ( $self->part_pkg->option('suspend_bill',1)
2014 and ! $self->option('no_suspend_bill',1)
2016 or $hash{'order_date'} == $hash{'susp'}
2021 if ( $adjust_bill ) {
2022 if ( $self->part_pkg->option('unused_credit_suspend')
2023 or ( ref($reason) and $reason->unused_credit ) ) {
2024 # then the customer was credited for the unused time before suspending,
2025 # so their next bill should be immediate
2026 $hash{'bill'} = time;
2028 # add the length of time suspended to the bill date
2029 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
2034 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
2035 $hash{'resume'} = '' if !$hash{'adjourn'};
2036 my $new = new FS::cust_pkg ( \%hash );
2037 $error = $new->replace( $self, options => { $self->options } );
2039 $dbh->rollback if $oldAutoCommit;
2046 if ( $reason->unsuspend_pkgpart ) {
2047 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
2048 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
2049 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
2051 my $start_date = $self->cust_main->next_bill_date
2052 if $reason->unsuspend_hold;
2055 $unsusp_pkg = FS::cust_pkg->new({
2056 'custnum' => $self->custnum,
2057 'pkgpart' => $reason->unsuspend_pkgpart,
2058 'start_date' => $start_date,
2059 'locationnum' => $self->locationnum,
2060 # discount? probably not...
2063 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
2066 # new way, using fees
2067 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
2068 # register the need to charge a fee, cust_main->bill will do the rest
2069 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
2071 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
2072 'pkgreasonnum' => $cust_pkg_reason->num,
2073 'pkgnum' => $self->pkgnum,
2074 'feepart' => $reason->feepart,
2075 'nextbill' => $reason->fee_hold,
2077 $error ||= $cust_pkg_reason_fee->insert;
2081 $dbh->rollback if $oldAutoCommit;
2086 if ( $conf->config('unsuspend_email_admin') ) {
2088 my $error = send_email(
2089 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2090 #invoice_from ??? well as good as any
2091 'to' => $conf->config('unsuspend_email_admin'),
2092 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2093 "This is an automatic message from your Freeside installation\n",
2094 "informing you that the following customer package has been unsuspended:\n",
2096 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2097 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2098 ( map { "Service : $_\n" } @labels ),
2100 "An unsuspension fee was charged: ".
2101 $unsusp_pkg->part_pkg->pkg_comment."\n"
2105 'custnum' => $self->custnum,
2106 'msgtype' => 'admin',
2110 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2116 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2117 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2119 $dbh->rollback if $oldAutoCommit;
2120 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2124 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2131 Cancels any pending suspension (sets the adjourn field to null)
2132 for this package and any supplemental packages.
2134 If there is an error, returns the error, otherwise returns false.
2142 my $oldAutoCommit = $FS::UID::AutoCommit;
2143 local $FS::UID::AutoCommit = 0;
2146 my $old = $self->select_for_update;
2148 my $pkgnum = $old->pkgnum;
2149 if ( $old->get('cancel') || $self->get('cancel') ) {
2150 dbh->rollback if $oldAutoCommit;
2151 return "Can't unadjourn cancelled package $pkgnum";
2152 # or at least it's pointless
2155 if ( $old->get('susp') || $self->get('susp') ) {
2156 dbh->rollback if $oldAutoCommit;
2157 return "Can't unadjourn suspended package $pkgnum";
2158 # perhaps this is arbitrary
2161 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2162 dbh->rollback if $oldAutoCommit;
2163 return ""; # no error
2166 my %hash = $self->hash;
2167 $hash{'adjourn'} = '';
2168 $hash{'resume'} = '';
2169 my $new = new FS::cust_pkg ( \%hash );
2170 $error = $new->replace( $self, options => { $self->options } );
2172 $dbh->rollback if $oldAutoCommit;
2176 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2177 $error = $supp_pkg->unadjourn;
2179 $dbh->rollback if $oldAutoCommit;
2180 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2184 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2191 =item change HASHREF | OPTION => VALUE ...
2193 Changes this package: cancels it and creates a new one, with a different
2194 pkgpart or locationnum or both. All services are transferred to the new
2195 package (no change will be made if this is not possible).
2197 Options may be passed as a list of key/value pairs or as a hash reference.
2204 New locationnum, to change the location for this package.
2208 New FS::cust_location object, to create a new location and assign it
2213 New FS::cust_main object, to create a new customer and assign the new package
2218 New pkgpart (see L<FS::part_pkg>).
2222 New refnum (see L<FS::part_referral>).
2226 New quantity; if unspecified, the new package will have the same quantity
2231 "New" (existing) FS::cust_pkg object. The package's services and other
2232 attributes will be transferred to this package.
2236 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2237 susp, adjourn, cancel, expire, and contract_end) to the new package.
2239 =item unprotect_svcs
2241 Normally, change() will rollback and return an error if some services
2242 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2243 If unprotect_svcs is true, this method will transfer as many services as
2244 it can and then unconditionally cancel the old package.
2248 If specified, sets this value for the contract_end date on the new package
2249 (without regard for keep_dates or the usual date-preservation behavior.)
2250 Will throw an error if defined but false; the UI doesn't allow editing
2251 this unless it already exists, making removal impossible to undo.
2255 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2256 cust_pkg must be specified (otherwise, what's the point?)
2258 Returns either the new FS::cust_pkg object or a scalar error.
2262 my $err_or_new_cust_pkg = $old_cust_pkg->change
2266 #used by change and change_later
2267 #didn't put with documented check methods because it depends on change-specific opts
2268 #and it also possibly edits the value of opts
2272 if ( defined($opt->{'contract_end'}) ) {
2273 my $current_contract_end = $self->get('contract_end');
2274 unless ($opt->{'contract_end'}) {
2275 if ($current_contract_end) {
2276 return "Cannot remove contract end date when changing packages";
2278 #shouldn't even pass this option if there's not a current value
2279 #but can be handled gracefully if the option is empty
2280 warn "Contract end date passed unexpectedly";
2281 delete $opt->{'contract_end'};
2285 unless ($current_contract_end) {
2286 #option shouldn't be passed, throw error if it's non-empty
2287 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2293 #some false laziness w/order
2296 my $opt = ref($_[0]) ? shift : { @_ };
2298 my $conf = new FS::Conf;
2300 # handle contract_end on cust_pkg same as passed option
2301 if ( $opt->{'cust_pkg'} ) {
2302 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2303 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2306 # check contract_end, prevent adding/removing
2307 my $error = $self->_check_change($opt);
2308 return $error if $error;
2310 # Transactionize this whole mess
2311 my $oldAutoCommit = $FS::UID::AutoCommit;
2312 local $FS::UID::AutoCommit = 0;
2315 if ( $opt->{'cust_location'} ) {
2316 $error = $opt->{'cust_location'}->find_or_insert;
2318 $dbh->rollback if $oldAutoCommit;
2319 return "creating location record: $error";
2321 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2324 # figure out if we're changing pkgpart
2325 if ( $opt->{'cust_pkg'} ) {
2326 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2329 # whether to override pkgpart checking on the new package
2330 my $same_pkgpart = 1;
2331 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2335 # Before going any further here: if the package is still in the pre-setup
2336 # state, it's safe to modify it in place. No need to charge/credit for
2337 # partial period, transfer usage pools, copy invoice details, or change any
2338 # dates. We DO need to "transfer" services (from the package to itself) to
2339 # check their validity on the new pkgpart.
2340 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2341 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2342 if ( length($opt->{$_}) ) {
2343 $self->set($_, $opt->{$_});
2346 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2348 if ( !$same_pkgpart ) {
2349 $error ||= $self->set_initial_timers;
2351 # but if contract_end was explicitly specified, that overrides all else
2352 $self->set('contract_end', $opt->{'contract_end'})
2353 if $opt->{'contract_end'};
2355 $error ||= $self->replace;
2357 $dbh->rollback if $oldAutoCommit;
2358 return "modifying package: $error";
2361 # check/convert services (only on pkgpart change, to avoid surprises
2362 # when editing locations)
2363 # (maybe do this if changing quantity?)
2364 if ( !$same_pkgpart ) {
2366 $error = $self->transfer($self);
2368 if ( $error and $error == 0 ) {
2369 $error = "transferring $error";
2370 } elsif ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2371 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2372 $error = $self->transfer($self, 'change_svcpart'=>1 );
2373 if ($error and $error == 0) {
2374 $error = "converting $error";
2379 $error = "unable to transfer all services";
2383 $dbh->rollback if $oldAutoCommit;
2387 } # done transferring services
2389 $dbh->commit if $oldAutoCommit;
2398 $hash{'setup'} = $time if $self->get('setup');
2400 $hash{'change_date'} = $time;
2401 $hash{"change_$_"} = $self->$_()
2402 foreach qw( pkgnum pkgpart locationnum );
2404 my $unused_credit = 0;
2405 my $keep_dates = $opt->{'keep_dates'};
2407 # Special case. If the pkgpart is changing, and the customer is going to be
2408 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2409 # and DO pass the flag to cancel() to credit the customer. If the old
2410 # package had a setup date, set the new package's setup to the package
2411 # change date so that it has the same status as before.
2412 if ( $opt->{'pkgpart'}
2413 and $opt->{'pkgpart'} != $self->pkgpart
2414 and $self->part_pkg->option('unused_credit_change', 1) ) {
2417 $hash{'last_bill'} = '';
2421 if ( $keep_dates ) {
2422 foreach my $date ( qw(setup bill last_bill) ) {
2423 $hash{$date} = $self->getfield($date);
2426 # always keep the following dates
2427 foreach my $date (qw(order_date susp adjourn cancel expire resume
2428 start_date contract_end)) {
2429 $hash{$date} = $self->getfield($date);
2431 # but if contract_end was explicitly specified, that overrides all else
2432 $hash{'contract_end'} = $opt->{'contract_end'}
2433 if $opt->{'contract_end'};
2435 # allow $opt->{'locationnum'} = '' to specifically set it to null
2436 # (i.e. customer default location)
2437 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2439 # usually this doesn't matter. the two cases where it does are:
2440 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2442 # 2. (more importantly) changing a package before it's billed
2443 $hash{'waive_setup'} = $self->waive_setup;
2445 # if this package is scheduled for a future package change, preserve that
2446 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2448 my $custnum = $self->custnum;
2449 if ( $opt->{cust_main} ) {
2450 my $cust_main = $opt->{cust_main};
2451 unless ( $cust_main->custnum ) {
2452 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2454 $dbh->rollback if $oldAutoCommit;
2455 return "inserting customer record: $error";
2458 $custnum = $cust_main->custnum;
2461 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2464 if ( $opt->{'cust_pkg'} ) {
2465 # The target package already exists; update it to show that it was
2466 # changed from this package.
2467 $cust_pkg = $opt->{'cust_pkg'};
2469 # follow all the above rules for date changes, etc.
2470 foreach (keys %hash) {
2471 $cust_pkg->set($_, $hash{$_});
2473 # except those that implement the future package change behavior
2474 foreach (qw(change_to_pkgnum start_date expire)) {
2475 $cust_pkg->set($_, '');
2478 $error = $cust_pkg->replace;
2481 # Create the new package.
2482 $cust_pkg = new FS::cust_pkg {
2483 custnum => $custnum,
2484 locationnum => $opt->{'locationnum'},
2485 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2486 qw( pkgpart quantity refnum salesnum )
2490 $error = $cust_pkg->insert( 'change' => 1,
2491 'allow_pkgpart' => $same_pkgpart );
2494 $dbh->rollback if $oldAutoCommit;
2495 return "inserting new package: $error";
2498 # Transfer services and cancel old package.
2499 # Enforce service limits only if this is a pkgpart change.
2500 local $FS::cust_svc::ignore_quantity;
2501 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2502 $error = $self->transfer($cust_pkg);
2503 if ($error and $error == 0) {
2504 # $old_pkg->transfer failed.
2505 $dbh->rollback if $oldAutoCommit;
2506 return "transferring $error";
2509 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2510 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2511 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2512 if ($error and $error == 0) {
2513 # $old_pkg->transfer failed.
2514 $dbh->rollback if $oldAutoCommit;
2515 return "converting $error";
2519 # We set unprotect_svcs when executing a "future package change". It's
2520 # not a user-interactive operation, so returning an error means the
2521 # package change will just fail. Rather than have that happen, we'll
2522 # let leftover services be deleted.
2523 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2524 # Transfers were successful, but we still had services left on the old
2525 # package. We can't change the package under this circumstances, so abort.
2526 $dbh->rollback if $oldAutoCommit;
2527 return "unable to transfer all services";
2530 #reset usage if changing pkgpart
2531 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2532 if ($self->pkgpart != $cust_pkg->pkgpart) {
2533 my $part_pkg = $cust_pkg->part_pkg;
2534 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2538 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2541 $dbh->rollback if $oldAutoCommit;
2542 return "setting usage values: $error";
2545 # if NOT changing pkgpart, transfer any usage pools over
2546 foreach my $usage ($self->cust_pkg_usage) {
2547 $usage->set('pkgnum', $cust_pkg->pkgnum);
2548 $error = $usage->replace;
2550 $dbh->rollback if $oldAutoCommit;
2551 return "transferring usage pools: $error";
2556 # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2557 if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2558 my @old_cust_pkg_usageprice;
2559 if ($opt->{'cust_pkg_usageprice'}) {
2560 @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2562 @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2564 foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2565 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2566 'pkgnum' => $cust_pkg->pkgnum,
2567 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2568 'quantity' => $old_cust_pkg_usageprice->quantity,
2570 $error = $new_cust_pkg_usageprice->insert;
2572 $dbh->rollback if $oldAutoCommit;
2573 return "Error transferring usage pricing add-on: $error";
2578 # transfer discounts, if we're not changing pkgpart
2579 if ( $same_pkgpart ) {
2580 foreach my $old_discount ($self->cust_pkg_discount_active) {
2581 # don't remove the old discount, we may still need to bill that package.
2582 my $new_discount = new FS::cust_pkg_discount {
2583 'pkgnum' => $cust_pkg->pkgnum,
2584 'discountnum' => $old_discount->discountnum,
2585 'months_used' => $old_discount->months_used,
2587 $error = $new_discount->insert;
2589 $dbh->rollback if $oldAutoCommit;
2590 return "transferring discounts: $error";
2595 # transfer (copy) invoice details
2596 foreach my $detail ($self->cust_pkg_detail) {
2597 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2598 $new_detail->set('pkgdetailnum', '');
2599 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2600 $error = $new_detail->insert;
2602 $dbh->rollback if $oldAutoCommit;
2603 return "transferring package notes: $error";
2607 # transfer scheduled expire/adjourn reasons
2608 foreach my $action ('expire', 'adjourn') {
2609 if ( $cust_pkg->get($action) ) {
2610 my $reason = $self->last_cust_pkg_reason($action);
2612 $reason->set('pkgnum', $cust_pkg->pkgnum);
2613 $error = $reason->replace;
2615 $dbh->rollback if $oldAutoCommit;
2616 return "transferring $action reason: $error";
2624 if ( !$opt->{'cust_pkg'} ) {
2625 # Order any supplemental packages.
2626 my $part_pkg = $cust_pkg->part_pkg;
2627 my @old_supp_pkgs = $self->supplemental_pkgs;
2628 foreach my $link ($part_pkg->supp_part_pkg_link) {
2630 foreach (@old_supp_pkgs) {
2631 if ($_->pkgpart == $link->dst_pkgpart) {
2633 $_->pkgpart(0); # so that it can't match more than once
2637 # false laziness with FS::cust_main::Packages::order_pkg
2638 my $new = FS::cust_pkg->new({
2639 pkgpart => $link->dst_pkgpart,
2640 pkglinknum => $link->pkglinknum,
2641 custnum => $custnum,
2642 main_pkgnum => $cust_pkg->pkgnum,
2643 locationnum => $cust_pkg->locationnum,
2644 start_date => $cust_pkg->start_date,
2645 order_date => $cust_pkg->order_date,
2646 expire => $cust_pkg->expire,
2647 adjourn => $cust_pkg->adjourn,
2648 contract_end => $cust_pkg->contract_end,
2649 refnum => $cust_pkg->refnum,
2650 discountnum => $cust_pkg->discountnum,
2651 waive_setup => $cust_pkg->waive_setup,
2653 if ( $old and $opt->{'keep_dates'} ) {
2654 foreach (qw(setup bill last_bill)) {
2655 $new->set($_, $old->get($_));
2658 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2661 $error ||= $old->transfer($new);
2663 if ( $error and $error > 0 ) {
2664 # no reason why this should ever fail, but still...
2665 $error = "Unable to transfer all services from supplemental package ".
2669 $dbh->rollback if $oldAutoCommit;
2672 push @new_supp_pkgs, $new;
2674 } # if !$opt->{'cust_pkg'}
2675 # because if there is one, then supplemental packages would already
2676 # have been created for it.
2678 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2680 #Don't allow billing the package (preceding period packages and/or
2681 #outstanding usage) if we are keeping dates (i.e. location changing),
2682 #because the new package will be billed for the same date range.
2683 #Supplemental packages are also canceled here.
2685 # during scheduled changes, avoid canceling the package we just
2687 $self->set('change_to_pkgnum' => '');
2689 $error = $self->cancel(
2691 unused_credit => $unused_credit,
2692 nobill => $keep_dates,
2693 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2694 no_delay_cancel => 1,
2697 $dbh->rollback if $oldAutoCommit;
2698 return "canceling old package: $error";
2701 # transfer rt_field_charge, if we're not changing pkgpart
2702 # after billing of old package, before billing of new package
2703 if ( $same_pkgpart ) {
2704 foreach my $rt_field_charge ($self->rt_field_charge) {
2705 $rt_field_charge->set('pkgnum', $cust_pkg->pkgnum);
2706 $error = $rt_field_charge->replace;
2708 $dbh->rollback if $oldAutoCommit;
2709 return "transferring rt_field_charge: $error";
2714 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2716 my $error = $cust_pkg->cust_main->bill(
2717 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2720 $dbh->rollback if $oldAutoCommit;
2721 return "billing new package: $error";
2725 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2731 =item change_later OPTION => VALUE...
2733 Schedule a package change for a later date. This actually orders the new
2734 package immediately, but sets its start date for a future date, and sets
2735 the current package to expire on the same date.
2737 If the package is already scheduled for a change, this can be called with
2738 'start_date' to change the scheduled date, or with pkgpart and/or
2739 locationnum to modify the package change. To cancel the scheduled change
2740 entirely, see C<abort_change>.
2748 The date for the package change. Required, and must be in the future.
2758 The pkgpart, locationnum, quantity and optional contract_end of the new
2759 package, with the same meaning as in C<change>.
2767 my $opt = ref($_[0]) ? shift : { @_ };
2769 # check contract_end, prevent adding/removing
2770 my $error = $self->_check_change($opt);
2771 return $error if $error;
2773 my $oldAutoCommit = $FS::UID::AutoCommit;
2774 local $FS::UID::AutoCommit = 0;
2777 my $cust_main = $self->cust_main;
2779 my $date = delete $opt->{'start_date'} or return 'start_date required';
2781 if ( $date <= time ) {
2782 $dbh->rollback if $oldAutoCommit;
2783 return "start_date $date is in the past";
2786 # If the user entered a new location, set it up now.
2787 if ( $opt->{'cust_location'} ) {
2788 $error = $opt->{'cust_location'}->find_or_insert;
2790 $dbh->rollback if $oldAutoCommit;
2791 return "creating location record: $error";
2793 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2796 if ( $self->change_to_pkgnum ) {
2797 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2798 my $new_pkgpart = $opt->{'pkgpart'}
2799 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2800 my $new_locationnum = $opt->{'locationnum'}
2801 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2802 my $new_quantity = $opt->{'quantity'}
2803 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2804 my $new_contract_end = $opt->{'contract_end'}
2805 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2806 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2807 # it hasn't been billed yet, so in principle we could just edit
2808 # it in place (w/o a package change), but that's bad form.
2809 # So change the package according to the new options...
2810 my $err_or_pkg = $change_to->change(%$opt);
2811 if ( ref $err_or_pkg ) {
2812 # Then set that package up for a future start.
2813 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2814 $self->set('expire', $date); # in case it's different
2815 $err_or_pkg->set('start_date', $date);
2816 $err_or_pkg->set('change_date', '');
2817 $err_or_pkg->set('change_pkgnum', '');
2819 $error = $self->replace ||
2820 $err_or_pkg->replace ||
2821 #because change() might've edited existing scheduled change in place
2822 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2823 $change_to->cancel('no_delay_cancel' => 1) ||
2824 $change_to->delete);
2826 $error = $err_or_pkg;
2828 } else { # change the start date only.
2829 $self->set('expire', $date);
2830 $change_to->set('start_date', $date);
2831 $error = $self->replace || $change_to->replace;
2834 $dbh->rollback if $oldAutoCommit;
2837 $dbh->commit if $oldAutoCommit;
2840 } # if $self->change_to_pkgnum
2842 my $new_pkgpart = $opt->{'pkgpart'}
2843 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2844 my $new_locationnum = $opt->{'locationnum'}
2845 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2846 my $new_quantity = $opt->{'quantity'}
2847 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2848 my $new_contract_end = $opt->{'contract_end'}
2849 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2851 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2853 # allow $opt->{'locationnum'} = '' to specifically set it to null
2854 # (i.e. customer default location)
2855 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2857 my $new = FS::cust_pkg->new( {
2858 custnum => $self->custnum,
2859 locationnum => $opt->{'locationnum'},
2860 start_date => $date,
2861 map { $_ => ( $opt->{$_} || $self->$_() ) }
2862 qw( pkgpart quantity refnum salesnum contract_end )
2864 $error = $new->insert('change' => 1,
2865 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2867 $self->set('change_to_pkgnum', $new->pkgnum);
2868 $self->set('expire', $date);
2869 $error = $self->replace;
2872 $dbh->rollback if $oldAutoCommit;
2874 $dbh->commit if $oldAutoCommit;
2882 Cancels a future package change scheduled by C<change_later>.
2888 my $oldAutoCommit = $FS::UID::AutoCommit;
2889 local $FS::UID::AutoCommit = 0;
2891 my $pkgnum = $self->change_to_pkgnum;
2892 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2894 $self->set('change_to_pkgnum', '');
2895 $self->set('expire', '');
2896 $error = $self->replace;
2898 $error ||= $change_to->cancel || $change_to->delete;
2901 if ( $oldAutoCommit ) {
2912 =item set_quantity QUANTITY
2914 Change the package's quantity field. This is one of the few package properties
2915 that can safely be changed without canceling and reordering the package
2916 (because it doesn't affect tax eligibility). Returns an error or an
2923 $self = $self->replace_old; # just to make sure
2924 $self->quantity(shift);
2928 =item set_salesnum SALESNUM
2930 Change the package's salesnum (sales person) field. This is one of the few
2931 package properties that can safely be changed without canceling and reordering
2932 the package (because it doesn't affect tax eligibility). Returns an error or
2939 $self = $self->replace_old; # just to make sure
2940 $self->salesnum(shift);
2942 # XXX this should probably reassign any credit that's already been given
2945 =item modify_charge OPTIONS
2947 Change the properties of a one-time charge. The following properties can
2948 be changed this way:
2949 - pkg: the package description
2950 - classnum: the package class
2951 - additional: arrayref of additional invoice details to add to this package
2953 and, I<if the charge has not yet been billed>:
2954 - start_date: the date when it will be billed
2955 - amount: the setup fee to be charged
2956 - quantity: the multiplier for the setup fee
2957 - separate_bill: whether to put the charge on a separate invoice
2959 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2960 commission credits linked to this charge, they will be recalculated.
2967 my $part_pkg = $self->part_pkg;
2968 my $pkgnum = $self->pkgnum;
2971 my $oldAutoCommit = $FS::UID::AutoCommit;
2972 local $FS::UID::AutoCommit = 0;
2974 return "Can't use modify_charge except on one-time charges"
2975 unless $part_pkg->freq eq '0';
2977 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2978 $part_pkg->set('pkg', $opt{'pkg'});
2981 my %pkg_opt = $part_pkg->options;
2982 my $pkg_opt_modified = 0;
2984 $opt{'additional'} ||= [];
2987 foreach (grep /^additional/, keys %pkg_opt) {
2988 ($i) = ($_ =~ /^additional_info(\d+)$/);
2989 $old_additional[$i] = $pkg_opt{$_} if $i;
2990 delete $pkg_opt{$_};
2993 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2994 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2995 if (!exists($old_additional[$i])
2996 or $old_additional[$i] ne $opt{'additional'}->[$i])
2998 $pkg_opt_modified = 1;
3001 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
3002 $pkg_opt{'additional_count'} = $i if $i > 0;
3005 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
3008 $old_classnum = $part_pkg->classnum;
3009 $part_pkg->set('classnum', $opt{'classnum'});
3012 if ( !$self->get('setup') ) {
3013 # not yet billed, so allow amount, setup_cost, quantity, start_date,
3016 if ( exists($opt{'amount'})
3017 and $part_pkg->option('setup_fee') != $opt{'amount'}
3018 and $opt{'amount'} > 0 ) {
3020 $pkg_opt{'setup_fee'} = $opt{'amount'};
3021 $pkg_opt_modified = 1;
3024 if ( exists($opt{'setup_cost'})
3025 and $part_pkg->setup_cost != $opt{'setup_cost'}
3026 and $opt{'setup_cost'} > 0 ) {
3028 $part_pkg->set('setup_cost', $opt{'setup_cost'});
3031 if ( exists($opt{'quantity'})
3032 and $opt{'quantity'} != $self->quantity
3033 and $opt{'quantity'} > 0 ) {
3035 $self->set('quantity', $opt{'quantity'});
3038 if ( exists($opt{'start_date'})
3039 and $opt{'start_date'} != $self->start_date ) {
3041 $self->set('start_date', $opt{'start_date'});
3044 if ( exists($opt{'separate_bill'})
3045 and $opt{'separate_bill'} ne $self->separate_bill ) {
3047 $self->set('separate_bill', $opt{'separate_bill'});
3051 } # else simply ignore them; the UI shouldn't allow editing the fields
3054 if ( exists($opt{'taxclass'})
3055 and $part_pkg->taxclass ne $opt{'taxclass'}) {
3057 $part_pkg->set('taxclass', $opt{'taxclass'});
3061 if ( $part_pkg->modified or $pkg_opt_modified ) {
3062 # can we safely modify the package def?
3063 # Yes, if it's not available for purchase, and this is the only instance
3065 if ( $part_pkg->disabled
3066 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
3067 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
3069 $error = $part_pkg->replace( options => \%pkg_opt );
3072 $part_pkg = $part_pkg->clone;
3073 $part_pkg->set('disabled' => 'Y');
3074 $error = $part_pkg->insert( options => \%pkg_opt );
3075 # and associate this as yet-unbilled package to the new package def
3076 $self->set('pkgpart' => $part_pkg->pkgpart);
3079 $dbh->rollback if $oldAutoCommit;
3084 if ($self->modified) { # for quantity or start_date change, or if we had
3085 # to clone the existing package def
3086 my $error = $self->replace;
3087 return $error if $error;
3089 if (defined $old_classnum) {
3090 # fix invoice grouping records
3091 my $old_catname = $old_classnum
3092 ? FS::pkg_class->by_key($old_classnum)->categoryname
3094 my $new_catname = $opt{'classnum'}
3095 ? $part_pkg->pkg_class->categoryname
3097 if ( $old_catname ne $new_catname ) {
3098 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
3099 # (there should only be one...)
3100 my @display = qsearch( 'cust_bill_pkg_display', {
3101 'billpkgnum' => $cust_bill_pkg->billpkgnum,
3102 'section' => $old_catname,
3104 foreach (@display) {
3105 $_->set('section', $new_catname);
3106 $error = $_->replace;
3108 $dbh->rollback if $oldAutoCommit;
3112 } # foreach $cust_bill_pkg
3115 if ( $opt{'adjust_commission'} ) {
3116 # fix commission credits...tricky.
3117 foreach my $cust_event ($self->cust_event) {
3118 my $part_event = $cust_event->part_event;
3119 foreach my $table (qw(sales agent)) {
3121 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3122 my $credit = qsearchs('cust_credit', {
3123 'eventnum' => $cust_event->eventnum,
3125 if ( $part_event->isa($class) ) {
3126 # Yes, this results in current commission rates being applied
3127 # retroactively to a one-time charge. For accounting purposes
3128 # there ought to be some kind of time limit on doing this.
3129 my $amount = $part_event->_calc_credit($self);
3130 if ( $credit and $credit->amount ne $amount ) {
3131 # Void the old credit.
3132 $error = $credit->void('Package class changed');
3134 $dbh->rollback if $oldAutoCommit;
3135 return "$error (adjusting commission credit)";
3138 # redo the event action to recreate the credit.
3140 eval { $part_event->do_action( $self, $cust_event ) };
3142 $dbh->rollback if $oldAutoCommit;
3145 } # if $part_event->isa($class)
3147 } # foreach $cust_event
3148 } # if $opt{'adjust_commission'}
3149 } # if defined $old_classnum
3151 $dbh->commit if $oldAutoCommit;
3158 sub process_bulk_cust_pkg {
3161 warn Dumper($param) if $DEBUG;
3163 my $old_part_pkg = qsearchs('part_pkg',
3164 { pkgpart => $param->{'old_pkgpart'} });
3165 my $new_part_pkg = qsearchs('part_pkg',
3166 { pkgpart => $param->{'new_pkgpart'} });
3167 die "Must select a new package type\n" unless $new_part_pkg;
3168 #my $keep_dates = $param->{'keep_dates'} || 0;
3169 my $keep_dates = 1; # there is no good reason to turn this off
3171 my $oldAutoCommit = $FS::UID::AutoCommit;
3172 local $FS::UID::AutoCommit = 0;
3175 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3178 foreach my $old_cust_pkg ( @cust_pkgs ) {
3180 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3181 if ( $old_cust_pkg->getfield('cancel') ) {
3182 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3183 $old_cust_pkg->pkgnum."\n"
3187 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3189 my $error = $old_cust_pkg->change(
3190 'pkgpart' => $param->{'new_pkgpart'},
3191 'keep_dates' => $keep_dates
3193 if ( !ref($error) ) { # change returns the cust_pkg on success
3195 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3198 $dbh->commit if $oldAutoCommit;
3204 Returns the last bill date, or if there is no last bill date, the setup date.
3205 Useful for billing metered services.
3211 return $self->setfield('last_bill', $_[0]) if @_;
3212 return $self->getfield('last_bill') if $self->getfield('last_bill');
3213 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3214 'edate' => $self->bill, } );
3215 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3218 =item last_cust_pkg_reason ACTION
3220 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3221 Returns false if there is no reason or the package is not currenly ACTION'd
3222 ACTION is one of adjourn, susp, cancel, or expire.
3226 sub last_cust_pkg_reason {
3227 my ( $self, $action ) = ( shift, shift );
3228 my $date = $self->get($action);
3230 'table' => 'cust_pkg_reason',
3231 'hashref' => { 'pkgnum' => $self->pkgnum,
3232 'action' => substr(uc($action), 0, 1),
3235 'order_by' => 'ORDER BY num DESC LIMIT 1',
3239 =item last_reason ACTION
3241 Returns the most recent ACTION FS::reason associated with the package.
3242 Returns false if there is no reason or the package is not currenly ACTION'd
3243 ACTION is one of adjourn, susp, cancel, or expire.
3248 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3249 $cust_pkg_reason->reason
3250 if $cust_pkg_reason;
3255 Returns the definition for this billing item, as an FS::part_pkg object (see
3262 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3263 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3264 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3269 Returns the cancelled package this package was changed from, if any.
3275 return '' unless $self->change_pkgnum;
3276 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3279 =item change_cust_main
3281 Returns the customter this package was detached to, if any.
3285 sub change_cust_main {
3287 return '' unless $self->change_custnum;
3288 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3293 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3300 $self->part_pkg->calc_setup($self, @_);
3305 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3312 $self->part_pkg->calc_recur($self, @_);
3317 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3324 $self->part_pkg->base_setup($self, @_);
3329 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3336 $self->part_pkg->base_recur($self, @_);
3341 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3348 $self->part_pkg->calc_remain($self, @_);
3353 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3360 $self->part_pkg->calc_cancel($self, @_);
3365 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3371 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3374 =item cust_pkg_detail [ DETAILTYPE ]
3376 Returns any customer package details for this package (see
3377 L<FS::cust_pkg_detail>).
3379 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3383 sub cust_pkg_detail {
3385 my %hash = ( 'pkgnum' => $self->pkgnum );
3386 $hash{detailtype} = shift if @_;
3388 'table' => 'cust_pkg_detail',
3389 'hashref' => \%hash,
3390 'order_by' => 'ORDER BY weight, pkgdetailnum',
3394 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3396 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3398 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3400 If there is an error, returns the error, otherwise returns false.
3404 sub set_cust_pkg_detail {
3405 my( $self, $detailtype, @details ) = @_;
3407 my $oldAutoCommit = $FS::UID::AutoCommit;
3408 local $FS::UID::AutoCommit = 0;
3411 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3412 my $error = $current->delete;
3414 $dbh->rollback if $oldAutoCommit;
3415 return "error removing old detail: $error";
3419 foreach my $detail ( @details ) {
3420 my $cust_pkg_detail = new FS::cust_pkg_detail {
3421 'pkgnum' => $self->pkgnum,
3422 'detailtype' => $detailtype,
3423 'detail' => $detail,
3425 my $error = $cust_pkg_detail->insert;
3427 $dbh->rollback if $oldAutoCommit;
3428 return "error adding new detail: $error";
3433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3440 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3444 #false laziness w/cust_bill.pm
3448 'table' => 'cust_event',
3449 'addl_from' => 'JOIN part_event USING ( eventpart )',
3450 'hashref' => { 'tablenum' => $self->pkgnum },
3451 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3455 =item num_cust_event
3457 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3461 #false laziness w/cust_bill.pm
3462 sub num_cust_event {
3464 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3465 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3468 =item exists_cust_event
3470 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3474 sub exists_cust_event {
3476 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3477 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3478 $row ? $row->[0] : '';
3481 sub _from_cust_event_where {
3483 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3484 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3488 my( $self, $sql, @args ) = @_;
3489 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3490 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3494 =item part_pkg_currency_option OPTIONNAME
3496 Returns a two item list consisting of the currency of this customer, if any,
3497 and a value for the provided option. If the customer has a currency, the value
3498 is the option value the given name and the currency (see
3499 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3500 regular option value for the given name (see L<FS::part_pkg_option>).
3504 sub part_pkg_currency_option {
3505 my( $self, $optionname ) = @_;
3506 my $part_pkg = $self->part_pkg;
3507 if ( my $currency = $self->cust_main->currency ) {
3508 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3510 ('', $part_pkg->option($optionname) );
3514 =item cust_svc [ SVCPART ] (old, deprecated usage)
3516 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3518 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3520 Returns the services for this package, as FS::cust_svc objects (see
3521 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3522 spcififed, returns only the matching services.
3524 As an optimization, use the cust_svc_unsorted version if you are not displaying
3531 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3532 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3535 sub cust_svc_unsorted {
3537 @{ $self->cust_svc_unsorted_arrayref(@_) };
3540 sub cust_svc_unsorted_arrayref {
3543 return [] unless $self->num_cust_svc(@_);
3546 if ( @_ && $_[0] =~ /^\d+/ ) {
3547 $opt{svcpart} = shift;
3548 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3555 'select' => 'cust_svc.*, part_svc.*',
3556 'table' => 'cust_svc',
3557 'hashref' => { 'pkgnum' => $self->pkgnum },
3558 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3560 $search{hashref}->{svcpart} = $opt{svcpart}
3562 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3565 [ qsearch(\%search) ];
3569 =item overlimit [ SVCPART ]
3571 Returns the services for this package which have exceeded their
3572 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3573 is specified, return only the matching services.
3579 return () unless $self->num_cust_svc(@_);
3580 grep { $_->overlimit } $self->cust_svc(@_);
3583 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3585 Returns historical services for this package created before END TIMESTAMP and
3586 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3587 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3588 I<pkg_svc.hidden> flag will be omitted.
3594 warn "$me _h_cust_svc called on $self\n"
3597 my ($end, $start, $mode) = @_;
3599 local($FS::Record::qsearch_qualify_columns) = 0;
3601 my @cust_svc = $self->_sort_cust_svc(
3602 [ qsearch( 'h_cust_svc',
3603 { 'pkgnum' => $self->pkgnum, },
3604 FS::h_cust_svc->sql_h_search(@_),
3608 if ( defined($mode) && $mode eq 'I' ) {
3609 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3610 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3616 sub _sort_cust_svc {
3617 my( $self, $arrayref ) = @_;
3620 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3622 my %pkg_svc = map { $_->svcpart => $_ }
3623 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3628 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3630 $pkg_svc ? $pkg_svc->primary_svc : '',
3631 $pkg_svc ? $pkg_svc->quantity : 0,
3638 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3640 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3642 Returns the number of services for this package. Available options are svcpart
3643 and svcdb. If either is spcififed, returns only the matching services.
3650 return $self->{'_num_cust_svc'}
3652 && exists($self->{'_num_cust_svc'})
3653 && $self->{'_num_cust_svc'} =~ /\d/;
3655 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3659 if ( @_ && $_[0] =~ /^\d+/ ) {
3660 $opt{svcpart} = shift;
3661 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3667 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3668 my $where = ' WHERE pkgnum = ? ';
3669 my @param = ($self->pkgnum);
3671 if ( $opt{'svcpart'} ) {
3672 $where .= ' AND svcpart = ? ';
3673 push @param, $opt{'svcpart'};
3675 if ( $opt{'svcdb'} ) {
3676 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3677 $where .= ' AND svcdb = ? ';
3678 push @param, $opt{'svcdb'};
3681 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3682 $sth->execute(@param) or die $sth->errstr;
3683 $sth->fetchrow_arrayref->[0];
3686 =item available_part_svc
3688 Returns a list of FS::part_svc objects representing services included in this
3689 package but not yet provisioned. Each FS::part_svc object also has an extra
3690 field, I<num_avail>, which specifies the number of available services.
3692 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3693 associated pkg_svc has the provision_hold flag set.
3697 sub available_part_svc {
3701 my $pkg_quantity = $self->quantity || 1;
3703 grep { $_->num_avail > 0 }
3705 my $part_svc = $_->part_svc;
3706 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3707 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3709 # more evil encapsulation breakage
3710 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3711 my @exports = $part_svc->part_export_did;
3712 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3717 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3718 $self->part_pkg->pkg_svc;
3721 =item part_svc [ OPTION => VALUE ... ]
3723 Returns a list of FS::part_svc objects representing provisioned and available
3724 services included in this package. Each FS::part_svc object also has the
3725 following extra fields:
3739 (services) - array reference containing the provisioned services, as cust_svc objects
3743 Accepts two options:
3747 =item summarize_size
3749 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3750 is this size or greater.
3752 =item hide_discontinued
3754 If true, will omit looking for services that are no longer avaialble in the
3762 #label -> ($cust_svc->label)[1]
3768 my $pkg_quantity = $self->quantity || 1;
3770 #XXX some sort of sort order besides numeric by svcpart...
3771 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3773 my $part_svc = $pkg_svc->part_svc;
3774 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3775 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3776 $part_svc->{'Hash'}{'num_avail'} =
3777 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3778 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3779 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3780 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3781 && $num_cust_svc >= $opt{summarize_size};
3782 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3784 } $self->part_pkg->pkg_svc;
3786 unless ( $opt{hide_discontinued} ) {
3788 push @part_svc, map {
3790 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3791 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3792 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3793 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3794 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3796 } $self->extra_part_svc;
3803 =item extra_part_svc
3805 Returns a list of FS::part_svc objects corresponding to services in this
3806 package which are still provisioned but not (any longer) available in the
3811 sub extra_part_svc {
3814 my $pkgnum = $self->pkgnum;
3815 #my $pkgpart = $self->pkgpart;
3818 # 'table' => 'part_svc',
3821 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3822 # WHERE pkg_svc.svcpart = part_svc.svcpart
3823 # AND pkg_svc.pkgpart = ?
3826 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3827 # LEFT JOIN cust_pkg USING ( pkgnum )
3828 # WHERE cust_svc.svcpart = part_svc.svcpart
3831 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3834 #seems to benchmark slightly faster... (or did?)
3836 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3837 my $pkgparts = join(',', @pkgparts);
3840 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3841 #MySQL doesn't grok DISINCT ON
3842 'select' => 'DISTINCT part_svc.*',
3843 'table' => 'part_svc',
3845 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3846 AND pkg_svc.pkgpart IN ($pkgparts)
3849 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3850 LEFT JOIN cust_pkg USING ( pkgnum )
3853 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3854 'extra_param' => [ [$self->pkgnum=>'int'] ],
3860 Returns a short status string for this package, currently:
3866 =item not yet billed
3868 =item one-time charge
3883 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3885 return 'cancelled' if $self->get('cancel');
3886 return 'on hold' if $self->susp && ! $self->setup;
3887 return 'suspended' if $self->susp;
3888 return 'not yet billed' unless $self->setup;
3889 return 'one-time charge' if $freq =~ /^(0|$)/;
3893 =item ucfirst_status
3895 Returns the status with the first character capitalized.
3899 sub ucfirst_status {
3900 ucfirst(shift->status);
3905 Class method that returns the list of possible status strings for packages
3906 (see L<the status method|/status>). For example:
3908 @statuses = FS::cust_pkg->statuses();
3912 tie my %statuscolor, 'Tie::IxHash',
3913 'on hold' => 'FF00F5', #brighter purple!
3914 'not yet billed' => '009999', #teal? cyan?
3915 'one-time charge' => '0000CC', #blue #'000000',
3916 'active' => '00CC00',
3917 'suspended' => 'FF9900',
3918 'cancelled' => 'FF0000',
3922 my $self = shift; #could be class...
3923 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3924 # # mayble split btw one-time vs. recur
3935 Returns a hex triplet color string for this package's status.
3941 $statuscolor{$self->status};
3944 =item is_status_delay_cancel
3946 Returns true if part_pkg has option delay_cancel,
3947 cust_pkg status is 'suspended' and expire is set
3948 to cancel package within the next day (or however
3949 many days are set in global config part_pkg-delay_cancel-days.
3951 Accepts option I<part_pkg-delay_cancel-days> which should be
3952 the value of the config setting, to avoid looking it up again.
3954 This is not a real status, this only meant for hacking display
3955 values, because otherwise treating the package as suspended is
3956 really the whole point of the delay_cancel option.
3960 sub is_status_delay_cancel {
3961 my ($self,%opt) = @_;
3962 if ( $self->main_pkgnum and $self->pkglinknum ) {
3963 return $self->main_pkg->is_status_delay_cancel;
3965 return 0 unless $self->part_pkg->option('delay_cancel',1);
3966 return 0 unless $self->status eq 'suspended';
3967 return 0 unless $self->expire;
3968 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3970 my $conf = new FS::Conf;
3971 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3973 my $expsecs = 60*60*24*$expdays;
3974 return 0 unless $self->expire < time + $expsecs;
3980 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3981 "pkg - comment" depending on user preference).
3987 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3988 $label = $self->pkgnum. ": $label"
3989 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3993 =item pkg_label_long
3995 Returns a long label for this package, adding the primary service's label to
4000 sub pkg_label_long {
4002 my $label = $self->pkg_label;
4003 my $cust_svc = $self->primary_cust_svc;
4004 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
4010 Returns a customer-localized label for this package.
4016 $self->part_pkg->pkg_locale( $self->cust_main->locale );
4019 =item primary_cust_svc
4021 Returns a primary service (as FS::cust_svc object) if one can be identified.
4025 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
4027 sub primary_cust_svc {
4030 my @cust_svc = $self->cust_svc;
4032 return '' unless @cust_svc; #no serivces - irrelevant then
4034 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
4036 # primary service as specified in the package definition
4037 # or exactly one service definition with quantity one
4038 my $svcpart = $self->part_pkg->svcpart;
4039 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
4040 return $cust_svc[0] if scalar(@cust_svc) == 1;
4042 #couldn't identify one thing..
4048 Returns a list of lists, calling the label method for all services
4049 (see L<FS::cust_svc>) of this billing item.
4055 map { [ $_->label ] } $self->cust_svc;
4058 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4060 Like the labels method, but returns historical information on services that
4061 were active as of END_TIMESTAMP and (optionally) not cancelled before
4062 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
4063 I<pkg_svc.hidden> flag will be omitted.
4065 If LOCALE is passed, service definition names will be localized.
4067 Returns a list of lists, calling the label method for all (historical)
4068 services (see L<FS::h_cust_svc>) of this billing item.
4074 my ($end, $start, $mode, $locale) = @_;
4075 warn "$me h_labels\n"
4077 map { [ $_->label($end, $start, $locale) ] }
4078 $self->h_cust_svc($end, $start, $mode);
4083 Like labels, except returns a simple flat list, and shortens long
4084 (currently >5 or the cust_bill-max_same_services configuration value) lists of
4085 identical services to one line that lists the service label and the number of
4086 individual services rather than individual items.
4091 shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
4094 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4096 Like h_labels, except returns a simple flat list, and shortens long
4097 (currently >5 or the cust_bill-max_same_services configuration value) lists
4098 of identical services to one line that lists the service label and the
4099 number of individual services rather than individual items.
4103 sub h_labels_short {
4104 shift->_labels_short( 'h_labels', @_ );
4107 # takes a method name ('labels' or 'h_labels') and all its arguments;
4108 # maybe should be "shorten($self->h_labels( ... ) )"
4111 my( $self, $method ) = ( shift, shift );
4113 warn "$me _labels_short called on $self with $method method\n"
4116 my $conf = new FS::Conf;
4117 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4119 warn "$me _labels_short populating \%labels\n"
4123 #tie %labels, 'Tie::IxHash';
4124 push @{ $labels{$_->[0]} }, $_->[1]
4125 foreach $self->$method(@_);
4127 warn "$me _labels_short populating \@labels\n"
4131 foreach my $label ( keys %labels ) {
4133 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4134 my $num = scalar(@values);
4135 warn "$me _labels_short $num items for $label\n"
4138 if ( $num > $max_same_services ) {
4139 warn "$me _labels_short more than $max_same_services, so summarizing\n"
4141 push @labels, "$label ($num)";
4143 if ( $conf->exists('cust_bill-consolidate_services') ) {
4144 warn "$me _labels_short consolidating services\n"
4146 # push @labels, "$label: ". join(', ', @values);
4148 my $detail = "$label: ";
4149 $detail .= shift(@values). ', '
4151 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4153 push @labels, $detail;
4155 warn "$me _labels_short done consolidating services\n"
4158 warn "$me _labels_short adding service data\n"
4160 push @labels, map { "$label: $_" } @values;
4171 Returns the parent customer object (see L<FS::cust_main>).
4175 Returns the balance for this specific package, when using
4176 experimental package balance.
4182 $self->cust_main->balance_pkgnum( $self->pkgnum );
4185 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4189 Returns the location object, if any (see L<FS::cust_location>).
4191 =item cust_location_or_main
4193 If this package is associated with a location, returns the locaiton (see
4194 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4196 =item location_label [ OPTION => VALUE ... ]
4198 Returns the label of the location object (see L<FS::cust_location>).
4202 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4204 =item tax_locationnum
4206 Returns the foreign key to a L<FS::cust_location> object for calculating
4207 tax on this package, as determined by the C<tax-pkg_address> and
4208 C<tax-ship_address> configuration flags.
4212 sub tax_locationnum {
4214 my $conf = FS::Conf->new;
4215 if ( $conf->exists('tax-pkg_address') ) {
4216 return $self->locationnum;
4218 elsif ( $conf->exists('tax-ship_address') ) {
4219 return $self->cust_main->ship_locationnum;
4222 return $self->cust_main->bill_locationnum;
4228 Returns the L<FS::cust_location> object for tax_locationnum.
4234 my $conf = FS::Conf->new;
4235 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4236 return FS::cust_location->by_key($self->locationnum);
4238 elsif ( $conf->exists('tax-ship_address') ) {
4239 return $self->cust_main->ship_location;
4242 return $self->cust_main->bill_location;
4246 =item seconds_since TIMESTAMP
4248 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4249 package have been online since TIMESTAMP, according to the session monitor.
4251 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4252 L<Time::Local> and L<Date::Parse> for conversion functions.
4257 my($self, $since) = @_;
4260 foreach my $cust_svc (
4261 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4263 $seconds += $cust_svc->seconds_since($since);
4270 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4272 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4273 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4276 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4277 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4283 sub seconds_since_sqlradacct {
4284 my($self, $start, $end) = @_;
4288 foreach my $cust_svc (
4290 my $part_svc = $_->part_svc;
4291 $part_svc->svcdb eq 'svc_acct'
4292 && scalar($part_svc->part_export_usage);
4295 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4302 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4304 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4305 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4309 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4310 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4315 sub attribute_since_sqlradacct {
4316 my($self, $start, $end, $attrib) = @_;
4320 foreach my $cust_svc (
4322 my $part_svc = $_->part_svc;
4323 scalar($part_svc->part_export_usage);
4326 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4338 my( $self, $value ) = @_;
4339 if ( defined($value) ) {
4340 $self->setfield('quantity', $value);
4342 $self->getfield('quantity') || 1;
4345 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4347 Transfers as many services as possible from this package to another package.
4349 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4350 object. The destination package must already exist.
4352 Services are moved only if the destination allows services with the correct
4353 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4354 this option with caution! No provision is made for export differences
4355 between the old and new service definitions. Probably only should be used
4356 when your exports for all service definitions of a given svcdb are identical.
4357 (attempt a transfer without it first, to move all possible svcpart-matching
4360 Any services that can't be moved remain in the original package.
4362 Returns an error, if there is one; otherwise, returns the number of services
4363 that couldn't be moved.
4368 my ($self, $dest_pkgnum, %opt) = @_;
4374 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4375 $dest = $dest_pkgnum;
4376 $dest_pkgnum = $dest->pkgnum;
4378 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4381 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4383 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4384 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4387 foreach my $cust_svc ($dest->cust_svc) {
4388 $target{$cust_svc->svcpart}--;
4391 my %svcpart2svcparts = ();
4392 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4393 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4394 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4395 next if exists $svcpart2svcparts{$svcpart};
4396 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4397 $svcpart2svcparts{$svcpart} = [
4399 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4401 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4402 'svcpart' => $_ } );
4404 $pkg_svc ? $pkg_svc->primary_svc : '',
4405 $pkg_svc ? $pkg_svc->quantity : 0,
4409 grep { $_ != $svcpart }
4411 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4413 warn "alternates for svcpart $svcpart: ".
4414 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4420 foreach my $cust_svc ($self->cust_svc) {
4421 my $svcnum = $cust_svc->svcnum;
4422 if($target{$cust_svc->svcpart} > 0
4423 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4424 $target{$cust_svc->svcpart}--;
4425 my $new = new FS::cust_svc { $cust_svc->hash };
4426 $new->pkgnum($dest_pkgnum);
4427 $error = $new->replace($cust_svc);
4428 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4430 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4431 warn "alternates to consider: ".
4432 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4434 my @alternate = grep {
4435 warn "considering alternate svcpart $_: ".
4436 "$target{$_} available in new package\n"
4439 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4441 warn "alternate(s) found\n" if $DEBUG;
4442 my $change_svcpart = $alternate[0];
4443 $target{$change_svcpart}--;
4444 my $new = new FS::cust_svc { $cust_svc->hash };
4445 $new->svcpart($change_svcpart);
4446 $new->pkgnum($dest_pkgnum);
4447 $error = $new->replace($cust_svc);
4455 my @label = $cust_svc->label;
4456 return "$label[0] $label[1]: $error";
4462 =item grab_svcnums SVCNUM, SVCNUM ...
4464 Change the pkgnum for the provided services to this packages. If there is an
4465 error, returns the error, otherwise returns false.
4473 my $oldAutoCommit = $FS::UID::AutoCommit;
4474 local $FS::UID::AutoCommit = 0;
4477 foreach my $svcnum (@svcnum) {
4478 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4479 $dbh->rollback if $oldAutoCommit;
4480 return "unknown svcnum $svcnum";
4482 $cust_svc->pkgnum( $self->pkgnum );
4483 my $error = $cust_svc->replace;
4485 $dbh->rollback if $oldAutoCommit;
4490 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4497 This method is deprecated. See the I<depend_jobnum> option to the insert and
4498 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4502 #looks like this is still used by the order_pkg and change_pkg methods in
4503 # ClientAPI/MyAccount, need to look into those before removing
4507 my $oldAutoCommit = $FS::UID::AutoCommit;
4508 local $FS::UID::AutoCommit = 0;
4511 foreach my $cust_svc ( $self->cust_svc ) {
4512 #false laziness w/svc_Common::insert
4513 my $svc_x = $cust_svc->svc_x;
4514 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4515 my $error = $part_export->export_insert($svc_x);
4517 $dbh->rollback if $oldAutoCommit;
4523 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4528 =item export_pkg_change OLD_CUST_PKG
4530 Calls the "pkg_change" export action for all services attached to this package.
4534 sub export_pkg_change {
4535 my( $self, $old ) = ( shift, shift );
4537 my $oldAutoCommit = $FS::UID::AutoCommit;
4538 local $FS::UID::AutoCommit = 0;
4541 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4542 my $error = $svc_x->export('pkg_change', $self, $old);
4544 $dbh->rollback if $oldAutoCommit;
4549 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4556 Associates this package with a (suspension or cancellation) reason (see
4557 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4560 Available options are:
4566 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.
4570 the access_user (see L<FS::access_user>) providing the reason
4578 the action (cancel, susp, adjourn, expire) associated with the reason
4582 If there is an error, returns the error, otherwise returns false.
4587 my ($self, %options) = @_;
4589 my $otaker = $options{reason_otaker} ||
4590 $FS::CurrentUser::CurrentUser->username;
4593 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4597 } elsif ( ref($options{'reason'}) ) {
4599 return 'Enter a new reason (or select an existing one)'
4600 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4602 my $reason = new FS::reason({
4603 'reason_type' => $options{'reason'}->{'typenum'},
4604 'reason' => $options{'reason'}->{'reason'},
4606 my $error = $reason->insert;
4607 return $error if $error;
4609 $reasonnum = $reason->reasonnum;
4612 return "Unparseable reason: ". $options{'reason'};
4615 my $cust_pkg_reason =
4616 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4617 'reasonnum' => $reasonnum,
4618 'otaker' => $otaker,
4619 'action' => substr(uc($options{'action'}),0,1),
4620 'date' => $options{'date'}
4625 $cust_pkg_reason->insert;
4628 =item insert_discount
4630 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4631 inserting a new discount on the fly (see L<FS::discount>).
4633 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4634 and if present, will create a setup discount. If the discountnum is -1,
4635 a new discount definition will be inserted using the value in
4636 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4638 If there is an error, returns the error, otherwise returns false.
4642 sub insert_discount {
4643 #my ($self, %options) = @_;
4646 foreach my $x (qw(setup recur)) {
4647 if ( my $discountnum = $self->get("${x}_discountnum") ) {
4648 my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4649 'pkgnum' => $self->pkgnum,
4650 'discountnum' => $discountnum,
4653 'end_date' => '', #XXX
4654 #for the create a new discount case
4655 'amount' => $self->get("${x}_discountnum_amount"),
4656 'percent' => $self->get("${x}_discountnum_percent"),
4657 'months' => $self->get("${x}_discountnum_months"),
4659 if ( $x eq 'setup' ) {
4660 $cust_pkg_discount->setup('Y');
4661 $cust_pkg_discount->months('');
4663 my $error = $cust_pkg_discount->insert;
4664 return $error if $error;
4671 =item set_usage USAGE_VALUE_HASHREF
4673 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4674 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4675 upbytes, downbytes, and totalbytes are appropriate keys.
4677 All svc_accts which are part of this package have their values reset.
4682 my ($self, $valueref, %opt) = @_;
4684 #only svc_acct can set_usage for now
4685 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4686 my $svc_x = $cust_svc->svc_x;
4687 $svc_x->set_usage($valueref, %opt)
4688 if $svc_x->can("set_usage");
4692 =item recharge USAGE_VALUE_HASHREF
4694 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4695 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4696 upbytes, downbytes, and totalbytes are appropriate keys.
4698 All svc_accts which are part of this package have their values incremented.
4703 my ($self, $valueref) = @_;
4705 #only svc_acct can set_usage for now
4706 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4707 my $svc_x = $cust_svc->svc_x;
4708 $svc_x->recharge($valueref)
4709 if $svc_x->can("recharge");
4713 =item apply_usageprice
4717 sub apply_usageprice {
4720 my $oldAutoCommit = $FS::UID::AutoCommit;
4721 local $FS::UID::AutoCommit = 0;
4726 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4727 $error ||= $cust_pkg_usageprice->apply;
4731 $dbh->rollback if $oldAutoCommit;
4732 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4735 $dbh->commit if $oldAutoCommit;
4741 =item cust_pkg_discount
4743 =item cust_pkg_discount_active
4747 sub cust_pkg_discount_active {
4749 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4752 =item cust_pkg_usage
4754 Returns a list of all voice usage counters attached to this package.
4756 =item apply_usage OPTIONS
4758 Takes the following options:
4759 - cdr: a call detail record (L<FS::cdr>)
4760 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4761 - minutes: the maximum number of minutes to be charged
4763 Finds available usage minutes for a call of this class, and subtracts
4764 up to that many minutes from the usage pool. If the usage pool is empty,
4765 and the C<cdr-minutes_priority> global config option is set, minutes may
4766 be taken from other calls as well. Either way, an allocation record will
4767 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4768 number of minutes of usage applied to the call.
4773 my ($self, %opt) = @_;
4774 my $cdr = $opt{cdr};
4775 my $rate_detail = $opt{rate_detail};
4776 my $minutes = $opt{minutes};
4777 my $classnum = $rate_detail->classnum;
4778 my $pkgnum = $self->pkgnum;
4779 my $custnum = $self->custnum;
4781 my $oldAutoCommit = $FS::UID::AutoCommit;
4782 local $FS::UID::AutoCommit = 0;
4785 my $order = FS::Conf->new->config('cdr-minutes_priority');
4789 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4791 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4793 my @usage_recs = qsearch({
4794 'table' => 'cust_pkg_usage',
4795 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4796 ' JOIN cust_pkg USING (pkgnum)'.
4797 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4798 'select' => 'cust_pkg_usage.*',
4799 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4800 " ( cust_pkg.custnum = $custnum AND ".
4801 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4802 $is_classnum . ' AND '.
4803 " cust_pkg_usage.minutes > 0",
4804 'order_by' => " ORDER BY priority ASC",
4807 my $orig_minutes = $minutes;
4809 while (!$error and $minutes > 0 and @usage_recs) {
4810 my $cust_pkg_usage = shift @usage_recs;
4811 $cust_pkg_usage->select_for_update;
4812 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4813 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4814 acctid => $cdr->acctid,
4815 minutes => min($cust_pkg_usage->minutes, $minutes),
4817 $cust_pkg_usage->set('minutes',
4818 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4820 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4821 $minutes -= $cdr_cust_pkg_usage->minutes;
4823 if ( $order and $minutes > 0 and !$error ) {
4824 # then try to steal minutes from another call
4826 'table' => 'cdr_cust_pkg_usage',
4827 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4828 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4829 ' JOIN cust_pkg USING (pkgnum)'.
4830 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4831 ' JOIN cdr USING (acctid)',
4832 'select' => 'cdr_cust_pkg_usage.*',
4833 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4834 " ( cust_pkg.pkgnum = $pkgnum OR ".
4835 " ( cust_pkg.custnum = $custnum AND ".
4836 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4837 " part_pkg_usage_class.classnum = $classnum",
4838 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4840 if ( $order eq 'time' ) {
4841 # find CDRs that are using minutes, but have a later startdate
4843 my $startdate = $cdr->startdate;
4844 if ($startdate !~ /^\d+$/) {
4845 die "bad cdr startdate '$startdate'";
4847 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4848 # minimize needless reshuffling
4849 $search{'order_by'} .= ', cdr.startdate DESC';
4851 # XXX may not work correctly with rate_time schedules. Could
4852 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4854 $search{'addl_from'} .=
4855 ' JOIN rate_detail'.
4856 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4857 if ( $order eq 'rate_high' ) {
4858 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4859 $rate_detail->min_charge;
4860 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4861 } elsif ( $order eq 'rate_low' ) {
4862 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4863 $rate_detail->min_charge;
4864 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4866 # this should really never happen
4867 die "invalid cdr-minutes_priority value '$order'\n";
4870 my @cdr_usage_recs = qsearch(\%search);
4872 while (!$error and @cdr_usage_recs and $minutes > 0) {
4873 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4874 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4875 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4876 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4877 $cdr_cust_pkg_usage->select_for_update;
4878 $old_cdr->select_for_update;
4879 $cust_pkg_usage->select_for_update;
4880 # in case someone else stole the usage from this CDR
4881 # while waiting for the lock...
4882 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4883 # steal the usage allocation and flag the old CDR for reprocessing
4884 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4885 # if the allocation is more minutes than we need, adjust it...
4886 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4888 $cdr_cust_pkg_usage->set('minutes', $minutes);
4889 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4890 $error = $cust_pkg_usage->replace;
4892 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4893 $error ||= $cdr_cust_pkg_usage->replace;
4894 # deduct the stolen minutes
4895 $minutes -= $cdr_cust_pkg_usage->minutes;
4897 # after all minute-stealing is done, reset the affected CDRs
4898 foreach (values %reproc_cdrs) {
4899 $error ||= $_->set_status('');
4900 # XXX or should we just call $cdr->rate right here?
4901 # it's not like we can create a loop this way, since the min_charge
4902 # or call time has to go monotonically in one direction.
4903 # we COULD get some very deep recursions going, though...
4905 } # if $order and $minutes
4908 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4910 $dbh->commit if $oldAutoCommit;
4911 return $orig_minutes - $minutes;
4915 =item supplemental_pkgs
4917 Returns a list of all packages supplemental to this one.
4921 sub supplemental_pkgs {
4923 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4928 Returns the package that this one is supplemental to, if any.
4934 if ( $self->main_pkgnum ) {
4935 return FS::cust_pkg->by_key($self->main_pkgnum);
4942 =head1 CLASS METHODS
4948 Returns an SQL expression identifying recurring packages.
4952 sub recurring_sql { "
4953 '0' != ( select freq from part_pkg
4954 where cust_pkg.pkgpart = part_pkg.pkgpart )
4959 Returns an SQL expression identifying one-time packages.
4964 '0' = ( select freq from part_pkg
4965 where cust_pkg.pkgpart = part_pkg.pkgpart )
4970 Returns an SQL expression identifying ordered packages (recurring packages not
4976 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4981 Returns an SQL expression identifying active packages.
4986 $_[0]->recurring_sql. "
4987 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4988 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4989 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4992 =item not_yet_billed_sql
4994 Returns an SQL expression identifying packages which have not yet been billed.
4998 sub not_yet_billed_sql { "
4999 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5000 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5001 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5006 Returns an SQL expression identifying inactive packages (one-time packages
5007 that are otherwise unsuspended/uncancelled).
5011 sub inactive_sql { "
5012 ". $_[0]->onetime_sql(). "
5013 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5014 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5015 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5020 Returns an SQL expression identifying on-hold packages.
5025 #$_[0]->recurring_sql(). ' AND '.
5027 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5028 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5029 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5036 Returns an SQL expression identifying suspended packages.
5040 sub suspended_sql { susp_sql(@_); }
5042 #$_[0]->recurring_sql(). ' AND '.
5044 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5045 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5046 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5053 Returns an SQL exprression identifying cancelled packages.
5057 sub cancelled_sql { cancel_sql(@_); }
5059 #$_[0]->recurring_sql(). ' AND '.
5060 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
5065 Returns an SQL expression to give the package status as a string.
5071 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
5072 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
5073 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
5074 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
5075 WHEN ".onetime_sql()." THEN 'one-time charge'
5082 Returns a list of two package counts. The first is a count of packages
5083 based on the supplied criteria and the second is the count of residential
5084 packages with those same criteria. Criteria are specified as in the search
5090 my ($class, $params) = @_;
5092 my $sql_query = $class->search( $params );
5094 my $count_sql = delete($sql_query->{'count_query'});
5095 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5096 or die "couldn't parse count_sql";
5098 my $count_sth = dbh->prepare($count_sql)
5099 or die "Error preparing $count_sql: ". dbh->errstr;
5101 or die "Error executing $count_sql: ". $count_sth->errstr;
5102 my $count_arrayref = $count_sth->fetchrow_arrayref;
5104 return ( @$count_arrayref );
5108 =item tax_locationnum_sql
5110 Returns an SQL expression for the tax location for a package, based
5111 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5115 sub tax_locationnum_sql {
5116 my $conf = FS::Conf->new;
5117 if ( $conf->exists('tax-pkg_address') ) {
5118 'cust_pkg.locationnum';
5120 elsif ( $conf->exists('tax-ship_address') ) {
5121 'cust_main.ship_locationnum';
5124 'cust_main.bill_locationnum';
5130 Returns a list: the first item is an SQL fragment identifying matching
5131 packages/customers via location (taking into account shipping and package
5132 address taxation, if enabled), and subsequent items are the parameters to
5133 substitute for the placeholders in that fragment.
5138 my($class, %opt) = @_;
5139 my $ornull = $opt{'ornull'};
5141 my $conf = new FS::Conf;
5143 # '?' placeholders in _location_sql_where
5144 my $x = $ornull ? 3 : 2;
5155 if ( $conf->exists('tax-ship_address') ) {
5158 ( ( ship_last IS NULL OR ship_last = '' )
5159 AND ". _location_sql_where('cust_main', '', $ornull ). "
5161 OR ( ship_last IS NOT NULL AND ship_last != ''
5162 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5165 # AND payby != 'COMP'
5167 @main_param = ( @bill_param, @bill_param );
5171 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5172 @main_param = @bill_param;
5178 if ( $conf->exists('tax-pkg_address') ) {
5180 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5183 ( cust_pkg.locationnum IS NULL AND $main_where )
5184 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5187 @param = ( @main_param, @bill_param );
5191 $where = $main_where;
5192 @param = @main_param;
5200 #subroutine, helper for location_sql
5201 sub _location_sql_where {
5203 my $prefix = @_ ? shift : '';
5204 my $ornull = @_ ? shift : '';
5206 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5208 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5210 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5211 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5212 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5214 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5216 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5218 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5219 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5220 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5221 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5222 AND $table.${prefix}country = ?
5227 my( $self, $what ) = @_;
5229 my $what_show_zero = $what. '_show_zero';
5230 length($self->$what_show_zero())
5231 ? ($self->$what_show_zero() eq 'Y')
5232 : $self->part_pkg->$what_show_zero();
5239 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5241 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5242 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5244 CUSTNUM is a customer (see L<FS::cust_main>)
5246 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5247 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5250 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5251 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5252 new billing items. An error is returned if this is not possible (see
5253 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5256 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5257 newly-created cust_pkg objects.
5259 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5260 and inserted. Multiple FS::pkg_referral records can be created by
5261 setting I<refnum> to an array reference of refnums or a hash reference with
5262 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5263 record will be created corresponding to cust_main.refnum.
5268 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5270 my $conf = new FS::Conf;
5272 # Transactionize this whole mess
5273 my $oldAutoCommit = $FS::UID::AutoCommit;
5274 local $FS::UID::AutoCommit = 0;
5278 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5279 # return "Customer not found: $custnum" unless $cust_main;
5281 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5284 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5287 my $change = scalar(@old_cust_pkg) != 0;
5290 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5292 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5293 " to pkgpart ". $pkgparts->[0]. "\n"
5296 my $err_or_cust_pkg =
5297 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5298 'refnum' => $refnum,
5301 unless (ref($err_or_cust_pkg)) {
5302 $dbh->rollback if $oldAutoCommit;
5303 return $err_or_cust_pkg;
5306 push @$return_cust_pkg, $err_or_cust_pkg;
5307 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5312 # Create the new packages.
5313 foreach my $pkgpart (@$pkgparts) {
5315 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5317 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5318 pkgpart => $pkgpart,
5322 $error = $cust_pkg->insert( 'change' => $change );
5323 push @$return_cust_pkg, $cust_pkg;
5325 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5326 my $supp_pkg = FS::cust_pkg->new({
5327 custnum => $custnum,
5328 pkgpart => $link->dst_pkgpart,
5330 main_pkgnum => $cust_pkg->pkgnum,
5333 $error ||= $supp_pkg->insert( 'change' => $change );
5334 push @$return_cust_pkg, $supp_pkg;
5338 $dbh->rollback if $oldAutoCommit;
5343 # $return_cust_pkg now contains refs to all of the newly
5346 # Transfer services and cancel old packages.
5347 foreach my $old_pkg (@old_cust_pkg) {
5349 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5352 foreach my $new_pkg (@$return_cust_pkg) {
5353 $error = $old_pkg->transfer($new_pkg);
5354 if ($error and $error == 0) {
5355 # $old_pkg->transfer failed.
5356 $dbh->rollback if $oldAutoCommit;
5361 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5362 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5363 foreach my $new_pkg (@$return_cust_pkg) {
5364 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5365 if ($error and $error == 0) {
5366 # $old_pkg->transfer failed.
5367 $dbh->rollback if $oldAutoCommit;
5374 # Transfers were successful, but we went through all of the
5375 # new packages and still had services left on the old package.
5376 # We can't cancel the package under the circumstances, so abort.
5377 $dbh->rollback if $oldAutoCommit;
5378 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5380 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5386 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5390 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5392 A bulk change method to change packages for multiple customers.
5394 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5395 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5398 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5399 replace. The services (see L<FS::cust_svc>) are moved to the
5400 new billing items. An error is returned if this is not possible (see
5403 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5404 newly-created cust_pkg objects.
5409 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5411 # Transactionize this whole mess
5412 my $oldAutoCommit = $FS::UID::AutoCommit;
5413 local $FS::UID::AutoCommit = 0;
5417 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5420 while(scalar(@old_cust_pkg)) {
5422 my $custnum = $old_cust_pkg[0]->custnum;
5423 my (@remove) = map { $_->pkgnum }
5424 grep { $_->custnum == $custnum } @old_cust_pkg;
5425 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5427 my $error = order $custnum, $pkgparts, \@remove, \@return;
5429 push @errors, $error
5431 push @$return_cust_pkg, @return;
5434 if (scalar(@errors)) {
5435 $dbh->rollback if $oldAutoCommit;
5436 return join(' / ', @errors);
5439 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5443 =item forward_emails
5445 Returns a hash of svcnums and corresponding email addresses
5446 for svc_acct services that can be used as source or dest
5447 for svc_forward services provisioned in this package.
5449 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5450 service; if included, will ensure the current values of the
5451 specified service are included in the list, even if for some
5452 other reason they wouldn't be. If called as a class method
5453 with a specified service, returns only these current values.
5455 Caution: does not actually check if svc_forward services are
5456 available to be provisioned on this package.
5460 sub forward_emails {
5464 #load optional service, thoroughly validated
5465 die "Use svcnum or svc_forward, not both"
5466 if $opt{'svcnum'} && $opt{'svc_forward'};
5467 my $svc_forward = $opt{'svc_forward'};
5468 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5470 die "Specified service is not a forward service"
5471 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5472 die "Specified service not found"
5473 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5477 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5478 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5480 #add current values from specified service, if there was one
5482 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5483 my $svc_acct = $svc_forward->$method();
5484 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5488 if (ref($self) eq 'FS::cust_pkg') {
5490 #and including the rest for this customer
5491 my($u_part_svc,@u_acct_svcparts);
5492 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5493 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5496 my $custnum = $self->getfield('custnum');
5497 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5498 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5499 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5500 foreach my $acct_svcpart (@u_acct_svcparts) {
5501 foreach my $i_cust_svc (
5502 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5503 'svcpart' => $acct_svcpart } )
5505 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5506 $email{$svc_acct->svcnum} = $svc_acct->email;
5515 # Used by FS::Upgrade to migrate to a new database.
5516 sub _upgrade_data { # class method
5517 my ($class, %opts) = @_;
5518 $class->_upgrade_otaker(%opts);
5520 # RT#10139, bug resulting in contract_end being set when it shouldn't
5521 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5522 # RT#10830, bad calculation of prorate date near end of year
5523 # the date range for bill is December 2009, and we move it forward
5524 # one year if it's before the previous bill date (which it should
5526 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5527 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5528 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5529 # RT6628, add order_date to cust_pkg
5530 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5531 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5532 history_action = \'insert\') where order_date is null',
5534 foreach my $sql (@statements) {
5535 my $sth = dbh->prepare($sql);
5536 $sth->execute or die $sth->errstr;
5539 # RT31194: supplemental package links that are deleted don't clean up
5541 my @pkglinknums = qsearch({
5542 'select' => 'DISTINCT cust_pkg.pkglinknum',
5543 'table' => 'cust_pkg',
5544 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5545 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5546 AND part_pkg_link.pkglinknum IS NULL',
5548 foreach (@pkglinknums) {
5549 my $pkglinknum = $_->pkglinknum;
5550 warn "cleaning part_pkg_link #$pkglinknum\n";
5551 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5552 my $error = $part_pkg_link->remove_linked;
5553 die $error if $error;
5561 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5563 In sub order, the @pkgparts array (passed by reference) is clobbered.
5565 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5566 method to pass dates to the recur_prog expression, it should do so.
5568 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5569 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5570 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5571 configuration values. Probably need a subroutine which decides what to do
5572 based on whether or not we've fetched the user yet, rather than a hash. See
5573 FS::UID and the TODO.
5575 Now that things are transactional should the check in the insert method be
5580 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5581 L<FS::pkg_svc>, schema.html from the base documentation