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,
1868 =item unsuspend [ OPTION => VALUE ... ]
1870 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1871 package, then unsuspends the package itself (clears the susp field and the
1872 adjourn field if it is in the past). If the suspend reason includes an
1873 unsuspension package, that package will be ordered.
1875 Available options are:
1881 Can be set to a date to unsuspend the package in the future (the 'resume'
1884 =item adjust_next_bill
1886 Can be set true to adjust the next bill date forward by
1887 the amount of time the account was inactive. This was set true by default
1888 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1889 explicitly requested with this option or in the price plan.
1893 If there is an error, returns the error, otherwise returns false.
1898 my( $self, %opt ) = @_;
1901 # pass all suspend/cancel actions to the main package
1902 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1903 return $self->main_pkg->unsuspend(%opt);
1906 my $oldAutoCommit = $FS::UID::AutoCommit;
1907 local $FS::UID::AutoCommit = 0;
1910 my $old = $self->select_for_update;
1912 my $pkgnum = $old->pkgnum;
1913 if ( $old->get('cancel') || $self->get('cancel') ) {
1914 $dbh->rollback if $oldAutoCommit;
1915 return "Can't unsuspend cancelled package $pkgnum";
1918 unless ( $old->get('susp') && $self->get('susp') ) {
1919 $dbh->rollback if $oldAutoCommit;
1920 return ""; # no error # complain instead?
1923 # handle the case of setting a future unsuspend (resume) date
1924 # and do not continue to actually unsuspend the package
1925 my $date = $opt{'date'};
1926 if ( $date and $date > time ) { # return an error if $date <= time?
1928 if ( $old->get('expire') && $old->get('expire') < $date ) {
1929 $dbh->rollback if $oldAutoCommit;
1930 return "Package $pkgnum expires before it would be unsuspended.";
1933 my $new = new FS::cust_pkg { $self->hash };
1934 $new->set('resume', $date);
1935 $error = $new->replace($self, options => $self->options);
1938 $dbh->rollback if $oldAutoCommit;
1942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1948 if (!$self->setup) {
1949 # then this package is being released from on-hold status
1950 $error = $self->set_initial_timers;
1952 $dbh->rollback if $oldAutoCommit;
1959 foreach my $cust_svc (
1960 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1962 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1964 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1965 $dbh->rollback if $oldAutoCommit;
1966 return "Illegal svcdb value in part_svc!";
1969 require "FS/$svcdb.pm";
1971 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1973 $error = $svc->unsuspend;
1975 $dbh->rollback if $oldAutoCommit;
1978 my( $label, $value ) = $cust_svc->label;
1979 push @labels, "$label: $value";
1984 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1985 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1987 my %hash = $self->hash;
1988 my $inactive = time - $hash{'susp'};
1990 my $conf = new FS::Conf;
1992 #adjust the next bill date forward
1993 # increment next bill date if certain conditions are met:
1994 # - it was due to be billed at some point
1995 # - either the global or local config says to do this
1996 my $adjust_bill = 0;
1999 && ( $hash{'bill'} || $hash{'setup'} )
2000 && ( $opt{'adjust_next_bill'}
2001 || $conf->exists('unsuspend-always_adjust_next_bill_date')
2002 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
2009 # - the package billed during suspension
2010 # - or it was ordered on hold
2011 # - or the customer was credited for the unused time
2013 if ( $self->option('suspend_bill',1)
2014 or ( $self->part_pkg->option('suspend_bill',1)
2015 and ! $self->option('no_suspend_bill',1)
2017 or $hash{'order_date'} == $hash{'susp'}
2022 if ( $adjust_bill ) {
2023 if ( $self->part_pkg->option('unused_credit_suspend')
2024 or ( ref($reason) and $reason->unused_credit ) ) {
2025 # then the customer was credited for the unused time before suspending,
2026 # so their next bill should be immediate
2027 $hash{'bill'} = time;
2029 # add the length of time suspended to the bill date
2030 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
2035 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
2036 $hash{'resume'} = '' if !$hash{'adjourn'};
2037 my $new = new FS::cust_pkg ( \%hash );
2038 $error = $new->replace( $self, options => { $self->options } );
2040 $dbh->rollback if $oldAutoCommit;
2047 if ( $reason->unsuspend_pkgpart ) {
2048 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
2049 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
2050 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
2052 my $start_date = $self->cust_main->next_bill_date
2053 if $reason->unsuspend_hold;
2056 $unsusp_pkg = FS::cust_pkg->new({
2057 'custnum' => $self->custnum,
2058 'pkgpart' => $reason->unsuspend_pkgpart,
2059 'start_date' => $start_date,
2060 'locationnum' => $self->locationnum,
2061 # discount? probably not...
2064 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
2067 # new way, using fees
2068 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
2069 # register the need to charge a fee, cust_main->bill will do the rest
2070 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
2072 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
2073 'pkgreasonnum' => $cust_pkg_reason->num,
2074 'pkgnum' => $self->pkgnum,
2075 'feepart' => $reason->feepart,
2076 'nextbill' => $reason->fee_hold,
2078 $error ||= $cust_pkg_reason_fee->insert;
2082 $dbh->rollback if $oldAutoCommit;
2087 if ( $conf->config('unsuspend_email_admin') ) {
2089 my $error = send_email(
2090 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2091 #invoice_from ??? well as good as any
2092 'to' => $conf->config('unsuspend_email_admin'),
2093 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2094 "This is an automatic message from your Freeside installation\n",
2095 "informing you that the following customer package has been unsuspended:\n",
2097 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2098 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2099 ( map { "Service : $_\n" } @labels ),
2101 "An unsuspension fee was charged: ".
2102 $unsusp_pkg->part_pkg->pkg_comment."\n"
2106 'custnum' => $self->custnum,
2107 'msgtype' => 'admin',
2111 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2117 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2118 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2120 $dbh->rollback if $oldAutoCommit;
2121 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2125 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2132 Cancels any pending suspension (sets the adjourn field to null)
2133 for this package and any supplemental packages.
2135 If there is an error, returns the error, otherwise returns false.
2143 my $oldAutoCommit = $FS::UID::AutoCommit;
2144 local $FS::UID::AutoCommit = 0;
2147 my $old = $self->select_for_update;
2149 my $pkgnum = $old->pkgnum;
2150 if ( $old->get('cancel') || $self->get('cancel') ) {
2151 dbh->rollback if $oldAutoCommit;
2152 return "Can't unadjourn cancelled package $pkgnum";
2153 # or at least it's pointless
2156 if ( $old->get('susp') || $self->get('susp') ) {
2157 dbh->rollback if $oldAutoCommit;
2158 return "Can't unadjourn suspended package $pkgnum";
2159 # perhaps this is arbitrary
2162 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2163 dbh->rollback if $oldAutoCommit;
2164 return ""; # no error
2167 my %hash = $self->hash;
2168 $hash{'adjourn'} = '';
2169 $hash{'resume'} = '';
2170 my $new = new FS::cust_pkg ( \%hash );
2171 $error = $new->replace( $self, options => { $self->options } );
2173 $dbh->rollback if $oldAutoCommit;
2177 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2178 $error = $supp_pkg->unadjourn;
2180 $dbh->rollback if $oldAutoCommit;
2181 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2185 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2192 =item change HASHREF | OPTION => VALUE ...
2194 Changes this package: cancels it and creates a new one, with a different
2195 pkgpart or locationnum or both. All services are transferred to the new
2196 package (no change will be made if this is not possible).
2198 Options may be passed as a list of key/value pairs or as a hash reference.
2205 New locationnum, to change the location for this package.
2209 New FS::cust_location object, to create a new location and assign it
2214 New FS::cust_main object, to create a new customer and assign the new package
2219 New pkgpart (see L<FS::part_pkg>).
2223 New refnum (see L<FS::part_referral>).
2227 New quantity; if unspecified, the new package will have the same quantity
2232 "New" (existing) FS::cust_pkg object. The package's services and other
2233 attributes will be transferred to this package.
2237 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2238 susp, adjourn, cancel, expire, and contract_end) to the new package.
2240 =item unprotect_svcs
2242 Normally, change() will rollback and return an error if some services
2243 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2244 If unprotect_svcs is true, this method will transfer as many services as
2245 it can and then unconditionally cancel the old package.
2249 If specified, sets this value for the contract_end date on the new package
2250 (without regard for keep_dates or the usual date-preservation behavior.)
2251 Will throw an error if defined but false; the UI doesn't allow editing
2252 this unless it already exists, making removal impossible to undo.
2256 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2257 cust_pkg must be specified (otherwise, what's the point?)
2259 Returns either the new FS::cust_pkg object or a scalar error.
2263 my $err_or_new_cust_pkg = $old_cust_pkg->change
2267 #used by change and change_later
2268 #didn't put with documented check methods because it depends on change-specific opts
2269 #and it also possibly edits the value of opts
2273 if ( defined($opt->{'contract_end'}) ) {
2274 my $current_contract_end = $self->get('contract_end');
2275 unless ($opt->{'contract_end'}) {
2276 if ($current_contract_end) {
2277 return "Cannot remove contract end date when changing packages";
2279 #shouldn't even pass this option if there's not a current value
2280 #but can be handled gracefully if the option is empty
2281 warn "Contract end date passed unexpectedly";
2282 delete $opt->{'contract_end'};
2286 unless ($current_contract_end) {
2287 #option shouldn't be passed, throw error if it's non-empty
2288 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2294 #some false laziness w/order
2297 my $opt = ref($_[0]) ? shift : { @_ };
2299 my $conf = new FS::Conf;
2301 # handle contract_end on cust_pkg same as passed option
2302 if ( $opt->{'cust_pkg'} ) {
2303 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2304 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2307 # check contract_end, prevent adding/removing
2308 my $error = $self->_check_change($opt);
2309 return $error if $error;
2311 # Transactionize this whole mess
2312 my $oldAutoCommit = $FS::UID::AutoCommit;
2313 local $FS::UID::AutoCommit = 0;
2316 if ( $opt->{'cust_location'} ) {
2317 $error = $opt->{'cust_location'}->find_or_insert;
2319 $dbh->rollback if $oldAutoCommit;
2320 return "creating location record: $error";
2322 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2325 # figure out if we're changing pkgpart
2326 if ( $opt->{'cust_pkg'} ) {
2327 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2330 # whether to override pkgpart checking on the new package
2331 my $same_pkgpart = 1;
2332 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2336 # Before going any further here: if the package is still in the pre-setup
2337 # state, it's safe to modify it in place. No need to charge/credit for
2338 # partial period, transfer usage pools, copy invoice details, or change any
2339 # dates. We DO need to "transfer" services (from the package to itself) to
2340 # check their validity on the new pkgpart.
2341 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2342 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2343 if ( length($opt->{$_}) ) {
2344 $self->set($_, $opt->{$_});
2347 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2349 if ( !$same_pkgpart ) {
2350 $error ||= $self->set_initial_timers;
2352 # but if contract_end was explicitly specified, that overrides all else
2353 $self->set('contract_end', $opt->{'contract_end'})
2354 if $opt->{'contract_end'};
2356 $error ||= $self->replace;
2358 $dbh->rollback if $oldAutoCommit;
2359 return "modifying package: $error";
2362 # check/convert services (only on pkgpart change, to avoid surprises
2363 # when editing locations)
2364 # (maybe do this if changing quantity?)
2365 if ( !$same_pkgpart ) {
2367 $error = $self->transfer($self);
2369 if ( $error and $error == 0 ) {
2370 $error = "transferring $error";
2371 } elsif ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2372 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2373 $error = $self->transfer($self, 'change_svcpart'=>1 );
2374 if ($error and $error == 0) {
2375 $error = "converting $error";
2380 $error = "unable to transfer all services";
2384 $dbh->rollback if $oldAutoCommit;
2388 } # done transferring services
2390 $dbh->commit if $oldAutoCommit;
2399 $hash{'setup'} = $time if $self->get('setup');
2401 $hash{'change_date'} = $time;
2402 $hash{"change_$_"} = $self->$_()
2403 foreach qw( pkgnum pkgpart locationnum );
2405 my $unused_credit = 0;
2406 my $keep_dates = $opt->{'keep_dates'};
2408 # Special case. If the pkgpart is changing, and the customer is going to be
2409 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2410 # and DO pass the flag to cancel() to credit the customer. If the old
2411 # package had a setup date, set the new package's setup to the package
2412 # change date so that it has the same status as before.
2413 if ( $opt->{'pkgpart'}
2414 and $opt->{'pkgpart'} != $self->pkgpart
2415 and $self->part_pkg->option('unused_credit_change', 1) ) {
2418 $hash{'last_bill'} = '';
2422 if ( $keep_dates ) {
2423 foreach my $date ( qw(setup bill last_bill) ) {
2424 $hash{$date} = $self->getfield($date);
2427 # always keep the following dates
2428 foreach my $date (qw(order_date susp adjourn cancel expire resume
2429 start_date contract_end)) {
2430 $hash{$date} = $self->getfield($date);
2432 # but if contract_end was explicitly specified, that overrides all else
2433 $hash{'contract_end'} = $opt->{'contract_end'}
2434 if $opt->{'contract_end'};
2436 # allow $opt->{'locationnum'} = '' to specifically set it to null
2437 # (i.e. customer default location)
2438 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2440 # usually this doesn't matter. the two cases where it does are:
2441 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2443 # 2. (more importantly) changing a package before it's billed
2444 $hash{'waive_setup'} = $self->waive_setup;
2446 # if this package is scheduled for a future package change, preserve that
2447 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2449 my $custnum = $self->custnum;
2450 if ( $opt->{cust_main} ) {
2451 my $cust_main = $opt->{cust_main};
2452 unless ( $cust_main->custnum ) {
2453 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2455 $dbh->rollback if $oldAutoCommit;
2456 return "inserting customer record: $error";
2459 $custnum = $cust_main->custnum;
2462 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2465 if ( $opt->{'cust_pkg'} ) {
2466 # The target package already exists; update it to show that it was
2467 # changed from this package.
2468 $cust_pkg = $opt->{'cust_pkg'};
2470 # follow all the above rules for date changes, etc.
2471 foreach (keys %hash) {
2472 $cust_pkg->set($_, $hash{$_});
2474 # except those that implement the future package change behavior
2475 foreach (qw(change_to_pkgnum start_date expire)) {
2476 $cust_pkg->set($_, '');
2479 $error = $cust_pkg->replace;
2482 # Create the new package.
2483 $cust_pkg = new FS::cust_pkg {
2484 custnum => $custnum,
2485 locationnum => $opt->{'locationnum'},
2486 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2487 qw( pkgpart quantity refnum salesnum )
2491 $error = $cust_pkg->insert( 'change' => 1,
2492 'allow_pkgpart' => $same_pkgpart );
2495 $dbh->rollback if $oldAutoCommit;
2496 return "inserting new package: $error";
2499 # Transfer services and cancel old package.
2500 # Enforce service limits only if this is a pkgpart change.
2501 local $FS::cust_svc::ignore_quantity;
2502 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2503 $error = $self->transfer($cust_pkg);
2504 if ($error and $error == 0) {
2505 # $old_pkg->transfer failed.
2506 $dbh->rollback if $oldAutoCommit;
2507 return "transferring $error";
2510 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2511 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2512 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2513 if ($error and $error == 0) {
2514 # $old_pkg->transfer failed.
2515 $dbh->rollback if $oldAutoCommit;
2516 return "converting $error";
2520 # We set unprotect_svcs when executing a "future package change". It's
2521 # not a user-interactive operation, so returning an error means the
2522 # package change will just fail. Rather than have that happen, we'll
2523 # let leftover services be deleted.
2524 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2525 # Transfers were successful, but we still had services left on the old
2526 # package. We can't change the package under this circumstances, so abort.
2527 $dbh->rollback if $oldAutoCommit;
2528 return "unable to transfer all services";
2531 #reset usage if changing pkgpart
2532 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2533 if ($self->pkgpart != $cust_pkg->pkgpart) {
2534 my $part_pkg = $cust_pkg->part_pkg;
2535 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2539 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2542 $dbh->rollback if $oldAutoCommit;
2543 return "setting usage values: $error";
2546 # if NOT changing pkgpart, transfer any usage pools over
2547 foreach my $usage ($self->cust_pkg_usage) {
2548 $usage->set('pkgnum', $cust_pkg->pkgnum);
2549 $error = $usage->replace;
2551 $dbh->rollback if $oldAutoCommit;
2552 return "transferring usage pools: $error";
2557 # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2558 if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2559 my @old_cust_pkg_usageprice;
2560 if ($opt->{'cust_pkg_usageprice'}) {
2561 @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2563 @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2565 foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2566 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2567 'pkgnum' => $cust_pkg->pkgnum,
2568 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2569 'quantity' => $old_cust_pkg_usageprice->quantity,
2571 $error = $new_cust_pkg_usageprice->insert;
2573 $dbh->rollback if $oldAutoCommit;
2574 return "Error transferring usage pricing add-on: $error";
2579 # transfer discounts, if we're not changing pkgpart
2580 if ( $same_pkgpart ) {
2581 foreach my $old_discount ($self->cust_pkg_discount_active) {
2582 # don't remove the old discount, we may still need to bill that package.
2583 my $new_discount = new FS::cust_pkg_discount {
2584 'pkgnum' => $cust_pkg->pkgnum,
2585 'discountnum' => $old_discount->discountnum,
2586 'months_used' => $old_discount->months_used,
2588 $error = $new_discount->insert;
2590 $dbh->rollback if $oldAutoCommit;
2591 return "transferring discounts: $error";
2596 # transfer (copy) invoice details
2597 foreach my $detail ($self->cust_pkg_detail) {
2598 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2599 $new_detail->set('pkgdetailnum', '');
2600 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2601 $error = $new_detail->insert;
2603 $dbh->rollback if $oldAutoCommit;
2604 return "transferring package notes: $error";
2608 # transfer scheduled expire/adjourn reasons
2609 foreach my $action ('expire', 'adjourn') {
2610 if ( $cust_pkg->get($action) ) {
2611 my $reason = $self->last_cust_pkg_reason($action);
2613 $reason->set('pkgnum', $cust_pkg->pkgnum);
2614 $error = $reason->replace;
2616 $dbh->rollback if $oldAutoCommit;
2617 return "transferring $action reason: $error";
2625 if ( !$opt->{'cust_pkg'} ) {
2626 # Order any supplemental packages.
2627 my $part_pkg = $cust_pkg->part_pkg;
2628 my @old_supp_pkgs = $self->supplemental_pkgs;
2629 foreach my $link ($part_pkg->supp_part_pkg_link) {
2631 foreach (@old_supp_pkgs) {
2632 if ($_->pkgpart == $link->dst_pkgpart) {
2634 $_->pkgpart(0); # so that it can't match more than once
2638 # false laziness with FS::cust_main::Packages::order_pkg
2639 my $new = FS::cust_pkg->new({
2640 pkgpart => $link->dst_pkgpart,
2641 pkglinknum => $link->pkglinknum,
2642 custnum => $custnum,
2643 main_pkgnum => $cust_pkg->pkgnum,
2644 locationnum => $cust_pkg->locationnum,
2645 start_date => $cust_pkg->start_date,
2646 order_date => $cust_pkg->order_date,
2647 expire => $cust_pkg->expire,
2648 adjourn => $cust_pkg->adjourn,
2649 contract_end => $cust_pkg->contract_end,
2650 refnum => $cust_pkg->refnum,
2651 discountnum => $cust_pkg->discountnum,
2652 waive_setup => $cust_pkg->waive_setup,
2654 if ( $old and $opt->{'keep_dates'} ) {
2655 foreach (qw(setup bill last_bill)) {
2656 $new->set($_, $old->get($_));
2659 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2662 $error ||= $old->transfer($new);
2664 if ( $error and $error > 0 ) {
2665 # no reason why this should ever fail, but still...
2666 $error = "Unable to transfer all services from supplemental package ".
2670 $dbh->rollback if $oldAutoCommit;
2673 push @new_supp_pkgs, $new;
2675 } # if !$opt->{'cust_pkg'}
2676 # because if there is one, then supplemental packages would already
2677 # have been created for it.
2679 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2681 #Don't allow billing the package (preceding period packages and/or
2682 #outstanding usage) if we are keeping dates (i.e. location changing),
2683 #because the new package will be billed for the same date range.
2684 #Supplemental packages are also canceled here.
2686 # during scheduled changes, avoid canceling the package we just
2688 $self->set('change_to_pkgnum' => '');
2690 $error = $self->cancel(
2692 unused_credit => $unused_credit,
2693 nobill => $keep_dates,
2694 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2695 no_delay_cancel => 1,
2698 $dbh->rollback if $oldAutoCommit;
2699 return "canceling old package: $error";
2702 # transfer rt_field_charge, if we're not changing pkgpart
2703 # after billing of old package, before billing of new package
2704 if ( $same_pkgpart ) {
2705 foreach my $rt_field_charge ($self->rt_field_charge) {
2706 $rt_field_charge->set('pkgnum', $cust_pkg->pkgnum);
2707 $error = $rt_field_charge->replace;
2709 $dbh->rollback if $oldAutoCommit;
2710 return "transferring rt_field_charge: $error";
2715 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2717 my $error = $cust_pkg->cust_main->bill(
2718 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2721 $dbh->rollback if $oldAutoCommit;
2722 return "billing new package: $error";
2726 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2732 =item change_later OPTION => VALUE...
2734 Schedule a package change for a later date. This actually orders the new
2735 package immediately, but sets its start date for a future date, and sets
2736 the current package to expire on the same date.
2738 If the package is already scheduled for a change, this can be called with
2739 'start_date' to change the scheduled date, or with pkgpart and/or
2740 locationnum to modify the package change. To cancel the scheduled change
2741 entirely, see C<abort_change>.
2749 The date for the package change. Required, and must be in the future.
2759 The pkgpart, locationnum, quantity and optional contract_end of the new
2760 package, with the same meaning as in C<change>.
2768 my $opt = ref($_[0]) ? shift : { @_ };
2770 # check contract_end, prevent adding/removing
2771 my $error = $self->_check_change($opt);
2772 return $error if $error;
2774 my $oldAutoCommit = $FS::UID::AutoCommit;
2775 local $FS::UID::AutoCommit = 0;
2778 my $cust_main = $self->cust_main;
2780 my $date = delete $opt->{'start_date'} or return 'start_date required';
2782 if ( $date <= time ) {
2783 $dbh->rollback if $oldAutoCommit;
2784 return "start_date $date is in the past";
2787 # If the user entered a new location, set it up now.
2788 if ( $opt->{'cust_location'} ) {
2789 $error = $opt->{'cust_location'}->find_or_insert;
2791 $dbh->rollback if $oldAutoCommit;
2792 return "creating location record: $error";
2794 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2797 if ( $self->change_to_pkgnum ) {
2798 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2799 my $new_pkgpart = $opt->{'pkgpart'}
2800 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2801 my $new_locationnum = $opt->{'locationnum'}
2802 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2803 my $new_quantity = $opt->{'quantity'}
2804 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2805 my $new_contract_end = $opt->{'contract_end'}
2806 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2807 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2808 # it hasn't been billed yet, so in principle we could just edit
2809 # it in place (w/o a package change), but that's bad form.
2810 # So change the package according to the new options...
2811 my $err_or_pkg = $change_to->change(%$opt);
2812 if ( ref $err_or_pkg ) {
2813 # Then set that package up for a future start.
2814 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2815 $self->set('expire', $date); # in case it's different
2816 $err_or_pkg->set('start_date', $date);
2817 $err_or_pkg->set('change_date', '');
2818 $err_or_pkg->set('change_pkgnum', '');
2820 $error = $self->replace ||
2821 $err_or_pkg->replace ||
2822 #because change() might've edited existing scheduled change in place
2823 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2824 $change_to->cancel('no_delay_cancel' => 1) ||
2825 $change_to->delete);
2827 $error = $err_or_pkg;
2829 } else { # change the start date only.
2830 $self->set('expire', $date);
2831 $change_to->set('start_date', $date);
2832 $error = $self->replace || $change_to->replace;
2835 $dbh->rollback if $oldAutoCommit;
2838 $dbh->commit if $oldAutoCommit;
2841 } # if $self->change_to_pkgnum
2843 my $new_pkgpart = $opt->{'pkgpart'}
2844 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2845 my $new_locationnum = $opt->{'locationnum'}
2846 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2847 my $new_quantity = $opt->{'quantity'}
2848 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2849 my $new_contract_end = $opt->{'contract_end'}
2850 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2852 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2854 # allow $opt->{'locationnum'} = '' to specifically set it to null
2855 # (i.e. customer default location)
2856 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2858 my $new = FS::cust_pkg->new( {
2859 custnum => $self->custnum,
2860 locationnum => $opt->{'locationnum'},
2861 start_date => $date,
2862 map { $_ => ( $opt->{$_} || $self->$_() ) }
2863 qw( pkgpart quantity refnum salesnum contract_end )
2865 $error = $new->insert('change' => 1,
2866 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2868 $self->set('change_to_pkgnum', $new->pkgnum);
2869 $self->set('expire', $date);
2870 $error = $self->replace;
2873 $dbh->rollback if $oldAutoCommit;
2875 $dbh->commit if $oldAutoCommit;
2883 Cancels a future package change scheduled by C<change_later>.
2889 my $oldAutoCommit = $FS::UID::AutoCommit;
2890 local $FS::UID::AutoCommit = 0;
2892 my $pkgnum = $self->change_to_pkgnum;
2893 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2895 $self->set('change_to_pkgnum', '');
2896 $self->set('expire', '');
2897 $error = $self->replace;
2899 $error ||= $change_to->cancel || $change_to->delete;
2902 if ( $oldAutoCommit ) {
2913 =item set_quantity QUANTITY
2915 Change the package's quantity field. This is one of the few package properties
2916 that can safely be changed without canceling and reordering the package
2917 (because it doesn't affect tax eligibility). Returns an error or an
2924 $self = $self->replace_old; # just to make sure
2925 $self->quantity(shift);
2929 =item set_salesnum SALESNUM
2931 Change the package's salesnum (sales person) field. This is one of the few
2932 package properties that can safely be changed without canceling and reordering
2933 the package (because it doesn't affect tax eligibility). Returns an error or
2940 $self = $self->replace_old; # just to make sure
2941 $self->salesnum(shift);
2943 # XXX this should probably reassign any credit that's already been given
2946 =item modify_charge OPTIONS
2948 Change the properties of a one-time charge. The following properties can
2949 be changed this way:
2950 - pkg: the package description
2951 - classnum: the package class
2952 - additional: arrayref of additional invoice details to add to this package
2954 and, I<if the charge has not yet been billed>:
2955 - start_date: the date when it will be billed
2956 - amount: the setup fee to be charged
2957 - quantity: the multiplier for the setup fee
2958 - separate_bill: whether to put the charge on a separate invoice
2960 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2961 commission credits linked to this charge, they will be recalculated.
2968 my $part_pkg = $self->part_pkg;
2969 my $pkgnum = $self->pkgnum;
2972 my $oldAutoCommit = $FS::UID::AutoCommit;
2973 local $FS::UID::AutoCommit = 0;
2975 return "Can't use modify_charge except on one-time charges"
2976 unless $part_pkg->freq eq '0';
2978 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2979 $part_pkg->set('pkg', $opt{'pkg'});
2982 my %pkg_opt = $part_pkg->options;
2983 my $pkg_opt_modified = 0;
2985 $opt{'additional'} ||= [];
2988 foreach (grep /^additional/, keys %pkg_opt) {
2989 ($i) = ($_ =~ /^additional_info(\d+)$/);
2990 $old_additional[$i] = $pkg_opt{$_} if $i;
2991 delete $pkg_opt{$_};
2994 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2995 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2996 if (!exists($old_additional[$i])
2997 or $old_additional[$i] ne $opt{'additional'}->[$i])
2999 $pkg_opt_modified = 1;
3002 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
3003 $pkg_opt{'additional_count'} = $i if $i > 0;
3006 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
3009 $old_classnum = $part_pkg->classnum;
3010 $part_pkg->set('classnum', $opt{'classnum'});
3013 if ( !$self->get('setup') ) {
3014 # not yet billed, so allow amount, setup_cost, quantity, start_date,
3017 if ( exists($opt{'amount'})
3018 and $part_pkg->option('setup_fee') != $opt{'amount'}
3019 and $opt{'amount'} > 0 ) {
3021 $pkg_opt{'setup_fee'} = $opt{'amount'};
3022 $pkg_opt_modified = 1;
3025 if ( exists($opt{'setup_cost'})
3026 and $part_pkg->setup_cost != $opt{'setup_cost'}
3027 and $opt{'setup_cost'} > 0 ) {
3029 $part_pkg->set('setup_cost', $opt{'setup_cost'});
3032 if ( exists($opt{'quantity'})
3033 and $opt{'quantity'} != $self->quantity
3034 and $opt{'quantity'} > 0 ) {
3036 $self->set('quantity', $opt{'quantity'});
3039 if ( exists($opt{'start_date'})
3040 and $opt{'start_date'} != $self->start_date ) {
3042 $self->set('start_date', $opt{'start_date'});
3045 if ( exists($opt{'separate_bill'})
3046 and $opt{'separate_bill'} ne $self->separate_bill ) {
3048 $self->set('separate_bill', $opt{'separate_bill'});
3052 } # else simply ignore them; the UI shouldn't allow editing the fields
3055 if ( exists($opt{'taxclass'})
3056 and $part_pkg->taxclass ne $opt{'taxclass'}) {
3058 $part_pkg->set('taxclass', $opt{'taxclass'});
3062 if ( $part_pkg->modified or $pkg_opt_modified ) {
3063 # can we safely modify the package def?
3064 # Yes, if it's not available for purchase, and this is the only instance
3066 if ( $part_pkg->disabled
3067 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
3068 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
3070 $error = $part_pkg->replace( options => \%pkg_opt );
3073 $part_pkg = $part_pkg->clone;
3074 $part_pkg->set('disabled' => 'Y');
3075 $error = $part_pkg->insert( options => \%pkg_opt );
3076 # and associate this as yet-unbilled package to the new package def
3077 $self->set('pkgpart' => $part_pkg->pkgpart);
3080 $dbh->rollback if $oldAutoCommit;
3085 if ($self->modified) { # for quantity or start_date change, or if we had
3086 # to clone the existing package def
3087 my $error = $self->replace;
3088 return $error if $error;
3090 if (defined $old_classnum) {
3091 # fix invoice grouping records
3092 my $old_catname = $old_classnum
3093 ? FS::pkg_class->by_key($old_classnum)->categoryname
3095 my $new_catname = $opt{'classnum'}
3096 ? $part_pkg->pkg_class->categoryname
3098 if ( $old_catname ne $new_catname ) {
3099 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
3100 # (there should only be one...)
3101 my @display = qsearch( 'cust_bill_pkg_display', {
3102 'billpkgnum' => $cust_bill_pkg->billpkgnum,
3103 'section' => $old_catname,
3105 foreach (@display) {
3106 $_->set('section', $new_catname);
3107 $error = $_->replace;
3109 $dbh->rollback if $oldAutoCommit;
3113 } # foreach $cust_bill_pkg
3116 if ( $opt{'adjust_commission'} ) {
3117 # fix commission credits...tricky.
3118 foreach my $cust_event ($self->cust_event) {
3119 my $part_event = $cust_event->part_event;
3120 foreach my $table (qw(sales agent)) {
3122 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3123 my $credit = qsearchs('cust_credit', {
3124 'eventnum' => $cust_event->eventnum,
3126 if ( $part_event->isa($class) ) {
3127 # Yes, this results in current commission rates being applied
3128 # retroactively to a one-time charge. For accounting purposes
3129 # there ought to be some kind of time limit on doing this.
3130 my $amount = $part_event->_calc_credit($self);
3131 if ( $credit and $credit->amount ne $amount ) {
3132 # Void the old credit.
3133 $error = $credit->void('Package class changed');
3135 $dbh->rollback if $oldAutoCommit;
3136 return "$error (adjusting commission credit)";
3139 # redo the event action to recreate the credit.
3141 eval { $part_event->do_action( $self, $cust_event ) };
3143 $dbh->rollback if $oldAutoCommit;
3146 } # if $part_event->isa($class)
3148 } # foreach $cust_event
3149 } # if $opt{'adjust_commission'}
3150 } # if defined $old_classnum
3152 $dbh->commit if $oldAutoCommit;
3159 sub process_bulk_cust_pkg {
3162 warn Dumper($param) if $DEBUG;
3164 my $old_part_pkg = qsearchs('part_pkg',
3165 { pkgpart => $param->{'old_pkgpart'} });
3166 my $new_part_pkg = qsearchs('part_pkg',
3167 { pkgpart => $param->{'new_pkgpart'} });
3168 die "Must select a new package type\n" unless $new_part_pkg;
3169 #my $keep_dates = $param->{'keep_dates'} || 0;
3170 my $keep_dates = 1; # there is no good reason to turn this off
3172 my $oldAutoCommit = $FS::UID::AutoCommit;
3173 local $FS::UID::AutoCommit = 0;
3176 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3179 foreach my $old_cust_pkg ( @cust_pkgs ) {
3181 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3182 if ( $old_cust_pkg->getfield('cancel') ) {
3183 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3184 $old_cust_pkg->pkgnum."\n"
3188 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3190 my $error = $old_cust_pkg->change(
3191 'pkgpart' => $param->{'new_pkgpart'},
3192 'keep_dates' => $keep_dates
3194 if ( !ref($error) ) { # change returns the cust_pkg on success
3196 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3199 $dbh->commit if $oldAutoCommit;
3205 Returns the last bill date, or if there is no last bill date, the setup date.
3206 Useful for billing metered services.
3212 return $self->setfield('last_bill', $_[0]) if @_;
3213 return $self->getfield('last_bill') if $self->getfield('last_bill');
3214 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3215 'edate' => $self->bill, } );
3216 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3219 =item last_cust_pkg_reason ACTION
3221 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3222 Returns false if there is no reason or the package is not currenly ACTION'd
3223 ACTION is one of adjourn, susp, cancel, or expire.
3227 sub last_cust_pkg_reason {
3228 my ( $self, $action ) = ( shift, shift );
3229 my $date = $self->get($action);
3231 'table' => 'cust_pkg_reason',
3232 'hashref' => { 'pkgnum' => $self->pkgnum,
3233 'action' => substr(uc($action), 0, 1),
3236 'order_by' => 'ORDER BY num DESC LIMIT 1',
3240 =item last_reason ACTION
3242 Returns the most recent ACTION FS::reason associated with the package.
3243 Returns false if there is no reason or the package is not currenly ACTION'd
3244 ACTION is one of adjourn, susp, cancel, or expire.
3249 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3250 $cust_pkg_reason->reason
3251 if $cust_pkg_reason;
3256 Returns the definition for this billing item, as an FS::part_pkg object (see
3263 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3264 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3265 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3270 Returns the cancelled package this package was changed from, if any.
3276 return '' unless $self->change_pkgnum;
3277 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3280 =item change_cust_main
3282 Returns the customter this package was detached to, if any.
3286 sub change_cust_main {
3288 return '' unless $self->change_custnum;
3289 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3294 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3301 $self->part_pkg->calc_setup($self, @_);
3306 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3313 $self->part_pkg->calc_recur($self, @_);
3318 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3325 $self->part_pkg->base_setup($self, @_);
3330 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3337 $self->part_pkg->base_recur($self, @_);
3342 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3349 $self->part_pkg->calc_remain($self, @_);
3354 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3361 $self->part_pkg->calc_cancel($self, @_);
3366 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3372 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3375 =item cust_pkg_detail [ DETAILTYPE ]
3377 Returns any customer package details for this package (see
3378 L<FS::cust_pkg_detail>).
3380 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3384 sub cust_pkg_detail {
3386 my %hash = ( 'pkgnum' => $self->pkgnum );
3387 $hash{detailtype} = shift if @_;
3389 'table' => 'cust_pkg_detail',
3390 'hashref' => \%hash,
3391 'order_by' => 'ORDER BY weight, pkgdetailnum',
3395 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3397 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3399 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3401 If there is an error, returns the error, otherwise returns false.
3405 sub set_cust_pkg_detail {
3406 my( $self, $detailtype, @details ) = @_;
3408 my $oldAutoCommit = $FS::UID::AutoCommit;
3409 local $FS::UID::AutoCommit = 0;
3412 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3413 my $error = $current->delete;
3415 $dbh->rollback if $oldAutoCommit;
3416 return "error removing old detail: $error";
3420 foreach my $detail ( @details ) {
3421 my $cust_pkg_detail = new FS::cust_pkg_detail {
3422 'pkgnum' => $self->pkgnum,
3423 'detailtype' => $detailtype,
3424 'detail' => $detail,
3426 my $error = $cust_pkg_detail->insert;
3428 $dbh->rollback if $oldAutoCommit;
3429 return "error adding new detail: $error";
3434 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3441 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3445 #false laziness w/cust_bill.pm
3449 'table' => 'cust_event',
3450 'addl_from' => 'JOIN part_event USING ( eventpart )',
3451 'hashref' => { 'tablenum' => $self->pkgnum },
3452 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3456 =item num_cust_event
3458 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3462 #false laziness w/cust_bill.pm
3463 sub num_cust_event {
3465 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3466 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3469 =item exists_cust_event
3471 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3475 sub exists_cust_event {
3477 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3478 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3479 $row ? $row->[0] : '';
3482 sub _from_cust_event_where {
3484 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3485 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3489 my( $self, $sql, @args ) = @_;
3490 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3491 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3495 =item part_pkg_currency_option OPTIONNAME
3497 Returns a two item list consisting of the currency of this customer, if any,
3498 and a value for the provided option. If the customer has a currency, the value
3499 is the option value the given name and the currency (see
3500 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3501 regular option value for the given name (see L<FS::part_pkg_option>).
3505 sub part_pkg_currency_option {
3506 my( $self, $optionname ) = @_;
3507 my $part_pkg = $self->part_pkg;
3508 if ( my $currency = $self->cust_main->currency ) {
3509 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3511 ('', $part_pkg->option($optionname) );
3515 =item cust_svc [ SVCPART ] (old, deprecated usage)
3517 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3519 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3521 Returns the services for this package, as FS::cust_svc objects (see
3522 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3523 spcififed, returns only the matching services.
3525 As an optimization, use the cust_svc_unsorted version if you are not displaying
3532 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3533 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3536 sub cust_svc_unsorted {
3538 @{ $self->cust_svc_unsorted_arrayref(@_) };
3541 sub cust_svc_unsorted_arrayref {
3544 return [] unless $self->num_cust_svc(@_);
3547 if ( @_ && $_[0] =~ /^\d+/ ) {
3548 $opt{svcpart} = shift;
3549 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3556 'select' => 'cust_svc.*, part_svc.*',
3557 'table' => 'cust_svc',
3558 'hashref' => { 'pkgnum' => $self->pkgnum },
3559 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3561 $search{hashref}->{svcpart} = $opt{svcpart}
3563 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3566 [ qsearch(\%search) ];
3570 =item overlimit [ SVCPART ]
3572 Returns the services for this package which have exceeded their
3573 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3574 is specified, return only the matching services.
3580 return () unless $self->num_cust_svc(@_);
3581 grep { $_->overlimit } $self->cust_svc(@_);
3584 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3586 Returns historical services for this package created before END TIMESTAMP and
3587 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3588 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3589 I<pkg_svc.hidden> flag will be omitted.
3595 warn "$me _h_cust_svc called on $self\n"
3598 my ($end, $start, $mode) = @_;
3600 local($FS::Record::qsearch_qualify_columns) = 0;
3602 my @cust_svc = $self->_sort_cust_svc(
3603 [ qsearch( 'h_cust_svc',
3604 { 'pkgnum' => $self->pkgnum, },
3605 FS::h_cust_svc->sql_h_search(@_),
3609 if ( defined($mode) && $mode eq 'I' ) {
3610 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3611 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3617 sub _sort_cust_svc {
3618 my( $self, $arrayref ) = @_;
3621 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3623 my %pkg_svc = map { $_->svcpart => $_ }
3624 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3629 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3631 $pkg_svc ? $pkg_svc->primary_svc : '',
3632 $pkg_svc ? $pkg_svc->quantity : 0,
3639 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3641 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3643 Returns the number of services for this package. Available options are svcpart
3644 and svcdb. If either is spcififed, returns only the matching services.
3651 return $self->{'_num_cust_svc'}
3653 && exists($self->{'_num_cust_svc'})
3654 && $self->{'_num_cust_svc'} =~ /\d/;
3656 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3660 if ( @_ && $_[0] =~ /^\d+/ ) {
3661 $opt{svcpart} = shift;
3662 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3668 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3669 my $where = ' WHERE pkgnum = ? ';
3670 my @param = ($self->pkgnum);
3672 if ( $opt{'svcpart'} ) {
3673 $where .= ' AND svcpart = ? ';
3674 push @param, $opt{'svcpart'};
3676 if ( $opt{'svcdb'} ) {
3677 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3678 $where .= ' AND svcdb = ? ';
3679 push @param, $opt{'svcdb'};
3682 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3683 $sth->execute(@param) or die $sth->errstr;
3684 $sth->fetchrow_arrayref->[0];
3687 =item available_part_svc
3689 Returns a list of FS::part_svc objects representing services included in this
3690 package but not yet provisioned. Each FS::part_svc object also has an extra
3691 field, I<num_avail>, which specifies the number of available services.
3693 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3694 associated pkg_svc has the provision_hold flag set.
3698 sub available_part_svc {
3702 my $pkg_quantity = $self->quantity || 1;
3704 grep { $_->num_avail > 0 }
3706 my $part_svc = $_->part_svc;
3707 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3708 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3710 # more evil encapsulation breakage
3711 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3712 my @exports = $part_svc->part_export_did;
3713 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3718 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3719 $self->part_pkg->pkg_svc;
3722 =item part_svc [ OPTION => VALUE ... ]
3724 Returns a list of FS::part_svc objects representing provisioned and available
3725 services included in this package. Each FS::part_svc object also has the
3726 following extra fields:
3740 (services) - array reference containing the provisioned services, as cust_svc objects
3744 Accepts two options:
3748 =item summarize_size
3750 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3751 is this size or greater.
3753 =item hide_discontinued
3755 If true, will omit looking for services that are no longer avaialble in the
3763 #label -> ($cust_svc->label)[1]
3769 my $pkg_quantity = $self->quantity || 1;
3771 #XXX some sort of sort order besides numeric by svcpart...
3772 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3774 my $part_svc = $pkg_svc->part_svc;
3775 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3776 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3777 $part_svc->{'Hash'}{'num_avail'} =
3778 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3779 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3780 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3781 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3782 && $num_cust_svc >= $opt{summarize_size};
3783 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3785 } $self->part_pkg->pkg_svc;
3787 unless ( $opt{hide_discontinued} ) {
3789 push @part_svc, map {
3791 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3792 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3793 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3794 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3795 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3797 } $self->extra_part_svc;
3804 =item extra_part_svc
3806 Returns a list of FS::part_svc objects corresponding to services in this
3807 package which are still provisioned but not (any longer) available in the
3812 sub extra_part_svc {
3815 my $pkgnum = $self->pkgnum;
3816 #my $pkgpart = $self->pkgpart;
3819 # 'table' => 'part_svc',
3822 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3823 # WHERE pkg_svc.svcpart = part_svc.svcpart
3824 # AND pkg_svc.pkgpart = ?
3827 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3828 # LEFT JOIN cust_pkg USING ( pkgnum )
3829 # WHERE cust_svc.svcpart = part_svc.svcpart
3832 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3835 #seems to benchmark slightly faster... (or did?)
3837 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3838 my $pkgparts = join(',', @pkgparts);
3841 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3842 #MySQL doesn't grok DISINCT ON
3843 'select' => 'DISTINCT part_svc.*',
3844 'table' => 'part_svc',
3846 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3847 AND pkg_svc.pkgpart IN ($pkgparts)
3850 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3851 LEFT JOIN cust_pkg USING ( pkgnum )
3854 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3855 'extra_param' => [ [$self->pkgnum=>'int'] ],
3861 Returns a short status string for this package, currently:
3867 =item not yet billed
3869 =item one-time charge
3884 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3886 return 'cancelled' if $self->get('cancel');
3887 return 'on hold' if $self->susp && ! $self->setup;
3888 return 'suspended' if $self->susp;
3889 return 'not yet billed' unless $self->setup;
3890 return 'one-time charge' if $freq =~ /^(0|$)/;
3894 =item ucfirst_status
3896 Returns the status with the first character capitalized.
3900 sub ucfirst_status {
3901 ucfirst(shift->status);
3906 Class method that returns the list of possible status strings for packages
3907 (see L<the status method|/status>). For example:
3909 @statuses = FS::cust_pkg->statuses();
3913 tie my %statuscolor, 'Tie::IxHash',
3914 'on hold' => 'FF00F5', #brighter purple!
3915 'not yet billed' => '009999', #teal? cyan?
3916 'one-time charge' => '0000CC', #blue #'000000',
3917 'active' => '00CC00',
3918 'suspended' => 'FF9900',
3919 'cancelled' => 'FF0000',
3923 my $self = shift; #could be class...
3924 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3925 # # mayble split btw one-time vs. recur
3936 Returns a hex triplet color string for this package's status.
3942 $statuscolor{$self->status};
3945 =item is_status_delay_cancel
3947 Returns true if part_pkg has option delay_cancel,
3948 cust_pkg status is 'suspended' and expire is set
3949 to cancel package within the next day (or however
3950 many days are set in global config part_pkg-delay_cancel-days.
3952 Accepts option I<part_pkg-delay_cancel-days> which should be
3953 the value of the config setting, to avoid looking it up again.
3955 This is not a real status, this only meant for hacking display
3956 values, because otherwise treating the package as suspended is
3957 really the whole point of the delay_cancel option.
3961 sub is_status_delay_cancel {
3962 my ($self,%opt) = @_;
3963 if ( $self->main_pkgnum and $self->pkglinknum ) {
3964 return $self->main_pkg->is_status_delay_cancel;
3966 return 0 unless $self->part_pkg->option('delay_cancel',1);
3967 return 0 unless $self->status eq 'suspended';
3968 return 0 unless $self->expire;
3969 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3971 my $conf = new FS::Conf;
3972 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3974 my $expsecs = 60*60*24*$expdays;
3975 return 0 unless $self->expire < time + $expsecs;
3981 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3982 "pkg - comment" depending on user preference).
3988 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3989 $label = $self->pkgnum. ": $label"
3990 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3994 =item pkg_label_long
3996 Returns a long label for this package, adding the primary service's label to
4001 sub pkg_label_long {
4003 my $label = $self->pkg_label;
4004 my $cust_svc = $self->primary_cust_svc;
4005 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
4011 Returns a customer-localized label for this package.
4017 $self->part_pkg->pkg_locale( $self->cust_main->locale );
4020 =item primary_cust_svc
4022 Returns a primary service (as FS::cust_svc object) if one can be identified.
4026 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
4028 sub primary_cust_svc {
4031 my @cust_svc = $self->cust_svc;
4033 return '' unless @cust_svc; #no serivces - irrelevant then
4035 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
4037 # primary service as specified in the package definition
4038 # or exactly one service definition with quantity one
4039 my $svcpart = $self->part_pkg->svcpart;
4040 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
4041 return $cust_svc[0] if scalar(@cust_svc) == 1;
4043 #couldn't identify one thing..
4049 Returns a list of lists, calling the label method for all services
4050 (see L<FS::cust_svc>) of this billing item.
4056 map { [ $_->label ] } $self->cust_svc;
4059 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4061 Like the labels method, but returns historical information on services that
4062 were active as of END_TIMESTAMP and (optionally) not cancelled before
4063 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
4064 I<pkg_svc.hidden> flag will be omitted.
4066 If LOCALE is passed, service definition names will be localized.
4068 Returns a list of lists, calling the label method for all (historical)
4069 services (see L<FS::h_cust_svc>) of this billing item.
4075 my ($end, $start, $mode, $locale) = @_;
4076 warn "$me h_labels\n"
4078 map { [ $_->label($end, $start, $locale) ] }
4079 $self->h_cust_svc($end, $start, $mode);
4084 Like labels, except returns a simple flat list, and shortens long
4085 (currently >5 or the cust_bill-max_same_services configuration value) lists of
4086 identical services to one line that lists the service label and the number of
4087 individual services rather than individual items.
4092 shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
4095 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4097 Like h_labels, except returns a simple flat list, and shortens long
4098 (currently >5 or the cust_bill-max_same_services configuration value) lists
4099 of identical services to one line that lists the service label and the
4100 number of individual services rather than individual items.
4104 sub h_labels_short {
4105 shift->_labels_short( 'h_labels', @_ );
4108 # takes a method name ('labels' or 'h_labels') and all its arguments;
4109 # maybe should be "shorten($self->h_labels( ... ) )"
4112 my( $self, $method ) = ( shift, shift );
4114 warn "$me _labels_short called on $self with $method method\n"
4117 my $conf = new FS::Conf;
4118 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4120 warn "$me _labels_short populating \%labels\n"
4124 #tie %labels, 'Tie::IxHash';
4125 push @{ $labels{$_->[0]} }, $_->[1]
4126 foreach $self->$method(@_);
4128 warn "$me _labels_short populating \@labels\n"
4132 foreach my $label ( keys %labels ) {
4134 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4135 my $num = scalar(@values);
4136 warn "$me _labels_short $num items for $label\n"
4139 if ( $num > $max_same_services ) {
4140 warn "$me _labels_short more than $max_same_services, so summarizing\n"
4142 push @labels, "$label ($num)";
4144 if ( $conf->exists('cust_bill-consolidate_services') ) {
4145 warn "$me _labels_short consolidating services\n"
4147 # push @labels, "$label: ". join(', ', @values);
4149 my $detail = "$label: ";
4150 $detail .= shift(@values). ', '
4152 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4154 push @labels, $detail;
4156 warn "$me _labels_short done consolidating services\n"
4159 warn "$me _labels_short adding service data\n"
4161 push @labels, map { "$label: $_" } @values;
4172 Returns the parent customer object (see L<FS::cust_main>).
4176 Returns the balance for this specific package, when using
4177 experimental package balance.
4183 $self->cust_main->balance_pkgnum( $self->pkgnum );
4186 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4190 Returns the location object, if any (see L<FS::cust_location>).
4192 =item cust_location_or_main
4194 If this package is associated with a location, returns the locaiton (see
4195 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4197 =item location_label [ OPTION => VALUE ... ]
4199 Returns the label of the location object (see L<FS::cust_location>).
4203 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4205 =item tax_locationnum
4207 Returns the foreign key to a L<FS::cust_location> object for calculating
4208 tax on this package, as determined by the C<tax-pkg_address> and
4209 C<tax-ship_address> configuration flags.
4213 sub tax_locationnum {
4215 my $conf = FS::Conf->new;
4216 if ( $conf->exists('tax-pkg_address') ) {
4217 return $self->locationnum;
4219 elsif ( $conf->exists('tax-ship_address') ) {
4220 return $self->cust_main->ship_locationnum;
4223 return $self->cust_main->bill_locationnum;
4229 Returns the L<FS::cust_location> object for tax_locationnum.
4235 my $conf = FS::Conf->new;
4236 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4237 return FS::cust_location->by_key($self->locationnum);
4239 elsif ( $conf->exists('tax-ship_address') ) {
4240 return $self->cust_main->ship_location;
4243 return $self->cust_main->bill_location;
4247 =item seconds_since TIMESTAMP
4249 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4250 package have been online since TIMESTAMP, according to the session monitor.
4252 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4253 L<Time::Local> and L<Date::Parse> for conversion functions.
4258 my($self, $since) = @_;
4261 foreach my $cust_svc (
4262 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4264 $seconds += $cust_svc->seconds_since($since);
4271 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4273 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4274 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4277 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4278 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4284 sub seconds_since_sqlradacct {
4285 my($self, $start, $end) = @_;
4289 foreach my $cust_svc (
4291 my $part_svc = $_->part_svc;
4292 $part_svc->svcdb eq 'svc_acct'
4293 && scalar($part_svc->part_export_usage);
4296 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4303 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4305 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4306 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4310 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4311 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4316 sub attribute_since_sqlradacct {
4317 my($self, $start, $end, $attrib) = @_;
4321 foreach my $cust_svc (
4323 my $part_svc = $_->part_svc;
4324 scalar($part_svc->part_export_usage);
4327 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4339 my( $self, $value ) = @_;
4340 if ( defined($value) ) {
4341 $self->setfield('quantity', $value);
4343 $self->getfield('quantity') || 1;
4346 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4348 Transfers as many services as possible from this package to another package.
4350 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4351 object. The destination package must already exist.
4353 Services are moved only if the destination allows services with the correct
4354 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4355 this option with caution! No provision is made for export differences
4356 between the old and new service definitions. Probably only should be used
4357 when your exports for all service definitions of a given svcdb are identical.
4358 (attempt a transfer without it first, to move all possible svcpart-matching
4361 Any services that can't be moved remain in the original package.
4363 Returns an error, if there is one; otherwise, returns the number of services
4364 that couldn't be moved.
4369 my ($self, $dest_pkgnum, %opt) = @_;
4375 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4376 $dest = $dest_pkgnum;
4377 $dest_pkgnum = $dest->pkgnum;
4379 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4382 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4384 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4385 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4388 foreach my $cust_svc ($dest->cust_svc) {
4389 $target{$cust_svc->svcpart}--;
4392 my %svcpart2svcparts = ();
4393 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4394 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4395 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4396 next if exists $svcpart2svcparts{$svcpart};
4397 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4398 $svcpart2svcparts{$svcpart} = [
4400 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4402 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4403 'svcpart' => $_ } );
4405 $pkg_svc ? $pkg_svc->primary_svc : '',
4406 $pkg_svc ? $pkg_svc->quantity : 0,
4410 grep { $_ != $svcpart }
4412 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4414 warn "alternates for svcpart $svcpart: ".
4415 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4421 foreach my $cust_svc ($self->cust_svc) {
4422 my $svcnum = $cust_svc->svcnum;
4423 if($target{$cust_svc->svcpart} > 0
4424 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4425 $target{$cust_svc->svcpart}--;
4426 my $new = new FS::cust_svc { $cust_svc->hash };
4427 $new->pkgnum($dest_pkgnum);
4428 $error = $new->replace($cust_svc);
4429 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4431 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4432 warn "alternates to consider: ".
4433 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4435 my @alternate = grep {
4436 warn "considering alternate svcpart $_: ".
4437 "$target{$_} available in new package\n"
4440 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4442 warn "alternate(s) found\n" if $DEBUG;
4443 my $change_svcpart = $alternate[0];
4444 $target{$change_svcpart}--;
4445 my $new = new FS::cust_svc { $cust_svc->hash };
4446 $new->svcpart($change_svcpart);
4447 $new->pkgnum($dest_pkgnum);
4448 $error = $new->replace($cust_svc);
4456 my @label = $cust_svc->label;
4457 return "$label[0] $label[1]: $error";
4463 =item grab_svcnums SVCNUM, SVCNUM ...
4465 Change the pkgnum for the provided services to this packages. If there is an
4466 error, returns the error, otherwise returns false.
4474 my $oldAutoCommit = $FS::UID::AutoCommit;
4475 local $FS::UID::AutoCommit = 0;
4478 foreach my $svcnum (@svcnum) {
4479 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4480 $dbh->rollback if $oldAutoCommit;
4481 return "unknown svcnum $svcnum";
4483 $cust_svc->pkgnum( $self->pkgnum );
4484 my $error = $cust_svc->replace;
4486 $dbh->rollback if $oldAutoCommit;
4491 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4498 This method is deprecated. See the I<depend_jobnum> option to the insert and
4499 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4503 #looks like this is still used by the order_pkg and change_pkg methods in
4504 # ClientAPI/MyAccount, need to look into those before removing
4508 my $oldAutoCommit = $FS::UID::AutoCommit;
4509 local $FS::UID::AutoCommit = 0;
4512 foreach my $cust_svc ( $self->cust_svc ) {
4513 #false laziness w/svc_Common::insert
4514 my $svc_x = $cust_svc->svc_x;
4515 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4516 my $error = $part_export->export_insert($svc_x);
4518 $dbh->rollback if $oldAutoCommit;
4524 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4529 =item export_pkg_change OLD_CUST_PKG
4531 Calls the "pkg_change" export action for all services attached to this package.
4535 sub export_pkg_change {
4536 my( $self, $old ) = ( shift, shift );
4538 my $oldAutoCommit = $FS::UID::AutoCommit;
4539 local $FS::UID::AutoCommit = 0;
4542 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4543 my $error = $svc_x->export('pkg_change', $self, $old);
4545 $dbh->rollback if $oldAutoCommit;
4550 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4557 Associates this package with a (suspension or cancellation) reason (see
4558 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4561 Available options are:
4567 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.
4571 the access_user (see L<FS::access_user>) providing the reason
4579 the action (cancel, susp, adjourn, expire) associated with the reason
4583 If there is an error, returns the error, otherwise returns false.
4588 my ($self, %options) = @_;
4590 my $otaker = $options{reason_otaker} ||
4591 $FS::CurrentUser::CurrentUser->username;
4594 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4598 } elsif ( ref($options{'reason'}) ) {
4600 return 'Enter a new reason (or select an existing one)'
4601 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4603 my $reason = new FS::reason({
4604 'reason_type' => $options{'reason'}->{'typenum'},
4605 'reason' => $options{'reason'}->{'reason'},
4607 my $error = $reason->insert;
4608 return $error if $error;
4610 $reasonnum = $reason->reasonnum;
4613 return "Unparseable reason: ". $options{'reason'};
4616 my $cust_pkg_reason =
4617 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4618 'reasonnum' => $reasonnum,
4619 'otaker' => $otaker,
4620 'action' => substr(uc($options{'action'}),0,1),
4621 'date' => $options{'date'}
4626 $cust_pkg_reason->insert;
4629 =item insert_discount
4631 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4632 inserting a new discount on the fly (see L<FS::discount>).
4634 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4635 and if present, will create a setup discount. If the discountnum is -1,
4636 a new discount definition will be inserted using the value in
4637 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4639 If there is an error, returns the error, otherwise returns false.
4643 sub insert_discount {
4644 #my ($self, %options) = @_;
4647 foreach my $x (qw(setup recur)) {
4648 if ( my $discountnum = $self->get("${x}_discountnum") ) {
4649 my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4650 'pkgnum' => $self->pkgnum,
4651 'discountnum' => $discountnum,
4654 'end_date' => '', #XXX
4655 #for the create a new discount case
4656 'amount' => $self->get("${x}_discountnum_amount"),
4657 'percent' => $self->get("${x}_discountnum_percent"),
4658 'months' => $self->get("${x}_discountnum_months"),
4660 if ( $x eq 'setup' ) {
4661 $cust_pkg_discount->setup('Y');
4662 $cust_pkg_discount->months('');
4664 my $error = $cust_pkg_discount->insert;
4665 return $error if $error;
4672 =item set_usage USAGE_VALUE_HASHREF
4674 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4675 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4676 upbytes, downbytes, and totalbytes are appropriate keys.
4678 All svc_accts which are part of this package have their values reset.
4683 my ($self, $valueref, %opt) = @_;
4685 #only svc_acct can set_usage for now
4686 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4687 my $svc_x = $cust_svc->svc_x;
4688 $svc_x->set_usage($valueref, %opt)
4689 if $svc_x->can("set_usage");
4693 =item recharge USAGE_VALUE_HASHREF
4695 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4696 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4697 upbytes, downbytes, and totalbytes are appropriate keys.
4699 All svc_accts which are part of this package have their values incremented.
4704 my ($self, $valueref) = @_;
4706 #only svc_acct can set_usage for now
4707 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4708 my $svc_x = $cust_svc->svc_x;
4709 $svc_x->recharge($valueref)
4710 if $svc_x->can("recharge");
4714 =item apply_usageprice
4718 sub apply_usageprice {
4721 my $oldAutoCommit = $FS::UID::AutoCommit;
4722 local $FS::UID::AutoCommit = 0;
4727 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4728 $error ||= $cust_pkg_usageprice->apply;
4732 $dbh->rollback if $oldAutoCommit;
4733 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4736 $dbh->commit if $oldAutoCommit;
4742 =item cust_pkg_discount
4744 =item cust_pkg_discount_active
4748 sub cust_pkg_discount_active {
4750 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4753 =item cust_pkg_usage
4755 Returns a list of all voice usage counters attached to this package.
4757 =item apply_usage OPTIONS
4759 Takes the following options:
4760 - cdr: a call detail record (L<FS::cdr>)
4761 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4762 - minutes: the maximum number of minutes to be charged
4764 Finds available usage minutes for a call of this class, and subtracts
4765 up to that many minutes from the usage pool. If the usage pool is empty,
4766 and the C<cdr-minutes_priority> global config option is set, minutes may
4767 be taken from other calls as well. Either way, an allocation record will
4768 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4769 number of minutes of usage applied to the call.
4774 my ($self, %opt) = @_;
4775 my $cdr = $opt{cdr};
4776 my $rate_detail = $opt{rate_detail};
4777 my $minutes = $opt{minutes};
4778 my $classnum = $rate_detail->classnum;
4779 my $pkgnum = $self->pkgnum;
4780 my $custnum = $self->custnum;
4782 my $oldAutoCommit = $FS::UID::AutoCommit;
4783 local $FS::UID::AutoCommit = 0;
4786 my $order = FS::Conf->new->config('cdr-minutes_priority');
4790 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4792 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4794 my @usage_recs = qsearch({
4795 'table' => 'cust_pkg_usage',
4796 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4797 ' JOIN cust_pkg USING (pkgnum)'.
4798 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4799 'select' => 'cust_pkg_usage.*',
4800 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4801 " ( cust_pkg.custnum = $custnum AND ".
4802 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4803 $is_classnum . ' AND '.
4804 " cust_pkg_usage.minutes > 0",
4805 'order_by' => " ORDER BY priority ASC",
4808 my $orig_minutes = $minutes;
4810 while (!$error and $minutes > 0 and @usage_recs) {
4811 my $cust_pkg_usage = shift @usage_recs;
4812 $cust_pkg_usage->select_for_update;
4813 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4814 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4815 acctid => $cdr->acctid,
4816 minutes => min($cust_pkg_usage->minutes, $minutes),
4818 $cust_pkg_usage->set('minutes',
4819 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4821 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4822 $minutes -= $cdr_cust_pkg_usage->minutes;
4824 if ( $order and $minutes > 0 and !$error ) {
4825 # then try to steal minutes from another call
4827 'table' => 'cdr_cust_pkg_usage',
4828 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4829 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4830 ' JOIN cust_pkg USING (pkgnum)'.
4831 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4832 ' JOIN cdr USING (acctid)',
4833 'select' => 'cdr_cust_pkg_usage.*',
4834 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4835 " ( cust_pkg.pkgnum = $pkgnum OR ".
4836 " ( cust_pkg.custnum = $custnum AND ".
4837 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4838 " part_pkg_usage_class.classnum = $classnum",
4839 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4841 if ( $order eq 'time' ) {
4842 # find CDRs that are using minutes, but have a later startdate
4844 my $startdate = $cdr->startdate;
4845 if ($startdate !~ /^\d+$/) {
4846 die "bad cdr startdate '$startdate'";
4848 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4849 # minimize needless reshuffling
4850 $search{'order_by'} .= ', cdr.startdate DESC';
4852 # XXX may not work correctly with rate_time schedules. Could
4853 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4855 $search{'addl_from'} .=
4856 ' JOIN rate_detail'.
4857 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4858 if ( $order eq 'rate_high' ) {
4859 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4860 $rate_detail->min_charge;
4861 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4862 } elsif ( $order eq 'rate_low' ) {
4863 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4864 $rate_detail->min_charge;
4865 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4867 # this should really never happen
4868 die "invalid cdr-minutes_priority value '$order'\n";
4871 my @cdr_usage_recs = qsearch(\%search);
4873 while (!$error and @cdr_usage_recs and $minutes > 0) {
4874 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4875 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4876 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4877 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4878 $cdr_cust_pkg_usage->select_for_update;
4879 $old_cdr->select_for_update;
4880 $cust_pkg_usage->select_for_update;
4881 # in case someone else stole the usage from this CDR
4882 # while waiting for the lock...
4883 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4884 # steal the usage allocation and flag the old CDR for reprocessing
4885 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4886 # if the allocation is more minutes than we need, adjust it...
4887 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4889 $cdr_cust_pkg_usage->set('minutes', $minutes);
4890 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4891 $error = $cust_pkg_usage->replace;
4893 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4894 $error ||= $cdr_cust_pkg_usage->replace;
4895 # deduct the stolen minutes
4896 $minutes -= $cdr_cust_pkg_usage->minutes;
4898 # after all minute-stealing is done, reset the affected CDRs
4899 foreach (values %reproc_cdrs) {
4900 $error ||= $_->set_status('');
4901 # XXX or should we just call $cdr->rate right here?
4902 # it's not like we can create a loop this way, since the min_charge
4903 # or call time has to go monotonically in one direction.
4904 # we COULD get some very deep recursions going, though...
4906 } # if $order and $minutes
4909 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4911 $dbh->commit if $oldAutoCommit;
4912 return $orig_minutes - $minutes;
4916 =item supplemental_pkgs
4918 Returns a list of all packages supplemental to this one.
4922 sub supplemental_pkgs {
4924 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4929 Returns the package that this one is supplemental to, if any.
4935 if ( $self->main_pkgnum ) {
4936 return FS::cust_pkg->by_key($self->main_pkgnum);
4943 =head1 CLASS METHODS
4949 Returns an SQL expression identifying recurring packages.
4953 sub recurring_sql { "
4954 '0' != ( select freq from part_pkg
4955 where cust_pkg.pkgpart = part_pkg.pkgpart )
4960 Returns an SQL expression identifying one-time packages.
4965 '0' = ( select freq from part_pkg
4966 where cust_pkg.pkgpart = part_pkg.pkgpart )
4971 Returns an SQL expression identifying ordered packages (recurring packages not
4977 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4982 Returns an SQL expression identifying active packages.
4987 $_[0]->recurring_sql. "
4988 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4989 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4990 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4993 =item not_yet_billed_sql
4995 Returns an SQL expression identifying packages which have not yet been billed.
4999 sub not_yet_billed_sql { "
5000 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5001 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5002 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5007 Returns an SQL expression identifying inactive packages (one-time packages
5008 that are otherwise unsuspended/uncancelled).
5012 sub inactive_sql { "
5013 ". $_[0]->onetime_sql(). "
5014 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5015 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5016 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5021 Returns an SQL expression identifying on-hold packages.
5026 #$_[0]->recurring_sql(). ' AND '.
5028 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5029 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5030 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5037 Returns an SQL expression identifying suspended packages.
5041 sub suspended_sql { susp_sql(@_); }
5043 #$_[0]->recurring_sql(). ' AND '.
5045 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5046 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5047 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5054 Returns an SQL exprression identifying cancelled packages.
5058 sub cancelled_sql { cancel_sql(@_); }
5060 #$_[0]->recurring_sql(). ' AND '.
5061 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
5066 Returns an SQL expression to give the package status as a string.
5072 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
5073 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
5074 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
5075 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
5076 WHEN ".onetime_sql()." THEN 'one-time charge'
5083 Returns a list of two package counts. The first is a count of packages
5084 based on the supplied criteria and the second is the count of residential
5085 packages with those same criteria. Criteria are specified as in the search
5091 my ($class, $params) = @_;
5093 my $sql_query = $class->search( $params );
5095 my $count_sql = delete($sql_query->{'count_query'});
5096 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5097 or die "couldn't parse count_sql";
5099 my $count_sth = dbh->prepare($count_sql)
5100 or die "Error preparing $count_sql: ". dbh->errstr;
5102 or die "Error executing $count_sql: ". $count_sth->errstr;
5103 my $count_arrayref = $count_sth->fetchrow_arrayref;
5105 return ( @$count_arrayref );
5109 =item tax_locationnum_sql
5111 Returns an SQL expression for the tax location for a package, based
5112 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5116 sub tax_locationnum_sql {
5117 my $conf = FS::Conf->new;
5118 if ( $conf->exists('tax-pkg_address') ) {
5119 'cust_pkg.locationnum';
5121 elsif ( $conf->exists('tax-ship_address') ) {
5122 'cust_main.ship_locationnum';
5125 'cust_main.bill_locationnum';
5131 Returns a list: the first item is an SQL fragment identifying matching
5132 packages/customers via location (taking into account shipping and package
5133 address taxation, if enabled), and subsequent items are the parameters to
5134 substitute for the placeholders in that fragment.
5139 my($class, %opt) = @_;
5140 my $ornull = $opt{'ornull'};
5142 my $conf = new FS::Conf;
5144 # '?' placeholders in _location_sql_where
5145 my $x = $ornull ? 3 : 2;
5156 if ( $conf->exists('tax-ship_address') ) {
5159 ( ( ship_last IS NULL OR ship_last = '' )
5160 AND ". _location_sql_where('cust_main', '', $ornull ). "
5162 OR ( ship_last IS NOT NULL AND ship_last != ''
5163 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5166 # AND payby != 'COMP'
5168 @main_param = ( @bill_param, @bill_param );
5172 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5173 @main_param = @bill_param;
5179 if ( $conf->exists('tax-pkg_address') ) {
5181 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5184 ( cust_pkg.locationnum IS NULL AND $main_where )
5185 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5188 @param = ( @main_param, @bill_param );
5192 $where = $main_where;
5193 @param = @main_param;
5201 #subroutine, helper for location_sql
5202 sub _location_sql_where {
5204 my $prefix = @_ ? shift : '';
5205 my $ornull = @_ ? shift : '';
5207 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5209 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5211 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5212 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5213 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5215 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5217 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5219 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5220 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5221 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5222 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5223 AND $table.${prefix}country = ?
5228 my( $self, $what ) = @_;
5230 my $what_show_zero = $what. '_show_zero';
5231 length($self->$what_show_zero())
5232 ? ($self->$what_show_zero() eq 'Y')
5233 : $self->part_pkg->$what_show_zero();
5240 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5242 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5243 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5245 CUSTNUM is a customer (see L<FS::cust_main>)
5247 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5248 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5251 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5252 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5253 new billing items. An error is returned if this is not possible (see
5254 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5257 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5258 newly-created cust_pkg objects.
5260 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5261 and inserted. Multiple FS::pkg_referral records can be created by
5262 setting I<refnum> to an array reference of refnums or a hash reference with
5263 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5264 record will be created corresponding to cust_main.refnum.
5269 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5271 my $conf = new FS::Conf;
5273 # Transactionize this whole mess
5274 my $oldAutoCommit = $FS::UID::AutoCommit;
5275 local $FS::UID::AutoCommit = 0;
5279 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5280 # return "Customer not found: $custnum" unless $cust_main;
5282 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5285 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5288 my $change = scalar(@old_cust_pkg) != 0;
5291 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5293 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5294 " to pkgpart ". $pkgparts->[0]. "\n"
5297 my $err_or_cust_pkg =
5298 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5299 'refnum' => $refnum,
5302 unless (ref($err_or_cust_pkg)) {
5303 $dbh->rollback if $oldAutoCommit;
5304 return $err_or_cust_pkg;
5307 push @$return_cust_pkg, $err_or_cust_pkg;
5308 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5313 # Create the new packages.
5314 foreach my $pkgpart (@$pkgparts) {
5316 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5318 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5319 pkgpart => $pkgpart,
5323 $error = $cust_pkg->insert( 'change' => $change );
5324 push @$return_cust_pkg, $cust_pkg;
5326 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5327 my $supp_pkg = FS::cust_pkg->new({
5328 custnum => $custnum,
5329 pkgpart => $link->dst_pkgpart,
5331 main_pkgnum => $cust_pkg->pkgnum,
5334 $error ||= $supp_pkg->insert( 'change' => $change );
5335 push @$return_cust_pkg, $supp_pkg;
5339 $dbh->rollback if $oldAutoCommit;
5344 # $return_cust_pkg now contains refs to all of the newly
5347 # Transfer services and cancel old packages.
5348 foreach my $old_pkg (@old_cust_pkg) {
5350 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5353 foreach my $new_pkg (@$return_cust_pkg) {
5354 $error = $old_pkg->transfer($new_pkg);
5355 if ($error and $error == 0) {
5356 # $old_pkg->transfer failed.
5357 $dbh->rollback if $oldAutoCommit;
5362 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5363 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5364 foreach my $new_pkg (@$return_cust_pkg) {
5365 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5366 if ($error and $error == 0) {
5367 # $old_pkg->transfer failed.
5368 $dbh->rollback if $oldAutoCommit;
5375 # Transfers were successful, but we went through all of the
5376 # new packages and still had services left on the old package.
5377 # We can't cancel the package under the circumstances, so abort.
5378 $dbh->rollback if $oldAutoCommit;
5379 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5381 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5387 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5391 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5393 A bulk change method to change packages for multiple customers.
5395 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5396 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5399 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5400 replace. The services (see L<FS::cust_svc>) are moved to the
5401 new billing items. An error is returned if this is not possible (see
5404 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5405 newly-created cust_pkg objects.
5410 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5412 # Transactionize this whole mess
5413 my $oldAutoCommit = $FS::UID::AutoCommit;
5414 local $FS::UID::AutoCommit = 0;
5418 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5421 while(scalar(@old_cust_pkg)) {
5423 my $custnum = $old_cust_pkg[0]->custnum;
5424 my (@remove) = map { $_->pkgnum }
5425 grep { $_->custnum == $custnum } @old_cust_pkg;
5426 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5428 my $error = order $custnum, $pkgparts, \@remove, \@return;
5430 push @errors, $error
5432 push @$return_cust_pkg, @return;
5435 if (scalar(@errors)) {
5436 $dbh->rollback if $oldAutoCommit;
5437 return join(' / ', @errors);
5440 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5444 =item forward_emails
5446 Returns a hash of svcnums and corresponding email addresses
5447 for svc_acct services that can be used as source or dest
5448 for svc_forward services provisioned in this package.
5450 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5451 service; if included, will ensure the current values of the
5452 specified service are included in the list, even if for some
5453 other reason they wouldn't be. If called as a class method
5454 with a specified service, returns only these current values.
5456 Caution: does not actually check if svc_forward services are
5457 available to be provisioned on this package.
5461 sub forward_emails {
5465 #load optional service, thoroughly validated
5466 die "Use svcnum or svc_forward, not both"
5467 if $opt{'svcnum'} && $opt{'svc_forward'};
5468 my $svc_forward = $opt{'svc_forward'};
5469 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5471 die "Specified service is not a forward service"
5472 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5473 die "Specified service not found"
5474 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5478 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5479 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5481 #add current values from specified service, if there was one
5483 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5484 my $svc_acct = $svc_forward->$method();
5485 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5489 if (ref($self) eq 'FS::cust_pkg') {
5491 #and including the rest for this customer
5492 my($u_part_svc,@u_acct_svcparts);
5493 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5494 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5497 my $custnum = $self->getfield('custnum');
5498 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5499 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5500 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5501 foreach my $acct_svcpart (@u_acct_svcparts) {
5502 foreach my $i_cust_svc (
5503 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5504 'svcpart' => $acct_svcpart } )
5506 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5507 $email{$svc_acct->svcnum} = $svc_acct->email;
5516 # Used by FS::Upgrade to migrate to a new database.
5517 sub _upgrade_data { # class method
5518 my ($class, %opts) = @_;
5519 $class->_upgrade_otaker(%opts);
5521 # RT#10139, bug resulting in contract_end being set when it shouldn't
5522 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5523 # RT#10830, bad calculation of prorate date near end of year
5524 # the date range for bill is December 2009, and we move it forward
5525 # one year if it's before the previous bill date (which it should
5527 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5528 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5529 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5530 # RT6628, add order_date to cust_pkg
5531 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5532 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5533 history_action = \'insert\') where order_date is null',
5535 foreach my $sql (@statements) {
5536 my $sth = dbh->prepare($sql);
5537 $sth->execute or die $sth->errstr;
5540 # RT31194: supplemental package links that are deleted don't clean up
5542 my @pkglinknums = qsearch({
5543 'select' => 'DISTINCT cust_pkg.pkglinknum',
5544 'table' => 'cust_pkg',
5545 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5546 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5547 AND part_pkg_link.pkglinknum IS NULL',
5549 foreach (@pkglinknums) {
5550 my $pkglinknum = $_->pkglinknum;
5551 warn "cleaning part_pkg_link #$pkglinknum\n";
5552 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5553 my $error = $part_pkg_link->remove_linked;
5554 die $error if $error;
5562 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5564 In sub order, the @pkgparts array (passed by reference) is clobbered.
5566 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5567 method to pass dates to the recur_prog expression, it should do so.
5569 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5570 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5571 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5572 configuration values. Probably need a subroutine which decides what to do
5573 based on whether or not we've fetched the user yet, rather than a hash. See
5574 FS::UID and the TODO.
5576 Now that things are transactional should the check in the insert method be
5581 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5582 L<FS::pkg_svc>, schema.html from the base documentation