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 _h_svc_x, which contains the service history object.
1138 Set pkgnum before inserting.
1140 Accepts the following options:
1142 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1143 (and only if they would otherwise be returned by this)
1147 sub uncancel_svc_x {
1148 my ($self, %opt) = @_;
1150 die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1152 #find historical services within this timeframe before the package cancel
1153 # (incompatible with "time" option to cust_pkg->cancel?)
1154 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1155 # too little? (unprovisioing export delay?)
1156 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1157 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1160 foreach my $h_cust_svc (@h_cust_svc) {
1161 next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1162 # filter out services that still exist on this package (ie preserved svcs)
1163 # but keep services that have since been provisioned on another package (for informational purposes)
1164 next if qsearchs('cust_svc',{ 'svcnum' => $h_cust_svc->svcnum, 'pkgnum' => $self->pkgnum });
1165 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1166 next unless $h_svc_x; # this probably doesn't happen, but just in case
1167 (my $table = $h_svc_x->table) =~ s/^h_//;
1168 require "FS/$table.pm";
1169 my $class = "FS::$table";
1170 my $svc_x = $class->new( {
1171 'svcpart' => $h_cust_svc->svcpart,
1172 '_h_svc_x' => $h_svc_x,
1173 map { $_ => $h_svc_x->get($_) } fields($table)
1177 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1178 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1181 #these are pretty rare, but should handle them
1182 # - dsl_device (mac addresses)
1183 # - phone_device (mac addresses)
1184 # - dsl_note (ikano notes)
1185 # - domain_record (i.e. restore DNS information w/domains)
1186 # - inventory_item(?) (inventory w/un-cancelling service?)
1187 # - nas (svc_broaband nas stuff)
1188 #this stuff is unused in the wild afaik
1189 # - mailinglistmember
1191 # - svc_domain.parent_svcnum?
1192 # - acct_snarf (ancient mail fetching config)
1193 # - cgp_rule (communigate)
1194 # - cust_svc_option (used by our Tron stuff)
1195 # - acct_rt_transaction (used by our time worked stuff)
1197 push @svc_x, $svc_x;
1202 =item uncancel_svc_summary
1204 Returns an array of hashrefs, one for each service that could
1205 potentially be reprovisioned by L</uncancel>, with the following keys:
1213 label - from history table if not currently calculable, undefined if it can't be loaded
1215 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1217 num_cust_svc - number of svcs for this svcpart, only if summarizing (see below)
1219 Cannot be run from within a transaction. Performs inserts
1220 to test the results, and then rolls back the transaction.
1221 Does not perform exports, so does not catch if export would fail.
1223 Also accepts the following options:
1225 no_test_reprovision - skip the test inserts (reprovisionable field will not exist)
1227 summarize_size - if true, returns a single summary record for svcparts with at
1228 least this many svcs, will have key num_cust_svc but not uncancel_svcnum, label or reprovisionable
1232 sub uncancel_svc_summary {
1233 my ($self, %opt) = @_;
1235 die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1236 die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1238 local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1239 local $FS::UID::AutoCommit = 0;
1241 # sort by svcpart, to check summarize_size
1242 my $uncancel_svc_x = {};
1243 foreach my $svc_x (sort { $a->{'svcpart'} <=> $b->{'svcpart'} } $self->uncancel_svc_x) {
1244 $uncancel_svc_x->{$svc_x->svcpart} = [] unless $uncancel_svc_x->{$svc_x->svcpart};
1245 push @{$uncancel_svc_x->{$svc_x->svcpart}}, $svc_x;
1249 foreach my $svcpart (keys %$uncancel_svc_x) {
1250 my @svcpart_svc_x = @{$uncancel_svc_x->{$svcpart}};
1251 if ($opt{'summarize_size'} && (@svcpart_svc_x >= $opt{'summarize_size'})) {
1252 my $svc_x = $svcpart_svc_x[0]; #grab first one for access to $part_svc
1253 my $part_svc = $svc_x->part_svc;
1255 'svcpart' => $part_svc->svcpart,
1256 'svc' => $part_svc->svc,
1257 'num_cust_svc' => scalar(@svcpart_svc_x),
1260 foreach my $svc_x (@svcpart_svc_x) {
1261 my $part_svc = $svc_x->part_svc;
1263 'svcpart' => $part_svc->svcpart,
1264 'svc' => $part_svc->svc,
1265 'uncancel_svcnum' => $svc_x->get('_h_svc_x')->svcnum,
1267 $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1268 if ($opt{'no_test_reprovision'} or $svc_x->insert) {
1269 # avoid possibly fatal errors from missing linked records
1270 eval { $out->{'label'} = $svc_x->label };
1271 eval { $out->{'label'} = $svc_x->get('_h_svc_x')->label } unless defined($out->{'label'});
1272 $out->{'reprovisionable'} = 0 unless $opt{'no_test_reprovision'};
1274 $out->{'label'} = $svc_x->label;
1275 $out->{'reprovisionable'} = 1;
1288 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1289 locationnum, (other fields?). Attempts to re-provision cancelled services
1290 using history information (errors at this stage are not fatal).
1292 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1294 svc_fatal: service provisioning errors are fatal
1296 svc_errors: pass an array reference, will be filled in with any provisioning errors
1298 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1300 main_pkgnum: link the package as a supplemental package of this one. For
1306 my( $self, %options ) = @_;
1308 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1309 return '' unless $self->get('cancel');
1311 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1312 return $self->main_pkg->uncancel(%options);
1319 my $oldAutoCommit = $FS::UID::AutoCommit;
1320 local $FS::UID::AutoCommit = 0;
1324 # insert the new package
1327 my $cust_pkg = new FS::cust_pkg {
1328 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1329 bill => ( $options{'bill'} || $self->get('bill') ),
1331 uncancel_pkgnum => $self->pkgnum,
1332 main_pkgnum => ($options{'main_pkgnum'} || ''),
1333 map { $_ => $self->get($_) } qw(
1334 custnum pkgpart locationnum
1336 susp adjourn resume expire start_date contract_end dundate
1337 change_date change_pkgpart change_locationnum
1338 no_auto separate_bill quantity agent_pkgid
1339 recur_show_zero setup_show_zero
1343 my $error = $cust_pkg->insert(
1344 'change' => 1, #supresses any referral credit to a referring customer
1345 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1348 $dbh->rollback if $oldAutoCommit;
1357 foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1359 $svc_x->pkgnum($cust_pkg->pkgnum);
1360 my $svc_error = $svc_x->insert;
1363 if ( $options{svc_fatal} ) {
1364 $dbh->rollback if $oldAutoCommit;
1367 # if we've failed to insert the svc_x object, svc_Common->insert
1368 # will have removed the cust_svc already. if not, then both records
1369 # were inserted but we failed for some other reason (export, most
1370 # likely). in that case, report the error and delete the records.
1371 push @svc_errors, $svc_error;
1372 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1374 # except if export_insert failed, export_delete probably won't be
1376 local $FS::svc_Common::noexport_hack = 1;
1377 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1378 if ( $cleanup_error ) { # and if THAT fails, then run away
1379 $dbh->rollback if $oldAutoCommit;
1380 return $cleanup_error;
1385 } #foreach uncancel_svc_x
1388 # also move over any services that didn't unprovision at cancellation
1391 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1392 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1393 my $error = $cust_svc->replace;
1395 $dbh->rollback if $oldAutoCommit;
1401 # Uncancel any supplemental packages, and make them supplemental to the
1405 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1407 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1409 $dbh->rollback if $oldAutoCommit;
1410 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1420 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1421 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1428 Cancels any pending expiration (sets the expire field to null)
1429 for this package and any supplemental packages.
1431 If there is an error, returns the error, otherwise returns false.
1439 my $oldAutoCommit = $FS::UID::AutoCommit;
1440 local $FS::UID::AutoCommit = 0;
1443 my $old = $self->select_for_update;
1445 my $pkgnum = $old->pkgnum;
1446 if ( $old->get('cancel') || $self->get('cancel') ) {
1447 dbh->rollback if $oldAutoCommit;
1448 return "Can't unexpire cancelled package $pkgnum";
1449 # or at least it's pointless
1452 unless ( $old->get('expire') && $self->get('expire') ) {
1453 dbh->rollback if $oldAutoCommit;
1454 return ""; # no error
1457 my %hash = $self->hash;
1458 $hash{'expire'} = '';
1459 my $new = new FS::cust_pkg ( \%hash );
1460 $error = $new->replace( $self, options => { $self->options } );
1462 $dbh->rollback if $oldAutoCommit;
1466 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1467 $error = $supp_pkg->unexpire;
1469 $dbh->rollback if $oldAutoCommit;
1470 return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1474 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1480 =item suspend [ OPTION => VALUE ... ]
1482 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1483 package, then suspends the package itself (sets the susp field to now).
1485 Available options are:
1489 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1490 either a reasonnum of an existing reason, or passing a hashref will create
1491 a new reason. The hashref should have the following keys:
1492 - typenum - Reason type (see L<FS::reason_type>
1493 - reason - Text of the new reason.
1495 =item date - can be set to a unix style timestamp to specify when to
1498 =item time - can be set to override the current time, for calculation
1499 of final invoices or unused-time credits
1501 =item resume_date - can be set to a time when the package should be
1502 unsuspended. This may be more convenient than calling C<unsuspend()>
1505 =item from_main - allows a supplemental package to be suspended, rather
1506 than redirecting the method call to its main package. For internal use.
1508 =item from_cancel - used when suspending from the cancel method, forces
1509 this to skip everything besides basic suspension. For internal use.
1513 If there is an error, returns the error, otherwise returns false.
1518 my( $self, %options ) = @_;
1521 # supplemental packages still can't be separately suspended, but silently
1522 # exit instead of failing or passing the action to the main package (so
1523 # that the "Suspend customer" action doesn't trip over the supplemental
1526 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1530 my $oldAutoCommit = $FS::UID::AutoCommit;
1531 local $FS::UID::AutoCommit = 0;
1534 my $old = $self->select_for_update;
1536 my $pkgnum = $old->pkgnum;
1537 if ( $old->get('cancel') || $self->get('cancel') ) {
1538 dbh->rollback if $oldAutoCommit;
1539 return "Can't suspend cancelled package $pkgnum";
1542 if ( $old->get('susp') || $self->get('susp') ) {
1543 dbh->rollback if $oldAutoCommit;
1544 return ""; # no error # complain on adjourn?
1547 my $suspend_time = $options{'time'} || time;
1548 my $date = $options{date} if $options{date}; # adjourn/suspend later
1549 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1551 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1552 dbh->rollback if $oldAutoCommit;
1553 return "Package $pkgnum expires before it would be suspended.";
1556 # some false laziness with sub cancel
1557 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1558 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1559 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1560 # make the entire cust_main->bill path recognize 'suspend' and
1561 # 'cancel' separately.
1562 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1563 my $copy = $self->new({$self->hash});
1565 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1567 'time' => $suspend_time );
1568 warn "Error billing during suspend, custnum ".
1569 #$self->cust_main->custnum. ": $error"
1574 my $cust_pkg_reason;
1575 if ( $options{'reason'} ) {
1576 $error = $self->insert_reason( 'reason' => $options{'reason'},
1577 'action' => $date ? 'adjourn' : 'suspend',
1578 'date' => $date ? $date : $suspend_time,
1579 'reason_otaker' => $options{'reason_otaker'},
1582 dbh->rollback if $oldAutoCommit;
1583 return "Error inserting cust_pkg_reason: $error";
1585 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1586 'date' => $date ? $date : $suspend_time,
1587 'action' => $date ? 'A' : 'S',
1588 'pkgnum' => $self->pkgnum,
1592 # if a reasonnum was passed, get the actual reason object so we can check
1594 # (passing a reason hashref is still allowed, but it can't be used with
1595 # the fancy behavioral options.)
1598 if ($options{'reason'} =~ /^\d+$/) {
1599 $reason = FS::reason->by_key($options{'reason'});
1602 my %hash = $self->hash;
1604 $hash{'adjourn'} = $date;
1606 $hash{'susp'} = $suspend_time;
1609 my $resume_date = $options{'resume_date'} || 0;
1610 if ( $resume_date > ($date || $suspend_time) ) {
1611 $hash{'resume'} = $resume_date;
1614 $options{options} ||= {};
1616 my $new = new FS::cust_pkg ( \%hash );
1617 $error = $new->replace( $self, options => { $self->options,
1618 %{ $options{options} },
1622 $dbh->rollback if $oldAutoCommit;
1626 unless ( $date ) { # then we are suspending now
1628 unless ($options{'from_cancel'}) {
1629 # credit remaining time if appropriate
1630 # (if required by the package def, or the suspend reason)
1631 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1632 || ( defined($reason) && $reason->unused_credit );
1634 if ( $unused_credit ) {
1635 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1636 my $error = $self->credit_remaining('suspend', $suspend_time);
1638 $dbh->rollback if $oldAutoCommit;
1644 my @cust_svc = qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
1646 #attempt ordering ala cust_svc_suspend_cascade (without infinite-looping
1647 # on the circular dep case)
1648 # (this is too simple for multi-level deps, we need to use something
1649 # to resolve the DAG properly when possible)
1651 $svcpart{$_->svcpart} = 0 foreach @cust_svc;
1652 foreach my $svcpart ( keys %svcpart ) {
1653 foreach my $part_svc_link (
1654 FS::part_svc_link->by_agentnum($self->cust_main->agentnum,
1655 src_svcpart => $svcpart,
1656 link_type => 'cust_svc_suspend_cascade'
1659 $svcpart{$part_svc_link->dst_svcpart} = max(
1660 $svcpart{$part_svc_link->dst_svcpart},
1661 $svcpart{$part_svc_link->src_svcpart} + 1
1665 @cust_svc = sort { $svcpart{ $a->svcpart } <=> $svcpart{ $b->svcpart } }
1669 foreach my $cust_svc ( @cust_svc ) {
1670 $cust_svc->suspend( 'labels_arrayref' => \@labels );
1673 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1674 # and this is not a suspend-before-cancel
1675 if ( $cust_pkg_reason ) {
1676 my $reason_obj = $cust_pkg_reason->reason;
1677 if ( $reason_obj->feepart and
1678 ! $reason_obj->fee_on_unsuspend and
1679 ! $options{'from_cancel'} ) {
1681 # register the need to charge a fee, cust_main->bill will do the rest
1682 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1684 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1685 'pkgreasonnum' => $cust_pkg_reason->num,
1686 'pkgnum' => $self->pkgnum,
1687 'feepart' => $reason->feepart,
1688 'nextbill' => $reason->fee_hold,
1690 $error ||= $cust_pkg_reason_fee->insert;
1694 my $conf = new FS::Conf;
1695 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1697 my $error = send_email(
1698 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1699 #invoice_from ??? well as good as any
1700 'to' => $conf->config('suspend_email_admin'),
1701 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1703 "This is an automatic message from your Freeside installation\n",
1704 "informing you that the following customer package has been suspended:\n",
1706 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1707 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1708 ( map { "Service : $_\n" } @labels ),
1710 'custnum' => $self->custnum,
1711 'msgtype' => 'admin'
1715 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1723 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1724 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1726 $dbh->rollback if $oldAutoCommit;
1727 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1731 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1736 =item credit_remaining MODE TIME
1738 Generate a credit for this package for the time remaining in the current
1739 billing period. MODE is either "suspend" or "cancel" (determines the
1740 credit type). TIME is the time of suspension/cancellation. Both arguments
1745 # Implementation note:
1747 # If you pkgpart-change a package that has been billed, and it's set to give
1748 # credit on package change, then this method gets called and then the new
1749 # package will have no last_bill date. Therefore the customer will be credited
1750 # only once (per billing period) even if there are multiple package changes.
1752 # If you location-change a package that has been billed, this method will NOT
1753 # be called and the new package WILL have the last bill date of the old
1756 # If the new package is then canceled within the same billing cycle,
1757 # credit_remaining needs to run calc_remain on the OLD package to determine
1758 # the amount of unused time to credit.
1760 sub credit_remaining {
1761 # Add a credit for remaining service
1762 my ($self, $mode, $time) = @_;
1763 die 'credit_remaining requires suspend or cancel'
1764 unless $mode eq 'suspend' or $mode eq 'cancel';
1765 die 'no suspend/cancel time' unless $time > 0;
1767 my $conf = FS::Conf->new;
1768 my $reason_type = $conf->config($mode.'_credit_type');
1770 my $last_bill = $self->getfield('last_bill') || 0;
1771 my $next_bill = $self->getfield('bill') || 0;
1772 if ( $last_bill > 0 # the package has been billed
1773 and $next_bill > 0 # the package has a next bill date
1774 and $next_bill >= $time # which is in the future
1776 my @cust_credit_source_bill_pkg = ();
1777 my $remaining_value = 0;
1779 my $remain_pkg = $self;
1780 $remaining_value = $remain_pkg->calc_remain(
1782 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1785 # we may have to walk back past some package changes to get to the
1786 # one that actually has unused time
1787 while ( $remaining_value == 0 ) {
1788 if ( $remain_pkg->change_pkgnum ) {
1789 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1791 # the package has really never been billed
1794 $remaining_value = $remain_pkg->calc_remain(
1796 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1800 if ( $remaining_value > 0 ) {
1801 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1803 my $error = $self->cust_main->credit(
1805 'Credit for unused time on '. $self->part_pkg->pkg,
1806 'reason_type' => $reason_type,
1807 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1809 return "Error crediting customer \$$remaining_value for unused time".
1810 " on ". $self->part_pkg->pkg. ": $error"
1812 } #if $remaining_value
1813 } #if $last_bill, etc.
1817 =item unsuspend [ OPTION => VALUE ... ]
1819 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1820 package, then unsuspends the package itself (clears the susp field and the
1821 adjourn field if it is in the past). If the suspend reason includes an
1822 unsuspension package, that package will be ordered.
1824 Available options are:
1830 Can be set to a date to unsuspend the package in the future (the 'resume'
1833 =item adjust_next_bill
1835 Can be set true to adjust the next bill date forward by
1836 the amount of time the account was inactive. This was set true by default
1837 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1838 explicitly requested with this option or in the price plan.
1842 If there is an error, returns the error, otherwise returns false.
1847 my( $self, %opt ) = @_;
1850 # pass all suspend/cancel actions to the main package
1851 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1852 return $self->main_pkg->unsuspend(%opt);
1855 my $oldAutoCommit = $FS::UID::AutoCommit;
1856 local $FS::UID::AutoCommit = 0;
1859 my $old = $self->select_for_update;
1861 my $pkgnum = $old->pkgnum;
1862 if ( $old->get('cancel') || $self->get('cancel') ) {
1863 $dbh->rollback if $oldAutoCommit;
1864 return "Can't unsuspend cancelled package $pkgnum";
1867 unless ( $old->get('susp') && $self->get('susp') ) {
1868 $dbh->rollback if $oldAutoCommit;
1869 return ""; # no error # complain instead?
1872 # handle the case of setting a future unsuspend (resume) date
1873 # and do not continue to actually unsuspend the package
1874 my $date = $opt{'date'};
1875 if ( $date and $date > time ) { # return an error if $date <= time?
1877 if ( $old->get('expire') && $old->get('expire') < $date ) {
1878 $dbh->rollback if $oldAutoCommit;
1879 return "Package $pkgnum expires before it would be unsuspended.";
1882 my $new = new FS::cust_pkg { $self->hash };
1883 $new->set('resume', $date);
1884 $error = $new->replace($self, options => $self->options);
1887 $dbh->rollback if $oldAutoCommit;
1891 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1897 if (!$self->setup) {
1898 # then this package is being released from on-hold status
1899 $error = $self->set_initial_timers;
1901 $dbh->rollback if $oldAutoCommit;
1908 foreach my $cust_svc (
1909 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1911 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1913 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1914 $dbh->rollback if $oldAutoCommit;
1915 return "Illegal svcdb value in part_svc!";
1918 require "FS/$svcdb.pm";
1920 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1922 $error = $svc->unsuspend;
1924 $dbh->rollback if $oldAutoCommit;
1927 my( $label, $value ) = $cust_svc->label;
1928 push @labels, "$label: $value";
1933 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1934 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1936 my %hash = $self->hash;
1937 my $inactive = time - $hash{'susp'};
1939 my $conf = new FS::Conf;
1941 #adjust the next bill date forward
1942 # increment next bill date if certain conditions are met:
1943 # - it was due to be billed at some point
1944 # - either the global or local config says to do this
1945 my $adjust_bill = 0;
1948 && ( $hash{'bill'} || $hash{'setup'} )
1949 && ( $opt{'adjust_next_bill'}
1950 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1951 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1958 # - the package billed during suspension
1959 # - or it was ordered on hold
1960 # - or the customer was credited for the unused time
1962 if ( $self->option('suspend_bill',1)
1963 or ( $self->part_pkg->option('suspend_bill',1)
1964 and ! $self->option('no_suspend_bill',1)
1966 or $hash{'order_date'} == $hash{'susp'}
1971 if ( $adjust_bill ) {
1972 if ( $self->part_pkg->option('unused_credit_suspend')
1973 or ( ref($reason) and $reason->unused_credit ) ) {
1974 # then the customer was credited for the unused time before suspending,
1975 # so their next bill should be immediate
1976 $hash{'bill'} = time;
1978 # add the length of time suspended to the bill date
1979 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1984 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1985 $hash{'resume'} = '' if !$hash{'adjourn'};
1986 my $new = new FS::cust_pkg ( \%hash );
1987 $error = $new->replace( $self, options => { $self->options } );
1989 $dbh->rollback if $oldAutoCommit;
1996 if ( $reason->unsuspend_pkgpart ) {
1997 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
1998 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1999 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
2001 my $start_date = $self->cust_main->next_bill_date
2002 if $reason->unsuspend_hold;
2005 $unsusp_pkg = FS::cust_pkg->new({
2006 'custnum' => $self->custnum,
2007 'pkgpart' => $reason->unsuspend_pkgpart,
2008 'start_date' => $start_date,
2009 'locationnum' => $self->locationnum,
2010 # discount? probably not...
2013 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
2016 # new way, using fees
2017 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
2018 # register the need to charge a fee, cust_main->bill will do the rest
2019 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
2021 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
2022 'pkgreasonnum' => $cust_pkg_reason->num,
2023 'pkgnum' => $self->pkgnum,
2024 'feepart' => $reason->feepart,
2025 'nextbill' => $reason->fee_hold,
2027 $error ||= $cust_pkg_reason_fee->insert;
2031 $dbh->rollback if $oldAutoCommit;
2036 if ( $conf->config('unsuspend_email_admin') ) {
2038 my $error = send_email(
2039 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2040 #invoice_from ??? well as good as any
2041 'to' => $conf->config('unsuspend_email_admin'),
2042 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2043 "This is an automatic message from your Freeside installation\n",
2044 "informing you that the following customer package has been unsuspended:\n",
2046 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2047 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2048 ( map { "Service : $_\n" } @labels ),
2050 "An unsuspension fee was charged: ".
2051 $unsusp_pkg->part_pkg->pkg_comment."\n"
2055 'custnum' => $self->custnum,
2056 'msgtype' => 'admin',
2060 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2066 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2067 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2069 $dbh->rollback if $oldAutoCommit;
2070 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2074 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2081 Cancels any pending suspension (sets the adjourn field to null)
2082 for this package and any supplemental packages.
2084 If there is an error, returns the error, otherwise returns false.
2092 my $oldAutoCommit = $FS::UID::AutoCommit;
2093 local $FS::UID::AutoCommit = 0;
2096 my $old = $self->select_for_update;
2098 my $pkgnum = $old->pkgnum;
2099 if ( $old->get('cancel') || $self->get('cancel') ) {
2100 dbh->rollback if $oldAutoCommit;
2101 return "Can't unadjourn cancelled package $pkgnum";
2102 # or at least it's pointless
2105 if ( $old->get('susp') || $self->get('susp') ) {
2106 dbh->rollback if $oldAutoCommit;
2107 return "Can't unadjourn suspended package $pkgnum";
2108 # perhaps this is arbitrary
2111 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2112 dbh->rollback if $oldAutoCommit;
2113 return ""; # no error
2116 my %hash = $self->hash;
2117 $hash{'adjourn'} = '';
2118 $hash{'resume'} = '';
2119 my $new = new FS::cust_pkg ( \%hash );
2120 $error = $new->replace( $self, options => { $self->options } );
2122 $dbh->rollback if $oldAutoCommit;
2126 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2127 $error = $supp_pkg->unadjourn;
2129 $dbh->rollback if $oldAutoCommit;
2130 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2134 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2141 =item change HASHREF | OPTION => VALUE ...
2143 Changes this package: cancels it and creates a new one, with a different
2144 pkgpart or locationnum or both. All services are transferred to the new
2145 package (no change will be made if this is not possible).
2147 Options may be passed as a list of key/value pairs or as a hash reference.
2154 New locationnum, to change the location for this package.
2158 New FS::cust_location object, to create a new location and assign it
2163 New FS::cust_main object, to create a new customer and assign the new package
2168 New pkgpart (see L<FS::part_pkg>).
2172 New refnum (see L<FS::part_referral>).
2176 New quantity; if unspecified, the new package will have the same quantity
2181 "New" (existing) FS::cust_pkg object. The package's services and other
2182 attributes will be transferred to this package.
2186 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2187 susp, adjourn, cancel, expire, and contract_end) to the new package.
2189 =item unprotect_svcs
2191 Normally, change() will rollback and return an error if some services
2192 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2193 If unprotect_svcs is true, this method will transfer as many services as
2194 it can and then unconditionally cancel the old package.
2198 If specified, sets this value for the contract_end date on the new package
2199 (without regard for keep_dates or the usual date-preservation behavior.)
2200 Will throw an error if defined but false; the UI doesn't allow editing
2201 this unless it already exists, making removal impossible to undo.
2205 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2206 cust_pkg must be specified (otherwise, what's the point?)
2208 Returns either the new FS::cust_pkg object or a scalar error.
2212 my $err_or_new_cust_pkg = $old_cust_pkg->change
2216 #used by change and change_later
2217 #didn't put with documented check methods because it depends on change-specific opts
2218 #and it also possibly edits the value of opts
2222 if ( defined($opt->{'contract_end'}) ) {
2223 my $current_contract_end = $self->get('contract_end');
2224 unless ($opt->{'contract_end'}) {
2225 if ($current_contract_end) {
2226 return "Cannot remove contract end date when changing packages";
2228 #shouldn't even pass this option if there's not a current value
2229 #but can be handled gracefully if the option is empty
2230 warn "Contract end date passed unexpectedly";
2231 delete $opt->{'contract_end'};
2235 unless ($current_contract_end) {
2236 #option shouldn't be passed, throw error if it's non-empty
2237 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2243 #some false laziness w/order
2246 my $opt = ref($_[0]) ? shift : { @_ };
2248 my $conf = new FS::Conf;
2250 # handle contract_end on cust_pkg same as passed option
2251 if ( $opt->{'cust_pkg'} ) {
2252 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2253 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2256 # check contract_end, prevent adding/removing
2257 my $error = $self->_check_change($opt);
2258 return $error if $error;
2260 # Transactionize this whole mess
2261 my $oldAutoCommit = $FS::UID::AutoCommit;
2262 local $FS::UID::AutoCommit = 0;
2265 if ( $opt->{'cust_location'} ) {
2266 $error = $opt->{'cust_location'}->find_or_insert;
2268 $dbh->rollback if $oldAutoCommit;
2269 return "creating location record: $error";
2271 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2274 # Before going any further here: if the package is still in the pre-setup
2275 # state, it's safe to modify it in place. No need to charge/credit for
2276 # partial period, transfer services, transfer usage pools, copy invoice
2277 # details, or change any dates.
2278 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2279 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2280 if ( length($opt->{$_}) ) {
2281 $self->set($_, $opt->{$_});
2284 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2286 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2287 $error ||= $self->set_initial_timers;
2289 # but if contract_end was explicitly specified, that overrides all else
2290 $self->set('contract_end', $opt->{'contract_end'})
2291 if $opt->{'contract_end'};
2292 $error ||= $self->replace;
2294 $dbh->rollback if $oldAutoCommit;
2295 return "modifying package: $error";
2297 $dbh->commit if $oldAutoCommit;
2306 $hash{'setup'} = $time if $self->get('setup');
2308 $hash{'change_date'} = $time;
2309 $hash{"change_$_"} = $self->$_()
2310 foreach qw( pkgnum pkgpart locationnum );
2312 if ( $opt->{'cust_pkg'} ) {
2313 # treat changing to a package with a different pkgpart as a
2314 # pkgpart change (because it is)
2315 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2318 # whether to override pkgpart checking on the new package
2319 my $same_pkgpart = 1;
2320 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2324 my $unused_credit = 0;
2325 my $keep_dates = $opt->{'keep_dates'};
2327 # Special case. If the pkgpart is changing, and the customer is going to be
2328 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2329 # and DO pass the flag to cancel() to credit the customer. If the old
2330 # package had a setup date, set the new package's setup to the package
2331 # change date so that it has the same status as before.
2332 if ( $opt->{'pkgpart'}
2333 and $opt->{'pkgpart'} != $self->pkgpart
2334 and $self->part_pkg->option('unused_credit_change', 1) ) {
2337 $hash{'last_bill'} = '';
2341 if ( $keep_dates ) {
2342 foreach my $date ( qw(setup bill last_bill) ) {
2343 $hash{$date} = $self->getfield($date);
2346 # always keep the following dates
2347 foreach my $date (qw(order_date susp adjourn cancel expire resume
2348 start_date contract_end)) {
2349 $hash{$date} = $self->getfield($date);
2351 # but if contract_end was explicitly specified, that overrides all else
2352 $hash{'contract_end'} = $opt->{'contract_end'}
2353 if $opt->{'contract_end'};
2355 # allow $opt->{'locationnum'} = '' to specifically set it to null
2356 # (i.e. customer default location)
2357 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2359 # usually this doesn't matter. the two cases where it does are:
2360 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2362 # 2. (more importantly) changing a package before it's billed
2363 $hash{'waive_setup'} = $self->waive_setup;
2365 # if this package is scheduled for a future package change, preserve that
2366 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2368 my $custnum = $self->custnum;
2369 if ( $opt->{cust_main} ) {
2370 my $cust_main = $opt->{cust_main};
2371 unless ( $cust_main->custnum ) {
2372 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2374 $dbh->rollback if $oldAutoCommit;
2375 return "inserting customer record: $error";
2378 $custnum = $cust_main->custnum;
2381 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2384 if ( $opt->{'cust_pkg'} ) {
2385 # The target package already exists; update it to show that it was
2386 # changed from this package.
2387 $cust_pkg = $opt->{'cust_pkg'};
2389 # follow all the above rules for date changes, etc.
2390 foreach (keys %hash) {
2391 $cust_pkg->set($_, $hash{$_});
2393 # except those that implement the future package change behavior
2394 foreach (qw(change_to_pkgnum start_date expire)) {
2395 $cust_pkg->set($_, '');
2398 $error = $cust_pkg->replace;
2401 # Create the new package.
2402 $cust_pkg = new FS::cust_pkg {
2403 custnum => $custnum,
2404 locationnum => $opt->{'locationnum'},
2405 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2406 qw( pkgpart quantity refnum salesnum )
2410 $error = $cust_pkg->insert( 'change' => 1,
2411 'allow_pkgpart' => $same_pkgpart );
2414 $dbh->rollback if $oldAutoCommit;
2415 return "inserting new package: $error";
2418 # Transfer services and cancel old package.
2419 # Enforce service limits only if this is a pkgpart change.
2420 local $FS::cust_svc::ignore_quantity;
2421 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2422 $error = $self->transfer($cust_pkg);
2423 if ($error and $error == 0) {
2424 # $old_pkg->transfer failed.
2425 $dbh->rollback if $oldAutoCommit;
2426 return "transferring $error";
2429 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2430 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2431 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2432 if ($error and $error == 0) {
2433 # $old_pkg->transfer failed.
2434 $dbh->rollback if $oldAutoCommit;
2435 return "converting $error";
2439 # We set unprotect_svcs when executing a "future package change". It's
2440 # not a user-interactive operation, so returning an error means the
2441 # package change will just fail. Rather than have that happen, we'll
2442 # let leftover services be deleted.
2443 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2444 # Transfers were successful, but we still had services left on the old
2445 # package. We can't change the package under this circumstances, so abort.
2446 $dbh->rollback if $oldAutoCommit;
2447 return "unable to transfer all services";
2450 #reset usage if changing pkgpart
2451 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2452 if ($self->pkgpart != $cust_pkg->pkgpart) {
2453 my $part_pkg = $cust_pkg->part_pkg;
2454 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2458 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2461 $dbh->rollback if $oldAutoCommit;
2462 return "setting usage values: $error";
2465 # if NOT changing pkgpart, transfer any usage pools over
2466 foreach my $usage ($self->cust_pkg_usage) {
2467 $usage->set('pkgnum', $cust_pkg->pkgnum);
2468 $error = $usage->replace;
2470 $dbh->rollback if $oldAutoCommit;
2471 return "transferring usage pools: $error";
2476 # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2477 if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2478 my @old_cust_pkg_usageprice;
2479 if ($opt->{'cust_pkg_usageprice'}) {
2480 @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2482 @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2484 foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2485 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2486 'pkgnum' => $cust_pkg->pkgnum,
2487 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2488 'quantity' => $old_cust_pkg_usageprice->quantity,
2490 $error = $new_cust_pkg_usageprice->insert;
2492 $dbh->rollback if $oldAutoCommit;
2493 return "Error transferring usage pricing add-on: $error";
2498 # transfer discounts, if we're not changing pkgpart
2499 if ( $same_pkgpart ) {
2500 foreach my $old_discount ($self->cust_pkg_discount_active) {
2501 # don't remove the old discount, we may still need to bill that package.
2502 my $new_discount = new FS::cust_pkg_discount {
2503 'pkgnum' => $cust_pkg->pkgnum,
2504 'discountnum' => $old_discount->discountnum,
2505 'months_used' => $old_discount->months_used,
2507 $error = $new_discount->insert;
2509 $dbh->rollback if $oldAutoCommit;
2510 return "transferring discounts: $error";
2515 # transfer (copy) invoice details
2516 foreach my $detail ($self->cust_pkg_detail) {
2517 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2518 $new_detail->set('pkgdetailnum', '');
2519 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2520 $error = $new_detail->insert;
2522 $dbh->rollback if $oldAutoCommit;
2523 return "transferring package notes: $error";
2529 if ( !$opt->{'cust_pkg'} ) {
2530 # Order any supplemental packages.
2531 my $part_pkg = $cust_pkg->part_pkg;
2532 my @old_supp_pkgs = $self->supplemental_pkgs;
2533 foreach my $link ($part_pkg->supp_part_pkg_link) {
2535 foreach (@old_supp_pkgs) {
2536 if ($_->pkgpart == $link->dst_pkgpart) {
2538 $_->pkgpart(0); # so that it can't match more than once
2542 # false laziness with FS::cust_main::Packages::order_pkg
2543 my $new = FS::cust_pkg->new({
2544 pkgpart => $link->dst_pkgpart,
2545 pkglinknum => $link->pkglinknum,
2546 custnum => $custnum,
2547 main_pkgnum => $cust_pkg->pkgnum,
2548 locationnum => $cust_pkg->locationnum,
2549 start_date => $cust_pkg->start_date,
2550 order_date => $cust_pkg->order_date,
2551 expire => $cust_pkg->expire,
2552 adjourn => $cust_pkg->adjourn,
2553 contract_end => $cust_pkg->contract_end,
2554 refnum => $cust_pkg->refnum,
2555 discountnum => $cust_pkg->discountnum,
2556 waive_setup => $cust_pkg->waive_setup,
2558 if ( $old and $opt->{'keep_dates'} ) {
2559 foreach (qw(setup bill last_bill)) {
2560 $new->set($_, $old->get($_));
2563 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2566 $error ||= $old->transfer($new);
2568 if ( $error and $error > 0 ) {
2569 # no reason why this should ever fail, but still...
2570 $error = "Unable to transfer all services from supplemental package ".
2574 $dbh->rollback if $oldAutoCommit;
2577 push @new_supp_pkgs, $new;
2579 } # if !$opt->{'cust_pkg'}
2580 # because if there is one, then supplemental packages would already
2581 # have been created for it.
2583 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2585 #Don't allow billing the package (preceding period packages and/or
2586 #outstanding usage) if we are keeping dates (i.e. location changing),
2587 #because the new package will be billed for the same date range.
2588 #Supplemental packages are also canceled here.
2590 # during scheduled changes, avoid canceling the package we just
2592 $self->set('change_to_pkgnum' => '');
2594 $error = $self->cancel(
2596 unused_credit => $unused_credit,
2597 nobill => $keep_dates,
2598 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2599 no_delay_cancel => 1,
2602 $dbh->rollback if $oldAutoCommit;
2603 return "canceling old package: $error";
2606 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2608 my $error = $cust_pkg->cust_main->bill(
2609 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2612 $dbh->rollback if $oldAutoCommit;
2613 return "billing new package: $error";
2617 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2623 =item change_later OPTION => VALUE...
2625 Schedule a package change for a later date. This actually orders the new
2626 package immediately, but sets its start date for a future date, and sets
2627 the current package to expire on the same date.
2629 If the package is already scheduled for a change, this can be called with
2630 'start_date' to change the scheduled date, or with pkgpart and/or
2631 locationnum to modify the package change. To cancel the scheduled change
2632 entirely, see C<abort_change>.
2640 The date for the package change. Required, and must be in the future.
2650 The pkgpart, locationnum, quantity and optional contract_end of the new
2651 package, with the same meaning as in C<change>.
2659 my $opt = ref($_[0]) ? shift : { @_ };
2661 # check contract_end, prevent adding/removing
2662 my $error = $self->_check_change($opt);
2663 return $error if $error;
2665 my $oldAutoCommit = $FS::UID::AutoCommit;
2666 local $FS::UID::AutoCommit = 0;
2669 my $cust_main = $self->cust_main;
2671 my $date = delete $opt->{'start_date'} or return 'start_date required';
2673 if ( $date <= time ) {
2674 $dbh->rollback if $oldAutoCommit;
2675 return "start_date $date is in the past";
2678 # If the user entered a new location, set it up now.
2679 if ( $opt->{'cust_location'} ) {
2680 $error = $opt->{'cust_location'}->find_or_insert;
2682 $dbh->rollback if $oldAutoCommit;
2683 return "creating location record: $error";
2685 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2688 if ( $self->change_to_pkgnum ) {
2689 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2690 my $new_pkgpart = $opt->{'pkgpart'}
2691 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2692 my $new_locationnum = $opt->{'locationnum'}
2693 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2694 my $new_quantity = $opt->{'quantity'}
2695 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2696 my $new_contract_end = $opt->{'contract_end'}
2697 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2698 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2699 # it hasn't been billed yet, so in principle we could just edit
2700 # it in place (w/o a package change), but that's bad form.
2701 # So change the package according to the new options...
2702 my $err_or_pkg = $change_to->change(%$opt);
2703 if ( ref $err_or_pkg ) {
2704 # Then set that package up for a future start.
2705 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2706 $self->set('expire', $date); # in case it's different
2707 $err_or_pkg->set('start_date', $date);
2708 $err_or_pkg->set('change_date', '');
2709 $err_or_pkg->set('change_pkgnum', '');
2711 $error = $self->replace ||
2712 $err_or_pkg->replace ||
2713 #because change() might've edited existing scheduled change in place
2714 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2715 $change_to->cancel('no_delay_cancel' => 1) ||
2716 $change_to->delete);
2718 $error = $err_or_pkg;
2720 } else { # change the start date only.
2721 $self->set('expire', $date);
2722 $change_to->set('start_date', $date);
2723 $error = $self->replace || $change_to->replace;
2726 $dbh->rollback if $oldAutoCommit;
2729 $dbh->commit if $oldAutoCommit;
2732 } # if $self->change_to_pkgnum
2734 my $new_pkgpart = $opt->{'pkgpart'}
2735 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2736 my $new_locationnum = $opt->{'locationnum'}
2737 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2738 my $new_quantity = $opt->{'quantity'}
2739 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2740 my $new_contract_end = $opt->{'contract_end'}
2741 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2743 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2745 # allow $opt->{'locationnum'} = '' to specifically set it to null
2746 # (i.e. customer default location)
2747 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2749 my $new = FS::cust_pkg->new( {
2750 custnum => $self->custnum,
2751 locationnum => $opt->{'locationnum'},
2752 start_date => $date,
2753 map { $_ => ( $opt->{$_} || $self->$_() ) }
2754 qw( pkgpart quantity refnum salesnum contract_end )
2756 $error = $new->insert('change' => 1,
2757 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2759 $self->set('change_to_pkgnum', $new->pkgnum);
2760 $self->set('expire', $date);
2761 $error = $self->replace;
2764 $dbh->rollback if $oldAutoCommit;
2766 $dbh->commit if $oldAutoCommit;
2774 Cancels a future package change scheduled by C<change_later>.
2780 my $oldAutoCommit = $FS::UID::AutoCommit;
2781 local $FS::UID::AutoCommit = 0;
2783 my $pkgnum = $self->change_to_pkgnum;
2784 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2786 $self->set('change_to_pkgnum', '');
2787 $self->set('expire', '');
2788 $error = $self->replace;
2790 $error ||= $change_to->cancel || $change_to->delete;
2793 if ( $oldAutoCommit ) {
2804 =item set_quantity QUANTITY
2806 Change the package's quantity field. This is one of the few package properties
2807 that can safely be changed without canceling and reordering the package
2808 (because it doesn't affect tax eligibility). Returns an error or an
2815 $self = $self->replace_old; # just to make sure
2816 $self->quantity(shift);
2820 =item set_salesnum SALESNUM
2822 Change the package's salesnum (sales person) field. This is one of the few
2823 package properties that can safely be changed without canceling and reordering
2824 the package (because it doesn't affect tax eligibility). Returns an error or
2831 $self = $self->replace_old; # just to make sure
2832 $self->salesnum(shift);
2834 # XXX this should probably reassign any credit that's already been given
2837 =item modify_charge OPTIONS
2839 Change the properties of a one-time charge. The following properties can
2840 be changed this way:
2841 - pkg: the package description
2842 - classnum: the package class
2843 - additional: arrayref of additional invoice details to add to this package
2845 and, I<if the charge has not yet been billed>:
2846 - start_date: the date when it will be billed
2847 - amount: the setup fee to be charged
2848 - quantity: the multiplier for the setup fee
2849 - separate_bill: whether to put the charge on a separate invoice
2851 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2852 commission credits linked to this charge, they will be recalculated.
2859 my $part_pkg = $self->part_pkg;
2860 my $pkgnum = $self->pkgnum;
2863 my $oldAutoCommit = $FS::UID::AutoCommit;
2864 local $FS::UID::AutoCommit = 0;
2866 return "Can't use modify_charge except on one-time charges"
2867 unless $part_pkg->freq eq '0';
2869 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2870 $part_pkg->set('pkg', $opt{'pkg'});
2873 my %pkg_opt = $part_pkg->options;
2874 my $pkg_opt_modified = 0;
2876 $opt{'additional'} ||= [];
2879 foreach (grep /^additional/, keys %pkg_opt) {
2880 ($i) = ($_ =~ /^additional_info(\d+)$/);
2881 $old_additional[$i] = $pkg_opt{$_} if $i;
2882 delete $pkg_opt{$_};
2885 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2886 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2887 if (!exists($old_additional[$i])
2888 or $old_additional[$i] ne $opt{'additional'}->[$i])
2890 $pkg_opt_modified = 1;
2893 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2894 $pkg_opt{'additional_count'} = $i if $i > 0;
2897 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2900 $old_classnum = $part_pkg->classnum;
2901 $part_pkg->set('classnum', $opt{'classnum'});
2904 if ( !$self->get('setup') ) {
2905 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2908 if ( exists($opt{'amount'})
2909 and $part_pkg->option('setup_fee') != $opt{'amount'}
2910 and $opt{'amount'} > 0 ) {
2912 $pkg_opt{'setup_fee'} = $opt{'amount'};
2913 $pkg_opt_modified = 1;
2916 if ( exists($opt{'setup_cost'})
2917 and $part_pkg->setup_cost != $opt{'setup_cost'}
2918 and $opt{'setup_cost'} > 0 ) {
2920 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2923 if ( exists($opt{'quantity'})
2924 and $opt{'quantity'} != $self->quantity
2925 and $opt{'quantity'} > 0 ) {
2927 $self->set('quantity', $opt{'quantity'});
2930 if ( exists($opt{'start_date'})
2931 and $opt{'start_date'} != $self->start_date ) {
2933 $self->set('start_date', $opt{'start_date'});
2936 if ( exists($opt{'separate_bill'})
2937 and $opt{'separate_bill'} ne $self->separate_bill ) {
2939 $self->set('separate_bill', $opt{'separate_bill'});
2943 } # else simply ignore them; the UI shouldn't allow editing the fields
2946 if ( exists($opt{'taxclass'})
2947 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2949 $part_pkg->set('taxclass', $opt{'taxclass'});
2953 if ( $part_pkg->modified or $pkg_opt_modified ) {
2954 # can we safely modify the package def?
2955 # Yes, if it's not available for purchase, and this is the only instance
2957 if ( $part_pkg->disabled
2958 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2959 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2961 $error = $part_pkg->replace( options => \%pkg_opt );
2964 $part_pkg = $part_pkg->clone;
2965 $part_pkg->set('disabled' => 'Y');
2966 $error = $part_pkg->insert( options => \%pkg_opt );
2967 # and associate this as yet-unbilled package to the new package def
2968 $self->set('pkgpart' => $part_pkg->pkgpart);
2971 $dbh->rollback if $oldAutoCommit;
2976 if ($self->modified) { # for quantity or start_date change, or if we had
2977 # to clone the existing package def
2978 my $error = $self->replace;
2979 return $error if $error;
2981 if (defined $old_classnum) {
2982 # fix invoice grouping records
2983 my $old_catname = $old_classnum
2984 ? FS::pkg_class->by_key($old_classnum)->categoryname
2986 my $new_catname = $opt{'classnum'}
2987 ? $part_pkg->pkg_class->categoryname
2989 if ( $old_catname ne $new_catname ) {
2990 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2991 # (there should only be one...)
2992 my @display = qsearch( 'cust_bill_pkg_display', {
2993 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2994 'section' => $old_catname,
2996 foreach (@display) {
2997 $_->set('section', $new_catname);
2998 $error = $_->replace;
3000 $dbh->rollback if $oldAutoCommit;
3004 } # foreach $cust_bill_pkg
3007 if ( $opt{'adjust_commission'} ) {
3008 # fix commission credits...tricky.
3009 foreach my $cust_event ($self->cust_event) {
3010 my $part_event = $cust_event->part_event;
3011 foreach my $table (qw(sales agent)) {
3013 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3014 my $credit = qsearchs('cust_credit', {
3015 'eventnum' => $cust_event->eventnum,
3017 if ( $part_event->isa($class) ) {
3018 # Yes, this results in current commission rates being applied
3019 # retroactively to a one-time charge. For accounting purposes
3020 # there ought to be some kind of time limit on doing this.
3021 my $amount = $part_event->_calc_credit($self);
3022 if ( $credit and $credit->amount ne $amount ) {
3023 # Void the old credit.
3024 $error = $credit->void('Package class changed');
3026 $dbh->rollback if $oldAutoCommit;
3027 return "$error (adjusting commission credit)";
3030 # redo the event action to recreate the credit.
3032 eval { $part_event->do_action( $self, $cust_event ) };
3034 $dbh->rollback if $oldAutoCommit;
3037 } # if $part_event->isa($class)
3039 } # foreach $cust_event
3040 } # if $opt{'adjust_commission'}
3041 } # if defined $old_classnum
3043 $dbh->commit if $oldAutoCommit;
3050 sub process_bulk_cust_pkg {
3053 warn Dumper($param) if $DEBUG;
3055 my $old_part_pkg = qsearchs('part_pkg',
3056 { pkgpart => $param->{'old_pkgpart'} });
3057 my $new_part_pkg = qsearchs('part_pkg',
3058 { pkgpart => $param->{'new_pkgpart'} });
3059 die "Must select a new package type\n" unless $new_part_pkg;
3060 #my $keep_dates = $param->{'keep_dates'} || 0;
3061 my $keep_dates = 1; # there is no good reason to turn this off
3063 my $oldAutoCommit = $FS::UID::AutoCommit;
3064 local $FS::UID::AutoCommit = 0;
3067 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3070 foreach my $old_cust_pkg ( @cust_pkgs ) {
3072 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3073 if ( $old_cust_pkg->getfield('cancel') ) {
3074 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3075 $old_cust_pkg->pkgnum."\n"
3079 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3081 my $error = $old_cust_pkg->change(
3082 'pkgpart' => $param->{'new_pkgpart'},
3083 'keep_dates' => $keep_dates
3085 if ( !ref($error) ) { # change returns the cust_pkg on success
3087 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3090 $dbh->commit if $oldAutoCommit;
3096 Returns the last bill date, or if there is no last bill date, the setup date.
3097 Useful for billing metered services.
3103 return $self->setfield('last_bill', $_[0]) if @_;
3104 return $self->getfield('last_bill') if $self->getfield('last_bill');
3105 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3106 'edate' => $self->bill, } );
3107 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3110 =item last_cust_pkg_reason ACTION
3112 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3113 Returns false if there is no reason or the package is not currenly ACTION'd
3114 ACTION is one of adjourn, susp, cancel, or expire.
3118 sub last_cust_pkg_reason {
3119 my ( $self, $action ) = ( shift, shift );
3120 my $date = $self->get($action);
3122 'table' => 'cust_pkg_reason',
3123 'hashref' => { 'pkgnum' => $self->pkgnum,
3124 'action' => substr(uc($action), 0, 1),
3127 'order_by' => 'ORDER BY num DESC LIMIT 1',
3131 =item last_reason ACTION
3133 Returns the most recent ACTION FS::reason associated with the package.
3134 Returns false if there is no reason or the package is not currenly ACTION'd
3135 ACTION is one of adjourn, susp, cancel, or expire.
3140 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3141 $cust_pkg_reason->reason
3142 if $cust_pkg_reason;
3147 Returns the definition for this billing item, as an FS::part_pkg object (see
3154 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3155 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3156 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3161 Returns the cancelled package this package was changed from, if any.
3167 return '' unless $self->change_pkgnum;
3168 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3171 =item change_cust_main
3173 Returns the customter this package was detached to, if any.
3177 sub change_cust_main {
3179 return '' unless $self->change_custnum;
3180 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3185 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3192 $self->part_pkg->calc_setup($self, @_);
3197 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3204 $self->part_pkg->calc_recur($self, @_);
3209 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3216 $self->part_pkg->base_setup($self, @_);
3221 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3228 $self->part_pkg->base_recur($self, @_);
3233 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3240 $self->part_pkg->calc_remain($self, @_);
3245 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3252 $self->part_pkg->calc_cancel($self, @_);
3257 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3263 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3266 =item cust_pkg_detail [ DETAILTYPE ]
3268 Returns any customer package details for this package (see
3269 L<FS::cust_pkg_detail>).
3271 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3275 sub cust_pkg_detail {
3277 my %hash = ( 'pkgnum' => $self->pkgnum );
3278 $hash{detailtype} = shift if @_;
3280 'table' => 'cust_pkg_detail',
3281 'hashref' => \%hash,
3282 'order_by' => 'ORDER BY weight, pkgdetailnum',
3286 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3288 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3290 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3292 If there is an error, returns the error, otherwise returns false.
3296 sub set_cust_pkg_detail {
3297 my( $self, $detailtype, @details ) = @_;
3299 my $oldAutoCommit = $FS::UID::AutoCommit;
3300 local $FS::UID::AutoCommit = 0;
3303 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3304 my $error = $current->delete;
3306 $dbh->rollback if $oldAutoCommit;
3307 return "error removing old detail: $error";
3311 foreach my $detail ( @details ) {
3312 my $cust_pkg_detail = new FS::cust_pkg_detail {
3313 'pkgnum' => $self->pkgnum,
3314 'detailtype' => $detailtype,
3315 'detail' => $detail,
3317 my $error = $cust_pkg_detail->insert;
3319 $dbh->rollback if $oldAutoCommit;
3320 return "error adding new detail: $error";
3325 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3332 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3336 #false laziness w/cust_bill.pm
3340 'table' => 'cust_event',
3341 'addl_from' => 'JOIN part_event USING ( eventpart )',
3342 'hashref' => { 'tablenum' => $self->pkgnum },
3343 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3347 =item num_cust_event
3349 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3353 #false laziness w/cust_bill.pm
3354 sub num_cust_event {
3356 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3357 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3360 =item exists_cust_event
3362 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3366 sub exists_cust_event {
3368 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3369 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3370 $row ? $row->[0] : '';
3373 sub _from_cust_event_where {
3375 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3376 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3380 my( $self, $sql, @args ) = @_;
3381 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3382 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3386 =item part_pkg_currency_option OPTIONNAME
3388 Returns a two item list consisting of the currency of this customer, if any,
3389 and a value for the provided option. If the customer has a currency, the value
3390 is the option value the given name and the currency (see
3391 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3392 regular option value for the given name (see L<FS::part_pkg_option>).
3396 sub part_pkg_currency_option {
3397 my( $self, $optionname ) = @_;
3398 my $part_pkg = $self->part_pkg;
3399 if ( my $currency = $self->cust_main->currency ) {
3400 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3402 ('', $part_pkg->option($optionname) );
3406 =item cust_svc [ SVCPART ] (old, deprecated usage)
3408 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3410 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3412 Returns the services for this package, as FS::cust_svc objects (see
3413 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3414 spcififed, returns only the matching services.
3416 As an optimization, use the cust_svc_unsorted version if you are not displaying
3423 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3424 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3427 sub cust_svc_unsorted {
3429 @{ $self->cust_svc_unsorted_arrayref(@_) };
3432 sub cust_svc_unsorted_arrayref {
3435 return [] unless $self->num_cust_svc(@_);
3438 if ( @_ && $_[0] =~ /^\d+/ ) {
3439 $opt{svcpart} = shift;
3440 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3447 'select' => 'cust_svc.*, part_svc.*',
3448 'table' => 'cust_svc',
3449 'hashref' => { 'pkgnum' => $self->pkgnum },
3450 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3452 $search{hashref}->{svcpart} = $opt{svcpart}
3454 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3457 [ qsearch(\%search) ];
3461 =item overlimit [ SVCPART ]
3463 Returns the services for this package which have exceeded their
3464 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3465 is specified, return only the matching services.
3471 return () unless $self->num_cust_svc(@_);
3472 grep { $_->overlimit } $self->cust_svc(@_);
3475 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3477 Returns historical services for this package created before END TIMESTAMP and
3478 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3479 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3480 I<pkg_svc.hidden> flag will be omitted.
3486 warn "$me _h_cust_svc called on $self\n"
3489 my ($end, $start, $mode) = @_;
3491 local($FS::Record::qsearch_qualify_columns) = 0;
3493 my @cust_svc = $self->_sort_cust_svc(
3494 [ qsearch( 'h_cust_svc',
3495 { 'pkgnum' => $self->pkgnum, },
3496 FS::h_cust_svc->sql_h_search(@_),
3500 if ( defined($mode) && $mode eq 'I' ) {
3501 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3502 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3508 sub _sort_cust_svc {
3509 my( $self, $arrayref ) = @_;
3512 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3514 my %pkg_svc = map { $_->svcpart => $_ }
3515 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3520 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3522 $pkg_svc ? $pkg_svc->primary_svc : '',
3523 $pkg_svc ? $pkg_svc->quantity : 0,
3530 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3532 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3534 Returns the number of services for this package. Available options are svcpart
3535 and svcdb. If either is spcififed, returns only the matching services.
3542 return $self->{'_num_cust_svc'}
3544 && exists($self->{'_num_cust_svc'})
3545 && $self->{'_num_cust_svc'} =~ /\d/;
3547 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3551 if ( @_ && $_[0] =~ /^\d+/ ) {
3552 $opt{svcpart} = shift;
3553 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3559 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3560 my $where = ' WHERE pkgnum = ? ';
3561 my @param = ($self->pkgnum);
3563 if ( $opt{'svcpart'} ) {
3564 $where .= ' AND svcpart = ? ';
3565 push @param, $opt{'svcpart'};
3567 if ( $opt{'svcdb'} ) {
3568 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3569 $where .= ' AND svcdb = ? ';
3570 push @param, $opt{'svcdb'};
3573 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3574 $sth->execute(@param) or die $sth->errstr;
3575 $sth->fetchrow_arrayref->[0];
3578 =item available_part_svc
3580 Returns a list of FS::part_svc objects representing services included in this
3581 package but not yet provisioned. Each FS::part_svc object also has an extra
3582 field, I<num_avail>, which specifies the number of available services.
3584 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3585 associated pkg_svc has the provision_hold flag set.
3589 sub available_part_svc {
3593 my $pkg_quantity = $self->quantity || 1;
3595 grep { $_->num_avail > 0 }
3597 my $part_svc = $_->part_svc;
3598 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3599 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3601 # more evil encapsulation breakage
3602 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3603 my @exports = $part_svc->part_export_did;
3604 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3609 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3610 $self->part_pkg->pkg_svc;
3613 =item part_svc [ OPTION => VALUE ... ]
3615 Returns a list of FS::part_svc objects representing provisioned and available
3616 services included in this package. Each FS::part_svc object also has the
3617 following extra fields:
3631 (services) - array reference containing the provisioned services, as cust_svc objects
3635 Accepts two options:
3639 =item summarize_size
3641 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3642 is this size or greater.
3644 =item hide_discontinued
3646 If true, will omit looking for services that are no longer avaialble in the
3654 #label -> ($cust_svc->label)[1]
3660 my $pkg_quantity = $self->quantity || 1;
3662 #XXX some sort of sort order besides numeric by svcpart...
3663 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3665 my $part_svc = $pkg_svc->part_svc;
3666 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3667 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3668 $part_svc->{'Hash'}{'num_avail'} =
3669 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3670 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3671 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3672 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3673 && $num_cust_svc >= $opt{summarize_size};
3674 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3676 } $self->part_pkg->pkg_svc;
3678 unless ( $opt{hide_discontinued} ) {
3680 push @part_svc, map {
3682 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3683 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3684 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3685 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3686 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3688 } $self->extra_part_svc;
3695 =item extra_part_svc
3697 Returns a list of FS::part_svc objects corresponding to services in this
3698 package which are still provisioned but not (any longer) available in the
3703 sub extra_part_svc {
3706 my $pkgnum = $self->pkgnum;
3707 #my $pkgpart = $self->pkgpart;
3710 # 'table' => 'part_svc',
3713 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3714 # WHERE pkg_svc.svcpart = part_svc.svcpart
3715 # AND pkg_svc.pkgpart = ?
3718 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3719 # LEFT JOIN cust_pkg USING ( pkgnum )
3720 # WHERE cust_svc.svcpart = part_svc.svcpart
3723 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3726 #seems to benchmark slightly faster... (or did?)
3728 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3729 my $pkgparts = join(',', @pkgparts);
3732 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3733 #MySQL doesn't grok DISINCT ON
3734 'select' => 'DISTINCT part_svc.*',
3735 'table' => 'part_svc',
3737 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3738 AND pkg_svc.pkgpart IN ($pkgparts)
3741 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3742 LEFT JOIN cust_pkg USING ( pkgnum )
3745 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3746 'extra_param' => [ [$self->pkgnum=>'int'] ],
3752 Returns a short status string for this package, currently:
3758 =item not yet billed
3760 =item one-time charge
3775 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3777 return 'cancelled' if $self->get('cancel');
3778 return 'on hold' if $self->susp && ! $self->setup;
3779 return 'suspended' if $self->susp;
3780 return 'not yet billed' unless $self->setup;
3781 return 'one-time charge' if $freq =~ /^(0|$)/;
3785 =item ucfirst_status
3787 Returns the status with the first character capitalized.
3791 sub ucfirst_status {
3792 ucfirst(shift->status);
3797 Class method that returns the list of possible status strings for packages
3798 (see L<the status method|/status>). For example:
3800 @statuses = FS::cust_pkg->statuses();
3804 tie my %statuscolor, 'Tie::IxHash',
3805 'on hold' => 'FF00F5', #brighter purple!
3806 'not yet billed' => '009999', #teal? cyan?
3807 'one-time charge' => '0000CC', #blue #'000000',
3808 'active' => '00CC00',
3809 'suspended' => 'FF9900',
3810 'cancelled' => 'FF0000',
3814 my $self = shift; #could be class...
3815 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3816 # # mayble split btw one-time vs. recur
3827 Returns a hex triplet color string for this package's status.
3833 $statuscolor{$self->status};
3836 =item is_status_delay_cancel
3838 Returns true if part_pkg has option delay_cancel,
3839 cust_pkg status is 'suspended' and expire is set
3840 to cancel package within the next day (or however
3841 many days are set in global config part_pkg-delay_cancel-days.
3843 Accepts option I<part_pkg-delay_cancel-days> which should be
3844 the value of the config setting, to avoid looking it up again.
3846 This is not a real status, this only meant for hacking display
3847 values, because otherwise treating the package as suspended is
3848 really the whole point of the delay_cancel option.
3852 sub is_status_delay_cancel {
3853 my ($self,%opt) = @_;
3854 if ( $self->main_pkgnum and $self->pkglinknum ) {
3855 return $self->main_pkg->is_status_delay_cancel;
3857 return 0 unless $self->part_pkg->option('delay_cancel',1);
3858 return 0 unless $self->status eq 'suspended';
3859 return 0 unless $self->expire;
3860 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3862 my $conf = new FS::Conf;
3863 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3865 my $expsecs = 60*60*24*$expdays;
3866 return 0 unless $self->expire < time + $expsecs;
3872 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3873 "pkg - comment" depending on user preference).
3879 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3880 $label = $self->pkgnum. ": $label"
3881 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3885 =item pkg_label_long
3887 Returns a long label for this package, adding the primary service's label to
3892 sub pkg_label_long {
3894 my $label = $self->pkg_label;
3895 my $cust_svc = $self->primary_cust_svc;
3896 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3902 Returns a customer-localized label for this package.
3908 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3911 =item primary_cust_svc
3913 Returns a primary service (as FS::cust_svc object) if one can be identified.
3917 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3919 sub primary_cust_svc {
3922 my @cust_svc = $self->cust_svc;
3924 return '' unless @cust_svc; #no serivces - irrelevant then
3926 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3928 # primary service as specified in the package definition
3929 # or exactly one service definition with quantity one
3930 my $svcpart = $self->part_pkg->svcpart;
3931 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3932 return $cust_svc[0] if scalar(@cust_svc) == 1;
3934 #couldn't identify one thing..
3940 Returns a list of lists, calling the label method for all services
3941 (see L<FS::cust_svc>) of this billing item.
3947 map { [ $_->label ] } $self->cust_svc;
3950 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3952 Like the labels method, but returns historical information on services that
3953 were active as of END_TIMESTAMP and (optionally) not cancelled before
3954 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3955 I<pkg_svc.hidden> flag will be omitted.
3957 Returns a list of lists, calling the label method for all (historical) services
3958 (see L<FS::h_cust_svc>) of this billing item.
3964 warn "$me _h_labels called on $self\n"
3966 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3971 Like labels, except returns a simple flat list, and shortens long
3972 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3973 identical services to one line that lists the service label and the number of
3974 individual services rather than individual items.
3979 shift->_labels_short( 'labels', @_ );
3982 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3984 Like h_labels, except returns a simple flat list, and shortens long
3985 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3986 identical services to one line that lists the service label and the number of
3987 individual services rather than individual items.
3991 sub h_labels_short {
3992 shift->_labels_short( 'h_labels', @_ );
3996 my( $self, $method ) = ( shift, shift );
3998 warn "$me _labels_short called on $self with $method method\n"
4001 my $conf = new FS::Conf;
4002 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4004 warn "$me _labels_short populating \%labels\n"
4008 #tie %labels, 'Tie::IxHash';
4009 push @{ $labels{$_->[0]} }, $_->[1]
4010 foreach $self->$method(@_);
4012 warn "$me _labels_short populating \@labels\n"
4016 foreach my $label ( keys %labels ) {
4018 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4019 my $num = scalar(@values);
4020 warn "$me _labels_short $num items for $label\n"
4023 if ( $num > $max_same_services ) {
4024 warn "$me _labels_short more than $max_same_services, so summarizing\n"
4026 push @labels, "$label ($num)";
4028 if ( $conf->exists('cust_bill-consolidate_services') ) {
4029 warn "$me _labels_short consolidating services\n"
4031 # push @labels, "$label: ". join(', ', @values);
4033 my $detail = "$label: ";
4034 $detail .= shift(@values). ', '
4036 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4038 push @labels, $detail;
4040 warn "$me _labels_short done consolidating services\n"
4043 warn "$me _labels_short adding service data\n"
4045 push @labels, map { "$label: $_" } @values;
4056 Returns the parent customer object (see L<FS::cust_main>).
4060 Returns the balance for this specific package, when using
4061 experimental package balance.
4067 $self->cust_main->balance_pkgnum( $self->pkgnum );
4070 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4074 Returns the location object, if any (see L<FS::cust_location>).
4076 =item cust_location_or_main
4078 If this package is associated with a location, returns the locaiton (see
4079 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4081 =item location_label [ OPTION => VALUE ... ]
4083 Returns the label of the location object (see L<FS::cust_location>).
4087 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4089 =item tax_locationnum
4091 Returns the foreign key to a L<FS::cust_location> object for calculating
4092 tax on this package, as determined by the C<tax-pkg_address> and
4093 C<tax-ship_address> configuration flags.
4097 sub tax_locationnum {
4099 my $conf = FS::Conf->new;
4100 if ( $conf->exists('tax-pkg_address') ) {
4101 return $self->locationnum;
4103 elsif ( $conf->exists('tax-ship_address') ) {
4104 return $self->cust_main->ship_locationnum;
4107 return $self->cust_main->bill_locationnum;
4113 Returns the L<FS::cust_location> object for tax_locationnum.
4119 my $conf = FS::Conf->new;
4120 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4121 return FS::cust_location->by_key($self->locationnum);
4123 elsif ( $conf->exists('tax-ship_address') ) {
4124 return $self->cust_main->ship_location;
4127 return $self->cust_main->bill_location;
4131 =item seconds_since TIMESTAMP
4133 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4134 package have been online since TIMESTAMP, according to the session monitor.
4136 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4137 L<Time::Local> and L<Date::Parse> for conversion functions.
4142 my($self, $since) = @_;
4145 foreach my $cust_svc (
4146 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4148 $seconds += $cust_svc->seconds_since($since);
4155 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4157 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4158 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4161 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4162 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4168 sub seconds_since_sqlradacct {
4169 my($self, $start, $end) = @_;
4173 foreach my $cust_svc (
4175 my $part_svc = $_->part_svc;
4176 $part_svc->svcdb eq 'svc_acct'
4177 && scalar($part_svc->part_export_usage);
4180 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4187 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4189 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4190 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4194 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4195 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4200 sub attribute_since_sqlradacct {
4201 my($self, $start, $end, $attrib) = @_;
4205 foreach my $cust_svc (
4207 my $part_svc = $_->part_svc;
4208 scalar($part_svc->part_export_usage);
4211 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4223 my( $self, $value ) = @_;
4224 if ( defined($value) ) {
4225 $self->setfield('quantity', $value);
4227 $self->getfield('quantity') || 1;
4230 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4232 Transfers as many services as possible from this package to another package.
4234 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4235 object. The destination package must already exist.
4237 Services are moved only if the destination allows services with the correct
4238 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4239 this option with caution! No provision is made for export differences
4240 between the old and new service definitions. Probably only should be used
4241 when your exports for all service definitions of a given svcdb are identical.
4242 (attempt a transfer without it first, to move all possible svcpart-matching
4245 Any services that can't be moved remain in the original package.
4247 Returns an error, if there is one; otherwise, returns the number of services
4248 that couldn't be moved.
4253 my ($self, $dest_pkgnum, %opt) = @_;
4259 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4260 $dest = $dest_pkgnum;
4261 $dest_pkgnum = $dest->pkgnum;
4263 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4266 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4268 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4269 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4272 foreach my $cust_svc ($dest->cust_svc) {
4273 $target{$cust_svc->svcpart}--;
4276 my %svcpart2svcparts = ();
4277 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4278 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4279 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4280 next if exists $svcpart2svcparts{$svcpart};
4281 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4282 $svcpart2svcparts{$svcpart} = [
4284 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4286 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4287 'svcpart' => $_ } );
4289 $pkg_svc ? $pkg_svc->primary_svc : '',
4290 $pkg_svc ? $pkg_svc->quantity : 0,
4294 grep { $_ != $svcpart }
4296 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4298 warn "alternates for svcpart $svcpart: ".
4299 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4305 foreach my $cust_svc ($self->cust_svc) {
4306 my $svcnum = $cust_svc->svcnum;
4307 if($target{$cust_svc->svcpart} > 0
4308 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4309 $target{$cust_svc->svcpart}--;
4310 my $new = new FS::cust_svc { $cust_svc->hash };
4311 $new->pkgnum($dest_pkgnum);
4312 $error = $new->replace($cust_svc);
4313 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4315 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4316 warn "alternates to consider: ".
4317 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4319 my @alternate = grep {
4320 warn "considering alternate svcpart $_: ".
4321 "$target{$_} available in new package\n"
4324 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4326 warn "alternate(s) found\n" if $DEBUG;
4327 my $change_svcpart = $alternate[0];
4328 $target{$change_svcpart}--;
4329 my $new = new FS::cust_svc { $cust_svc->hash };
4330 $new->svcpart($change_svcpart);
4331 $new->pkgnum($dest_pkgnum);
4332 $error = $new->replace($cust_svc);
4340 my @label = $cust_svc->label;
4341 return "$label[0] $label[1]: $error";
4347 =item grab_svcnums SVCNUM, SVCNUM ...
4349 Change the pkgnum for the provided services to this packages. If there is an
4350 error, returns the error, otherwise returns false.
4358 my $oldAutoCommit = $FS::UID::AutoCommit;
4359 local $FS::UID::AutoCommit = 0;
4362 foreach my $svcnum (@svcnum) {
4363 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4364 $dbh->rollback if $oldAutoCommit;
4365 return "unknown svcnum $svcnum";
4367 $cust_svc->pkgnum( $self->pkgnum );
4368 my $error = $cust_svc->replace;
4370 $dbh->rollback if $oldAutoCommit;
4375 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4382 This method is deprecated. See the I<depend_jobnum> option to the insert and
4383 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4387 #looks like this is still used by the order_pkg and change_pkg methods in
4388 # ClientAPI/MyAccount, need to look into those before removing
4392 my $oldAutoCommit = $FS::UID::AutoCommit;
4393 local $FS::UID::AutoCommit = 0;
4396 foreach my $cust_svc ( $self->cust_svc ) {
4397 #false laziness w/svc_Common::insert
4398 my $svc_x = $cust_svc->svc_x;
4399 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4400 my $error = $part_export->export_insert($svc_x);
4402 $dbh->rollback if $oldAutoCommit;
4408 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4413 =item export_pkg_change OLD_CUST_PKG
4415 Calls the "pkg_change" export action for all services attached to this package.
4419 sub export_pkg_change {
4420 my( $self, $old ) = ( shift, shift );
4422 my $oldAutoCommit = $FS::UID::AutoCommit;
4423 local $FS::UID::AutoCommit = 0;
4426 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4427 my $error = $svc_x->export('pkg_change', $self, $old);
4429 $dbh->rollback if $oldAutoCommit;
4434 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4441 Associates this package with a (suspension or cancellation) reason (see
4442 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4445 Available options are:
4451 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.
4455 the access_user (see L<FS::access_user>) providing the reason
4463 the action (cancel, susp, adjourn, expire) associated with the reason
4467 If there is an error, returns the error, otherwise returns false.
4472 my ($self, %options) = @_;
4474 my $otaker = $options{reason_otaker} ||
4475 $FS::CurrentUser::CurrentUser->username;
4478 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4482 } elsif ( ref($options{'reason'}) ) {
4484 return 'Enter a new reason (or select an existing one)'
4485 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4487 my $reason = new FS::reason({
4488 'reason_type' => $options{'reason'}->{'typenum'},
4489 'reason' => $options{'reason'}->{'reason'},
4491 my $error = $reason->insert;
4492 return $error if $error;
4494 $reasonnum = $reason->reasonnum;
4497 return "Unparseable reason: ". $options{'reason'};
4500 my $cust_pkg_reason =
4501 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4502 'reasonnum' => $reasonnum,
4503 'otaker' => $otaker,
4504 'action' => substr(uc($options{'action'}),0,1),
4505 'date' => $options{'date'}
4510 $cust_pkg_reason->insert;
4513 =item insert_discount
4515 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4516 inserting a new discount on the fly (see L<FS::discount>).
4518 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4519 and if present, will create a setup discount. If the discountnum is -1,
4520 a new discount definition will be inserted using the value in
4521 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4523 If there is an error, returns the error, otherwise returns false.
4527 sub insert_discount {
4528 #my ($self, %options) = @_;
4531 foreach my $x (qw(setup recur)) {
4532 if ( my $discountnum = $self->get("${x}_discountnum") ) {
4533 my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4534 'pkgnum' => $self->pkgnum,
4535 'discountnum' => $discountnum,
4538 'end_date' => '', #XXX
4539 #for the create a new discount case
4540 'amount' => $self->get("${x}_discountnum_amount"),
4541 'percent' => $self->get("${x}_discountnum_percent"),
4542 'months' => $self->get("${x}_discountnum_months"),
4544 if ( $x eq 'setup' ) {
4545 $cust_pkg_discount->setup('Y');
4546 $cust_pkg_discount->months('');
4548 my $error = $cust_pkg_discount->insert;
4549 return $error if $error;
4556 =item set_usage USAGE_VALUE_HASHREF
4558 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4559 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4560 upbytes, downbytes, and totalbytes are appropriate keys.
4562 All svc_accts which are part of this package have their values reset.
4567 my ($self, $valueref, %opt) = @_;
4569 #only svc_acct can set_usage for now
4570 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4571 my $svc_x = $cust_svc->svc_x;
4572 $svc_x->set_usage($valueref, %opt)
4573 if $svc_x->can("set_usage");
4577 =item recharge USAGE_VALUE_HASHREF
4579 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4580 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4581 upbytes, downbytes, and totalbytes are appropriate keys.
4583 All svc_accts which are part of this package have their values incremented.
4588 my ($self, $valueref) = @_;
4590 #only svc_acct can set_usage for now
4591 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4592 my $svc_x = $cust_svc->svc_x;
4593 $svc_x->recharge($valueref)
4594 if $svc_x->can("recharge");
4598 =item apply_usageprice
4602 sub apply_usageprice {
4605 my $oldAutoCommit = $FS::UID::AutoCommit;
4606 local $FS::UID::AutoCommit = 0;
4611 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4612 $error ||= $cust_pkg_usageprice->apply;
4616 $dbh->rollback if $oldAutoCommit;
4617 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4620 $dbh->commit if $oldAutoCommit;
4626 =item cust_pkg_discount
4628 =item cust_pkg_discount_active
4632 sub cust_pkg_discount_active {
4634 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4637 =item cust_pkg_usage
4639 Returns a list of all voice usage counters attached to this package.
4641 =item apply_usage OPTIONS
4643 Takes the following options:
4644 - cdr: a call detail record (L<FS::cdr>)
4645 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4646 - minutes: the maximum number of minutes to be charged
4648 Finds available usage minutes for a call of this class, and subtracts
4649 up to that many minutes from the usage pool. If the usage pool is empty,
4650 and the C<cdr-minutes_priority> global config option is set, minutes may
4651 be taken from other calls as well. Either way, an allocation record will
4652 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4653 number of minutes of usage applied to the call.
4658 my ($self, %opt) = @_;
4659 my $cdr = $opt{cdr};
4660 my $rate_detail = $opt{rate_detail};
4661 my $minutes = $opt{minutes};
4662 my $classnum = $rate_detail->classnum;
4663 my $pkgnum = $self->pkgnum;
4664 my $custnum = $self->custnum;
4666 my $oldAutoCommit = $FS::UID::AutoCommit;
4667 local $FS::UID::AutoCommit = 0;
4670 my $order = FS::Conf->new->config('cdr-minutes_priority');
4674 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4676 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4678 my @usage_recs = qsearch({
4679 'table' => 'cust_pkg_usage',
4680 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4681 ' JOIN cust_pkg USING (pkgnum)'.
4682 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4683 'select' => 'cust_pkg_usage.*',
4684 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4685 " ( cust_pkg.custnum = $custnum AND ".
4686 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4687 $is_classnum . ' AND '.
4688 " cust_pkg_usage.minutes > 0",
4689 'order_by' => " ORDER BY priority ASC",
4692 my $orig_minutes = $minutes;
4694 while (!$error and $minutes > 0 and @usage_recs) {
4695 my $cust_pkg_usage = shift @usage_recs;
4696 $cust_pkg_usage->select_for_update;
4697 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4698 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4699 acctid => $cdr->acctid,
4700 minutes => min($cust_pkg_usage->minutes, $minutes),
4702 $cust_pkg_usage->set('minutes',
4703 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4705 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4706 $minutes -= $cdr_cust_pkg_usage->minutes;
4708 if ( $order and $minutes > 0 and !$error ) {
4709 # then try to steal minutes from another call
4711 'table' => 'cdr_cust_pkg_usage',
4712 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4713 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4714 ' JOIN cust_pkg USING (pkgnum)'.
4715 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4716 ' JOIN cdr USING (acctid)',
4717 'select' => 'cdr_cust_pkg_usage.*',
4718 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4719 " ( cust_pkg.pkgnum = $pkgnum OR ".
4720 " ( cust_pkg.custnum = $custnum AND ".
4721 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4722 " part_pkg_usage_class.classnum = $classnum",
4723 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4725 if ( $order eq 'time' ) {
4726 # find CDRs that are using minutes, but have a later startdate
4728 my $startdate = $cdr->startdate;
4729 if ($startdate !~ /^\d+$/) {
4730 die "bad cdr startdate '$startdate'";
4732 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4733 # minimize needless reshuffling
4734 $search{'order_by'} .= ', cdr.startdate DESC';
4736 # XXX may not work correctly with rate_time schedules. Could
4737 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4739 $search{'addl_from'} .=
4740 ' JOIN rate_detail'.
4741 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4742 if ( $order eq 'rate_high' ) {
4743 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4744 $rate_detail->min_charge;
4745 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4746 } elsif ( $order eq 'rate_low' ) {
4747 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4748 $rate_detail->min_charge;
4749 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4751 # this should really never happen
4752 die "invalid cdr-minutes_priority value '$order'\n";
4755 my @cdr_usage_recs = qsearch(\%search);
4757 while (!$error and @cdr_usage_recs and $minutes > 0) {
4758 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4759 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4760 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4761 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4762 $cdr_cust_pkg_usage->select_for_update;
4763 $old_cdr->select_for_update;
4764 $cust_pkg_usage->select_for_update;
4765 # in case someone else stole the usage from this CDR
4766 # while waiting for the lock...
4767 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4768 # steal the usage allocation and flag the old CDR for reprocessing
4769 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4770 # if the allocation is more minutes than we need, adjust it...
4771 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4773 $cdr_cust_pkg_usage->set('minutes', $minutes);
4774 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4775 $error = $cust_pkg_usage->replace;
4777 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4778 $error ||= $cdr_cust_pkg_usage->replace;
4779 # deduct the stolen minutes
4780 $minutes -= $cdr_cust_pkg_usage->minutes;
4782 # after all minute-stealing is done, reset the affected CDRs
4783 foreach (values %reproc_cdrs) {
4784 $error ||= $_->set_status('');
4785 # XXX or should we just call $cdr->rate right here?
4786 # it's not like we can create a loop this way, since the min_charge
4787 # or call time has to go monotonically in one direction.
4788 # we COULD get some very deep recursions going, though...
4790 } # if $order and $minutes
4793 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4795 $dbh->commit if $oldAutoCommit;
4796 return $orig_minutes - $minutes;
4800 =item supplemental_pkgs
4802 Returns a list of all packages supplemental to this one.
4806 sub supplemental_pkgs {
4808 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4813 Returns the package that this one is supplemental to, if any.
4819 if ( $self->main_pkgnum ) {
4820 return FS::cust_pkg->by_key($self->main_pkgnum);
4827 =head1 CLASS METHODS
4833 Returns an SQL expression identifying recurring packages.
4837 sub recurring_sql { "
4838 '0' != ( select freq from part_pkg
4839 where cust_pkg.pkgpart = part_pkg.pkgpart )
4844 Returns an SQL expression identifying one-time packages.
4849 '0' = ( select freq from part_pkg
4850 where cust_pkg.pkgpart = part_pkg.pkgpart )
4855 Returns an SQL expression identifying ordered packages (recurring packages not
4861 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4866 Returns an SQL expression identifying active packages.
4871 $_[0]->recurring_sql. "
4872 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4873 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4874 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4877 =item not_yet_billed_sql
4879 Returns an SQL expression identifying packages which have not yet been billed.
4883 sub not_yet_billed_sql { "
4884 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4885 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4886 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4891 Returns an SQL expression identifying inactive packages (one-time packages
4892 that are otherwise unsuspended/uncancelled).
4896 sub inactive_sql { "
4897 ". $_[0]->onetime_sql(). "
4898 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4899 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4900 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4905 Returns an SQL expression identifying on-hold packages.
4910 #$_[0]->recurring_sql(). ' AND '.
4912 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4913 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4914 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4921 Returns an SQL expression identifying suspended packages.
4925 sub suspended_sql { susp_sql(@_); }
4927 #$_[0]->recurring_sql(). ' AND '.
4929 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4930 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4931 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4938 Returns an SQL exprression identifying cancelled packages.
4942 sub cancelled_sql { cancel_sql(@_); }
4944 #$_[0]->recurring_sql(). ' AND '.
4945 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4950 Returns an SQL expression to give the package status as a string.
4956 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4957 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4958 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4959 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4960 WHEN ".onetime_sql()." THEN 'one-time charge'
4967 Returns a list of two package counts. The first is a count of packages
4968 based on the supplied criteria and the second is the count of residential
4969 packages with those same criteria. Criteria are specified as in the search
4975 my ($class, $params) = @_;
4977 my $sql_query = $class->search( $params );
4979 my $count_sql = delete($sql_query->{'count_query'});
4980 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4981 or die "couldn't parse count_sql";
4983 my $count_sth = dbh->prepare($count_sql)
4984 or die "Error preparing $count_sql: ". dbh->errstr;
4986 or die "Error executing $count_sql: ". $count_sth->errstr;
4987 my $count_arrayref = $count_sth->fetchrow_arrayref;
4989 return ( @$count_arrayref );
4993 =item tax_locationnum_sql
4995 Returns an SQL expression for the tax location for a package, based
4996 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5000 sub tax_locationnum_sql {
5001 my $conf = FS::Conf->new;
5002 if ( $conf->exists('tax-pkg_address') ) {
5003 'cust_pkg.locationnum';
5005 elsif ( $conf->exists('tax-ship_address') ) {
5006 'cust_main.ship_locationnum';
5009 'cust_main.bill_locationnum';
5015 Returns a list: the first item is an SQL fragment identifying matching
5016 packages/customers via location (taking into account shipping and package
5017 address taxation, if enabled), and subsequent items are the parameters to
5018 substitute for the placeholders in that fragment.
5023 my($class, %opt) = @_;
5024 my $ornull = $opt{'ornull'};
5026 my $conf = new FS::Conf;
5028 # '?' placeholders in _location_sql_where
5029 my $x = $ornull ? 3 : 2;
5040 if ( $conf->exists('tax-ship_address') ) {
5043 ( ( ship_last IS NULL OR ship_last = '' )
5044 AND ". _location_sql_where('cust_main', '', $ornull ). "
5046 OR ( ship_last IS NOT NULL AND ship_last != ''
5047 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5050 # AND payby != 'COMP'
5052 @main_param = ( @bill_param, @bill_param );
5056 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5057 @main_param = @bill_param;
5063 if ( $conf->exists('tax-pkg_address') ) {
5065 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5068 ( cust_pkg.locationnum IS NULL AND $main_where )
5069 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5072 @param = ( @main_param, @bill_param );
5076 $where = $main_where;
5077 @param = @main_param;
5085 #subroutine, helper for location_sql
5086 sub _location_sql_where {
5088 my $prefix = @_ ? shift : '';
5089 my $ornull = @_ ? shift : '';
5091 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5093 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5095 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5096 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5097 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5099 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5101 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5103 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5104 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5105 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5106 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5107 AND $table.${prefix}country = ?
5112 my( $self, $what ) = @_;
5114 my $what_show_zero = $what. '_show_zero';
5115 length($self->$what_show_zero())
5116 ? ($self->$what_show_zero() eq 'Y')
5117 : $self->part_pkg->$what_show_zero();
5124 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5126 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5127 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5129 CUSTNUM is a customer (see L<FS::cust_main>)
5131 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5132 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5135 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5136 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5137 new billing items. An error is returned if this is not possible (see
5138 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5141 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5142 newly-created cust_pkg objects.
5144 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5145 and inserted. Multiple FS::pkg_referral records can be created by
5146 setting I<refnum> to an array reference of refnums or a hash reference with
5147 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5148 record will be created corresponding to cust_main.refnum.
5153 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5155 my $conf = new FS::Conf;
5157 # Transactionize this whole mess
5158 my $oldAutoCommit = $FS::UID::AutoCommit;
5159 local $FS::UID::AutoCommit = 0;
5163 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5164 # return "Customer not found: $custnum" unless $cust_main;
5166 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5169 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5172 my $change = scalar(@old_cust_pkg) != 0;
5175 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5177 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5178 " to pkgpart ". $pkgparts->[0]. "\n"
5181 my $err_or_cust_pkg =
5182 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5183 'refnum' => $refnum,
5186 unless (ref($err_or_cust_pkg)) {
5187 $dbh->rollback if $oldAutoCommit;
5188 return $err_or_cust_pkg;
5191 push @$return_cust_pkg, $err_or_cust_pkg;
5192 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5197 # Create the new packages.
5198 foreach my $pkgpart (@$pkgparts) {
5200 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5202 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5203 pkgpart => $pkgpart,
5207 $error = $cust_pkg->insert( 'change' => $change );
5208 push @$return_cust_pkg, $cust_pkg;
5210 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5211 my $supp_pkg = FS::cust_pkg->new({
5212 custnum => $custnum,
5213 pkgpart => $link->dst_pkgpart,
5215 main_pkgnum => $cust_pkg->pkgnum,
5218 $error ||= $supp_pkg->insert( 'change' => $change );
5219 push @$return_cust_pkg, $supp_pkg;
5223 $dbh->rollback if $oldAutoCommit;
5228 # $return_cust_pkg now contains refs to all of the newly
5231 # Transfer services and cancel old packages.
5232 foreach my $old_pkg (@old_cust_pkg) {
5234 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5237 foreach my $new_pkg (@$return_cust_pkg) {
5238 $error = $old_pkg->transfer($new_pkg);
5239 if ($error and $error == 0) {
5240 # $old_pkg->transfer failed.
5241 $dbh->rollback if $oldAutoCommit;
5246 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5247 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5248 foreach my $new_pkg (@$return_cust_pkg) {
5249 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5250 if ($error and $error == 0) {
5251 # $old_pkg->transfer failed.
5252 $dbh->rollback if $oldAutoCommit;
5259 # Transfers were successful, but we went through all of the
5260 # new packages and still had services left on the old package.
5261 # We can't cancel the package under the circumstances, so abort.
5262 $dbh->rollback if $oldAutoCommit;
5263 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5265 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5271 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5275 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5277 A bulk change method to change packages for multiple customers.
5279 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5280 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5283 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5284 replace. The services (see L<FS::cust_svc>) are moved to the
5285 new billing items. An error is returned if this is not possible (see
5288 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5289 newly-created cust_pkg objects.
5294 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5296 # Transactionize this whole mess
5297 my $oldAutoCommit = $FS::UID::AutoCommit;
5298 local $FS::UID::AutoCommit = 0;
5302 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5305 while(scalar(@old_cust_pkg)) {
5307 my $custnum = $old_cust_pkg[0]->custnum;
5308 my (@remove) = map { $_->pkgnum }
5309 grep { $_->custnum == $custnum } @old_cust_pkg;
5310 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5312 my $error = order $custnum, $pkgparts, \@remove, \@return;
5314 push @errors, $error
5316 push @$return_cust_pkg, @return;
5319 if (scalar(@errors)) {
5320 $dbh->rollback if $oldAutoCommit;
5321 return join(' / ', @errors);
5324 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5328 =item forward_emails
5330 Returns a hash of svcnums and corresponding email addresses
5331 for svc_acct services that can be used as source or dest
5332 for svc_forward services provisioned in this package.
5334 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5335 service; if included, will ensure the current values of the
5336 specified service are included in the list, even if for some
5337 other reason they wouldn't be. If called as a class method
5338 with a specified service, returns only these current values.
5340 Caution: does not actually check if svc_forward services are
5341 available to be provisioned on this package.
5345 sub forward_emails {
5349 #load optional service, thoroughly validated
5350 die "Use svcnum or svc_forward, not both"
5351 if $opt{'svcnum'} && $opt{'svc_forward'};
5352 my $svc_forward = $opt{'svc_forward'};
5353 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5355 die "Specified service is not a forward service"
5356 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5357 die "Specified service not found"
5358 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5362 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5363 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5365 #add current values from specified service, if there was one
5367 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5368 my $svc_acct = $svc_forward->$method();
5369 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5373 if (ref($self) eq 'FS::cust_pkg') {
5375 #and including the rest for this customer
5376 my($u_part_svc,@u_acct_svcparts);
5377 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5378 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5381 my $custnum = $self->getfield('custnum');
5382 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5383 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5384 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5385 foreach my $acct_svcpart (@u_acct_svcparts) {
5386 foreach my $i_cust_svc (
5387 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5388 'svcpart' => $acct_svcpart } )
5390 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5391 $email{$svc_acct->svcnum} = $svc_acct->email;
5400 # Used by FS::Upgrade to migrate to a new database.
5401 sub _upgrade_data { # class method
5402 my ($class, %opts) = @_;
5403 $class->_upgrade_otaker(%opts);
5405 # RT#10139, bug resulting in contract_end being set when it shouldn't
5406 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5407 # RT#10830, bad calculation of prorate date near end of year
5408 # the date range for bill is December 2009, and we move it forward
5409 # one year if it's before the previous bill date (which it should
5411 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5412 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5413 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5414 # RT6628, add order_date to cust_pkg
5415 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5416 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5417 history_action = \'insert\') where order_date is null',
5419 foreach my $sql (@statements) {
5420 my $sth = dbh->prepare($sql);
5421 $sth->execute or die $sth->errstr;
5424 # RT31194: supplemental package links that are deleted don't clean up
5426 my @pkglinknums = qsearch({
5427 'select' => 'DISTINCT cust_pkg.pkglinknum',
5428 'table' => 'cust_pkg',
5429 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5430 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5431 AND part_pkg_link.pkglinknum IS NULL',
5433 foreach (@pkglinknums) {
5434 my $pkglinknum = $_->pkglinknum;
5435 warn "cleaning part_pkg_link #$pkglinknum\n";
5436 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5437 my $error = $part_pkg_link->remove_linked;
5438 die $error if $error;
5446 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5448 In sub order, the @pkgparts array (passed by reference) is clobbered.
5450 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5451 method to pass dates to the recur_prog expression, it should do so.
5453 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5454 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5455 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5456 configuration values. Probably need a subroutine which decides what to do
5457 based on whether or not we've fetched the user yet, rather than a hash. See
5458 FS::UID and the TODO.
5460 Now that things are transactional should the check in the insert method be
5465 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5466 L<FS::pkg_svc>, schema.html from the base documentation