2 use base qw( FS::cust_pkg::Search FS::cust_pkg::API
3 FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
4 FS::contact_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common
10 use Scalar::Util qw( blessed );
11 use List::Util qw(min max);
13 use Time::Local qw( timelocal timelocal_nocheck );
15 use FS::UID qw( dbh driver_name );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_usageprice;
35 use FS::cust_pkg_discount;
41 # 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
537 # cust_svc is handled by canceling the package before deleting it
538 # cust_pkg_option is handled via option_Common
540 my $oldAutoCommit = $FS::UID::AutoCommit;
541 local $FS::UID::AutoCommit = 0;
544 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
545 my $error = $cust_pkg_discount->delete;
547 $dbh->rollback if $oldAutoCommit;
551 #cust_bill_pkg_discount?
553 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
554 my $error = $cust_pkg_detail->delete;
556 $dbh->rollback if $oldAutoCommit;
561 foreach my $cust_pkg_reason (
563 'table' => 'cust_pkg_reason',
564 'hashref' => { 'pkgnum' => $self->pkgnum },
568 my $error = $cust_pkg_reason->delete;
570 $dbh->rollback if $oldAutoCommit;
575 foreach my $pkg_referral ( $self->pkg_referral ) {
576 my $error = $pkg_referral->delete;
578 $dbh->rollback if $oldAutoCommit;
583 my $error = $self->SUPER::delete(@_);
585 $dbh->rollback if $oldAutoCommit;
589 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
595 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
597 Replaces the OLD_RECORD with this one in the database. If there is an error,
598 returns the error, otherwise returns false.
600 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
602 Changing pkgpart may have disasterous effects. See the order subroutine.
604 setup and bill are normally updated by calling the bill method of a customer
605 object (see L<FS::cust_main>).
607 suspend is normally updated by the suspend and unsuspend methods.
609 cancel is normally updated by the cancel method (and also the order subroutine
612 Available options are:
618 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.
622 the access_user (see L<FS::access_user>) providing the reason
626 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
635 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
640 ( ref($_[0]) eq 'HASH' )
644 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
645 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
648 #return "Can't change setup once it exists!"
649 # if $old->getfield('setup') &&
650 # $old->getfield('setup') != $new->getfield('setup');
652 #some logic for bill, susp, cancel?
654 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
656 my $oldAutoCommit = $FS::UID::AutoCommit;
657 local $FS::UID::AutoCommit = 0;
660 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
661 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
662 my $error = $new->insert_reason(
663 'reason' => $options->{'reason'},
664 'date' => $new->$method,
666 'reason_otaker' => $options->{'reason_otaker'},
669 dbh->rollback if $oldAutoCommit;
670 return "Error inserting cust_pkg_reason: $error";
675 #save off and freeze RADIUS attributes for any associated svc_acct records
677 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
679 #also check for specific exports?
680 # to avoid spurious modify export events
681 @svc_acct = map { $_->svc_x }
682 grep { $_->part_svc->svcdb eq 'svc_acct' }
685 $_->snapshot foreach @svc_acct;
689 my $error = $new->export_pkg_change($old)
690 || $new->SUPER::replace( $old,
692 ? $options->{options}
696 $dbh->rollback if $oldAutoCommit;
700 #for prepaid packages,
701 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
702 foreach my $old_svc_acct ( @svc_acct ) {
703 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
705 $new_svc_acct->replace( $old_svc_acct,
706 'depend_jobnum' => $options->{depend_jobnum},
709 $dbh->rollback if $oldAutoCommit;
714 # also run exports if removing locationnum?
715 # doesn't seem to happen, and we don't export blank locationnum on insert...
716 if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
717 my $conf = new FS::Conf;
719 map qsearch( 'part_export', {exportnum=>$_} ),
720 $conf->config('cust_location-exports'); #, $agentnum
722 foreach my $part_export ( @part_export ) {
723 my $error = $part_export->export_pkg_location($new); #, @$export_args);
725 $dbh->rollback if $oldAutoCommit;
726 return "exporting to ". $part_export->exporttype.
727 " (transaction rolled back): $error";
732 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
739 Checks all fields to make sure this is a valid billing item. If there is an
740 error, returns the error, otherwise returns false. Called by the insert and
748 if ( !$self->locationnum or $self->locationnum == -1 ) {
749 $self->set('locationnum', $self->cust_main->ship_locationnum);
753 $self->ut_numbern('pkgnum')
754 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
755 || $self->ut_numbern('pkgpart')
756 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
757 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
758 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
759 || $self->ut_numbern('quantity')
760 || $self->ut_numbern('start_date')
761 || $self->ut_numbern('setup')
762 || $self->ut_numbern('bill')
763 || $self->ut_numbern('susp')
764 || $self->ut_numbern('cancel')
765 || $self->ut_numbern('adjourn')
766 || $self->ut_numbern('resume')
767 || $self->ut_numbern('expire')
768 || $self->ut_numbern('dundate')
769 || $self->ut_flag('no_auto', [ '', 'Y' ])
770 || $self->ut_flag('waive_setup', [ '', 'Y' ])
771 || $self->ut_flag('separate_bill')
772 || $self->ut_textn('agent_pkgid')
773 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
774 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
775 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
776 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
777 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
779 return $error if $error;
781 return "A package with both start date (future start) and setup date (already started) will never bill"
782 if $self->start_date && $self->setup && ! $upgrade;
784 return "A future unsuspend date can only be set for a package with a suspend date"
785 if $self->resume and !$self->susp and !$self->adjourn;
787 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
794 Check the pkgpart to make sure it's allowed with the reg_code and/or
795 promo_code of the package (if present) and with the customer's agent.
796 Called from C<insert>, unless we are doing a package change that doesn't
804 # my $error = $self->ut_numbern('pkgpart'); # already done
807 if ( $self->reg_code ) {
809 unless ( grep { $self->pkgpart == $_->pkgpart }
810 map { $_->reg_code_pkg }
811 qsearchs( 'reg_code', { 'code' => $self->reg_code,
812 'agentnum' => $self->cust_main->agentnum })
814 return "Unknown registration code";
817 } elsif ( $self->promo_code ) {
820 qsearchs('part_pkg', {
821 'pkgpart' => $self->pkgpart,
822 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
824 return 'Unknown promotional code' unless $promo_part_pkg;
828 unless ( $disable_agentcheck ) {
830 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
831 return "agent ". $agent->agentnum. ':'. $agent->agent.
832 " can't purchase pkgpart ". $self->pkgpart
833 unless $agent->pkgpart_hashref->{ $self->pkgpart }
834 || $agent->agentnum == $self->part_pkg->agentnum;
837 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
838 return $error if $error;
846 =item cancel [ OPTION => VALUE ... ]
848 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
849 in this package, then cancels the package itself (sets the cancel field to
852 Available options are:
856 =item quiet - can be set true to supress email cancellation notices.
858 =item time - can be set to cancel the package based on a specific future or
859 historical date. Using time ensures that the remaining amount is calculated
860 correctly. Note however that this is an immediate cancel and just changes
861 the date. You are PROBABLY looking to expire the account instead of using
864 =item reason - can be set to a cancellation reason (see L<FS:reason>),
865 either a reasonnum of an existing reason, or passing a hashref will create
866 a new reason. The hashref should have the following keys: typenum - Reason
867 type (see L<FS::reason_type>, reason - Text of the new reason.
869 =item date - can be set to a unix style timestamp to specify when to
872 =item nobill - can be set true to skip billing if it might otherwise be done.
874 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
875 not credit it. This must be set (by change()) when changing the package
876 to a different pkgpart or location, and probably shouldn't be in any other
877 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
880 =item no_delay_cancel - prevents delay_cancel behavior
881 no matter what other options say, for use when changing packages (or any
882 other time you're really sure you want an immediate cancel)
886 If there is an error, returns the error, otherwise returns false.
890 #NOT DOCUMENTING - this should only be used when calling recursively
891 #=item delay_cancel - for internal use, to allow proper handling of
892 #supplemental packages when the main package is flagged to suspend
893 #before cancelling, probably shouldn't be used otherwise (set the
894 #corresponding package option instead)
897 my( $self, %options ) = @_;
900 # supplemental packages can now be separately canceled, though the UI
901 # shouldn't permit it
903 ## pass all suspend/cancel actions to the main package
904 ## (unless the pkglinknum has been removed, then the link is defunct and
905 ## this package can be canceled on its own)
906 #if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
907 # return $self->main_pkg->cancel(%options);
910 my $conf = new FS::Conf;
912 warn "cust_pkg::cancel called with options".
913 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
916 my $oldAutoCommit = $FS::UID::AutoCommit;
917 local $FS::UID::AutoCommit = 0;
920 my $old = $self->select_for_update;
922 if ( $old->get('cancel') || $self->get('cancel') ) {
923 dbh->rollback if $oldAutoCommit;
924 return ""; # no error
927 # XXX possibly set cancel_time to the expire date?
928 my $cancel_time = $options{'time'} || time;
929 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
930 $date = '' if ($date && $date <= $cancel_time); # complain instead?
932 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
933 if ( !$date && $self->part_pkg->option('delay_cancel',1)
934 && (($self->status eq 'active') || ($self->status eq 'suspended'))
935 && !$options{'no_delay_cancel'}
937 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
938 my $expsecs = 60*60*24*$expdays;
939 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
940 $expsecs = $expsecs - $suspfor if $suspfor;
941 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
943 $date = $cancel_time + $expsecs;
947 #race condition: usage could be ongoing until unprovisioned
948 #resolved by performing a change package instead (which unprovisions) and
950 if ( !$options{nobill} && !$date ) {
951 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
952 my $copy = $self->new({$self->hash});
954 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
956 'time' => $cancel_time );
957 warn "Error billing during cancel, custnum ".
958 #$self->cust_main->custnum. ": $error"
963 if ( $options{'reason'} ) {
964 $error = $self->insert_reason( 'reason' => $options{'reason'},
965 'action' => $date ? 'expire' : 'cancel',
966 'date' => $date ? $date : $cancel_time,
967 'reason_otaker' => $options{'reason_otaker'},
970 dbh->rollback if $oldAutoCommit;
971 return "Error inserting cust_pkg_reason: $error";
975 my %svc_cancel_opt = ();
976 $svc_cancel_opt{'date'} = $date if $date;
977 foreach my $cust_svc (
980 sort { $a->[1] <=> $b->[1] }
981 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
982 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
984 my $part_svc = $cust_svc->part_svc;
985 next if ( defined($part_svc) and $part_svc->preserve );
986 my $error = $cust_svc->cancel( %svc_cancel_opt );
989 $dbh->rollback if $oldAutoCommit;
990 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
995 # if a reasonnum was passed, get the actual reason object so we can check
999 if ($options{'reason'} =~ /^\d+$/) {
1000 $reason = FS::reason->by_key($options{'reason'});
1004 # credit remaining time if any of these are true:
1005 # - unused_credit => 1 was passed (this happens when canceling a package
1006 # for a package change when unused_credit_change is set)
1007 # - no unused_credit option, and there is a cancel reason, and the cancel
1008 # reason says to credit the package
1009 # - no unused_credit option, and the package definition says to credit the
1010 # package on cancellation
1012 if ( exists($options{'unused_credit'}) ) {
1013 $do_credit = $options{'unused_credit'};
1014 } elsif ( defined($reason) && $reason->unused_credit ) {
1017 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
1020 my $error = $self->credit_remaining('cancel', $cancel_time);
1022 $dbh->rollback if $oldAutoCommit;
1028 my %hash = $self->hash;
1030 $hash{'expire'} = $date;
1031 if ($delay_cancel) {
1032 # just to be sure these are clear
1033 $hash{'adjourn'} = undef;
1034 $hash{'resume'} = undef;
1037 $hash{'cancel'} = $cancel_time;
1039 $hash{'change_custnum'} = $options{'change_custnum'};
1041 # if this is a supplemental package that's lost its part_pkg_link, and it's
1042 # being canceled for real, unlink it completely
1043 if ( !$date and ! $self->pkglinknum ) {
1044 $hash{main_pkgnum} = '';
1047 # if there is a future package change scheduled, unlink from it (like
1048 # abort_change) first, then delete it.
1049 $hash{'change_to_pkgnum'} = '';
1051 # save the package state
1052 my $new = new FS::cust_pkg ( \%hash );
1053 $error = $new->replace( $self, options => { $self->options } );
1055 if ( $self->change_to_pkgnum ) {
1056 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1057 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1060 $dbh->rollback if $oldAutoCommit;
1064 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1065 $error = $supp_pkg->cancel(%options,
1067 'date' => $date, #in case it got changed by delay_cancel
1068 'delay_cancel' => $delay_cancel,
1071 $dbh->rollback if $oldAutoCommit;
1072 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1076 if ($delay_cancel && !$options{'from_main'}) {
1077 $error = $new->suspend(
1079 'time' => $cancel_time
1084 foreach my $usage ( $self->cust_pkg_usage ) {
1085 $error = $usage->delete;
1087 $dbh->rollback if $oldAutoCommit;
1088 return "deleting usage pools: $error";
1093 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1094 return '' if $date; #no errors
1096 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
1097 if ( !$options{'quiet'} &&
1098 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
1100 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1103 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1104 $error = $msg_template->send( 'cust_main' => $self->cust_main,
1105 'object' => $self );
1107 #should this do something on errors?
1114 =item cancel_if_expired [ NOW_TIMESTAMP ]
1116 Cancels this package if its expire date has been reached.
1120 sub cancel_if_expired {
1122 my $time = shift || time;
1123 return '' unless $self->expire && $self->expire <= $time;
1124 my $error = $self->cancel;
1126 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1127 $self->custnum. ": $error";
1132 =item uncancel_svc_x
1134 For cancelled cust_pkg, returns a list of new, uninserted FS::svc_X records
1135 for services that would be inserted by L</uncancel>. Returned objects also
1136 include the field '_uncancel_svcnum' that contains the original svcnum.
1137 Set pkgnum before inserting.
1139 Accepts the following options:
1141 summarize_size - if true, returns empty list if number of potential services is
1142 equal to or greater than this
1144 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1145 (and only if they would otherwise be returned by this)
1149 sub uncancel_svc_x {
1150 my ($self, %opt) = @_;
1152 die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1154 #find historical services within this timeframe before the package cancel
1155 # (incompatible with "time" option to cust_pkg->cancel?)
1156 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1157 # too little? (unprovisioing export delay?)
1158 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1159 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1161 return () if $opt{'summarize_size'} and @h_cust_svc >= $opt{'summarize_size'};
1164 foreach my $h_cust_svc (@h_cust_svc) {
1165 next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1166 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1167 #next unless $h_svc_x; #should this happen?
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 '_uncancel_svcnum' => $h_cust_svc->svcnum,
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:
1216 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1218 Cannot be run from within a transaction. Performs inserts
1219 to test the results, and then rolls back the transaction.
1220 Does not perform exports, so does not catch if export would fail.
1222 Also accepts the following options:
1224 summarize_size - if true, returns empty list if number of potential services is
1225 equal to or greater than this
1229 sub uncancel_svc_summary {
1230 my ($self, %opt) = @_;
1232 die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1233 die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1235 local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1236 local $FS::UID::AutoCommit = 0;
1239 foreach my $svc_x ($self->uncancel_svc_x(%opt)) {
1240 $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1241 my $part_svc = $svc_x->part_svc;
1243 'svcpart' => $part_svc->svcpart,
1244 'svc' => $part_svc->svc,
1245 'uncancel_svcnum' => $svc_x->get('_uncancel_svcnum'),
1247 if ($svc_x->insert) { # if error inserting
1248 $out->{'label'} = "(cannot re-provision)";
1249 $out->{'reprovisionable'} = 0;
1251 $out->{'label'} = $svc_x->label;
1252 $out->{'reprovisionable'} = 1;
1263 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1264 locationnum, (other fields?). Attempts to re-provision cancelled services
1265 using history information (errors at this stage are not fatal).
1267 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1269 svc_fatal: service provisioning errors are fatal
1271 svc_errors: pass an array reference, will be filled in with any provisioning errors
1273 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1275 main_pkgnum: link the package as a supplemental package of this one. For
1281 my( $self, %options ) = @_;
1283 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1284 return '' unless $self->get('cancel');
1286 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1287 return $self->main_pkg->uncancel(%options);
1294 my $oldAutoCommit = $FS::UID::AutoCommit;
1295 local $FS::UID::AutoCommit = 0;
1299 # insert the new package
1302 my $cust_pkg = new FS::cust_pkg {
1303 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1304 bill => ( $options{'bill'} || $self->get('bill') ),
1306 uncancel_pkgnum => $self->pkgnum,
1307 main_pkgnum => ($options{'main_pkgnum'} || ''),
1308 map { $_ => $self->get($_) } qw(
1309 custnum pkgpart locationnum
1311 susp adjourn resume expire start_date contract_end dundate
1312 change_date change_pkgpart change_locationnum
1313 no_auto separate_bill quantity agent_pkgid
1314 recur_show_zero setup_show_zero
1318 my $error = $cust_pkg->insert(
1319 'change' => 1, #supresses any referral credit to a referring customer
1320 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1323 $dbh->rollback if $oldAutoCommit;
1332 foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1334 $svc_x->pkgnum($cust_pkg->pkgnum);
1335 my $svc_error = $svc_x->insert;
1338 if ( $options{svc_fatal} ) {
1339 $dbh->rollback if $oldAutoCommit;
1342 # if we've failed to insert the svc_x object, svc_Common->insert
1343 # will have removed the cust_svc already. if not, then both records
1344 # were inserted but we failed for some other reason (export, most
1345 # likely). in that case, report the error and delete the records.
1346 push @svc_errors, $svc_error;
1347 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1349 # except if export_insert failed, export_delete probably won't be
1351 local $FS::svc_Common::noexport_hack = 1;
1352 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1353 if ( $cleanup_error ) { # and if THAT fails, then run away
1354 $dbh->rollback if $oldAutoCommit;
1355 return $cleanup_error;
1360 } #foreach uncancel_svc_x
1363 # also move over any services that didn't unprovision at cancellation
1366 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1367 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1368 my $error = $cust_svc->replace;
1370 $dbh->rollback if $oldAutoCommit;
1376 # Uncancel any supplemental packages, and make them supplemental to the
1380 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1382 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1384 $dbh->rollback if $oldAutoCommit;
1385 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1393 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1395 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1396 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1403 Cancels any pending expiration (sets the expire field to null).
1405 If there is an error, returns the error, otherwise returns false.
1410 my( $self, %options ) = @_;
1413 my $oldAutoCommit = $FS::UID::AutoCommit;
1414 local $FS::UID::AutoCommit = 0;
1417 my $old = $self->select_for_update;
1419 my $pkgnum = $old->pkgnum;
1420 if ( $old->get('cancel') || $self->get('cancel') ) {
1421 dbh->rollback if $oldAutoCommit;
1422 return "Can't unexpire cancelled package $pkgnum";
1423 # or at least it's pointless
1426 unless ( $old->get('expire') && $self->get('expire') ) {
1427 dbh->rollback if $oldAutoCommit;
1428 return ""; # no error
1431 my %hash = $self->hash;
1432 $hash{'expire'} = '';
1433 my $new = new FS::cust_pkg ( \%hash );
1434 $error = $new->replace( $self, options => { $self->options } );
1436 $dbh->rollback if $oldAutoCommit;
1440 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1446 =item suspend [ OPTION => VALUE ... ]
1448 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1449 package, then suspends the package itself (sets the susp field to now).
1451 Available options are:
1455 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1456 either a reasonnum of an existing reason, or passing a hashref will create
1457 a new reason. The hashref should have the following keys:
1458 - typenum - Reason type (see L<FS::reason_type>
1459 - reason - Text of the new reason.
1461 =item date - can be set to a unix style timestamp to specify when to
1464 =item time - can be set to override the current time, for calculation
1465 of final invoices or unused-time credits
1467 =item resume_date - can be set to a time when the package should be
1468 unsuspended. This may be more convenient than calling C<unsuspend()>
1471 =item from_main - allows a supplemental package to be suspended, rather
1472 than redirecting the method call to its main package. For internal use.
1474 =item from_cancel - used when suspending from the cancel method, forces
1475 this to skip everything besides basic suspension. For internal use.
1479 If there is an error, returns the error, otherwise returns false.
1484 my( $self, %options ) = @_;
1487 # supplemental packages still can't be separately suspended, but silently
1488 # exit instead of failing or passing the action to the main package (so
1489 # that the "Suspend customer" action doesn't trip over the supplemental
1492 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1496 my $oldAutoCommit = $FS::UID::AutoCommit;
1497 local $FS::UID::AutoCommit = 0;
1500 my $old = $self->select_for_update;
1502 my $pkgnum = $old->pkgnum;
1503 if ( $old->get('cancel') || $self->get('cancel') ) {
1504 dbh->rollback if $oldAutoCommit;
1505 return "Can't suspend cancelled package $pkgnum";
1508 if ( $old->get('susp') || $self->get('susp') ) {
1509 dbh->rollback if $oldAutoCommit;
1510 return ""; # no error # complain on adjourn?
1513 my $suspend_time = $options{'time'} || time;
1514 my $date = $options{date} if $options{date}; # adjourn/suspend later
1515 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1517 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1518 dbh->rollback if $oldAutoCommit;
1519 return "Package $pkgnum expires before it would be suspended.";
1522 # some false laziness with sub cancel
1523 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1524 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1525 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1526 # make the entire cust_main->bill path recognize 'suspend' and
1527 # 'cancel' separately.
1528 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1529 my $copy = $self->new({$self->hash});
1531 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1533 'time' => $suspend_time );
1534 warn "Error billing during suspend, custnum ".
1535 #$self->cust_main->custnum. ": $error"
1540 my $cust_pkg_reason;
1541 if ( $options{'reason'} ) {
1542 $error = $self->insert_reason( 'reason' => $options{'reason'},
1543 'action' => $date ? 'adjourn' : 'suspend',
1544 'date' => $date ? $date : $suspend_time,
1545 'reason_otaker' => $options{'reason_otaker'},
1548 dbh->rollback if $oldAutoCommit;
1549 return "Error inserting cust_pkg_reason: $error";
1551 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1552 'date' => $date ? $date : $suspend_time,
1553 'action' => $date ? 'A' : 'S',
1554 'pkgnum' => $self->pkgnum,
1558 # if a reasonnum was passed, get the actual reason object so we can check
1560 # (passing a reason hashref is still allowed, but it can't be used with
1561 # the fancy behavioral options.)
1564 if ($options{'reason'} =~ /^\d+$/) {
1565 $reason = FS::reason->by_key($options{'reason'});
1568 my %hash = $self->hash;
1570 $hash{'adjourn'} = $date;
1572 $hash{'susp'} = $suspend_time;
1575 my $resume_date = $options{'resume_date'} || 0;
1576 if ( $resume_date > ($date || $suspend_time) ) {
1577 $hash{'resume'} = $resume_date;
1580 $options{options} ||= {};
1582 my $new = new FS::cust_pkg ( \%hash );
1583 $error = $new->replace( $self, options => { $self->options,
1584 %{ $options{options} },
1588 $dbh->rollback if $oldAutoCommit;
1592 unless ( $date ) { # then we are suspending now
1594 unless ($options{'from_cancel'}) {
1595 # credit remaining time if appropriate
1596 # (if required by the package def, or the suspend reason)
1597 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1598 || ( defined($reason) && $reason->unused_credit );
1600 if ( $unused_credit ) {
1601 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1602 my $error = $self->credit_remaining('suspend', $suspend_time);
1604 $dbh->rollback if $oldAutoCommit;
1610 my @cust_svc = qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
1612 #attempt ordering ala cust_svc_suspend_cascade (without infinite-looping
1613 # on the circular dep case)
1614 # (this is too simple for multi-level deps, we need to use something
1615 # to resolve the DAG properly when possible)
1617 $svcpart{$_->svcpart} = 0 foreach @cust_svc;
1618 foreach my $svcpart ( keys %svcpart ) {
1619 foreach my $part_svc_link (
1620 FS::part_svc_link->by_agentnum($self->cust_main->agentnum,
1621 src_svcpart => $svcpart,
1622 link_type => 'cust_svc_suspend_cascade'
1625 $svcpart{$part_svc_link->dst_svcpart} = max(
1626 $svcpart{$part_svc_link->dst_svcpart},
1627 $svcpart{$part_svc_link->src_svcpart} + 1
1631 @cust_svc = sort { $svcpart{ $a->svcpart } <=> $svcpart{ $b->svcpart } }
1635 foreach my $cust_svc ( @cust_svc ) {
1636 $cust_svc->suspend( 'labels_arrayref' => \@labels );
1639 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1640 # and this is not a suspend-before-cancel
1641 if ( $cust_pkg_reason ) {
1642 my $reason_obj = $cust_pkg_reason->reason;
1643 if ( $reason_obj->feepart and
1644 ! $reason_obj->fee_on_unsuspend and
1645 ! $options{'from_cancel'} ) {
1647 # register the need to charge a fee, cust_main->bill will do the rest
1648 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1650 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1651 'pkgreasonnum' => $cust_pkg_reason->num,
1652 'pkgnum' => $self->pkgnum,
1653 'feepart' => $reason->feepart,
1654 'nextbill' => $reason->fee_hold,
1656 $error ||= $cust_pkg_reason_fee->insert;
1660 my $conf = new FS::Conf;
1661 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1663 my $error = send_email(
1664 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1665 #invoice_from ??? well as good as any
1666 'to' => $conf->config('suspend_email_admin'),
1667 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1669 "This is an automatic message from your Freeside installation\n",
1670 "informing you that the following customer package has been suspended:\n",
1672 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1673 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1674 ( map { "Service : $_\n" } @labels ),
1676 'custnum' => $self->custnum,
1677 'msgtype' => 'admin'
1681 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1689 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1690 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1692 $dbh->rollback if $oldAutoCommit;
1693 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1697 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1702 =item credit_remaining MODE TIME
1704 Generate a credit for this package for the time remaining in the current
1705 billing period. MODE is either "suspend" or "cancel" (determines the
1706 credit type). TIME is the time of suspension/cancellation. Both arguments
1711 # Implementation note:
1713 # If you pkgpart-change a package that has been billed, and it's set to give
1714 # credit on package change, then this method gets called and then the new
1715 # package will have no last_bill date. Therefore the customer will be credited
1716 # only once (per billing period) even if there are multiple package changes.
1718 # If you location-change a package that has been billed, this method will NOT
1719 # be called and the new package WILL have the last bill date of the old
1722 # If the new package is then canceled within the same billing cycle,
1723 # credit_remaining needs to run calc_remain on the OLD package to determine
1724 # the amount of unused time to credit.
1726 sub credit_remaining {
1727 # Add a credit for remaining service
1728 my ($self, $mode, $time) = @_;
1729 die 'credit_remaining requires suspend or cancel'
1730 unless $mode eq 'suspend' or $mode eq 'cancel';
1731 die 'no suspend/cancel time' unless $time > 0;
1733 my $conf = FS::Conf->new;
1734 my $reason_type = $conf->config($mode.'_credit_type');
1736 my $last_bill = $self->getfield('last_bill') || 0;
1737 my $next_bill = $self->getfield('bill') || 0;
1738 if ( $last_bill > 0 # the package has been billed
1739 and $next_bill > 0 # the package has a next bill date
1740 and $next_bill >= $time # which is in the future
1742 my @cust_credit_source_bill_pkg = ();
1743 my $remaining_value = 0;
1745 my $remain_pkg = $self;
1746 $remaining_value = $remain_pkg->calc_remain(
1748 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1751 # we may have to walk back past some package changes to get to the
1752 # one that actually has unused time
1753 while ( $remaining_value == 0 ) {
1754 if ( $remain_pkg->change_pkgnum ) {
1755 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1757 # the package has really never been billed
1760 $remaining_value = $remain_pkg->calc_remain(
1762 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1766 if ( $remaining_value > 0 ) {
1767 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1769 my $error = $self->cust_main->credit(
1771 'Credit for unused time on '. $self->part_pkg->pkg,
1772 'reason_type' => $reason_type,
1773 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1775 return "Error crediting customer \$$remaining_value for unused time".
1776 " on ". $self->part_pkg->pkg. ": $error"
1778 } #if $remaining_value
1779 } #if $last_bill, etc.
1783 =item unsuspend [ OPTION => VALUE ... ]
1785 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1786 package, then unsuspends the package itself (clears the susp field and the
1787 adjourn field if it is in the past). If the suspend reason includes an
1788 unsuspension package, that package will be ordered.
1790 Available options are:
1796 Can be set to a date to unsuspend the package in the future (the 'resume'
1799 =item adjust_next_bill
1801 Can be set true to adjust the next bill date forward by
1802 the amount of time the account was inactive. This was set true by default
1803 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1804 explicitly requested with this option or in the price plan.
1808 If there is an error, returns the error, otherwise returns false.
1813 my( $self, %opt ) = @_;
1816 # pass all suspend/cancel actions to the main package
1817 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1818 return $self->main_pkg->unsuspend(%opt);
1821 my $oldAutoCommit = $FS::UID::AutoCommit;
1822 local $FS::UID::AutoCommit = 0;
1825 my $old = $self->select_for_update;
1827 my $pkgnum = $old->pkgnum;
1828 if ( $old->get('cancel') || $self->get('cancel') ) {
1829 $dbh->rollback if $oldAutoCommit;
1830 return "Can't unsuspend cancelled package $pkgnum";
1833 unless ( $old->get('susp') && $self->get('susp') ) {
1834 $dbh->rollback if $oldAutoCommit;
1835 return ""; # no error # complain instead?
1838 # handle the case of setting a future unsuspend (resume) date
1839 # and do not continue to actually unsuspend the package
1840 my $date = $opt{'date'};
1841 if ( $date and $date > time ) { # return an error if $date <= time?
1843 if ( $old->get('expire') && $old->get('expire') < $date ) {
1844 $dbh->rollback if $oldAutoCommit;
1845 return "Package $pkgnum expires before it would be unsuspended.";
1848 my $new = new FS::cust_pkg { $self->hash };
1849 $new->set('resume', $date);
1850 $error = $new->replace($self, options => $self->options);
1853 $dbh->rollback if $oldAutoCommit;
1857 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1863 if (!$self->setup) {
1864 # then this package is being released from on-hold status
1865 $error = $self->set_initial_timers;
1867 $dbh->rollback if $oldAutoCommit;
1874 foreach my $cust_svc (
1875 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1877 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1879 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1880 $dbh->rollback if $oldAutoCommit;
1881 return "Illegal svcdb value in part_svc!";
1884 require "FS/$svcdb.pm";
1886 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1888 $error = $svc->unsuspend;
1890 $dbh->rollback if $oldAutoCommit;
1893 my( $label, $value ) = $cust_svc->label;
1894 push @labels, "$label: $value";
1899 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1900 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1902 my %hash = $self->hash;
1903 my $inactive = time - $hash{'susp'};
1905 my $conf = new FS::Conf;
1907 #adjust the next bill date forward
1908 # increment next bill date if certain conditions are met:
1909 # - it was due to be billed at some point
1910 # - either the global or local config says to do this
1911 my $adjust_bill = 0;
1914 && ( $hash{'bill'} || $hash{'setup'} )
1915 && ( $opt{'adjust_next_bill'}
1916 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1917 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1924 # - the package billed during suspension
1925 # - or it was ordered on hold
1926 # - or the customer was credited for the unused time
1928 if ( $self->option('suspend_bill',1)
1929 or ( $self->part_pkg->option('suspend_bill',1)
1930 and ! $self->option('no_suspend_bill',1)
1932 or $hash{'order_date'} == $hash{'susp'}
1937 if ( $adjust_bill ) {
1938 if ( $self->part_pkg->option('unused_credit_suspend')
1939 or ( ref($reason) and $reason->unused_credit ) ) {
1940 # then the customer was credited for the unused time before suspending,
1941 # so their next bill should be immediate
1942 $hash{'bill'} = time;
1944 # add the length of time suspended to the bill date
1945 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1950 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1951 $hash{'resume'} = '' if !$hash{'adjourn'};
1952 my $new = new FS::cust_pkg ( \%hash );
1953 $error = $new->replace( $self, options => { $self->options } );
1955 $dbh->rollback if $oldAutoCommit;
1962 if ( $reason->unsuspend_pkgpart ) {
1963 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
1964 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1965 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1967 my $start_date = $self->cust_main->next_bill_date
1968 if $reason->unsuspend_hold;
1971 $unsusp_pkg = FS::cust_pkg->new({
1972 'custnum' => $self->custnum,
1973 'pkgpart' => $reason->unsuspend_pkgpart,
1974 'start_date' => $start_date,
1975 'locationnum' => $self->locationnum,
1976 # discount? probably not...
1979 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1982 # new way, using fees
1983 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1984 # register the need to charge a fee, cust_main->bill will do the rest
1985 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1987 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1988 'pkgreasonnum' => $cust_pkg_reason->num,
1989 'pkgnum' => $self->pkgnum,
1990 'feepart' => $reason->feepart,
1991 'nextbill' => $reason->fee_hold,
1993 $error ||= $cust_pkg_reason_fee->insert;
1997 $dbh->rollback if $oldAutoCommit;
2002 if ( $conf->config('unsuspend_email_admin') ) {
2004 my $error = send_email(
2005 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2006 #invoice_from ??? well as good as any
2007 'to' => $conf->config('unsuspend_email_admin'),
2008 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2009 "This is an automatic message from your Freeside installation\n",
2010 "informing you that the following customer package has been unsuspended:\n",
2012 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2013 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2014 ( map { "Service : $_\n" } @labels ),
2016 "An unsuspension fee was charged: ".
2017 $unsusp_pkg->part_pkg->pkg_comment."\n"
2021 'custnum' => $self->custnum,
2022 'msgtype' => 'admin',
2026 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2032 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2033 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2035 $dbh->rollback if $oldAutoCommit;
2036 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2040 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2047 Cancels any pending suspension (sets the adjourn field to null).
2049 If there is an error, returns the error, otherwise returns false.
2054 my( $self, %options ) = @_;
2057 my $oldAutoCommit = $FS::UID::AutoCommit;
2058 local $FS::UID::AutoCommit = 0;
2061 my $old = $self->select_for_update;
2063 my $pkgnum = $old->pkgnum;
2064 if ( $old->get('cancel') || $self->get('cancel') ) {
2065 dbh->rollback if $oldAutoCommit;
2066 return "Can't unadjourn cancelled package $pkgnum";
2067 # or at least it's pointless
2070 if ( $old->get('susp') || $self->get('susp') ) {
2071 dbh->rollback if $oldAutoCommit;
2072 return "Can't unadjourn suspended package $pkgnum";
2073 # perhaps this is arbitrary
2076 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2077 dbh->rollback if $oldAutoCommit;
2078 return ""; # no error
2081 my %hash = $self->hash;
2082 $hash{'adjourn'} = '';
2083 $hash{'resume'} = '';
2084 my $new = new FS::cust_pkg ( \%hash );
2085 $error = $new->replace( $self, options => { $self->options } );
2087 $dbh->rollback if $oldAutoCommit;
2091 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2098 =item change HASHREF | OPTION => VALUE ...
2100 Changes this package: cancels it and creates a new one, with a different
2101 pkgpart or locationnum or both. All services are transferred to the new
2102 package (no change will be made if this is not possible).
2104 Options may be passed as a list of key/value pairs or as a hash reference.
2111 New locationnum, to change the location for this package.
2115 New FS::cust_location object, to create a new location and assign it
2120 New FS::cust_main object, to create a new customer and assign the new package
2125 New pkgpart (see L<FS::part_pkg>).
2129 New refnum (see L<FS::part_referral>).
2133 New quantity; if unspecified, the new package will have the same quantity
2138 "New" (existing) FS::cust_pkg object. The package's services and other
2139 attributes will be transferred to this package.
2143 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2144 susp, adjourn, cancel, expire, and contract_end) to the new package.
2146 =item unprotect_svcs
2148 Normally, change() will rollback and return an error if some services
2149 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2150 If unprotect_svcs is true, this method will transfer as many services as
2151 it can and then unconditionally cancel the old package.
2155 If specified, sets this value for the contract_end date on the new package
2156 (without regard for keep_dates or the usual date-preservation behavior.)
2157 Will throw an error if defined but false; the UI doesn't allow editing
2158 this unless it already exists, making removal impossible to undo.
2162 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2163 cust_pkg must be specified (otherwise, what's the point?)
2165 Returns either the new FS::cust_pkg object or a scalar error.
2169 my $err_or_new_cust_pkg = $old_cust_pkg->change
2173 #used by change and change_later
2174 #didn't put with documented check methods because it depends on change-specific opts
2175 #and it also possibly edits the value of opts
2179 if ( defined($opt->{'contract_end'}) ) {
2180 my $current_contract_end = $self->get('contract_end');
2181 unless ($opt->{'contract_end'}) {
2182 if ($current_contract_end) {
2183 return "Cannot remove contract end date when changing packages";
2185 #shouldn't even pass this option if there's not a current value
2186 #but can be handled gracefully if the option is empty
2187 warn "Contract end date passed unexpectedly";
2188 delete $opt->{'contract_end'};
2192 unless ($current_contract_end) {
2193 #option shouldn't be passed, throw error if it's non-empty
2194 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2200 #some false laziness w/order
2203 my $opt = ref($_[0]) ? shift : { @_ };
2205 my $conf = new FS::Conf;
2207 # handle contract_end on cust_pkg same as passed option
2208 if ( $opt->{'cust_pkg'} ) {
2209 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2210 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2213 # check contract_end, prevent adding/removing
2214 my $error = $self->_check_change($opt);
2215 return $error if $error;
2217 # Transactionize this whole mess
2218 my $oldAutoCommit = $FS::UID::AutoCommit;
2219 local $FS::UID::AutoCommit = 0;
2222 if ( $opt->{'cust_location'} ) {
2223 $error = $opt->{'cust_location'}->find_or_insert;
2225 $dbh->rollback if $oldAutoCommit;
2226 return "creating location record: $error";
2228 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2231 # Before going any further here: if the package is still in the pre-setup
2232 # state, it's safe to modify it in place. No need to charge/credit for
2233 # partial period, transfer services, transfer usage pools, copy invoice
2234 # details, or change any dates.
2235 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2236 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2237 if ( length($opt->{$_}) ) {
2238 $self->set($_, $opt->{$_});
2241 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2243 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2244 $error ||= $self->set_initial_timers;
2246 # but if contract_end was explicitly specified, that overrides all else
2247 $self->set('contract_end', $opt->{'contract_end'})
2248 if $opt->{'contract_end'};
2249 $error ||= $self->replace;
2251 $dbh->rollback if $oldAutoCommit;
2252 return "modifying package: $error";
2254 $dbh->commit if $oldAutoCommit;
2263 $hash{'setup'} = $time if $self->get('setup');
2265 $hash{'change_date'} = $time;
2266 $hash{"change_$_"} = $self->$_()
2267 foreach qw( pkgnum pkgpart locationnum );
2269 if ( $opt->{'cust_pkg'} ) {
2270 # treat changing to a package with a different pkgpart as a
2271 # pkgpart change (because it is)
2272 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2275 # whether to override pkgpart checking on the new package
2276 my $same_pkgpart = 1;
2277 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2281 my $unused_credit = 0;
2282 my $keep_dates = $opt->{'keep_dates'};
2284 # Special case. If the pkgpart is changing, and the customer is going to be
2285 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2286 # and DO pass the flag to cancel() to credit the customer. If the old
2287 # package had a setup date, set the new package's setup to the package
2288 # change date so that it has the same status as before.
2289 if ( $opt->{'pkgpart'}
2290 and $opt->{'pkgpart'} != $self->pkgpart
2291 and $self->part_pkg->option('unused_credit_change', 1) ) {
2294 $hash{'last_bill'} = '';
2298 if ( $keep_dates ) {
2299 foreach my $date ( qw(setup bill last_bill) ) {
2300 $hash{$date} = $self->getfield($date);
2303 # always keep the following dates
2304 foreach my $date (qw(order_date susp adjourn cancel expire resume
2305 start_date contract_end)) {
2306 $hash{$date} = $self->getfield($date);
2308 # but if contract_end was explicitly specified, that overrides all else
2309 $hash{'contract_end'} = $opt->{'contract_end'}
2310 if $opt->{'contract_end'};
2312 # allow $opt->{'locationnum'} = '' to specifically set it to null
2313 # (i.e. customer default location)
2314 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2316 # usually this doesn't matter. the two cases where it does are:
2317 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2319 # 2. (more importantly) changing a package before it's billed
2320 $hash{'waive_setup'} = $self->waive_setup;
2322 # if this package is scheduled for a future package change, preserve that
2323 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2325 my $custnum = $self->custnum;
2326 if ( $opt->{cust_main} ) {
2327 my $cust_main = $opt->{cust_main};
2328 unless ( $cust_main->custnum ) {
2329 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2331 $dbh->rollback if $oldAutoCommit;
2332 return "inserting customer record: $error";
2335 $custnum = $cust_main->custnum;
2338 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2341 if ( $opt->{'cust_pkg'} ) {
2342 # The target package already exists; update it to show that it was
2343 # changed from this package.
2344 $cust_pkg = $opt->{'cust_pkg'};
2346 # follow all the above rules for date changes, etc.
2347 foreach (keys %hash) {
2348 $cust_pkg->set($_, $hash{$_});
2350 # except those that implement the future package change behavior
2351 foreach (qw(change_to_pkgnum start_date expire)) {
2352 $cust_pkg->set($_, '');
2355 $error = $cust_pkg->replace;
2358 # Create the new package.
2359 $cust_pkg = new FS::cust_pkg {
2360 custnum => $custnum,
2361 locationnum => $opt->{'locationnum'},
2362 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2363 qw( pkgpart quantity refnum salesnum )
2367 $error = $cust_pkg->insert( 'change' => 1,
2368 'allow_pkgpart' => $same_pkgpart );
2371 $dbh->rollback if $oldAutoCommit;
2372 return "inserting new package: $error";
2375 # Transfer services and cancel old package.
2376 # Enforce service limits only if this is a pkgpart change.
2377 local $FS::cust_svc::ignore_quantity;
2378 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2379 $error = $self->transfer($cust_pkg);
2380 if ($error and $error == 0) {
2381 # $old_pkg->transfer failed.
2382 $dbh->rollback if $oldAutoCommit;
2383 return "transferring $error";
2386 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2387 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2388 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2389 if ($error and $error == 0) {
2390 # $old_pkg->transfer failed.
2391 $dbh->rollback if $oldAutoCommit;
2392 return "converting $error";
2396 # We set unprotect_svcs when executing a "future package change". It's
2397 # not a user-interactive operation, so returning an error means the
2398 # package change will just fail. Rather than have that happen, we'll
2399 # let leftover services be deleted.
2400 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2401 # Transfers were successful, but we still had services left on the old
2402 # package. We can't change the package under this circumstances, so abort.
2403 $dbh->rollback if $oldAutoCommit;
2404 return "unable to transfer all services";
2407 #reset usage if changing pkgpart
2408 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2409 if ($self->pkgpart != $cust_pkg->pkgpart) {
2410 my $part_pkg = $cust_pkg->part_pkg;
2411 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2415 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2418 $dbh->rollback if $oldAutoCommit;
2419 return "setting usage values: $error";
2422 # if NOT changing pkgpart, transfer any usage pools over
2423 foreach my $usage ($self->cust_pkg_usage) {
2424 $usage->set('pkgnum', $cust_pkg->pkgnum);
2425 $error = $usage->replace;
2427 $dbh->rollback if $oldAutoCommit;
2428 return "transferring usage pools: $error";
2433 # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2434 if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2435 my @old_cust_pkg_usageprice;
2436 if ($opt->{'cust_pkg_usageprice'}) {
2437 @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2439 @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2441 foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2442 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2443 'pkgnum' => $cust_pkg->pkgnum,
2444 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2445 'quantity' => $old_cust_pkg_usageprice->quantity,
2447 $error = $new_cust_pkg_usageprice->insert;
2449 $dbh->rollback if $oldAutoCommit;
2450 return "Error transferring usage pricing add-on: $error";
2455 # transfer discounts, if we're not changing pkgpart
2456 if ( $same_pkgpart ) {
2457 foreach my $old_discount ($self->cust_pkg_discount_active) {
2458 # don't remove the old discount, we may still need to bill that package.
2459 my $new_discount = new FS::cust_pkg_discount {
2460 'pkgnum' => $cust_pkg->pkgnum,
2461 'discountnum' => $old_discount->discountnum,
2462 'months_used' => $old_discount->months_used,
2464 $error = $new_discount->insert;
2466 $dbh->rollback if $oldAutoCommit;
2467 return "transferring discounts: $error";
2472 # transfer (copy) invoice details
2473 foreach my $detail ($self->cust_pkg_detail) {
2474 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2475 $new_detail->set('pkgdetailnum', '');
2476 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2477 $error = $new_detail->insert;
2479 $dbh->rollback if $oldAutoCommit;
2480 return "transferring package notes: $error";
2486 if ( !$opt->{'cust_pkg'} ) {
2487 # Order any supplemental packages.
2488 my $part_pkg = $cust_pkg->part_pkg;
2489 my @old_supp_pkgs = $self->supplemental_pkgs;
2490 foreach my $link ($part_pkg->supp_part_pkg_link) {
2492 foreach (@old_supp_pkgs) {
2493 if ($_->pkgpart == $link->dst_pkgpart) {
2495 $_->pkgpart(0); # so that it can't match more than once
2499 # false laziness with FS::cust_main::Packages::order_pkg
2500 my $new = FS::cust_pkg->new({
2501 pkgpart => $link->dst_pkgpart,
2502 pkglinknum => $link->pkglinknum,
2503 custnum => $custnum,
2504 main_pkgnum => $cust_pkg->pkgnum,
2505 locationnum => $cust_pkg->locationnum,
2506 start_date => $cust_pkg->start_date,
2507 order_date => $cust_pkg->order_date,
2508 expire => $cust_pkg->expire,
2509 adjourn => $cust_pkg->adjourn,
2510 contract_end => $cust_pkg->contract_end,
2511 refnum => $cust_pkg->refnum,
2512 discountnum => $cust_pkg->discountnum,
2513 waive_setup => $cust_pkg->waive_setup,
2515 if ( $old and $opt->{'keep_dates'} ) {
2516 foreach (qw(setup bill last_bill)) {
2517 $new->set($_, $old->get($_));
2520 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2523 $error ||= $old->transfer($new);
2525 if ( $error and $error > 0 ) {
2526 # no reason why this should ever fail, but still...
2527 $error = "Unable to transfer all services from supplemental package ".
2531 $dbh->rollback if $oldAutoCommit;
2534 push @new_supp_pkgs, $new;
2536 } # if !$opt->{'cust_pkg'}
2537 # because if there is one, then supplemental packages would already
2538 # have been created for it.
2540 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2542 #Don't allow billing the package (preceding period packages and/or
2543 #outstanding usage) if we are keeping dates (i.e. location changing),
2544 #because the new package will be billed for the same date range.
2545 #Supplemental packages are also canceled here.
2547 # during scheduled changes, avoid canceling the package we just
2549 $self->set('change_to_pkgnum' => '');
2551 $error = $self->cancel(
2553 unused_credit => $unused_credit,
2554 nobill => $keep_dates,
2555 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2556 no_delay_cancel => 1,
2559 $dbh->rollback if $oldAutoCommit;
2560 return "canceling old package: $error";
2563 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2565 my $error = $cust_pkg->cust_main->bill(
2566 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2569 $dbh->rollback if $oldAutoCommit;
2570 return "billing new package: $error";
2574 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2580 =item change_later OPTION => VALUE...
2582 Schedule a package change for a later date. This actually orders the new
2583 package immediately, but sets its start date for a future date, and sets
2584 the current package to expire on the same date.
2586 If the package is already scheduled for a change, this can be called with
2587 'start_date' to change the scheduled date, or with pkgpart and/or
2588 locationnum to modify the package change. To cancel the scheduled change
2589 entirely, see C<abort_change>.
2597 The date for the package change. Required, and must be in the future.
2607 The pkgpart, locationnum, quantity and optional contract_end of the new
2608 package, with the same meaning as in C<change>.
2616 my $opt = ref($_[0]) ? shift : { @_ };
2618 # check contract_end, prevent adding/removing
2619 my $error = $self->_check_change($opt);
2620 return $error if $error;
2622 my $oldAutoCommit = $FS::UID::AutoCommit;
2623 local $FS::UID::AutoCommit = 0;
2626 my $cust_main = $self->cust_main;
2628 my $date = delete $opt->{'start_date'} or return 'start_date required';
2630 if ( $date <= time ) {
2631 $dbh->rollback if $oldAutoCommit;
2632 return "start_date $date is in the past";
2635 # If the user entered a new location, set it up now.
2636 if ( $opt->{'cust_location'} ) {
2637 $error = $opt->{'cust_location'}->find_or_insert;
2639 $dbh->rollback if $oldAutoCommit;
2640 return "creating location record: $error";
2642 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2645 if ( $self->change_to_pkgnum ) {
2646 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2647 my $new_pkgpart = $opt->{'pkgpart'}
2648 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2649 my $new_locationnum = $opt->{'locationnum'}
2650 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2651 my $new_quantity = $opt->{'quantity'}
2652 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2653 my $new_contract_end = $opt->{'contract_end'}
2654 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2655 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2656 # it hasn't been billed yet, so in principle we could just edit
2657 # it in place (w/o a package change), but that's bad form.
2658 # So change the package according to the new options...
2659 my $err_or_pkg = $change_to->change(%$opt);
2660 if ( ref $err_or_pkg ) {
2661 # Then set that package up for a future start.
2662 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2663 $self->set('expire', $date); # in case it's different
2664 $err_or_pkg->set('start_date', $date);
2665 $err_or_pkg->set('change_date', '');
2666 $err_or_pkg->set('change_pkgnum', '');
2668 $error = $self->replace ||
2669 $err_or_pkg->replace ||
2670 #because change() might've edited existing scheduled change in place
2671 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2672 $change_to->cancel('no_delay_cancel' => 1) ||
2673 $change_to->delete);
2675 $error = $err_or_pkg;
2677 } else { # change the start date only.
2678 $self->set('expire', $date);
2679 $change_to->set('start_date', $date);
2680 $error = $self->replace || $change_to->replace;
2683 $dbh->rollback if $oldAutoCommit;
2686 $dbh->commit if $oldAutoCommit;
2689 } # if $self->change_to_pkgnum
2691 my $new_pkgpart = $opt->{'pkgpart'}
2692 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2693 my $new_locationnum = $opt->{'locationnum'}
2694 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2695 my $new_quantity = $opt->{'quantity'}
2696 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2697 my $new_contract_end = $opt->{'contract_end'}
2698 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2700 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2702 # allow $opt->{'locationnum'} = '' to specifically set it to null
2703 # (i.e. customer default location)
2704 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2706 my $new = FS::cust_pkg->new( {
2707 custnum => $self->custnum,
2708 locationnum => $opt->{'locationnum'},
2709 start_date => $date,
2710 map { $_ => ( $opt->{$_} || $self->$_() ) }
2711 qw( pkgpart quantity refnum salesnum contract_end )
2713 $error = $new->insert('change' => 1,
2714 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2716 $self->set('change_to_pkgnum', $new->pkgnum);
2717 $self->set('expire', $date);
2718 $error = $self->replace;
2721 $dbh->rollback if $oldAutoCommit;
2723 $dbh->commit if $oldAutoCommit;
2731 Cancels a future package change scheduled by C<change_later>.
2737 my $oldAutoCommit = $FS::UID::AutoCommit;
2738 local $FS::UID::AutoCommit = 0;
2740 my $pkgnum = $self->change_to_pkgnum;
2741 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2743 $self->set('change_to_pkgnum', '');
2744 $self->set('expire', '');
2745 $error = $self->replace;
2747 $error ||= $change_to->cancel || $change_to->delete;
2750 if ( $oldAutoCommit ) {
2761 =item set_quantity QUANTITY
2763 Change the package's quantity field. This is one of the few package properties
2764 that can safely be changed without canceling and reordering the package
2765 (because it doesn't affect tax eligibility). Returns an error or an
2772 $self = $self->replace_old; # just to make sure
2773 $self->quantity(shift);
2777 =item set_salesnum SALESNUM
2779 Change the package's salesnum (sales person) field. This is one of the few
2780 package properties that can safely be changed without canceling and reordering
2781 the package (because it doesn't affect tax eligibility). Returns an error or
2788 $self = $self->replace_old; # just to make sure
2789 $self->salesnum(shift);
2791 # XXX this should probably reassign any credit that's already been given
2794 =item modify_charge OPTIONS
2796 Change the properties of a one-time charge. The following properties can
2797 be changed this way:
2798 - pkg: the package description
2799 - classnum: the package class
2800 - additional: arrayref of additional invoice details to add to this package
2802 and, I<if the charge has not yet been billed>:
2803 - start_date: the date when it will be billed
2804 - amount: the setup fee to be charged
2805 - quantity: the multiplier for the setup fee
2806 - separate_bill: whether to put the charge on a separate invoice
2808 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2809 commission credits linked to this charge, they will be recalculated.
2816 my $part_pkg = $self->part_pkg;
2817 my $pkgnum = $self->pkgnum;
2820 my $oldAutoCommit = $FS::UID::AutoCommit;
2821 local $FS::UID::AutoCommit = 0;
2823 return "Can't use modify_charge except on one-time charges"
2824 unless $part_pkg->freq eq '0';
2826 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2827 $part_pkg->set('pkg', $opt{'pkg'});
2830 my %pkg_opt = $part_pkg->options;
2831 my $pkg_opt_modified = 0;
2833 $opt{'additional'} ||= [];
2836 foreach (grep /^additional/, keys %pkg_opt) {
2837 ($i) = ($_ =~ /^additional_info(\d+)$/);
2838 $old_additional[$i] = $pkg_opt{$_} if $i;
2839 delete $pkg_opt{$_};
2842 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2843 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2844 if (!exists($old_additional[$i])
2845 or $old_additional[$i] ne $opt{'additional'}->[$i])
2847 $pkg_opt_modified = 1;
2850 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2851 $pkg_opt{'additional_count'} = $i if $i > 0;
2854 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2857 $old_classnum = $part_pkg->classnum;
2858 $part_pkg->set('classnum', $opt{'classnum'});
2861 if ( !$self->get('setup') ) {
2862 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2865 if ( exists($opt{'amount'})
2866 and $part_pkg->option('setup_fee') != $opt{'amount'}
2867 and $opt{'amount'} > 0 ) {
2869 $pkg_opt{'setup_fee'} = $opt{'amount'};
2870 $pkg_opt_modified = 1;
2873 if ( exists($opt{'setup_cost'})
2874 and $part_pkg->setup_cost != $opt{'setup_cost'}
2875 and $opt{'setup_cost'} > 0 ) {
2877 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2880 if ( exists($opt{'quantity'})
2881 and $opt{'quantity'} != $self->quantity
2882 and $opt{'quantity'} > 0 ) {
2884 $self->set('quantity', $opt{'quantity'});
2887 if ( exists($opt{'start_date'})
2888 and $opt{'start_date'} != $self->start_date ) {
2890 $self->set('start_date', $opt{'start_date'});
2893 if ( exists($opt{'separate_bill'})
2894 and $opt{'separate_bill'} ne $self->separate_bill ) {
2896 $self->set('separate_bill', $opt{'separate_bill'});
2900 } # else simply ignore them; the UI shouldn't allow editing the fields
2903 if ( exists($opt{'taxclass'})
2904 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2906 $part_pkg->set('taxclass', $opt{'taxclass'});
2910 if ( $part_pkg->modified or $pkg_opt_modified ) {
2911 # can we safely modify the package def?
2912 # Yes, if it's not available for purchase, and this is the only instance
2914 if ( $part_pkg->disabled
2915 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2916 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2918 $error = $part_pkg->replace( options => \%pkg_opt );
2921 $part_pkg = $part_pkg->clone;
2922 $part_pkg->set('disabled' => 'Y');
2923 $error = $part_pkg->insert( options => \%pkg_opt );
2924 # and associate this as yet-unbilled package to the new package def
2925 $self->set('pkgpart' => $part_pkg->pkgpart);
2928 $dbh->rollback if $oldAutoCommit;
2933 if ($self->modified) { # for quantity or start_date change, or if we had
2934 # to clone the existing package def
2935 my $error = $self->replace;
2936 return $error if $error;
2938 if (defined $old_classnum) {
2939 # fix invoice grouping records
2940 my $old_catname = $old_classnum
2941 ? FS::pkg_class->by_key($old_classnum)->categoryname
2943 my $new_catname = $opt{'classnum'}
2944 ? $part_pkg->pkg_class->categoryname
2946 if ( $old_catname ne $new_catname ) {
2947 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2948 # (there should only be one...)
2949 my @display = qsearch( 'cust_bill_pkg_display', {
2950 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2951 'section' => $old_catname,
2953 foreach (@display) {
2954 $_->set('section', $new_catname);
2955 $error = $_->replace;
2957 $dbh->rollback if $oldAutoCommit;
2961 } # foreach $cust_bill_pkg
2964 if ( $opt{'adjust_commission'} ) {
2965 # fix commission credits...tricky.
2966 foreach my $cust_event ($self->cust_event) {
2967 my $part_event = $cust_event->part_event;
2968 foreach my $table (qw(sales agent)) {
2970 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2971 my $credit = qsearchs('cust_credit', {
2972 'eventnum' => $cust_event->eventnum,
2974 if ( $part_event->isa($class) ) {
2975 # Yes, this results in current commission rates being applied
2976 # retroactively to a one-time charge. For accounting purposes
2977 # there ought to be some kind of time limit on doing this.
2978 my $amount = $part_event->_calc_credit($self);
2979 if ( $credit and $credit->amount ne $amount ) {
2980 # Void the old credit.
2981 $error = $credit->void('Package class changed');
2983 $dbh->rollback if $oldAutoCommit;
2984 return "$error (adjusting commission credit)";
2987 # redo the event action to recreate the credit.
2989 eval { $part_event->do_action( $self, $cust_event ) };
2991 $dbh->rollback if $oldAutoCommit;
2994 } # if $part_event->isa($class)
2996 } # foreach $cust_event
2997 } # if $opt{'adjust_commission'}
2998 } # if defined $old_classnum
3000 $dbh->commit if $oldAutoCommit;
3007 sub process_bulk_cust_pkg {
3010 warn Dumper($param) if $DEBUG;
3012 my $old_part_pkg = qsearchs('part_pkg',
3013 { pkgpart => $param->{'old_pkgpart'} });
3014 my $new_part_pkg = qsearchs('part_pkg',
3015 { pkgpart => $param->{'new_pkgpart'} });
3016 die "Must select a new package type\n" unless $new_part_pkg;
3017 #my $keep_dates = $param->{'keep_dates'} || 0;
3018 my $keep_dates = 1; # there is no good reason to turn this off
3020 my $oldAutoCommit = $FS::UID::AutoCommit;
3021 local $FS::UID::AutoCommit = 0;
3024 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3027 foreach my $old_cust_pkg ( @cust_pkgs ) {
3029 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3030 if ( $old_cust_pkg->getfield('cancel') ) {
3031 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3032 $old_cust_pkg->pkgnum."\n"
3036 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3038 my $error = $old_cust_pkg->change(
3039 'pkgpart' => $param->{'new_pkgpart'},
3040 'keep_dates' => $keep_dates
3042 if ( !ref($error) ) { # change returns the cust_pkg on success
3044 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3047 $dbh->commit if $oldAutoCommit;
3053 Returns the last bill date, or if there is no last bill date, the setup date.
3054 Useful for billing metered services.
3060 return $self->setfield('last_bill', $_[0]) if @_;
3061 return $self->getfield('last_bill') if $self->getfield('last_bill');
3062 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3063 'edate' => $self->bill, } );
3064 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3067 =item last_cust_pkg_reason ACTION
3069 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3070 Returns false if there is no reason or the package is not currenly ACTION'd
3071 ACTION is one of adjourn, susp, cancel, or expire.
3075 sub last_cust_pkg_reason {
3076 my ( $self, $action ) = ( shift, shift );
3077 my $date = $self->get($action);
3079 'table' => 'cust_pkg_reason',
3080 'hashref' => { 'pkgnum' => $self->pkgnum,
3081 'action' => substr(uc($action), 0, 1),
3084 'order_by' => 'ORDER BY num DESC LIMIT 1',
3088 =item last_reason ACTION
3090 Returns the most recent ACTION FS::reason associated with the package.
3091 Returns false if there is no reason or the package is not currenly ACTION'd
3092 ACTION is one of adjourn, susp, cancel, or expire.
3097 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3098 $cust_pkg_reason->reason
3099 if $cust_pkg_reason;
3104 Returns the definition for this billing item, as an FS::part_pkg object (see
3111 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3112 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3113 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3118 Returns the cancelled package this package was changed from, if any.
3124 return '' unless $self->change_pkgnum;
3125 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3128 =item change_cust_main
3130 Returns the customter this package was detached to, if any.
3134 sub change_cust_main {
3136 return '' unless $self->change_custnum;
3137 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3142 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3149 $self->part_pkg->calc_setup($self, @_);
3154 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3161 $self->part_pkg->calc_recur($self, @_);
3166 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3173 $self->part_pkg->base_setup($self, @_);
3178 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3185 $self->part_pkg->base_recur($self, @_);
3190 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3197 $self->part_pkg->calc_remain($self, @_);
3202 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3209 $self->part_pkg->calc_cancel($self, @_);
3214 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3220 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3223 =item cust_pkg_detail [ DETAILTYPE ]
3225 Returns any customer package details for this package (see
3226 L<FS::cust_pkg_detail>).
3228 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3232 sub cust_pkg_detail {
3234 my %hash = ( 'pkgnum' => $self->pkgnum );
3235 $hash{detailtype} = shift if @_;
3237 'table' => 'cust_pkg_detail',
3238 'hashref' => \%hash,
3239 'order_by' => 'ORDER BY weight, pkgdetailnum',
3243 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3245 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3247 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3249 If there is an error, returns the error, otherwise returns false.
3253 sub set_cust_pkg_detail {
3254 my( $self, $detailtype, @details ) = @_;
3256 my $oldAutoCommit = $FS::UID::AutoCommit;
3257 local $FS::UID::AutoCommit = 0;
3260 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3261 my $error = $current->delete;
3263 $dbh->rollback if $oldAutoCommit;
3264 return "error removing old detail: $error";
3268 foreach my $detail ( @details ) {
3269 my $cust_pkg_detail = new FS::cust_pkg_detail {
3270 'pkgnum' => $self->pkgnum,
3271 'detailtype' => $detailtype,
3272 'detail' => $detail,
3274 my $error = $cust_pkg_detail->insert;
3276 $dbh->rollback if $oldAutoCommit;
3277 return "error adding new detail: $error";
3282 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3289 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3293 #false laziness w/cust_bill.pm
3297 'table' => 'cust_event',
3298 'addl_from' => 'JOIN part_event USING ( eventpart )',
3299 'hashref' => { 'tablenum' => $self->pkgnum },
3300 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3304 =item num_cust_event
3306 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3310 #false laziness w/cust_bill.pm
3311 sub num_cust_event {
3313 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3314 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3317 =item exists_cust_event
3319 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3323 sub exists_cust_event {
3325 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3326 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3327 $row ? $row->[0] : '';
3330 sub _from_cust_event_where {
3332 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3333 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3337 my( $self, $sql, @args ) = @_;
3338 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3339 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3343 =item part_pkg_currency_option OPTIONNAME
3345 Returns a two item list consisting of the currency of this customer, if any,
3346 and a value for the provided option. If the customer has a currency, the value
3347 is the option value the given name and the currency (see
3348 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3349 regular option value for the given name (see L<FS::part_pkg_option>).
3353 sub part_pkg_currency_option {
3354 my( $self, $optionname ) = @_;
3355 my $part_pkg = $self->part_pkg;
3356 if ( my $currency = $self->cust_main->currency ) {
3357 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3359 ('', $part_pkg->option($optionname) );
3363 =item cust_svc [ SVCPART ] (old, deprecated usage)
3365 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3367 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3369 Returns the services for this package, as FS::cust_svc objects (see
3370 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3371 spcififed, returns only the matching services.
3373 As an optimization, use the cust_svc_unsorted version if you are not displaying
3380 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3381 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3384 sub cust_svc_unsorted {
3386 @{ $self->cust_svc_unsorted_arrayref(@_) };
3389 sub cust_svc_unsorted_arrayref {
3392 return [] unless $self->num_cust_svc(@_);
3395 if ( @_ && $_[0] =~ /^\d+/ ) {
3396 $opt{svcpart} = shift;
3397 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3404 'select' => 'cust_svc.*, part_svc.*',
3405 'table' => 'cust_svc',
3406 'hashref' => { 'pkgnum' => $self->pkgnum },
3407 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3409 $search{hashref}->{svcpart} = $opt{svcpart}
3411 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3414 [ qsearch(\%search) ];
3418 =item overlimit [ SVCPART ]
3420 Returns the services for this package which have exceeded their
3421 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3422 is specified, return only the matching services.
3428 return () unless $self->num_cust_svc(@_);
3429 grep { $_->overlimit } $self->cust_svc(@_);
3432 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3434 Returns historical services for this package created before END TIMESTAMP and
3435 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3436 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3437 I<pkg_svc.hidden> flag will be omitted.
3443 warn "$me _h_cust_svc called on $self\n"
3446 my ($end, $start, $mode) = @_;
3448 local($FS::Record::qsearch_qualify_columns) = 0;
3450 my @cust_svc = $self->_sort_cust_svc(
3451 [ qsearch( 'h_cust_svc',
3452 { 'pkgnum' => $self->pkgnum, },
3453 FS::h_cust_svc->sql_h_search(@_),
3457 if ( defined($mode) && $mode eq 'I' ) {
3458 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3459 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3465 sub _sort_cust_svc {
3466 my( $self, $arrayref ) = @_;
3469 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3471 my %pkg_svc = map { $_->svcpart => $_ }
3472 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3477 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3479 $pkg_svc ? $pkg_svc->primary_svc : '',
3480 $pkg_svc ? $pkg_svc->quantity : 0,
3487 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3489 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3491 Returns the number of services for this package. Available options are svcpart
3492 and svcdb. If either is spcififed, returns only the matching services.
3499 return $self->{'_num_cust_svc'}
3501 && exists($self->{'_num_cust_svc'})
3502 && $self->{'_num_cust_svc'} =~ /\d/;
3504 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3508 if ( @_ && $_[0] =~ /^\d+/ ) {
3509 $opt{svcpart} = shift;
3510 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3516 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3517 my $where = ' WHERE pkgnum = ? ';
3518 my @param = ($self->pkgnum);
3520 if ( $opt{'svcpart'} ) {
3521 $where .= ' AND svcpart = ? ';
3522 push @param, $opt{'svcpart'};
3524 if ( $opt{'svcdb'} ) {
3525 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3526 $where .= ' AND svcdb = ? ';
3527 push @param, $opt{'svcdb'};
3530 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3531 $sth->execute(@param) or die $sth->errstr;
3532 $sth->fetchrow_arrayref->[0];
3535 =item available_part_svc
3537 Returns a list of FS::part_svc objects representing services included in this
3538 package but not yet provisioned. Each FS::part_svc object also has an extra
3539 field, I<num_avail>, which specifies the number of available services.
3541 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3542 associated pkg_svc has the provision_hold flag set.
3546 sub available_part_svc {
3550 my $pkg_quantity = $self->quantity || 1;
3552 grep { $_->num_avail > 0 }
3554 my $part_svc = $_->part_svc;
3555 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3556 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3558 # more evil encapsulation breakage
3559 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3560 my @exports = $part_svc->part_export_did;
3561 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3566 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3567 $self->part_pkg->pkg_svc;
3570 =item part_svc [ OPTION => VALUE ... ]
3572 Returns a list of FS::part_svc objects representing provisioned and available
3573 services included in this package. Each FS::part_svc object also has the
3574 following extra fields:
3588 (services) - array reference containing the provisioned services, as cust_svc objects
3592 Accepts two options:
3596 =item summarize_size
3598 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3599 is this size or greater.
3601 =item hide_discontinued
3603 If true, will omit looking for services that are no longer avaialble in the
3611 #label -> ($cust_svc->label)[1]
3617 my $pkg_quantity = $self->quantity || 1;
3619 #XXX some sort of sort order besides numeric by svcpart...
3620 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3622 my $part_svc = $pkg_svc->part_svc;
3623 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3624 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3625 $part_svc->{'Hash'}{'num_avail'} =
3626 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3627 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3628 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3629 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3630 && $num_cust_svc >= $opt{summarize_size};
3631 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3633 } $self->part_pkg->pkg_svc;
3635 unless ( $opt{hide_discontinued} ) {
3637 push @part_svc, map {
3639 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3640 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3641 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3642 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3643 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3645 } $self->extra_part_svc;
3652 =item extra_part_svc
3654 Returns a list of FS::part_svc objects corresponding to services in this
3655 package which are still provisioned but not (any longer) available in the
3660 sub extra_part_svc {
3663 my $pkgnum = $self->pkgnum;
3664 #my $pkgpart = $self->pkgpart;
3667 # 'table' => 'part_svc',
3670 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3671 # WHERE pkg_svc.svcpart = part_svc.svcpart
3672 # AND pkg_svc.pkgpart = ?
3675 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3676 # LEFT JOIN cust_pkg USING ( pkgnum )
3677 # WHERE cust_svc.svcpart = part_svc.svcpart
3680 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3683 #seems to benchmark slightly faster... (or did?)
3685 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3686 my $pkgparts = join(',', @pkgparts);
3689 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3690 #MySQL doesn't grok DISINCT ON
3691 'select' => 'DISTINCT part_svc.*',
3692 'table' => 'part_svc',
3694 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3695 AND pkg_svc.pkgpart IN ($pkgparts)
3698 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3699 LEFT JOIN cust_pkg USING ( pkgnum )
3702 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3703 'extra_param' => [ [$self->pkgnum=>'int'] ],
3709 Returns a short status string for this package, currently:
3715 =item not yet billed
3717 =item one-time charge
3732 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3734 return 'cancelled' if $self->get('cancel');
3735 return 'on hold' if $self->susp && ! $self->setup;
3736 return 'suspended' if $self->susp;
3737 return 'not yet billed' unless $self->setup;
3738 return 'one-time charge' if $freq =~ /^(0|$)/;
3742 =item ucfirst_status
3744 Returns the status with the first character capitalized.
3748 sub ucfirst_status {
3749 ucfirst(shift->status);
3754 Class method that returns the list of possible status strings for packages
3755 (see L<the status method|/status>). For example:
3757 @statuses = FS::cust_pkg->statuses();
3761 tie my %statuscolor, 'Tie::IxHash',
3762 'on hold' => 'FF00F5', #brighter purple!
3763 'not yet billed' => '009999', #teal? cyan?
3764 'one-time charge' => '0000CC', #blue #'000000',
3765 'active' => '00CC00',
3766 'suspended' => 'FF9900',
3767 'cancelled' => 'FF0000',
3771 my $self = shift; #could be class...
3772 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3773 # # mayble split btw one-time vs. recur
3784 Returns a hex triplet color string for this package's status.
3790 $statuscolor{$self->status};
3793 =item is_status_delay_cancel
3795 Returns true if part_pkg has option delay_cancel,
3796 cust_pkg status is 'suspended' and expire is set
3797 to cancel package within the next day (or however
3798 many days are set in global config part_pkg-delay_cancel-days.
3800 Accepts option I<part_pkg-delay_cancel-days> which should be
3801 the value of the config setting, to avoid looking it up again.
3803 This is not a real status, this only meant for hacking display
3804 values, because otherwise treating the package as suspended is
3805 really the whole point of the delay_cancel option.
3809 sub is_status_delay_cancel {
3810 my ($self,%opt) = @_;
3811 if ( $self->main_pkgnum and $self->pkglinknum ) {
3812 return $self->main_pkg->is_status_delay_cancel;
3814 return 0 unless $self->part_pkg->option('delay_cancel',1);
3815 return 0 unless $self->status eq 'suspended';
3816 return 0 unless $self->expire;
3817 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3819 my $conf = new FS::Conf;
3820 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3822 my $expsecs = 60*60*24*$expdays;
3823 return 0 unless $self->expire < time + $expsecs;
3829 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3830 "pkg - comment" depending on user preference).
3836 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3837 $label = $self->pkgnum. ": $label"
3838 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3842 =item pkg_label_long
3844 Returns a long label for this package, adding the primary service's label to
3849 sub pkg_label_long {
3851 my $label = $self->pkg_label;
3852 my $cust_svc = $self->primary_cust_svc;
3853 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3859 Returns a customer-localized label for this package.
3865 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3868 =item primary_cust_svc
3870 Returns a primary service (as FS::cust_svc object) if one can be identified.
3874 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3876 sub primary_cust_svc {
3879 my @cust_svc = $self->cust_svc;
3881 return '' unless @cust_svc; #no serivces - irrelevant then
3883 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3885 # primary service as specified in the package definition
3886 # or exactly one service definition with quantity one
3887 my $svcpart = $self->part_pkg->svcpart;
3888 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3889 return $cust_svc[0] if scalar(@cust_svc) == 1;
3891 #couldn't identify one thing..
3897 Returns a list of lists, calling the label method for all services
3898 (see L<FS::cust_svc>) of this billing item.
3904 map { [ $_->label ] } $self->cust_svc;
3907 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3909 Like the labels method, but returns historical information on services that
3910 were active as of END_TIMESTAMP and (optionally) not cancelled before
3911 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3912 I<pkg_svc.hidden> flag will be omitted.
3914 Returns a list of lists, calling the label method for all (historical) services
3915 (see L<FS::h_cust_svc>) of this billing item.
3921 warn "$me _h_labels called on $self\n"
3923 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3928 Like labels, except returns a simple flat list, and shortens long
3929 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3930 identical services to one line that lists the service label and the number of
3931 individual services rather than individual items.
3936 shift->_labels_short( 'labels', @_ );
3939 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3941 Like h_labels, except returns a simple flat list, and shortens long
3942 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3943 identical services to one line that lists the service label and the number of
3944 individual services rather than individual items.
3948 sub h_labels_short {
3949 shift->_labels_short( 'h_labels', @_ );
3953 my( $self, $method ) = ( shift, shift );
3955 warn "$me _labels_short called on $self with $method method\n"
3958 my $conf = new FS::Conf;
3959 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3961 warn "$me _labels_short populating \%labels\n"
3965 #tie %labels, 'Tie::IxHash';
3966 push @{ $labels{$_->[0]} }, $_->[1]
3967 foreach $self->$method(@_);
3969 warn "$me _labels_short populating \@labels\n"
3973 foreach my $label ( keys %labels ) {
3975 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3976 my $num = scalar(@values);
3977 warn "$me _labels_short $num items for $label\n"
3980 if ( $num > $max_same_services ) {
3981 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3983 push @labels, "$label ($num)";
3985 if ( $conf->exists('cust_bill-consolidate_services') ) {
3986 warn "$me _labels_short consolidating services\n"
3988 # push @labels, "$label: ". join(', ', @values);
3990 my $detail = "$label: ";
3991 $detail .= shift(@values). ', '
3993 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3995 push @labels, $detail;
3997 warn "$me _labels_short done consolidating services\n"
4000 warn "$me _labels_short adding service data\n"
4002 push @labels, map { "$label: $_" } @values;
4013 Returns the parent customer object (see L<FS::cust_main>).
4017 Returns the balance for this specific package, when using
4018 experimental package balance.
4024 $self->cust_main->balance_pkgnum( $self->pkgnum );
4027 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4031 Returns the location object, if any (see L<FS::cust_location>).
4033 =item cust_location_or_main
4035 If this package is associated with a location, returns the locaiton (see
4036 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4038 =item location_label [ OPTION => VALUE ... ]
4040 Returns the label of the location object (see L<FS::cust_location>).
4044 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4046 =item tax_locationnum
4048 Returns the foreign key to a L<FS::cust_location> object for calculating
4049 tax on this package, as determined by the C<tax-pkg_address> and
4050 C<tax-ship_address> configuration flags.
4054 sub tax_locationnum {
4056 my $conf = FS::Conf->new;
4057 if ( $conf->exists('tax-pkg_address') ) {
4058 return $self->locationnum;
4060 elsif ( $conf->exists('tax-ship_address') ) {
4061 return $self->cust_main->ship_locationnum;
4064 return $self->cust_main->bill_locationnum;
4070 Returns the L<FS::cust_location> object for tax_locationnum.
4076 my $conf = FS::Conf->new;
4077 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4078 return FS::cust_location->by_key($self->locationnum);
4080 elsif ( $conf->exists('tax-ship_address') ) {
4081 return $self->cust_main->ship_location;
4084 return $self->cust_main->bill_location;
4088 =item seconds_since TIMESTAMP
4090 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4091 package have been online since TIMESTAMP, according to the session monitor.
4093 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4094 L<Time::Local> and L<Date::Parse> for conversion functions.
4099 my($self, $since) = @_;
4102 foreach my $cust_svc (
4103 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4105 $seconds += $cust_svc->seconds_since($since);
4112 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4114 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4115 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4118 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4119 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4125 sub seconds_since_sqlradacct {
4126 my($self, $start, $end) = @_;
4130 foreach my $cust_svc (
4132 my $part_svc = $_->part_svc;
4133 $part_svc->svcdb eq 'svc_acct'
4134 && scalar($part_svc->part_export_usage);
4137 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4144 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4146 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4147 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4151 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4152 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4157 sub attribute_since_sqlradacct {
4158 my($self, $start, $end, $attrib) = @_;
4162 foreach my $cust_svc (
4164 my $part_svc = $_->part_svc;
4165 scalar($part_svc->part_export_usage);
4168 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4180 my( $self, $value ) = @_;
4181 if ( defined($value) ) {
4182 $self->setfield('quantity', $value);
4184 $self->getfield('quantity') || 1;
4187 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4189 Transfers as many services as possible from this package to another package.
4191 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4192 object. The destination package must already exist.
4194 Services are moved only if the destination allows services with the correct
4195 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4196 this option with caution! No provision is made for export differences
4197 between the old and new service definitions. Probably only should be used
4198 when your exports for all service definitions of a given svcdb are identical.
4199 (attempt a transfer without it first, to move all possible svcpart-matching
4202 Any services that can't be moved remain in the original package.
4204 Returns an error, if there is one; otherwise, returns the number of services
4205 that couldn't be moved.
4210 my ($self, $dest_pkgnum, %opt) = @_;
4216 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4217 $dest = $dest_pkgnum;
4218 $dest_pkgnum = $dest->pkgnum;
4220 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4223 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4225 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4226 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4229 foreach my $cust_svc ($dest->cust_svc) {
4230 $target{$cust_svc->svcpart}--;
4233 my %svcpart2svcparts = ();
4234 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4235 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4236 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4237 next if exists $svcpart2svcparts{$svcpart};
4238 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4239 $svcpart2svcparts{$svcpart} = [
4241 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4243 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4244 'svcpart' => $_ } );
4246 $pkg_svc ? $pkg_svc->primary_svc : '',
4247 $pkg_svc ? $pkg_svc->quantity : 0,
4251 grep { $_ != $svcpart }
4253 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4255 warn "alternates for svcpart $svcpart: ".
4256 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4262 foreach my $cust_svc ($self->cust_svc) {
4263 my $svcnum = $cust_svc->svcnum;
4264 if($target{$cust_svc->svcpart} > 0
4265 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4266 $target{$cust_svc->svcpart}--;
4267 my $new = new FS::cust_svc { $cust_svc->hash };
4268 $new->pkgnum($dest_pkgnum);
4269 $error = $new->replace($cust_svc);
4270 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4272 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4273 warn "alternates to consider: ".
4274 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4276 my @alternate = grep {
4277 warn "considering alternate svcpart $_: ".
4278 "$target{$_} available in new package\n"
4281 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4283 warn "alternate(s) found\n" if $DEBUG;
4284 my $change_svcpart = $alternate[0];
4285 $target{$change_svcpart}--;
4286 my $new = new FS::cust_svc { $cust_svc->hash };
4287 $new->svcpart($change_svcpart);
4288 $new->pkgnum($dest_pkgnum);
4289 $error = $new->replace($cust_svc);
4297 my @label = $cust_svc->label;
4298 return "$label[0] $label[1]: $error";
4304 =item grab_svcnums SVCNUM, SVCNUM ...
4306 Change the pkgnum for the provided services to this packages. If there is an
4307 error, returns the error, otherwise returns false.
4315 my $oldAutoCommit = $FS::UID::AutoCommit;
4316 local $FS::UID::AutoCommit = 0;
4319 foreach my $svcnum (@svcnum) {
4320 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4321 $dbh->rollback if $oldAutoCommit;
4322 return "unknown svcnum $svcnum";
4324 $cust_svc->pkgnum( $self->pkgnum );
4325 my $error = $cust_svc->replace;
4327 $dbh->rollback if $oldAutoCommit;
4332 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4339 This method is deprecated. See the I<depend_jobnum> option to the insert and
4340 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4344 #looks like this is still used by the order_pkg and change_pkg methods in
4345 # ClientAPI/MyAccount, need to look into those before removing
4349 my $oldAutoCommit = $FS::UID::AutoCommit;
4350 local $FS::UID::AutoCommit = 0;
4353 foreach my $cust_svc ( $self->cust_svc ) {
4354 #false laziness w/svc_Common::insert
4355 my $svc_x = $cust_svc->svc_x;
4356 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4357 my $error = $part_export->export_insert($svc_x);
4359 $dbh->rollback if $oldAutoCommit;
4365 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4370 =item export_pkg_change OLD_CUST_PKG
4372 Calls the "pkg_change" export action for all services attached to this package.
4376 sub export_pkg_change {
4377 my( $self, $old ) = ( shift, shift );
4379 my $oldAutoCommit = $FS::UID::AutoCommit;
4380 local $FS::UID::AutoCommit = 0;
4383 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4384 my $error = $svc_x->export('pkg_change', $self, $old);
4386 $dbh->rollback if $oldAutoCommit;
4391 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4398 Associates this package with a (suspension or cancellation) reason (see
4399 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4402 Available options are:
4408 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.
4412 the access_user (see L<FS::access_user>) providing the reason
4420 the action (cancel, susp, adjourn, expire) associated with the reason
4424 If there is an error, returns the error, otherwise returns false.
4429 my ($self, %options) = @_;
4431 my $otaker = $options{reason_otaker} ||
4432 $FS::CurrentUser::CurrentUser->username;
4435 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4439 } elsif ( ref($options{'reason'}) ) {
4441 return 'Enter a new reason (or select an existing one)'
4442 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4444 my $reason = new FS::reason({
4445 'reason_type' => $options{'reason'}->{'typenum'},
4446 'reason' => $options{'reason'}->{'reason'},
4448 my $error = $reason->insert;
4449 return $error if $error;
4451 $reasonnum = $reason->reasonnum;
4454 return "Unparseable reason: ". $options{'reason'};
4457 my $cust_pkg_reason =
4458 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4459 'reasonnum' => $reasonnum,
4460 'otaker' => $otaker,
4461 'action' => substr(uc($options{'action'}),0,1),
4462 'date' => $options{'date'}
4467 $cust_pkg_reason->insert;
4470 =item insert_discount
4472 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4473 inserting a new discount on the fly (see L<FS::discount>).
4475 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4476 and if present, will create a setup discount. If the discountnum is -1,
4477 a new discount definition will be inserted using the value in
4478 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4480 If there is an error, returns the error, otherwise returns false.
4484 sub insert_discount {
4485 #my ($self, %options) = @_;
4488 foreach my $x (qw(setup recur)) {
4489 if ( my $discountnum = $self->get("${x}_discountnum") ) {
4490 my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4491 'pkgnum' => $self->pkgnum,
4492 'discountnum' => $discountnum,
4495 'end_date' => '', #XXX
4496 #for the create a new discount case
4497 'amount' => $self->get("${x}_discountnum_amount"),
4498 'percent' => $self->get("${x}_discountnum_percent"),
4499 'months' => $self->get("${x}_discountnum_months"),
4501 if ( $x eq 'setup' ) {
4502 $cust_pkg_discount->setup('Y');
4503 $cust_pkg_discount->months('');
4505 my $error = $cust_pkg_discount->insert;
4506 return $error if $error;
4513 =item set_usage USAGE_VALUE_HASHREF
4515 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4516 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4517 upbytes, downbytes, and totalbytes are appropriate keys.
4519 All svc_accts which are part of this package have their values reset.
4524 my ($self, $valueref, %opt) = @_;
4526 #only svc_acct can set_usage for now
4527 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4528 my $svc_x = $cust_svc->svc_x;
4529 $svc_x->set_usage($valueref, %opt)
4530 if $svc_x->can("set_usage");
4534 =item recharge USAGE_VALUE_HASHREF
4536 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4537 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4538 upbytes, downbytes, and totalbytes are appropriate keys.
4540 All svc_accts which are part of this package have their values incremented.
4545 my ($self, $valueref) = @_;
4547 #only svc_acct can set_usage for now
4548 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4549 my $svc_x = $cust_svc->svc_x;
4550 $svc_x->recharge($valueref)
4551 if $svc_x->can("recharge");
4555 =item apply_usageprice
4559 sub apply_usageprice {
4562 my $oldAutoCommit = $FS::UID::AutoCommit;
4563 local $FS::UID::AutoCommit = 0;
4568 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4569 $error ||= $cust_pkg_usageprice->apply;
4573 $dbh->rollback if $oldAutoCommit;
4574 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4577 $dbh->commit if $oldAutoCommit;
4583 =item cust_pkg_discount
4585 =item cust_pkg_discount_active
4589 sub cust_pkg_discount_active {
4591 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4594 =item cust_pkg_usage
4596 Returns a list of all voice usage counters attached to this package.
4598 =item apply_usage OPTIONS
4600 Takes the following options:
4601 - cdr: a call detail record (L<FS::cdr>)
4602 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4603 - minutes: the maximum number of minutes to be charged
4605 Finds available usage minutes for a call of this class, and subtracts
4606 up to that many minutes from the usage pool. If the usage pool is empty,
4607 and the C<cdr-minutes_priority> global config option is set, minutes may
4608 be taken from other calls as well. Either way, an allocation record will
4609 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4610 number of minutes of usage applied to the call.
4615 my ($self, %opt) = @_;
4616 my $cdr = $opt{cdr};
4617 my $rate_detail = $opt{rate_detail};
4618 my $minutes = $opt{minutes};
4619 my $classnum = $rate_detail->classnum;
4620 my $pkgnum = $self->pkgnum;
4621 my $custnum = $self->custnum;
4623 my $oldAutoCommit = $FS::UID::AutoCommit;
4624 local $FS::UID::AutoCommit = 0;
4627 my $order = FS::Conf->new->config('cdr-minutes_priority');
4631 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4633 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4635 my @usage_recs = qsearch({
4636 'table' => 'cust_pkg_usage',
4637 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4638 ' JOIN cust_pkg USING (pkgnum)'.
4639 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4640 'select' => 'cust_pkg_usage.*',
4641 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4642 " ( cust_pkg.custnum = $custnum AND ".
4643 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4644 $is_classnum . ' AND '.
4645 " cust_pkg_usage.minutes > 0",
4646 'order_by' => " ORDER BY priority ASC",
4649 my $orig_minutes = $minutes;
4651 while (!$error and $minutes > 0 and @usage_recs) {
4652 my $cust_pkg_usage = shift @usage_recs;
4653 $cust_pkg_usage->select_for_update;
4654 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4655 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4656 acctid => $cdr->acctid,
4657 minutes => min($cust_pkg_usage->minutes, $minutes),
4659 $cust_pkg_usage->set('minutes',
4660 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4662 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4663 $minutes -= $cdr_cust_pkg_usage->minutes;
4665 if ( $order and $minutes > 0 and !$error ) {
4666 # then try to steal minutes from another call
4668 'table' => 'cdr_cust_pkg_usage',
4669 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4670 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4671 ' JOIN cust_pkg USING (pkgnum)'.
4672 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4673 ' JOIN cdr USING (acctid)',
4674 'select' => 'cdr_cust_pkg_usage.*',
4675 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4676 " ( cust_pkg.pkgnum = $pkgnum OR ".
4677 " ( cust_pkg.custnum = $custnum AND ".
4678 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4679 " part_pkg_usage_class.classnum = $classnum",
4680 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4682 if ( $order eq 'time' ) {
4683 # find CDRs that are using minutes, but have a later startdate
4685 my $startdate = $cdr->startdate;
4686 if ($startdate !~ /^\d+$/) {
4687 die "bad cdr startdate '$startdate'";
4689 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4690 # minimize needless reshuffling
4691 $search{'order_by'} .= ', cdr.startdate DESC';
4693 # XXX may not work correctly with rate_time schedules. Could
4694 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4696 $search{'addl_from'} .=
4697 ' JOIN rate_detail'.
4698 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4699 if ( $order eq 'rate_high' ) {
4700 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4701 $rate_detail->min_charge;
4702 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4703 } elsif ( $order eq 'rate_low' ) {
4704 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4705 $rate_detail->min_charge;
4706 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4708 # this should really never happen
4709 die "invalid cdr-minutes_priority value '$order'\n";
4712 my @cdr_usage_recs = qsearch(\%search);
4714 while (!$error and @cdr_usage_recs and $minutes > 0) {
4715 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4716 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4717 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4718 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4719 $cdr_cust_pkg_usage->select_for_update;
4720 $old_cdr->select_for_update;
4721 $cust_pkg_usage->select_for_update;
4722 # in case someone else stole the usage from this CDR
4723 # while waiting for the lock...
4724 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4725 # steal the usage allocation and flag the old CDR for reprocessing
4726 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4727 # if the allocation is more minutes than we need, adjust it...
4728 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4730 $cdr_cust_pkg_usage->set('minutes', $minutes);
4731 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4732 $error = $cust_pkg_usage->replace;
4734 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4735 $error ||= $cdr_cust_pkg_usage->replace;
4736 # deduct the stolen minutes
4737 $minutes -= $cdr_cust_pkg_usage->minutes;
4739 # after all minute-stealing is done, reset the affected CDRs
4740 foreach (values %reproc_cdrs) {
4741 $error ||= $_->set_status('');
4742 # XXX or should we just call $cdr->rate right here?
4743 # it's not like we can create a loop this way, since the min_charge
4744 # or call time has to go monotonically in one direction.
4745 # we COULD get some very deep recursions going, though...
4747 } # if $order and $minutes
4750 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4752 $dbh->commit if $oldAutoCommit;
4753 return $orig_minutes - $minutes;
4757 =item supplemental_pkgs
4759 Returns a list of all packages supplemental to this one.
4763 sub supplemental_pkgs {
4765 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4770 Returns the package that this one is supplemental to, if any.
4776 if ( $self->main_pkgnum ) {
4777 return FS::cust_pkg->by_key($self->main_pkgnum);
4784 =head1 CLASS METHODS
4790 Returns an SQL expression identifying recurring packages.
4794 sub recurring_sql { "
4795 '0' != ( select freq from part_pkg
4796 where cust_pkg.pkgpart = part_pkg.pkgpart )
4801 Returns an SQL expression identifying one-time packages.
4806 '0' = ( select freq from part_pkg
4807 where cust_pkg.pkgpart = part_pkg.pkgpart )
4812 Returns an SQL expression identifying ordered packages (recurring packages not
4818 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4823 Returns an SQL expression identifying active packages.
4828 $_[0]->recurring_sql. "
4829 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4830 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4831 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4834 =item not_yet_billed_sql
4836 Returns an SQL expression identifying packages which have not yet been billed.
4840 sub not_yet_billed_sql { "
4841 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4842 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4843 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4848 Returns an SQL expression identifying inactive packages (one-time packages
4849 that are otherwise unsuspended/uncancelled).
4853 sub inactive_sql { "
4854 ". $_[0]->onetime_sql(). "
4855 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4856 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4857 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4862 Returns an SQL expression identifying on-hold packages.
4867 #$_[0]->recurring_sql(). ' AND '.
4869 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4870 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4871 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4878 Returns an SQL expression identifying suspended packages.
4882 sub suspended_sql { susp_sql(@_); }
4884 #$_[0]->recurring_sql(). ' AND '.
4886 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4887 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4888 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4895 Returns an SQL exprression identifying cancelled packages.
4899 sub cancelled_sql { cancel_sql(@_); }
4901 #$_[0]->recurring_sql(). ' AND '.
4902 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4907 Returns an SQL expression to give the package status as a string.
4913 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4914 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4915 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4916 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4917 WHEN ".onetime_sql()." THEN 'one-time charge'
4924 Returns a list of two package counts. The first is a count of packages
4925 based on the supplied criteria and the second is the count of residential
4926 packages with those same criteria. Criteria are specified as in the search
4932 my ($class, $params) = @_;
4934 my $sql_query = $class->search( $params );
4936 my $count_sql = delete($sql_query->{'count_query'});
4937 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4938 or die "couldn't parse count_sql";
4940 my $count_sth = dbh->prepare($count_sql)
4941 or die "Error preparing $count_sql: ". dbh->errstr;
4943 or die "Error executing $count_sql: ". $count_sth->errstr;
4944 my $count_arrayref = $count_sth->fetchrow_arrayref;
4946 return ( @$count_arrayref );
4950 =item tax_locationnum_sql
4952 Returns an SQL expression for the tax location for a package, based
4953 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4957 sub tax_locationnum_sql {
4958 my $conf = FS::Conf->new;
4959 if ( $conf->exists('tax-pkg_address') ) {
4960 'cust_pkg.locationnum';
4962 elsif ( $conf->exists('tax-ship_address') ) {
4963 'cust_main.ship_locationnum';
4966 'cust_main.bill_locationnum';
4972 Returns a list: the first item is an SQL fragment identifying matching
4973 packages/customers via location (taking into account shipping and package
4974 address taxation, if enabled), and subsequent items are the parameters to
4975 substitute for the placeholders in that fragment.
4980 my($class, %opt) = @_;
4981 my $ornull = $opt{'ornull'};
4983 my $conf = new FS::Conf;
4985 # '?' placeholders in _location_sql_where
4986 my $x = $ornull ? 3 : 2;
4997 if ( $conf->exists('tax-ship_address') ) {
5000 ( ( ship_last IS NULL OR ship_last = '' )
5001 AND ". _location_sql_where('cust_main', '', $ornull ). "
5003 OR ( ship_last IS NOT NULL AND ship_last != ''
5004 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5007 # AND payby != 'COMP'
5009 @main_param = ( @bill_param, @bill_param );
5013 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5014 @main_param = @bill_param;
5020 if ( $conf->exists('tax-pkg_address') ) {
5022 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5025 ( cust_pkg.locationnum IS NULL AND $main_where )
5026 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5029 @param = ( @main_param, @bill_param );
5033 $where = $main_where;
5034 @param = @main_param;
5042 #subroutine, helper for location_sql
5043 sub _location_sql_where {
5045 my $prefix = @_ ? shift : '';
5046 my $ornull = @_ ? shift : '';
5048 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5050 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5052 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5053 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5054 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5056 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5058 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5060 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5061 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5062 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5063 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5064 AND $table.${prefix}country = ?
5069 my( $self, $what ) = @_;
5071 my $what_show_zero = $what. '_show_zero';
5072 length($self->$what_show_zero())
5073 ? ($self->$what_show_zero() eq 'Y')
5074 : $self->part_pkg->$what_show_zero();
5081 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5083 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5084 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5086 CUSTNUM is a customer (see L<FS::cust_main>)
5088 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5089 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5092 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5093 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5094 new billing items. An error is returned if this is not possible (see
5095 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5098 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5099 newly-created cust_pkg objects.
5101 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5102 and inserted. Multiple FS::pkg_referral records can be created by
5103 setting I<refnum> to an array reference of refnums or a hash reference with
5104 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5105 record will be created corresponding to cust_main.refnum.
5110 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5112 my $conf = new FS::Conf;
5114 # Transactionize this whole mess
5115 my $oldAutoCommit = $FS::UID::AutoCommit;
5116 local $FS::UID::AutoCommit = 0;
5120 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5121 # return "Customer not found: $custnum" unless $cust_main;
5123 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5126 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5129 my $change = scalar(@old_cust_pkg) != 0;
5132 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5134 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5135 " to pkgpart ". $pkgparts->[0]. "\n"
5138 my $err_or_cust_pkg =
5139 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5140 'refnum' => $refnum,
5143 unless (ref($err_or_cust_pkg)) {
5144 $dbh->rollback if $oldAutoCommit;
5145 return $err_or_cust_pkg;
5148 push @$return_cust_pkg, $err_or_cust_pkg;
5149 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5154 # Create the new packages.
5155 foreach my $pkgpart (@$pkgparts) {
5157 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5159 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5160 pkgpart => $pkgpart,
5164 $error = $cust_pkg->insert( 'change' => $change );
5165 push @$return_cust_pkg, $cust_pkg;
5167 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5168 my $supp_pkg = FS::cust_pkg->new({
5169 custnum => $custnum,
5170 pkgpart => $link->dst_pkgpart,
5172 main_pkgnum => $cust_pkg->pkgnum,
5175 $error ||= $supp_pkg->insert( 'change' => $change );
5176 push @$return_cust_pkg, $supp_pkg;
5180 $dbh->rollback if $oldAutoCommit;
5185 # $return_cust_pkg now contains refs to all of the newly
5188 # Transfer services and cancel old packages.
5189 foreach my $old_pkg (@old_cust_pkg) {
5191 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5194 foreach my $new_pkg (@$return_cust_pkg) {
5195 $error = $old_pkg->transfer($new_pkg);
5196 if ($error and $error == 0) {
5197 # $old_pkg->transfer failed.
5198 $dbh->rollback if $oldAutoCommit;
5203 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5204 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5205 foreach my $new_pkg (@$return_cust_pkg) {
5206 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5207 if ($error and $error == 0) {
5208 # $old_pkg->transfer failed.
5209 $dbh->rollback if $oldAutoCommit;
5216 # Transfers were successful, but we went through all of the
5217 # new packages and still had services left on the old package.
5218 # We can't cancel the package under the circumstances, so abort.
5219 $dbh->rollback if $oldAutoCommit;
5220 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5222 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5228 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5232 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5234 A bulk change method to change packages for multiple customers.
5236 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5237 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5240 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5241 replace. The services (see L<FS::cust_svc>) are moved to the
5242 new billing items. An error is returned if this is not possible (see
5245 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5246 newly-created cust_pkg objects.
5251 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5253 # Transactionize this whole mess
5254 my $oldAutoCommit = $FS::UID::AutoCommit;
5255 local $FS::UID::AutoCommit = 0;
5259 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5262 while(scalar(@old_cust_pkg)) {
5264 my $custnum = $old_cust_pkg[0]->custnum;
5265 my (@remove) = map { $_->pkgnum }
5266 grep { $_->custnum == $custnum } @old_cust_pkg;
5267 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5269 my $error = order $custnum, $pkgparts, \@remove, \@return;
5271 push @errors, $error
5273 push @$return_cust_pkg, @return;
5276 if (scalar(@errors)) {
5277 $dbh->rollback if $oldAutoCommit;
5278 return join(' / ', @errors);
5281 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5285 =item forward_emails
5287 Returns a hash of svcnums and corresponding email addresses
5288 for svc_acct services that can be used as source or dest
5289 for svc_forward services provisioned in this package.
5291 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5292 service; if included, will ensure the current values of the
5293 specified service are included in the list, even if for some
5294 other reason they wouldn't be. If called as a class method
5295 with a specified service, returns only these current values.
5297 Caution: does not actually check if svc_forward services are
5298 available to be provisioned on this package.
5302 sub forward_emails {
5306 #load optional service, thoroughly validated
5307 die "Use svcnum or svc_forward, not both"
5308 if $opt{'svcnum'} && $opt{'svc_forward'};
5309 my $svc_forward = $opt{'svc_forward'};
5310 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5312 die "Specified service is not a forward service"
5313 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5314 die "Specified service not found"
5315 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5319 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5320 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5322 #add current values from specified service, if there was one
5324 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5325 my $svc_acct = $svc_forward->$method();
5326 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5330 if (ref($self) eq 'FS::cust_pkg') {
5332 #and including the rest for this customer
5333 my($u_part_svc,@u_acct_svcparts);
5334 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5335 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5338 my $custnum = $self->getfield('custnum');
5339 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5340 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5341 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5342 foreach my $acct_svcpart (@u_acct_svcparts) {
5343 foreach my $i_cust_svc (
5344 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5345 'svcpart' => $acct_svcpart } )
5347 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5348 $email{$svc_acct->svcnum} = $svc_acct->email;
5357 # Used by FS::Upgrade to migrate to a new database.
5358 sub _upgrade_data { # class method
5359 my ($class, %opts) = @_;
5360 $class->_upgrade_otaker(%opts);
5362 # RT#10139, bug resulting in contract_end being set when it shouldn't
5363 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5364 # RT#10830, bad calculation of prorate date near end of year
5365 # the date range for bill is December 2009, and we move it forward
5366 # one year if it's before the previous bill date (which it should
5368 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5369 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5370 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5371 # RT6628, add order_date to cust_pkg
5372 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5373 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5374 history_action = \'insert\') where order_date is null',
5376 foreach my $sql (@statements) {
5377 my $sth = dbh->prepare($sql);
5378 $sth->execute or die $sth->errstr;
5381 # RT31194: supplemental package links that are deleted don't clean up
5383 my @pkglinknums = qsearch({
5384 'select' => 'DISTINCT cust_pkg.pkglinknum',
5385 'table' => 'cust_pkg',
5386 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5387 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5388 AND part_pkg_link.pkglinknum IS NULL',
5390 foreach (@pkglinknums) {
5391 my $pkglinknum = $_->pkglinknum;
5392 warn "cleaning part_pkg_link #$pkglinknum\n";
5393 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5394 my $error = $part_pkg_link->remove_linked;
5395 die $error if $error;
5403 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5405 In sub order, the @pkgparts array (passed by reference) is clobbered.
5407 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5408 method to pass dates to the recur_prog expression, it should do so.
5410 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5411 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5412 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5413 configuration values. Probably need a subroutine which decides what to do
5414 based on whether or not we've fetched the user yet, rather than a hash. See
5415 FS::UID and the TODO.
5417 Now that things are transactional should the check in the insert method be
5422 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5423 L<FS::pkg_svc>, schema.html from the base documentation