2 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
3 FS::contact_Mixin FS::location_Mixin
4 FS::m2m_Common FS::option_Common );
8 use Scalar::Util qw( blessed );
9 use List::Util qw(min max);
11 use Time::Local qw( timelocal timelocal_nocheck );
13 use FS::UID qw( dbh driver_name );
14 use FS::Misc qw( send_email );
15 use FS::Record qw( qsearch qsearchs fields );
21 use FS::cust_location;
23 use FS::cust_bill_pkg;
24 use FS::cust_pkg_detail;
25 use FS::cust_pkg_usage;
26 use FS::cdr_cust_pkg_usage;
31 use FS::cust_pkg_reason;
33 use FS::cust_pkg_usageprice;
34 use FS::cust_pkg_discount;
41 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
43 # because they load configuration by setting FS::UID::callback (see TODO)
49 # for sending cancel emails in sub cancel
52 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
54 our $upgrade = 0; #go away after setup+start dates cleaned up for old customers
58 my ( $hashref, $cache ) = @_;
59 #if ( $hashref->{'pkgpart'} ) {
60 if ( $hashref->{'pkg'} ) {
61 # #@{ $self->{'_pkgnum'} } = ();
62 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
63 # $self->{'_pkgpart'} = $subcache;
64 # #push @{ $self->{'_pkgnum'} },
65 # FS::part_pkg->new_or_cached($hashref, $subcache);
66 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
68 if ( exists $hashref->{'svcnum'} ) {
69 #@{ $self->{'_pkgnum'} } = ();
70 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
71 $self->{'_svcnum'} = $subcache;
72 #push @{ $self->{'_pkgnum'} },
73 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
79 FS::cust_pkg - Object methods for cust_pkg objects
85 $record = new FS::cust_pkg \%hash;
86 $record = new FS::cust_pkg { 'column' => 'value' };
88 $error = $record->insert;
90 $error = $new_record->replace($old_record);
92 $error = $record->delete;
94 $error = $record->check;
96 $error = $record->cancel;
98 $error = $record->suspend;
100 $error = $record->unsuspend;
102 $part_pkg = $record->part_pkg;
104 @labels = $record->labels;
106 $seconds = $record->seconds_since($timestamp);
108 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
109 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
113 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
114 inherits from FS::Record. The following fields are currently supported:
120 Primary key (assigned automatically for new billing items)
124 Customer (see L<FS::cust_main>)
128 Billing item definition (see L<FS::part_pkg>)
132 Optional link to package location (see L<FS::location>)
136 date package was ordered (also remains same on changes)
148 date (next bill date)
176 order taker (see L<FS::access_user>)
180 If this field is set to 1, disables the automatic
181 unsuspension of this package when using the B<unsuspendauto> config option.
185 If not set, defaults to 1
189 Date of change from previous package
199 =item change_locationnum
207 The pkgnum of the package that this package is supplemental to, if any.
211 The package link (L<FS::part_pkg_link>) that defines this supplemental
212 package, if it is one.
214 =item change_to_pkgnum
216 The pkgnum of the package this one will be "changed to" in the future
217 (on its expiration date).
221 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
222 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
223 L<Time::Local> and L<Date::Parse> for conversion functions.
231 Create a new billing item. To add the item to the database, see L<"insert">.
235 sub table { 'cust_pkg'; }
236 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
237 sub cust_unlinked_msg {
239 "WARNING: can't find cust_main.custnum ". $self->custnum.
240 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
243 =item insert [ OPTION => VALUE ... ]
245 Adds this billing item to the database ("Orders" the item). If there is an
246 error, returns the error, otherwise returns false.
248 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
249 will be used to look up the package definition and agent restrictions will be
252 If the additional field I<refnum> is defined, an FS::pkg_referral record will
253 be created and inserted. Multiple FS::pkg_referral records can be created by
254 setting I<refnum> to an array reference of refnums or a hash reference with
255 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
256 record will be created corresponding to cust_main.refnum.
258 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
259 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
260 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
261 It can be set as part of the hash when creating the object, or with the B<set>
264 The following options are available:
270 If set true, supresses actions that should only be taken for new package
271 orders. (Currently this includes: intro periods when delay_setup is on.)
275 cust_pkg_option records will be created
279 a ticket will be added to this customer with this subject
283 an optional queue name for ticket additions
287 Don't check the legality of the package definition. This should be used
288 when performing a package change that doesn't change the pkgpart (i.e.
296 my( $self, %options ) = @_;
299 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
300 return $error if $error;
302 my $part_pkg = $self->part_pkg;
305 # if the package def says to start only on the first of the month:
306 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
307 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
308 $mon += 1 unless $mday == 1;
309 until ( $mon < 12 ) { $mon -= 12; $year++; }
310 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
313 # set up any automatic expire/adjourn/contract_end timers
314 # based on the start date
315 foreach my $action ( qw(expire adjourn contract_end) ) {
316 my $months = $part_pkg->option("${action}_months",1);
317 if($months and !$self->$action) {
318 my $start = $self->start_date || $self->setup || time;
319 $self->$action( $part_pkg->add_freq($start, $months) );
323 # if this package has "free days" and delayed setup fee, tehn
324 # set start date that many days in the future.
325 # (this should have been set in the UI, but enforce it here)
326 if ( ! $options{'change'}
327 && ( my $free_days = $part_pkg->option('free_days',1) )
328 && $part_pkg->option('delay_setup',1)
329 #&& ! $self->start_date
332 $self->start_date( $part_pkg->default_start_date );
336 # set order date unless it was specified as part of an import
337 # or this was previously a different package
338 $self->order_date(time) unless ($import && $self->order_date)
339 or $self->change_pkgnum;
341 my $oldAutoCommit = $FS::UID::AutoCommit;
342 local $FS::UID::AutoCommit = 0;
345 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
347 $dbh->rollback if $oldAutoCommit;
351 $self->refnum($self->cust_main->refnum) unless $self->refnum;
352 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
353 $self->process_m2m( 'link_table' => 'pkg_referral',
354 'target_table' => 'part_referral',
355 'params' => $self->refnum,
358 if ( $self->hashref->{cust_pkg_usageprice} ) {
359 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
360 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
361 my $error = $cust_pkg_usageprice->insert;
363 $dbh->rollback if $oldAutoCommit;
369 if ( $self->discountnum ) {
370 my $error = $self->insert_discount();
372 $dbh->rollback if $oldAutoCommit;
377 my $conf = new FS::Conf;
379 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
381 #this init stuff is still inefficient, but at least its limited to
382 # the small number (any?) folks using ticket emailing on pkg order
385 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
392 use FS::TicketSystem;
393 FS::TicketSystem->init();
395 my $q = new RT::Queue($RT::SystemUser);
396 $q->Load($options{ticket_queue}) if $options{ticket_queue};
397 my $t = new RT::Ticket($RT::SystemUser);
398 my $mime = new MIME::Entity;
399 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
400 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
401 Subject => $options{ticket_subject},
404 $t->AddLink( Type => 'MemberOf',
405 Target => 'freeside://freeside/cust_main/'. $self->custnum,
409 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
410 my $queue = new FS::queue {
411 'job' => 'FS::cust_main::queueable_print',
413 $error = $queue->insert(
414 'custnum' => $self->custnum,
415 'template' => 'welcome_letter',
419 warn "can't send welcome letter: $error";
424 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
431 This method now works but you probably shouldn't use it.
433 You don't want to delete packages, because there would then be no record
434 the customer ever purchased the package. Instead, see the cancel method and
435 hide cancelled packages.
442 my $oldAutoCommit = $FS::UID::AutoCommit;
443 local $FS::UID::AutoCommit = 0;
446 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
447 my $error = $cust_pkg_discount->delete;
449 $dbh->rollback if $oldAutoCommit;
453 #cust_bill_pkg_discount?
455 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
456 my $error = $cust_pkg_detail->delete;
458 $dbh->rollback if $oldAutoCommit;
463 foreach my $cust_pkg_reason (
465 'table' => 'cust_pkg_reason',
466 'hashref' => { 'pkgnum' => $self->pkgnum },
470 my $error = $cust_pkg_reason->delete;
472 $dbh->rollback if $oldAutoCommit;
479 my $error = $self->SUPER::delete(@_);
481 $dbh->rollback if $oldAutoCommit;
485 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
491 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
493 Replaces the OLD_RECORD with this one in the database. If there is an error,
494 returns the error, otherwise returns false.
496 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
498 Changing pkgpart may have disasterous effects. See the order subroutine.
500 setup and bill are normally updated by calling the bill method of a customer
501 object (see L<FS::cust_main>).
503 suspend is normally updated by the suspend and unsuspend methods.
505 cancel is normally updated by the cancel method (and also the order subroutine
508 Available options are:
514 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.
518 the access_user (see L<FS::access_user>) providing the reason
522 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
531 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
536 ( ref($_[0]) eq 'HASH' )
540 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
541 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
544 #return "Can't change setup once it exists!"
545 # if $old->getfield('setup') &&
546 # $old->getfield('setup') != $new->getfield('setup');
548 #some logic for bill, susp, cancel?
550 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
552 my $oldAutoCommit = $FS::UID::AutoCommit;
553 local $FS::UID::AutoCommit = 0;
556 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
557 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
558 my $error = $new->insert_reason(
559 'reason' => $options->{'reason'},
560 'date' => $new->$method,
562 'reason_otaker' => $options->{'reason_otaker'},
565 dbh->rollback if $oldAutoCommit;
566 return "Error inserting cust_pkg_reason: $error";
571 #save off and freeze RADIUS attributes for any associated svc_acct records
573 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
575 #also check for specific exports?
576 # to avoid spurious modify export events
577 @svc_acct = map { $_->svc_x }
578 grep { $_->part_svc->svcdb eq 'svc_acct' }
581 $_->snapshot foreach @svc_acct;
585 my $error = $new->export_pkg_change($old)
586 || $new->SUPER::replace( $old,
588 ? $options->{options}
592 $dbh->rollback if $oldAutoCommit;
596 #for prepaid packages,
597 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
598 foreach my $old_svc_acct ( @svc_acct ) {
599 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
601 $new_svc_acct->replace( $old_svc_acct,
602 'depend_jobnum' => $options->{depend_jobnum},
605 $dbh->rollback if $oldAutoCommit;
610 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
617 Checks all fields to make sure this is a valid billing item. If there is an
618 error, returns the error, otherwise returns false. Called by the insert and
626 if ( !$self->locationnum or $self->locationnum == -1 ) {
627 $self->set('locationnum', $self->cust_main->ship_locationnum);
631 $self->ut_numbern('pkgnum')
632 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
633 || $self->ut_numbern('pkgpart')
634 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
635 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
636 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
637 || $self->ut_numbern('quantity')
638 || $self->ut_numbern('start_date')
639 || $self->ut_numbern('setup')
640 || $self->ut_numbern('bill')
641 || $self->ut_numbern('susp')
642 || $self->ut_numbern('cancel')
643 || $self->ut_numbern('adjourn')
644 || $self->ut_numbern('resume')
645 || $self->ut_numbern('expire')
646 || $self->ut_numbern('dundate')
647 || $self->ut_enum('no_auto', [ '', 'Y' ])
648 || $self->ut_enum('waive_setup', [ '', 'Y' ])
649 || $self->ut_numbern('agent_pkgid')
650 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
651 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
652 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
653 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
654 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
656 return $error if $error;
658 return "A package with both start date (future start) and setup date (already started) will never bill"
659 if $self->start_date && $self->setup && ! $upgrade;
661 return "A future unsuspend date can only be set for a package with a suspend date"
662 if $self->resume and !$self->susp and !$self->adjourn;
664 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
666 if ( $self->dbdef_table->column('manual_flag') ) {
667 $self->manual_flag('') if $self->manual_flag eq ' ';
668 $self->manual_flag =~ /^([01]?)$/
669 or return "Illegal manual_flag ". $self->manual_flag;
670 $self->manual_flag($1);
678 Check the pkgpart to make sure it's allowed with the reg_code and/or
679 promo_code of the package (if present) and with the customer's agent.
680 Called from C<insert>, unless we are doing a package change that doesn't
688 # my $error = $self->ut_numbern('pkgpart'); # already done
691 if ( $self->reg_code ) {
693 unless ( grep { $self->pkgpart == $_->pkgpart }
694 map { $_->reg_code_pkg }
695 qsearchs( 'reg_code', { 'code' => $self->reg_code,
696 'agentnum' => $self->cust_main->agentnum })
698 return "Unknown registration code";
701 } elsif ( $self->promo_code ) {
704 qsearchs('part_pkg', {
705 'pkgpart' => $self->pkgpart,
706 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
708 return 'Unknown promotional code' unless $promo_part_pkg;
712 unless ( $disable_agentcheck ) {
714 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
715 return "agent ". $agent->agentnum. ':'. $agent->agent.
716 " can't purchase pkgpart ". $self->pkgpart
717 unless $agent->pkgpart_hashref->{ $self->pkgpart }
718 || $agent->agentnum == $self->part_pkg->agentnum;
721 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
722 return $error if $error;
730 =item cancel [ OPTION => VALUE ... ]
732 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
733 in this package, then cancels the package itself (sets the cancel field to
736 Available options are:
740 =item quiet - can be set true to supress email cancellation notices.
742 =item time - can be set to cancel the package based on a specific future or
743 historical date. Using time ensures that the remaining amount is calculated
744 correctly. Note however that this is an immediate cancel and just changes
745 the date. You are PROBABLY looking to expire the account instead of using
748 =item reason - can be set to a cancellation reason (see L<FS:reason>),
749 either a reasonnum of an existing reason, or passing a hashref will create
750 a new reason. The hashref should have the following keys: typenum - Reason
751 type (see L<FS::reason_type>, reason - Text of the new reason.
753 =item date - can be set to a unix style timestamp to specify when to
756 =item nobill - can be set true to skip billing if it might otherwise be done.
758 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
759 not credit it. This must be set (by change()) when changing the package
760 to a different pkgpart or location, and probably shouldn't be in any other
761 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
766 If there is an error, returns the error, otherwise returns false.
771 my( $self, %options ) = @_;
774 # pass all suspend/cancel actions to the main package
775 if ( $self->main_pkgnum and !$options{'from_main'} ) {
776 return $self->main_pkg->cancel(%options);
779 my $conf = new FS::Conf;
781 warn "cust_pkg::cancel called with options".
782 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
785 my $oldAutoCommit = $FS::UID::AutoCommit;
786 local $FS::UID::AutoCommit = 0;
789 my $old = $self->select_for_update;
791 if ( $old->get('cancel') || $self->get('cancel') ) {
792 dbh->rollback if $oldAutoCommit;
793 return ""; # no error
796 # XXX possibly set cancel_time to the expire date?
797 my $cancel_time = $options{'time'} || time;
798 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
799 $date = '' if ($date && $date <= $cancel_time); # complain instead?
801 #race condition: usage could be ongoing until unprovisioned
802 #resolved by performing a change package instead (which unprovisions) and
804 if ( !$options{nobill} && !$date ) {
805 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
806 my $copy = $self->new({$self->hash});
808 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
810 'time' => $cancel_time );
811 warn "Error billing during cancel, custnum ".
812 #$self->cust_main->custnum. ": $error"
817 if ( $options{'reason'} ) {
818 $error = $self->insert_reason( 'reason' => $options{'reason'},
819 'action' => $date ? 'expire' : 'cancel',
820 'date' => $date ? $date : $cancel_time,
821 'reason_otaker' => $options{'reason_otaker'},
824 dbh->rollback if $oldAutoCommit;
825 return "Error inserting cust_pkg_reason: $error";
829 my %svc_cancel_opt = ();
830 $svc_cancel_opt{'date'} = $date if $date;
831 foreach my $cust_svc (
834 sort { $a->[1] <=> $b->[1] }
835 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
836 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
838 my $part_svc = $cust_svc->part_svc;
839 next if ( defined($part_svc) and $part_svc->preserve );
840 my $error = $cust_svc->cancel( %svc_cancel_opt );
843 $dbh->rollback if $oldAutoCommit;
844 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
850 # credit remaining time if appropriate
852 if ( exists($options{'unused_credit'}) ) {
853 $do_credit = $options{'unused_credit'};
856 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
859 my $error = $self->credit_remaining('cancel', $cancel_time);
861 $dbh->rollback if $oldAutoCommit;
868 my %hash = $self->hash;
870 $hash{'expire'} = $date;
872 $hash{'cancel'} = $cancel_time;
874 $hash{'change_custnum'} = $options{'change_custnum'};
876 my $new = new FS::cust_pkg ( \%hash );
877 $error = $new->replace( $self, options => { $self->options } );
878 if ( $self->change_to_pkgnum ) {
879 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
880 $error ||= $change_to->cancel || $change_to->delete;
883 $dbh->rollback if $oldAutoCommit;
887 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
888 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
890 $dbh->rollback if $oldAutoCommit;
891 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
895 foreach my $usage ( $self->cust_pkg_usage ) {
896 $error = $usage->delete;
898 $dbh->rollback if $oldAutoCommit;
899 return "deleting usage pools: $error";
903 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
904 return '' if $date; #no errors
906 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
907 if ( !$options{'quiet'} &&
908 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
910 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
913 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
914 $error = $msg_template->send( 'cust_main' => $self->cust_main,
919 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
920 'to' => \@invoicing_list,
921 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
922 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
925 #should this do something on errors?
932 =item cancel_if_expired [ NOW_TIMESTAMP ]
934 Cancels this package if its expire date has been reached.
938 sub cancel_if_expired {
940 my $time = shift || time;
941 return '' unless $self->expire && $self->expire <= $time;
942 my $error = $self->cancel;
944 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
945 $self->custnum. ": $error";
952 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
953 locationnum, (other fields?). Attempts to re-provision cancelled services
954 using history information (errors at this stage are not fatal).
956 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
958 svc_fatal: service provisioning errors are fatal
960 svc_errors: pass an array reference, will be filled in with any provisioning errors
962 main_pkgnum: link the package as a supplemental package of this one. For
968 my( $self, %options ) = @_;
970 #in case you try do do $uncancel-date = $cust_pkg->uncacel
971 return '' unless $self->get('cancel');
973 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
974 return $self->main_pkg->uncancel(%options);
981 my $oldAutoCommit = $FS::UID::AutoCommit;
982 local $FS::UID::AutoCommit = 0;
986 # insert the new package
989 my $cust_pkg = new FS::cust_pkg {
990 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
991 bill => ( $options{'bill'} || $self->get('bill') ),
993 uncancel_pkgnum => $self->pkgnum,
994 main_pkgnum => ($options{'main_pkgnum'} || ''),
995 map { $_ => $self->get($_) } qw(
996 custnum pkgpart locationnum
998 susp adjourn resume expire start_date contract_end dundate
999 change_date change_pkgpart change_locationnum
1000 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1004 my $error = $cust_pkg->insert(
1005 'change' => 1, #supresses any referral credit to a referring customer
1006 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1009 $dbh->rollback if $oldAutoCommit;
1017 #find historical services within this timeframe before the package cancel
1018 # (incompatible with "time" option to cust_pkg->cancel?)
1019 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1020 # too little? (unprovisioing export delay?)
1021 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1022 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1025 foreach my $h_cust_svc (@h_cust_svc) {
1026 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1027 #next unless $h_svc_x; #should this happen?
1028 (my $table = $h_svc_x->table) =~ s/^h_//;
1029 require "FS/$table.pm";
1030 my $class = "FS::$table";
1031 my $svc_x = $class->new( {
1032 'pkgnum' => $cust_pkg->pkgnum,
1033 'svcpart' => $h_cust_svc->svcpart,
1034 map { $_ => $h_svc_x->get($_) } fields($table)
1038 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1039 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1042 my $svc_error = $svc_x->insert;
1044 if ( $options{svc_fatal} ) {
1045 $dbh->rollback if $oldAutoCommit;
1048 # if we've failed to insert the svc_x object, svc_Common->insert
1049 # will have removed the cust_svc already. if not, then both records
1050 # were inserted but we failed for some other reason (export, most
1051 # likely). in that case, report the error and delete the records.
1052 push @svc_errors, $svc_error;
1053 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1055 # except if export_insert failed, export_delete probably won't be
1057 local $FS::svc_Common::noexport_hack = 1;
1058 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1059 if ( $cleanup_error ) { # and if THAT fails, then run away
1060 $dbh->rollback if $oldAutoCommit;
1061 return $cleanup_error;
1066 } #foreach $h_cust_svc
1068 #these are pretty rare, but should handle them
1069 # - dsl_device (mac addresses)
1070 # - phone_device (mac addresses)
1071 # - dsl_note (ikano notes)
1072 # - domain_record (i.e. restore DNS information w/domains)
1073 # - inventory_item(?) (inventory w/un-cancelling service?)
1074 # - nas (svc_broaband nas stuff)
1075 #this stuff is unused in the wild afaik
1076 # - mailinglistmember
1078 # - svc_domain.parent_svcnum?
1079 # - acct_snarf (ancient mail fetching config)
1080 # - cgp_rule (communigate)
1081 # - cust_svc_option (used by our Tron stuff)
1082 # - acct_rt_transaction (used by our time worked stuff)
1085 # also move over any services that didn't unprovision at cancellation
1088 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1089 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1090 my $error = $cust_svc->replace;
1092 $dbh->rollback if $oldAutoCommit;
1098 # Uncancel any supplemental packages, and make them supplemental to the
1102 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1104 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1106 $dbh->rollback if $oldAutoCommit;
1107 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1115 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1117 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1118 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1125 Cancels any pending expiration (sets the expire field to null).
1127 If there is an error, returns the error, otherwise returns false.
1132 my( $self, %options ) = @_;
1135 my $oldAutoCommit = $FS::UID::AutoCommit;
1136 local $FS::UID::AutoCommit = 0;
1139 my $old = $self->select_for_update;
1141 my $pkgnum = $old->pkgnum;
1142 if ( $old->get('cancel') || $self->get('cancel') ) {
1143 dbh->rollback if $oldAutoCommit;
1144 return "Can't unexpire cancelled package $pkgnum";
1145 # or at least it's pointless
1148 unless ( $old->get('expire') && $self->get('expire') ) {
1149 dbh->rollback if $oldAutoCommit;
1150 return ""; # no error
1153 my %hash = $self->hash;
1154 $hash{'expire'} = '';
1155 my $new = new FS::cust_pkg ( \%hash );
1156 $error = $new->replace( $self, options => { $self->options } );
1158 $dbh->rollback if $oldAutoCommit;
1162 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1168 =item suspend [ OPTION => VALUE ... ]
1170 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1171 package, then suspends the package itself (sets the susp field to now).
1173 Available options are:
1177 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1178 either a reasonnum of an existing reason, or passing a hashref will create
1179 a new reason. The hashref should have the following keys:
1180 - typenum - Reason type (see L<FS::reason_type>
1181 - reason - Text of the new reason.
1183 =item date - can be set to a unix style timestamp to specify when to
1186 =item time - can be set to override the current time, for calculation
1187 of final invoices or unused-time credits
1189 =item resume_date - can be set to a time when the package should be
1190 unsuspended. This may be more convenient than calling C<unsuspend()>
1193 =item from_main - allows a supplemental package to be suspended, rather
1194 than redirecting the method call to its main package. For internal use.
1198 If there is an error, returns the error, otherwise returns false.
1203 my( $self, %options ) = @_;
1206 # pass all suspend/cancel actions to the main package
1207 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1208 return $self->main_pkg->suspend(%options);
1211 my $oldAutoCommit = $FS::UID::AutoCommit;
1212 local $FS::UID::AutoCommit = 0;
1215 my $old = $self->select_for_update;
1217 my $pkgnum = $old->pkgnum;
1218 if ( $old->get('cancel') || $self->get('cancel') ) {
1219 dbh->rollback if $oldAutoCommit;
1220 return "Can't suspend cancelled package $pkgnum";
1223 if ( $old->get('susp') || $self->get('susp') ) {
1224 dbh->rollback if $oldAutoCommit;
1225 return ""; # no error # complain on adjourn?
1228 my $suspend_time = $options{'time'} || time;
1229 my $date = $options{date} if $options{date}; # adjourn/suspend later
1230 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1232 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1233 dbh->rollback if $oldAutoCommit;
1234 return "Package $pkgnum expires before it would be suspended.";
1237 # some false laziness with sub cancel
1238 if ( !$options{nobill} && !$date &&
1239 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1240 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1241 # make the entire cust_main->bill path recognize 'suspend' and
1242 # 'cancel' separately.
1243 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1244 my $copy = $self->new({$self->hash});
1246 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1248 'time' => $suspend_time );
1249 warn "Error billing during suspend, custnum ".
1250 #$self->cust_main->custnum. ": $error"
1255 if ( $options{'reason'} ) {
1256 $error = $self->insert_reason( 'reason' => $options{'reason'},
1257 'action' => $date ? 'adjourn' : 'suspend',
1258 'date' => $date ? $date : $suspend_time,
1259 'reason_otaker' => $options{'reason_otaker'},
1262 dbh->rollback if $oldAutoCommit;
1263 return "Error inserting cust_pkg_reason: $error";
1267 my %hash = $self->hash;
1269 $hash{'adjourn'} = $date;
1271 $hash{'susp'} = $suspend_time;
1274 my $resume_date = $options{'resume_date'} || 0;
1275 if ( $resume_date > ($date || $suspend_time) ) {
1276 $hash{'resume'} = $resume_date;
1279 $options{options} ||= {};
1281 my $new = new FS::cust_pkg ( \%hash );
1282 $error = $new->replace( $self, options => { $self->options,
1283 %{ $options{options} },
1287 $dbh->rollback if $oldAutoCommit;
1292 # credit remaining time if appropriate
1293 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1294 my $error = $self->credit_remaining('suspend', $suspend_time);
1296 $dbh->rollback if $oldAutoCommit;
1303 foreach my $cust_svc (
1304 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1306 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1308 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1309 $dbh->rollback if $oldAutoCommit;
1310 return "Illegal svcdb value in part_svc!";
1313 require "FS/$svcdb.pm";
1315 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1317 $error = $svc->suspend;
1319 $dbh->rollback if $oldAutoCommit;
1322 my( $label, $value ) = $cust_svc->label;
1323 push @labels, "$label: $value";
1327 my $conf = new FS::Conf;
1328 if ( $conf->config('suspend_email_admin') ) {
1330 my $error = send_email(
1331 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1332 #invoice_from ??? well as good as any
1333 'to' => $conf->config('suspend_email_admin'),
1334 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1336 "This is an automatic message from your Freeside installation\n",
1337 "informing you that the following customer package has been suspended:\n",
1339 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1340 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1341 ( map { "Service : $_\n" } @labels ),
1346 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1354 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1355 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1357 $dbh->rollback if $oldAutoCommit;
1358 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1362 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1367 =item credit_remaining MODE TIME
1369 Generate a credit for this package for the time remaining in the current
1370 billing period. MODE is either "suspend" or "cancel" (determines the
1371 credit type). TIME is the time of suspension/cancellation. Both arguments
1376 sub credit_remaining {
1377 # Add a credit for remaining service
1378 my ($self, $mode, $time) = @_;
1379 die 'credit_remaining requires suspend or cancel'
1380 unless $mode eq 'suspend' or $mode eq 'cancel';
1381 die 'no suspend/cancel time' unless $time > 0;
1383 my $conf = FS::Conf->new;
1384 my $reason_type = $conf->config($mode.'_credit_type');
1386 my $last_bill = $self->getfield('last_bill') || 0;
1387 my $next_bill = $self->getfield('bill') || 0;
1388 if ( $last_bill > 0 # the package has been billed
1389 and $next_bill > 0 # the package has a next bill date
1390 and $next_bill >= $time # which is in the future
1392 my $remaining_value = $self->calc_remain('time' => $time);
1393 if ( $remaining_value > 0 ) {
1394 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1396 my $error = $self->cust_main->credit(
1398 'Credit for unused time on '. $self->part_pkg->pkg,
1399 'reason_type' => $reason_type,
1401 return "Error crediting customer \$$remaining_value for unused time".
1402 " on ". $self->part_pkg->pkg. ": $error"
1404 } #if $remaining_value
1405 } #if $last_bill, etc.
1409 =item unsuspend [ OPTION => VALUE ... ]
1411 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1412 package, then unsuspends the package itself (clears the susp field and the
1413 adjourn field if it is in the past). If the suspend reason includes an
1414 unsuspension package, that package will be ordered.
1416 Available options are:
1422 Can be set to a date to unsuspend the package in the future (the 'resume'
1425 =item adjust_next_bill
1427 Can be set true to adjust the next bill date forward by
1428 the amount of time the account was inactive. This was set true by default
1429 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1430 explicitly requested with this option or in the price plan.
1434 If there is an error, returns the error, otherwise returns false.
1439 my( $self, %opt ) = @_;
1442 # pass all suspend/cancel actions to the main package
1443 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1444 return $self->main_pkg->unsuspend(%opt);
1447 my $oldAutoCommit = $FS::UID::AutoCommit;
1448 local $FS::UID::AutoCommit = 0;
1451 my $old = $self->select_for_update;
1453 my $pkgnum = $old->pkgnum;
1454 if ( $old->get('cancel') || $self->get('cancel') ) {
1455 $dbh->rollback if $oldAutoCommit;
1456 return "Can't unsuspend cancelled package $pkgnum";
1459 unless ( $old->get('susp') && $self->get('susp') ) {
1460 $dbh->rollback if $oldAutoCommit;
1461 return ""; # no error # complain instead?
1464 my $date = $opt{'date'};
1465 if ( $date and $date > time ) { # return an error if $date <= time?
1467 if ( $old->get('expire') && $old->get('expire') < $date ) {
1468 $dbh->rollback if $oldAutoCommit;
1469 return "Package $pkgnum expires before it would be unsuspended.";
1472 my $new = new FS::cust_pkg { $self->hash };
1473 $new->set('resume', $date);
1474 $error = $new->replace($self, options => $self->options);
1477 $dbh->rollback if $oldAutoCommit;
1481 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1489 foreach my $cust_svc (
1490 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1492 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1494 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1495 $dbh->rollback if $oldAutoCommit;
1496 return "Illegal svcdb value in part_svc!";
1499 require "FS/$svcdb.pm";
1501 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1503 $error = $svc->unsuspend;
1505 $dbh->rollback if $oldAutoCommit;
1508 my( $label, $value ) = $cust_svc->label;
1509 push @labels, "$label: $value";
1514 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1515 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1517 my %hash = $self->hash;
1518 my $inactive = time - $hash{'susp'};
1520 my $conf = new FS::Conf;
1522 if ( $inactive > 0 &&
1523 ( $hash{'bill'} || $hash{'setup'} ) &&
1524 ( $opt{'adjust_next_bill'} ||
1525 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1526 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1529 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1534 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1535 $hash{'resume'} = '' if !$hash{'adjourn'};
1536 my $new = new FS::cust_pkg ( \%hash );
1537 $error = $new->replace( $self, options => { $self->options } );
1539 $dbh->rollback if $oldAutoCommit;
1545 if ( $reason && $reason->unsuspend_pkgpart ) {
1546 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1547 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1549 my $start_date = $self->cust_main->next_bill_date
1550 if $reason->unsuspend_hold;
1553 $unsusp_pkg = FS::cust_pkg->new({
1554 'custnum' => $self->custnum,
1555 'pkgpart' => $reason->unsuspend_pkgpart,
1556 'start_date' => $start_date,
1557 'locationnum' => $self->locationnum,
1558 # discount? probably not...
1561 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1565 $dbh->rollback if $oldAutoCommit;
1570 if ( $conf->config('unsuspend_email_admin') ) {
1572 my $error = send_email(
1573 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1574 #invoice_from ??? well as good as any
1575 'to' => $conf->config('unsuspend_email_admin'),
1576 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1577 "This is an automatic message from your Freeside installation\n",
1578 "informing you that the following customer package has been unsuspended:\n",
1580 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1581 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1582 ( map { "Service : $_\n" } @labels ),
1584 "An unsuspension fee was charged: ".
1585 $unsusp_pkg->part_pkg->pkg_comment."\n"
1592 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1598 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1599 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1601 $dbh->rollback if $oldAutoCommit;
1602 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1606 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1613 Cancels any pending suspension (sets the adjourn field to null).
1615 If there is an error, returns the error, otherwise returns false.
1620 my( $self, %options ) = @_;
1623 my $oldAutoCommit = $FS::UID::AutoCommit;
1624 local $FS::UID::AutoCommit = 0;
1627 my $old = $self->select_for_update;
1629 my $pkgnum = $old->pkgnum;
1630 if ( $old->get('cancel') || $self->get('cancel') ) {
1631 dbh->rollback if $oldAutoCommit;
1632 return "Can't unadjourn cancelled package $pkgnum";
1633 # or at least it's pointless
1636 if ( $old->get('susp') || $self->get('susp') ) {
1637 dbh->rollback if $oldAutoCommit;
1638 return "Can't unadjourn suspended package $pkgnum";
1639 # perhaps this is arbitrary
1642 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1643 dbh->rollback if $oldAutoCommit;
1644 return ""; # no error
1647 my %hash = $self->hash;
1648 $hash{'adjourn'} = '';
1649 $hash{'resume'} = '';
1650 my $new = new FS::cust_pkg ( \%hash );
1651 $error = $new->replace( $self, options => { $self->options } );
1653 $dbh->rollback if $oldAutoCommit;
1657 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1664 =item change HASHREF | OPTION => VALUE ...
1666 Changes this package: cancels it and creates a new one, with a different
1667 pkgpart or locationnum or both. All services are transferred to the new
1668 package (no change will be made if this is not possible).
1670 Options may be passed as a list of key/value pairs or as a hash reference.
1677 New locationnum, to change the location for this package.
1681 New FS::cust_location object, to create a new location and assign it
1686 New FS::cust_main object, to create a new customer and assign the new package
1691 New pkgpart (see L<FS::part_pkg>).
1695 New refnum (see L<FS::part_referral>).
1699 New quantity; if unspecified, the new package will have the same quantity
1704 "New" (existing) FS::cust_pkg object. The package's services and other
1705 attributes will be transferred to this package.
1709 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1710 susp, adjourn, cancel, expire, and contract_end) to the new package.
1712 =item unprotect_svcs
1714 Normally, change() will rollback and return an error if some services
1715 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1716 If unprotect_svcs is true, this method will transfer as many services as
1717 it can and then unconditionally cancel the old package.
1721 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1722 cust_pkg must be specified (otherwise, what's the point?)
1724 Returns either the new FS::cust_pkg object or a scalar error.
1728 my $err_or_new_cust_pkg = $old_cust_pkg->change
1732 #some false laziness w/order
1735 my $opt = ref($_[0]) ? shift : { @_ };
1737 my $conf = new FS::Conf;
1739 # Transactionize this whole mess
1740 my $oldAutoCommit = $FS::UID::AutoCommit;
1741 local $FS::UID::AutoCommit = 0;
1750 $hash{'setup'} = $time if $self->setup;
1752 $hash{'change_date'} = $time;
1753 $hash{"change_$_"} = $self->$_()
1754 foreach qw( pkgnum pkgpart locationnum );
1756 if ( $opt->{'cust_location'} ) {
1757 $error = $opt->{'cust_location'}->find_or_insert;
1759 $dbh->rollback if $oldAutoCommit;
1760 return "creating location record: $error";
1762 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1765 if ( $opt->{'cust_pkg'} ) {
1766 # treat changing to a package with a different pkgpart as a
1767 # pkgpart change (because it is)
1768 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1771 # whether to override pkgpart checking on the new package
1772 my $same_pkgpart = 1;
1773 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1777 my $unused_credit = 0;
1778 my $keep_dates = $opt->{'keep_dates'};
1779 # Special case. If the pkgpart is changing, and the customer is
1780 # going to be credited for remaining time, don't keep setup, bill,
1781 # or last_bill dates, and DO pass the flag to cancel() to credit
1783 if ( $opt->{'pkgpart'}
1784 and $opt->{'pkgpart'} != $self->pkgpart
1785 and $self->part_pkg->option('unused_credit_change', 1) ) {
1788 $hash{$_} = '' foreach qw(setup bill last_bill);
1791 if ( $keep_dates ) {
1792 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1793 resume start_date contract_end ) ) {
1794 $hash{$date} = $self->getfield($date);
1797 # always keep this date, regardless of anything
1798 # (the date of the package change is in a different field)
1799 $hash{'order_date'} = $self->getfield('order_date');
1801 # allow $opt->{'locationnum'} = '' to specifically set it to null
1802 # (i.e. customer default location)
1803 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1805 # usually this doesn't matter. the two cases where it does are:
1806 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1808 # 2. (more importantly) changing a package before it's billed
1809 $hash{'waive_setup'} = $self->waive_setup;
1811 my $custnum = $self->custnum;
1812 if ( $opt->{cust_main} ) {
1813 my $cust_main = $opt->{cust_main};
1814 unless ( $cust_main->custnum ) {
1815 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1817 $dbh->rollback if $oldAutoCommit;
1818 return "inserting customer record: $error";
1821 $custnum = $cust_main->custnum;
1824 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1827 if ( $opt->{'cust_pkg'} ) {
1828 # The target package already exists; update it to show that it was
1829 # changed from this package.
1830 $cust_pkg = $opt->{'cust_pkg'};
1832 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1833 $cust_pkg->set("change_$_", $self->get($_));
1835 $cust_pkg->set('change_date', $time);
1836 $error = $cust_pkg->replace;
1839 # Create the new package.
1840 $cust_pkg = new FS::cust_pkg {
1841 custnum => $custnum,
1842 locationnum => $opt->{'locationnum'},
1843 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
1844 qw( pkgpart quantity refnum salesnum )
1848 $error = $cust_pkg->insert( 'change' => 1,
1849 'allow_pkgpart' => $same_pkgpart );
1852 $dbh->rollback if $oldAutoCommit;
1853 return "inserting new package: $error";
1856 # Transfer services and cancel old package.
1858 $error = $self->transfer($cust_pkg);
1859 if ($error and $error == 0) {
1860 # $old_pkg->transfer failed.
1861 $dbh->rollback if $oldAutoCommit;
1862 return "transferring $error";
1865 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1866 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1867 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1868 if ($error and $error == 0) {
1869 # $old_pkg->transfer failed.
1870 $dbh->rollback if $oldAutoCommit;
1871 return "converting $error";
1875 # We set unprotect_svcs when executing a "future package change". It's
1876 # not a user-interactive operation, so returning an error means the
1877 # package change will just fail. Rather than have that happen, we'll
1878 # let leftover services be deleted.
1879 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
1880 # Transfers were successful, but we still had services left on the old
1881 # package. We can't change the package under this circumstances, so abort.
1882 $dbh->rollback if $oldAutoCommit;
1883 return "unable to transfer all services";
1886 #reset usage if changing pkgpart
1887 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1888 if ($self->pkgpart != $cust_pkg->pkgpart) {
1889 my $part_pkg = $cust_pkg->part_pkg;
1890 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1894 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1897 $dbh->rollback if $oldAutoCommit;
1898 return "setting usage values: $error";
1901 # if NOT changing pkgpart, transfer any usage pools over
1902 foreach my $usage ($self->cust_pkg_usage) {
1903 $usage->set('pkgnum', $cust_pkg->pkgnum);
1904 $error = $usage->replace;
1906 $dbh->rollback if $oldAutoCommit;
1907 return "transferring usage pools: $error";
1912 # transfer usage pricing add-ons, if we're not changing pkgpart
1913 if ( $same_pkgpart ) {
1914 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
1915 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
1916 'pkgnum' => $cust_pkg->pkgnum,
1917 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
1918 'quantity' => $old_cust_pkg_usageprice->quantity,
1920 $error = $new_cust_pkg_usageprice->insert;
1922 $dbh->rollback if $oldAutoCommit;
1923 return "Error transferring usage pricing add-on: $error";
1928 # transfer discounts, if we're not changing pkgpart
1929 if ( $same_pkgpart ) {
1930 foreach my $old_discount ($self->cust_pkg_discount_active) {
1931 # don't remove the old discount, we may still need to bill that package.
1932 my $new_discount = new FS::cust_pkg_discount {
1933 'pkgnum' => $cust_pkg->pkgnum,
1934 'discountnum' => $old_discount->discountnum,
1935 'months_used' => $old_discount->months_used,
1937 $error = $new_discount->insert;
1939 $dbh->rollback if $oldAutoCommit;
1940 return "transferring discounts: $error";
1945 # transfer (copy) invoice details
1946 foreach my $detail ($self->cust_pkg_detail) {
1947 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
1948 $new_detail->set('pkgdetailnum', '');
1949 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
1950 $error = $new_detail->insert;
1952 $dbh->rollback if $oldAutoCommit;
1953 return "transferring package notes: $error";
1959 if ( !$opt->{'cust_pkg'} ) {
1960 # Order any supplemental packages.
1961 my $part_pkg = $cust_pkg->part_pkg;
1962 my @old_supp_pkgs = $self->supplemental_pkgs;
1963 foreach my $link ($part_pkg->supp_part_pkg_link) {
1965 foreach (@old_supp_pkgs) {
1966 if ($_->pkgpart == $link->dst_pkgpart) {
1968 $_->pkgpart(0); # so that it can't match more than once
1972 # false laziness with FS::cust_main::Packages::order_pkg
1973 my $new = FS::cust_pkg->new({
1974 pkgpart => $link->dst_pkgpart,
1975 pkglinknum => $link->pkglinknum,
1976 custnum => $custnum,
1977 main_pkgnum => $cust_pkg->pkgnum,
1978 locationnum => $cust_pkg->locationnum,
1979 start_date => $cust_pkg->start_date,
1980 order_date => $cust_pkg->order_date,
1981 expire => $cust_pkg->expire,
1982 adjourn => $cust_pkg->adjourn,
1983 contract_end => $cust_pkg->contract_end,
1984 refnum => $cust_pkg->refnum,
1985 discountnum => $cust_pkg->discountnum,
1986 waive_setup => $cust_pkg->waive_setup,
1988 if ( $old and $opt->{'keep_dates'} ) {
1989 foreach (qw(setup bill last_bill)) {
1990 $new->set($_, $old->get($_));
1993 $error = $new->insert( allow_pkgpart => $same_pkgpart );
1996 $error ||= $old->transfer($new);
1998 if ( $error and $error > 0 ) {
1999 # no reason why this should ever fail, but still...
2000 $error = "Unable to transfer all services from supplemental package ".
2004 $dbh->rollback if $oldAutoCommit;
2007 push @new_supp_pkgs, $new;
2009 } # if !$opt->{'cust_pkg'}
2010 # because if there is one, then supplemental packages would already
2011 # have been created for it.
2013 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2015 #Don't allow billing the package (preceding period packages and/or
2016 #outstanding usage) if we are keeping dates (i.e. location changing),
2017 #because the new package will be billed for the same date range.
2018 #Supplemental packages are also canceled here.
2020 # during scheduled changes, avoid canceling the package we just
2022 $self->set('change_to_pkgnum' => '');
2024 $error = $self->cancel(
2026 unused_credit => $unused_credit,
2027 nobill => $keep_dates,
2028 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2031 $dbh->rollback if $oldAutoCommit;
2032 return "canceling old package: $error";
2035 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2037 my $error = $cust_pkg->cust_main->bill(
2038 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2041 $dbh->rollback if $oldAutoCommit;
2042 return "billing new package: $error";
2046 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2052 =item change_later OPTION => VALUE...
2054 Schedule a package change for a later date. This actually orders the new
2055 package immediately, but sets its start date for a future date, and sets
2056 the current package to expire on the same date.
2058 If the package is already scheduled for a change, this can be called with
2059 'start_date' to change the scheduled date, or with pkgpart and/or
2060 locationnum to modify the package change. To cancel the scheduled change
2061 entirely, see C<abort_change>.
2069 The date for the package change. Required, and must be in the future.
2077 The pkgpart. locationnum, and quantity of the new package, with the same
2078 meaning as in C<change>.
2086 my $opt = ref($_[0]) ? shift : { @_ };
2088 my $oldAutoCommit = $FS::UID::AutoCommit;
2089 local $FS::UID::AutoCommit = 0;
2092 my $cust_main = $self->cust_main;
2094 my $date = delete $opt->{'start_date'} or return 'start_date required';
2096 if ( $date <= time ) {
2097 $dbh->rollback if $oldAutoCommit;
2098 return "start_date $date is in the past";
2103 if ( $self->change_to_pkgnum ) {
2104 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2105 my $new_pkgpart = $opt->{'pkgpart'}
2106 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2107 my $new_locationnum = $opt->{'locationnum'}
2108 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2109 my $new_quantity = $opt->{'quantity'}
2110 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2111 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2112 # it hasn't been billed yet, so in principle we could just edit
2113 # it in place (w/o a package change), but that's bad form.
2114 # So change the package according to the new options...
2115 my $err_or_pkg = $change_to->change(%$opt);
2116 if ( ref $err_or_pkg ) {
2117 # Then set that package up for a future start.
2118 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2119 $self->set('expire', $date); # in case it's different
2120 $err_or_pkg->set('start_date', $date);
2121 $err_or_pkg->set('change_date', '');
2122 $err_or_pkg->set('change_pkgnum', '');
2124 $error = $self->replace ||
2125 $err_or_pkg->replace ||
2126 $change_to->cancel ||
2129 $error = $err_or_pkg;
2131 } else { # change the start date only.
2132 $self->set('expire', $date);
2133 $change_to->set('start_date', $date);
2134 $error = $self->replace || $change_to->replace;
2137 $dbh->rollback if $oldAutoCommit;
2140 $dbh->commit if $oldAutoCommit;
2143 } # if $self->change_to_pkgnum
2145 my $new_pkgpart = $opt->{'pkgpart'}
2146 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2147 my $new_locationnum = $opt->{'locationnum'}
2148 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2149 my $new_quantity = $opt->{'quantity'}
2150 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2152 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2154 # allow $opt->{'locationnum'} = '' to specifically set it to null
2155 # (i.e. customer default location)
2156 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2158 my $new = FS::cust_pkg->new( {
2159 custnum => $self->custnum,
2160 locationnum => $opt->{'locationnum'},
2161 start_date => $date,
2162 map { $_ => ( $opt->{$_} || $self->$_() ) }
2163 qw( pkgpart quantity refnum salesnum )
2165 $error = $new->insert('change' => 1,
2166 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2168 $self->set('change_to_pkgnum', $new->pkgnum);
2169 $self->set('expire', $date);
2170 $error = $self->replace;
2173 $dbh->rollback if $oldAutoCommit;
2175 $dbh->commit if $oldAutoCommit;
2183 Cancels a future package change scheduled by C<change_later>.
2189 my $pkgnum = $self->change_to_pkgnum;
2190 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2193 $error = $change_to->cancel || $change_to->delete;
2194 return $error if $error;
2196 $self->set('change_to_pkgnum', '');
2197 $self->set('expire', '');
2201 =item set_quantity QUANTITY
2203 Change the package's quantity field. This is one of the few package properties
2204 that can safely be changed without canceling and reordering the package
2205 (because it doesn't affect tax eligibility). Returns an error or an
2212 $self = $self->replace_old; # just to make sure
2213 $self->quantity(shift);
2217 =item set_salesnum SALESNUM
2219 Change the package's salesnum (sales person) field. This is one of the few
2220 package properties that can safely be changed without canceling and reordering
2221 the package (because it doesn't affect tax eligibility). Returns an error or
2228 $self = $self->replace_old; # just to make sure
2229 $self->salesnum(shift);
2231 # XXX this should probably reassign any credit that's already been given
2234 =item modify_charge OPTIONS
2236 Change the properties of a one-time charge. The following properties can
2237 be changed this way:
2238 - pkg: the package description
2239 - classnum: the package class
2240 - additional: arrayref of additional invoice details to add to this package
2242 and, I<if the charge has not yet been billed>:
2243 - start_date: the date when it will be billed
2244 - amount: the setup fee to be charged
2245 - quantity: the multiplier for the setup fee
2247 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2248 commission credits linked to this charge, they will be recalculated.
2255 my $part_pkg = $self->part_pkg;
2256 my $pkgnum = $self->pkgnum;
2259 my $oldAutoCommit = $FS::UID::AutoCommit;
2260 local $FS::UID::AutoCommit = 0;
2262 return "Can't use modify_charge except on one-time charges"
2263 unless $part_pkg->freq eq '0';
2265 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2266 $part_pkg->set('pkg', $opt{'pkg'});
2269 my %pkg_opt = $part_pkg->options;
2270 if ( ref($opt{'additional'}) ) {
2271 delete $pkg_opt{$_} foreach grep /^additional/, keys %pkg_opt;
2273 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2274 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2276 $pkg_opt{'additional_count'} = $i if $i > 0;
2280 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2283 $old_classnum = $part_pkg->classnum;
2284 $part_pkg->set('classnum', $opt{'classnum'});
2287 if ( !$self->get('setup') ) {
2288 # not yet billed, so allow amount and quantity
2289 if ( exists($opt{'quantity'})
2290 and $opt{'quantity'} != $self->quantity
2291 and $opt{'quantity'} > 0 ) {
2293 $self->set('quantity', $opt{'quantity'});
2295 if ( exists($opt{'start_date'})
2296 and $opt{'start_date'} != $self->start_date ) {
2298 $self->set('start_date', $opt{'start_date'});
2300 if ($self->modified) { # for quantity or start_date change
2301 my $error = $self->replace;
2302 return $error if $error;
2305 if ( exists($opt{'amount'})
2306 and $part_pkg->option('setup_fee') != $opt{'amount'}
2307 and $opt{'amount'} > 0 ) {
2309 $pkg_opt{'setup_fee'} = $opt{'amount'};
2310 # standard for one-time charges is to set comment = (formatted) amount
2311 # update it to avoid confusion
2312 my $conf = FS::Conf->new;
2313 $part_pkg->set('comment',
2314 ($conf->config('money_char') || '$') .
2315 sprintf('%.2f', $opt{'amount'})
2318 } # else simply ignore them; the UI shouldn't allow editing the fields
2320 my $error = $part_pkg->replace( options => \%pkg_opt );
2322 $dbh->rollback if $oldAutoCommit;
2326 if (defined $old_classnum) {
2327 # fix invoice grouping records
2328 my $old_catname = $old_classnum
2329 ? FS::pkg_class->by_key($old_classnum)->categoryname
2331 my $new_catname = $opt{'classnum'}
2332 ? $part_pkg->pkg_class->categoryname
2334 if ( $old_catname ne $new_catname ) {
2335 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2336 # (there should only be one...)
2337 my @display = qsearch( 'cust_bill_pkg_display', {
2338 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2339 'section' => $old_catname,
2341 foreach (@display) {
2342 $_->set('section', $new_catname);
2343 $error = $_->replace;
2345 $dbh->rollback if $oldAutoCommit;
2349 } # foreach $cust_bill_pkg
2352 if ( $opt{'adjust_commission'} ) {
2353 # fix commission credits...tricky.
2354 foreach my $cust_event ($self->cust_event) {
2355 my $part_event = $cust_event->part_event;
2356 foreach my $table (qw(sales agent)) {
2358 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2359 my $credit = qsearchs('cust_credit', {
2360 'eventnum' => $cust_event->eventnum,
2362 if ( $part_event->isa($class) ) {
2363 # Yes, this results in current commission rates being applied
2364 # retroactively to a one-time charge. For accounting purposes
2365 # there ought to be some kind of time limit on doing this.
2366 my $amount = $part_event->_calc_credit($self);
2367 if ( $credit and $credit->amount ne $amount ) {
2368 # Void the old credit.
2369 $error = $credit->void('Package class changed');
2371 $dbh->rollback if $oldAutoCommit;
2372 return "$error (adjusting commission credit)";
2375 # redo the event action to recreate the credit.
2377 eval { $part_event->do_action( $self, $cust_event ) };
2379 $dbh->rollback if $oldAutoCommit;
2382 } # if $part_event->isa($class)
2384 } # foreach $cust_event
2385 } # if $opt{'adjust_commission'}
2386 } # if defined $old_classnum
2388 $dbh->commit if $oldAutoCommit;
2394 use Storable 'thaw';
2397 sub process_bulk_cust_pkg {
2399 my $param = thaw(decode_base64(shift));
2400 warn Dumper($param) if $DEBUG;
2402 my $old_part_pkg = qsearchs('part_pkg',
2403 { pkgpart => $param->{'old_pkgpart'} });
2404 my $new_part_pkg = qsearchs('part_pkg',
2405 { pkgpart => $param->{'new_pkgpart'} });
2406 die "Must select a new package type\n" unless $new_part_pkg;
2407 #my $keep_dates = $param->{'keep_dates'} || 0;
2408 my $keep_dates = 1; # there is no good reason to turn this off
2410 my $oldAutoCommit = $FS::UID::AutoCommit;
2411 local $FS::UID::AutoCommit = 0;
2414 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2417 foreach my $old_cust_pkg ( @cust_pkgs ) {
2419 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2420 if ( $old_cust_pkg->getfield('cancel') ) {
2421 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2422 $old_cust_pkg->pkgnum."\n"
2426 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2428 my $error = $old_cust_pkg->change(
2429 'pkgpart' => $param->{'new_pkgpart'},
2430 'keep_dates' => $keep_dates
2432 if ( !ref($error) ) { # change returns the cust_pkg on success
2434 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2437 $dbh->commit if $oldAutoCommit;
2443 Returns the last bill date, or if there is no last bill date, the setup date.
2444 Useful for billing metered services.
2450 return $self->setfield('last_bill', $_[0]) if @_;
2451 return $self->getfield('last_bill') if $self->getfield('last_bill');
2452 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2453 'edate' => $self->bill, } );
2454 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2457 =item last_cust_pkg_reason ACTION
2459 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2460 Returns false if there is no reason or the package is not currenly ACTION'd
2461 ACTION is one of adjourn, susp, cancel, or expire.
2465 sub last_cust_pkg_reason {
2466 my ( $self, $action ) = ( shift, shift );
2467 my $date = $self->get($action);
2469 'table' => 'cust_pkg_reason',
2470 'hashref' => { 'pkgnum' => $self->pkgnum,
2471 'action' => substr(uc($action), 0, 1),
2474 'order_by' => 'ORDER BY num DESC LIMIT 1',
2478 =item last_reason ACTION
2480 Returns the most recent ACTION FS::reason associated with the package.
2481 Returns false if there is no reason or the package is not currenly ACTION'd
2482 ACTION is one of adjourn, susp, cancel, or expire.
2487 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2488 $cust_pkg_reason->reason
2489 if $cust_pkg_reason;
2494 Returns the definition for this billing item, as an FS::part_pkg object (see
2501 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2502 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2503 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2508 Returns the cancelled package this package was changed from, if any.
2514 return '' unless $self->change_pkgnum;
2515 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2518 =item change_cust_main
2520 Returns the customter this package was detached to, if any.
2524 sub change_cust_main {
2526 return '' unless $self->change_custnum;
2527 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2532 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2539 $self->part_pkg->calc_setup($self, @_);
2544 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2551 $self->part_pkg->calc_recur($self, @_);
2556 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2563 $self->part_pkg->base_setup($self, @_);
2568 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2575 $self->part_pkg->base_recur($self, @_);
2580 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2587 $self->part_pkg->calc_remain($self, @_);
2592 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2599 $self->part_pkg->calc_cancel($self, @_);
2604 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2610 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2613 =item cust_pkg_detail [ DETAILTYPE ]
2615 Returns any customer package details for this package (see
2616 L<FS::cust_pkg_detail>).
2618 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2622 sub cust_pkg_detail {
2624 my %hash = ( 'pkgnum' => $self->pkgnum );
2625 $hash{detailtype} = shift if @_;
2627 'table' => 'cust_pkg_detail',
2628 'hashref' => \%hash,
2629 'order_by' => 'ORDER BY weight, pkgdetailnum',
2633 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2635 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2637 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2639 If there is an error, returns the error, otherwise returns false.
2643 sub set_cust_pkg_detail {
2644 my( $self, $detailtype, @details ) = @_;
2646 my $oldAutoCommit = $FS::UID::AutoCommit;
2647 local $FS::UID::AutoCommit = 0;
2650 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2651 my $error = $current->delete;
2653 $dbh->rollback if $oldAutoCommit;
2654 return "error removing old detail: $error";
2658 foreach my $detail ( @details ) {
2659 my $cust_pkg_detail = new FS::cust_pkg_detail {
2660 'pkgnum' => $self->pkgnum,
2661 'detailtype' => $detailtype,
2662 'detail' => $detail,
2664 my $error = $cust_pkg_detail->insert;
2666 $dbh->rollback if $oldAutoCommit;
2667 return "error adding new detail: $error";
2672 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2679 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2683 #false laziness w/cust_bill.pm
2687 'table' => 'cust_event',
2688 'addl_from' => 'JOIN part_event USING ( eventpart )',
2689 'hashref' => { 'tablenum' => $self->pkgnum },
2690 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2694 =item num_cust_event
2696 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2700 #false laziness w/cust_bill.pm
2701 sub num_cust_event {
2704 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2705 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2706 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2707 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2708 $sth->fetchrow_arrayref->[0];
2711 =item part_pkg_currency_option OPTIONNAME
2713 Returns a two item list consisting of the currency of this customer, if any,
2714 and a value for the provided option. If the customer has a currency, the value
2715 is the option value the given name and the currency (see
2716 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2717 regular option value for the given name (see L<FS::part_pkg_option>).
2721 sub part_pkg_currency_option {
2722 my( $self, $optionname ) = @_;
2723 my $part_pkg = $self->part_pkg;
2724 if ( my $currency = $self->cust_main->currency ) {
2725 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2727 ('', $part_pkg->option($optionname) );
2731 =item cust_svc [ SVCPART ] (old, deprecated usage)
2733 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2735 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2737 Returns the services for this package, as FS::cust_svc objects (see
2738 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2739 spcififed, returns only the matching services.
2741 As an optimization, use the cust_svc_unsorted version if you are not displaying
2748 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2749 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2752 sub cust_svc_unsorted {
2754 @{ $self->cust_svc_unsorted_arrayref(@_) };
2757 sub cust_svc_unsorted_arrayref {
2760 return () unless $self->num_cust_svc(@_);
2763 if ( @_ && $_[0] =~ /^\d+/ ) {
2764 $opt{svcpart} = shift;
2765 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2772 'table' => 'cust_svc',
2773 'hashref' => { 'pkgnum' => $self->pkgnum },
2775 if ( $opt{svcpart} ) {
2776 $search{hashref}->{svcpart} = $opt{'svcpart'};
2778 if ( $opt{'svcdb'} ) {
2779 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2780 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2783 [ qsearch(\%search) ];
2787 =item overlimit [ SVCPART ]
2789 Returns the services for this package which have exceeded their
2790 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2791 is specified, return only the matching services.
2797 return () unless $self->num_cust_svc(@_);
2798 grep { $_->overlimit } $self->cust_svc(@_);
2801 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2803 Returns historical services for this package created before END TIMESTAMP and
2804 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2805 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2806 I<pkg_svc.hidden> flag will be omitted.
2812 warn "$me _h_cust_svc called on $self\n"
2815 my ($end, $start, $mode) = @_;
2816 my @cust_svc = $self->_sort_cust_svc(
2817 [ qsearch( 'h_cust_svc',
2818 { 'pkgnum' => $self->pkgnum, },
2819 FS::h_cust_svc->sql_h_search(@_),
2822 if ( defined($mode) && $mode eq 'I' ) {
2823 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2824 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2830 sub _sort_cust_svc {
2831 my( $self, $arrayref ) = @_;
2834 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2836 my %pkg_svc = map { $_->svcpart => $_ }
2837 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
2842 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
2844 $pkg_svc ? $pkg_svc->primary_svc : '',
2845 $pkg_svc ? $pkg_svc->quantity : 0,
2852 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2854 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2856 Returns the number of services for this package. Available options are svcpart
2857 and svcdb. If either is spcififed, returns only the matching services.
2864 return $self->{'_num_cust_svc'}
2866 && exists($self->{'_num_cust_svc'})
2867 && $self->{'_num_cust_svc'} =~ /\d/;
2869 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2873 if ( @_ && $_[0] =~ /^\d+/ ) {
2874 $opt{svcpart} = shift;
2875 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2881 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2882 my $where = ' WHERE pkgnum = ? ';
2883 my @param = ($self->pkgnum);
2885 if ( $opt{'svcpart'} ) {
2886 $where .= ' AND svcpart = ? ';
2887 push @param, $opt{'svcpart'};
2889 if ( $opt{'svcdb'} ) {
2890 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2891 $where .= ' AND svcdb = ? ';
2892 push @param, $opt{'svcdb'};
2895 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2896 $sth->execute(@param) or die $sth->errstr;
2897 $sth->fetchrow_arrayref->[0];
2900 =item available_part_svc
2902 Returns a list of FS::part_svc objects representing services included in this
2903 package but not yet provisioned. Each FS::part_svc object also has an extra
2904 field, I<num_avail>, which specifies the number of available services.
2908 sub available_part_svc {
2911 my $pkg_quantity = $self->quantity || 1;
2913 grep { $_->num_avail > 0 }
2915 my $part_svc = $_->part_svc;
2916 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2917 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2919 # more evil encapsulation breakage
2920 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2921 my @exports = $part_svc->part_export_did;
2922 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2927 $self->part_pkg->pkg_svc;
2930 =item part_svc [ OPTION => VALUE ... ]
2932 Returns a list of FS::part_svc objects representing provisioned and available
2933 services included in this package. Each FS::part_svc object also has the
2934 following extra fields:
2938 =item num_cust_svc (count)
2940 =item num_avail (quantity - count)
2942 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2946 Accepts one option: summarize_size. If specified and non-zero, will omit the
2947 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2953 #label -> ($cust_svc->label)[1]
2959 my $pkg_quantity = $self->quantity || 1;
2961 #XXX some sort of sort order besides numeric by svcpart...
2962 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2964 my $part_svc = $pkg_svc->part_svc;
2965 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2966 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2967 $part_svc->{'Hash'}{'num_avail'} =
2968 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2969 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2970 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2971 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2972 && $num_cust_svc >= $opt{summarize_size};
2973 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2975 } $self->part_pkg->pkg_svc;
2978 push @part_svc, map {
2980 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2981 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2982 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2983 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2984 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2986 } $self->extra_part_svc;
2992 =item extra_part_svc
2994 Returns a list of FS::part_svc objects corresponding to services in this
2995 package which are still provisioned but not (any longer) available in the
3000 sub extra_part_svc {
3003 my $pkgnum = $self->pkgnum;
3004 #my $pkgpart = $self->pkgpart;
3007 # 'table' => 'part_svc',
3010 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3011 # WHERE pkg_svc.svcpart = part_svc.svcpart
3012 # AND pkg_svc.pkgpart = ?
3015 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3016 # LEFT JOIN cust_pkg USING ( pkgnum )
3017 # WHERE cust_svc.svcpart = part_svc.svcpart
3020 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3023 #seems to benchmark slightly faster... (or did?)
3025 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3026 my $pkgparts = join(',', @pkgparts);
3029 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3030 #MySQL doesn't grok DISINCT ON
3031 'select' => 'DISTINCT part_svc.*',
3032 'table' => 'part_svc',
3034 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3035 AND pkg_svc.pkgpart IN ($pkgparts)
3038 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3039 LEFT JOIN cust_pkg USING ( pkgnum )
3042 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3043 'extra_param' => [ [$self->pkgnum=>'int'] ],
3049 Returns a short status string for this package, currently:
3053 =item not yet billed
3055 =item one-time charge
3070 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3072 return 'cancelled' if $self->get('cancel');
3073 return 'suspended' if $self->susp;
3074 return 'not yet billed' unless $self->setup;
3075 return 'one-time charge' if $freq =~ /^(0|$)/;
3079 =item ucfirst_status
3081 Returns the status with the first character capitalized.
3085 sub ucfirst_status {
3086 ucfirst(shift->status);
3091 Class method that returns the list of possible status strings for packages
3092 (see L<the status method|/status>). For example:
3094 @statuses = FS::cust_pkg->statuses();
3098 tie my %statuscolor, 'Tie::IxHash',
3099 'not yet billed' => '009999', #teal? cyan?
3100 'one-time charge' => '000000',
3101 'active' => '00CC00',
3102 'suspended' => 'FF9900',
3103 'cancelled' => 'FF0000',
3107 my $self = shift; #could be class...
3108 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3109 # # mayble split btw one-time vs. recur
3115 Returns a hex triplet color string for this package's status.
3121 $statuscolor{$self->status};
3126 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3127 "pkg - comment" depending on user preference).
3133 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3134 $label = $self->pkgnum. ": $label"
3135 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3139 =item pkg_label_long
3141 Returns a long label for this package, adding the primary service's label to
3146 sub pkg_label_long {
3148 my $label = $self->pkg_label;
3149 my $cust_svc = $self->primary_cust_svc;
3150 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3156 Returns a customer-localized label for this package.
3162 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3165 =item primary_cust_svc
3167 Returns a primary service (as FS::cust_svc object) if one can be identified.
3171 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3173 sub primary_cust_svc {
3176 my @cust_svc = $self->cust_svc;
3178 return '' unless @cust_svc; #no serivces - irrelevant then
3180 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3182 # primary service as specified in the package definition
3183 # or exactly one service definition with quantity one
3184 my $svcpart = $self->part_pkg->svcpart;
3185 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3186 return $cust_svc[0] if scalar(@cust_svc) == 1;
3188 #couldn't identify one thing..
3194 Returns a list of lists, calling the label method for all services
3195 (see L<FS::cust_svc>) of this billing item.
3201 map { [ $_->label ] } $self->cust_svc;
3204 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3206 Like the labels method, but returns historical information on services that
3207 were active as of END_TIMESTAMP and (optionally) not cancelled before
3208 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3209 I<pkg_svc.hidden> flag will be omitted.
3211 Returns a list of lists, calling the label method for all (historical) services
3212 (see L<FS::h_cust_svc>) of this billing item.
3218 warn "$me _h_labels called on $self\n"
3220 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3225 Like labels, except returns a simple flat list, and shortens long
3226 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3227 identical services to one line that lists the service label and the number of
3228 individual services rather than individual items.
3233 shift->_labels_short( 'labels', @_ );
3236 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3238 Like h_labels, except returns a simple flat list, and shortens long
3239 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3240 identical services to one line that lists the service label and the number of
3241 individual services rather than individual items.
3245 sub h_labels_short {
3246 shift->_labels_short( 'h_labels', @_ );
3250 my( $self, $method ) = ( shift, shift );
3252 warn "$me _labels_short called on $self with $method method\n"
3255 my $conf = new FS::Conf;
3256 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3258 warn "$me _labels_short populating \%labels\n"
3262 #tie %labels, 'Tie::IxHash';
3263 push @{ $labels{$_->[0]} }, $_->[1]
3264 foreach $self->$method(@_);
3266 warn "$me _labels_short populating \@labels\n"
3270 foreach my $label ( keys %labels ) {
3272 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3273 my $num = scalar(@values);
3274 warn "$me _labels_short $num items for $label\n"
3277 if ( $num > $max_same_services ) {
3278 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3280 push @labels, "$label ($num)";
3282 if ( $conf->exists('cust_bill-consolidate_services') ) {
3283 warn "$me _labels_short consolidating services\n"
3285 # push @labels, "$label: ". join(', ', @values);
3287 my $detail = "$label: ";
3288 $detail .= shift(@values). ', '
3290 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3292 push @labels, $detail;
3294 warn "$me _labels_short done consolidating services\n"
3297 warn "$me _labels_short adding service data\n"
3299 push @labels, map { "$label: $_" } @values;
3310 Returns the parent customer object (see L<FS::cust_main>).
3314 Returns the balance for this specific package, when using
3315 experimental package balance.
3321 $self->cust_main->balance_pkgnum( $self->pkgnum );
3324 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3328 Returns the location object, if any (see L<FS::cust_location>).
3330 =item cust_location_or_main
3332 If this package is associated with a location, returns the locaiton (see
3333 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3335 =item location_label [ OPTION => VALUE ... ]
3337 Returns the label of the location object (see L<FS::cust_location>).
3341 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3343 =item tax_locationnum
3345 Returns the foreign key to a L<FS::cust_location> object for calculating
3346 tax on this package, as determined by the C<tax-pkg_address> and
3347 C<tax-ship_address> configuration flags.
3351 sub tax_locationnum {
3353 my $conf = FS::Conf->new;
3354 if ( $conf->exists('tax-pkg_address') ) {
3355 return $self->locationnum;
3357 elsif ( $conf->exists('tax-ship_address') ) {
3358 return $self->cust_main->ship_locationnum;
3361 return $self->cust_main->bill_locationnum;
3367 Returns the L<FS::cust_location> object for tax_locationnum.
3373 FS::cust_location->by_key( $self->tax_locationnum )
3376 =item seconds_since TIMESTAMP
3378 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3379 package have been online since TIMESTAMP, according to the session monitor.
3381 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3382 L<Time::Local> and L<Date::Parse> for conversion functions.
3387 my($self, $since) = @_;
3390 foreach my $cust_svc (
3391 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3393 $seconds += $cust_svc->seconds_since($since);
3400 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3402 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3403 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3406 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3407 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3413 sub seconds_since_sqlradacct {
3414 my($self, $start, $end) = @_;
3418 foreach my $cust_svc (
3420 my $part_svc = $_->part_svc;
3421 $part_svc->svcdb eq 'svc_acct'
3422 && scalar($part_svc->part_export_usage);
3425 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3432 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3434 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3435 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3439 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3440 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3445 sub attribute_since_sqlradacct {
3446 my($self, $start, $end, $attrib) = @_;
3450 foreach my $cust_svc (
3452 my $part_svc = $_->part_svc;
3453 scalar($part_svc->part_export_usage);
3456 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3468 my( $self, $value ) = @_;
3469 if ( defined($value) ) {
3470 $self->setfield('quantity', $value);
3472 $self->getfield('quantity') || 1;
3475 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3477 Transfers as many services as possible from this package to another package.
3479 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3480 object. The destination package must already exist.
3482 Services are moved only if the destination allows services with the correct
3483 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3484 this option with caution! No provision is made for export differences
3485 between the old and new service definitions. Probably only should be used
3486 when your exports for all service definitions of a given svcdb are identical.
3487 (attempt a transfer without it first, to move all possible svcpart-matching
3490 Any services that can't be moved remain in the original package.
3492 Returns an error, if there is one; otherwise, returns the number of services
3493 that couldn't be moved.
3498 my ($self, $dest_pkgnum, %opt) = @_;
3504 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3505 $dest = $dest_pkgnum;
3506 $dest_pkgnum = $dest->pkgnum;
3508 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3511 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3513 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3514 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3517 foreach my $cust_svc ($dest->cust_svc) {
3518 $target{$cust_svc->svcpart}--;
3521 my %svcpart2svcparts = ();
3522 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3523 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3524 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3525 next if exists $svcpart2svcparts{$svcpart};
3526 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3527 $svcpart2svcparts{$svcpart} = [
3529 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3531 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3532 'svcpart' => $_ } );
3534 $pkg_svc ? $pkg_svc->primary_svc : '',
3535 $pkg_svc ? $pkg_svc->quantity : 0,
3539 grep { $_ != $svcpart }
3541 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3543 warn "alternates for svcpart $svcpart: ".
3544 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3550 foreach my $cust_svc ($self->cust_svc) {
3551 my $svcnum = $cust_svc->svcnum;
3552 if($target{$cust_svc->svcpart} > 0
3553 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3554 $target{$cust_svc->svcpart}--;
3555 my $new = new FS::cust_svc { $cust_svc->hash };
3556 $new->pkgnum($dest_pkgnum);
3557 $error = $new->replace($cust_svc);
3558 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3560 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3561 warn "alternates to consider: ".
3562 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3564 my @alternate = grep {
3565 warn "considering alternate svcpart $_: ".
3566 "$target{$_} available in new package\n"
3569 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3571 warn "alternate(s) found\n" if $DEBUG;
3572 my $change_svcpart = $alternate[0];
3573 $target{$change_svcpart}--;
3574 my $new = new FS::cust_svc { $cust_svc->hash };
3575 $new->svcpart($change_svcpart);
3576 $new->pkgnum($dest_pkgnum);
3577 $error = $new->replace($cust_svc);
3585 my @label = $cust_svc->label;
3586 return "$label[0] $label[1]: $error";
3592 =item grab_svcnums SVCNUM, SVCNUM ...
3594 Change the pkgnum for the provided services to this packages. If there is an
3595 error, returns the error, otherwise returns false.
3603 my $oldAutoCommit = $FS::UID::AutoCommit;
3604 local $FS::UID::AutoCommit = 0;
3607 foreach my $svcnum (@svcnum) {
3608 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3609 $dbh->rollback if $oldAutoCommit;
3610 return "unknown svcnum $svcnum";
3612 $cust_svc->pkgnum( $self->pkgnum );
3613 my $error = $cust_svc->replace;
3615 $dbh->rollback if $oldAutoCommit;
3620 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3627 This method is deprecated. See the I<depend_jobnum> option to the insert and
3628 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3632 #looks like this is still used by the order_pkg and change_pkg methods in
3633 # ClientAPI/MyAccount, need to look into those before removing
3637 my $oldAutoCommit = $FS::UID::AutoCommit;
3638 local $FS::UID::AutoCommit = 0;
3641 foreach my $cust_svc ( $self->cust_svc ) {
3642 #false laziness w/svc_Common::insert
3643 my $svc_x = $cust_svc->svc_x;
3644 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3645 my $error = $part_export->export_insert($svc_x);
3647 $dbh->rollback if $oldAutoCommit;
3653 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3658 =item export_pkg_change OLD_CUST_PKG
3660 Calls the "pkg_change" export action for all services attached to this package.
3664 sub export_pkg_change {
3665 my( $self, $old ) = ( shift, shift );
3667 my $oldAutoCommit = $FS::UID::AutoCommit;
3668 local $FS::UID::AutoCommit = 0;
3671 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3672 my $error = $svc_x->export('pkg_change', $self, $old);
3674 $dbh->rollback if $oldAutoCommit;
3679 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3686 Associates this package with a (suspension or cancellation) reason (see
3687 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3690 Available options are:
3696 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.
3700 the access_user (see L<FS::access_user>) providing the reason
3708 the action (cancel, susp, adjourn, expire) associated with the reason
3712 If there is an error, returns the error, otherwise returns false.
3717 my ($self, %options) = @_;
3719 my $otaker = $options{reason_otaker} ||
3720 $FS::CurrentUser::CurrentUser->username;
3723 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3727 } elsif ( ref($options{'reason'}) ) {
3729 return 'Enter a new reason (or select an existing one)'
3730 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3732 my $reason = new FS::reason({
3733 'reason_type' => $options{'reason'}->{'typenum'},
3734 'reason' => $options{'reason'}->{'reason'},
3736 my $error = $reason->insert;
3737 return $error if $error;
3739 $reasonnum = $reason->reasonnum;
3742 return "Unparsable reason: ". $options{'reason'};
3745 my $cust_pkg_reason =
3746 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3747 'reasonnum' => $reasonnum,
3748 'otaker' => $otaker,
3749 'action' => substr(uc($options{'action'}),0,1),
3750 'date' => $options{'date'}
3755 $cust_pkg_reason->insert;
3758 =item insert_discount
3760 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3761 inserting a new discount on the fly (see L<FS::discount>).
3763 Available options are:
3771 If there is an error, returns the error, otherwise returns false.
3775 sub insert_discount {
3776 #my ($self, %options) = @_;
3779 my $cust_pkg_discount = new FS::cust_pkg_discount {
3780 'pkgnum' => $self->pkgnum,
3781 'discountnum' => $self->discountnum,
3783 'end_date' => '', #XXX
3784 #for the create a new discount case
3785 '_type' => $self->discountnum__type,
3786 'amount' => $self->discountnum_amount,
3787 'percent' => $self->discountnum_percent,
3788 'months' => $self->discountnum_months,
3789 'setup' => $self->discountnum_setup,
3790 #'disabled' => $self->discountnum_disabled,
3793 $cust_pkg_discount->insert;
3796 =item set_usage USAGE_VALUE_HASHREF
3798 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3799 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3800 upbytes, downbytes, and totalbytes are appropriate keys.
3802 All svc_accts which are part of this package have their values reset.
3807 my ($self, $valueref, %opt) = @_;
3809 #only svc_acct can set_usage for now
3810 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3811 my $svc_x = $cust_svc->svc_x;
3812 $svc_x->set_usage($valueref, %opt)
3813 if $svc_x->can("set_usage");
3817 =item recharge USAGE_VALUE_HASHREF
3819 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3820 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3821 upbytes, downbytes, and totalbytes are appropriate keys.
3823 All svc_accts which are part of this package have their values incremented.
3828 my ($self, $valueref) = @_;
3830 #only svc_acct can set_usage for now
3831 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3832 my $svc_x = $cust_svc->svc_x;
3833 $svc_x->recharge($valueref)
3834 if $svc_x->can("recharge");
3838 =item apply_usageprice
3842 sub apply_usageprice {
3845 my $oldAutoCommit = $FS::UID::AutoCommit;
3846 local $FS::UID::AutoCommit = 0;
3851 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
3852 $error ||= $cust_pkg_usageprice->apply;
3856 $dbh->rollback if $oldAutoCommit;
3857 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
3860 $dbh->commit if $oldAutoCommit;
3866 =item cust_pkg_discount
3868 =item cust_pkg_discount_active
3872 sub cust_pkg_discount_active {
3874 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3877 =item cust_pkg_usage
3879 Returns a list of all voice usage counters attached to this package.
3881 =item apply_usage OPTIONS
3883 Takes the following options:
3884 - cdr: a call detail record (L<FS::cdr>)
3885 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3886 - minutes: the maximum number of minutes to be charged
3888 Finds available usage minutes for a call of this class, and subtracts
3889 up to that many minutes from the usage pool. If the usage pool is empty,
3890 and the C<cdr-minutes_priority> global config option is set, minutes may
3891 be taken from other calls as well. Either way, an allocation record will
3892 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3893 number of minutes of usage applied to the call.
3898 my ($self, %opt) = @_;
3899 my $cdr = $opt{cdr};
3900 my $rate_detail = $opt{rate_detail};
3901 my $minutes = $opt{minutes};
3902 my $classnum = $rate_detail->classnum;
3903 my $pkgnum = $self->pkgnum;
3904 my $custnum = $self->custnum;
3906 my $oldAutoCommit = $FS::UID::AutoCommit;
3907 local $FS::UID::AutoCommit = 0;
3910 my $order = FS::Conf->new->config('cdr-minutes_priority');
3914 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3916 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3918 my @usage_recs = qsearch({
3919 'table' => 'cust_pkg_usage',
3920 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3921 ' JOIN cust_pkg USING (pkgnum)'.
3922 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3923 'select' => 'cust_pkg_usage.*',
3924 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3925 " ( cust_pkg.custnum = $custnum AND ".
3926 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3927 $is_classnum . ' AND '.
3928 " cust_pkg_usage.minutes > 0",
3929 'order_by' => " ORDER BY priority ASC",
3932 my $orig_minutes = $minutes;
3934 while (!$error and $minutes > 0 and @usage_recs) {
3935 my $cust_pkg_usage = shift @usage_recs;
3936 $cust_pkg_usage->select_for_update;
3937 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3938 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3939 acctid => $cdr->acctid,
3940 minutes => min($cust_pkg_usage->minutes, $minutes),
3942 $cust_pkg_usage->set('minutes',
3943 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3945 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3946 $minutes -= $cdr_cust_pkg_usage->minutes;
3948 if ( $order and $minutes > 0 and !$error ) {
3949 # then try to steal minutes from another call
3951 'table' => 'cdr_cust_pkg_usage',
3952 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3953 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3954 ' JOIN cust_pkg USING (pkgnum)'.
3955 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3956 ' JOIN cdr USING (acctid)',
3957 'select' => 'cdr_cust_pkg_usage.*',
3958 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3959 " ( cust_pkg.pkgnum = $pkgnum OR ".
3960 " ( cust_pkg.custnum = $custnum AND ".
3961 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3962 " part_pkg_usage_class.classnum = $classnum",
3963 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3965 if ( $order eq 'time' ) {
3966 # find CDRs that are using minutes, but have a later startdate
3968 my $startdate = $cdr->startdate;
3969 if ($startdate !~ /^\d+$/) {
3970 die "bad cdr startdate '$startdate'";
3972 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3973 # minimize needless reshuffling
3974 $search{'order_by'} .= ', cdr.startdate DESC';
3976 # XXX may not work correctly with rate_time schedules. Could
3977 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3979 $search{'addl_from'} .=
3980 ' JOIN rate_detail'.
3981 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3982 if ( $order eq 'rate_high' ) {
3983 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3984 $rate_detail->min_charge;
3985 $search{'order_by'} .= ', rate_detail.min_charge ASC';
3986 } elsif ( $order eq 'rate_low' ) {
3987 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3988 $rate_detail->min_charge;
3989 $search{'order_by'} .= ', rate_detail.min_charge DESC';
3991 # this should really never happen
3992 die "invalid cdr-minutes_priority value '$order'\n";
3995 my @cdr_usage_recs = qsearch(\%search);
3997 while (!$error and @cdr_usage_recs and $minutes > 0) {
3998 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3999 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4000 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4001 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4002 $cdr_cust_pkg_usage->select_for_update;
4003 $old_cdr->select_for_update;
4004 $cust_pkg_usage->select_for_update;
4005 # in case someone else stole the usage from this CDR
4006 # while waiting for the lock...
4007 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4008 # steal the usage allocation and flag the old CDR for reprocessing
4009 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4010 # if the allocation is more minutes than we need, adjust it...
4011 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4013 $cdr_cust_pkg_usage->set('minutes', $minutes);
4014 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4015 $error = $cust_pkg_usage->replace;
4017 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4018 $error ||= $cdr_cust_pkg_usage->replace;
4019 # deduct the stolen minutes
4020 $minutes -= $cdr_cust_pkg_usage->minutes;
4022 # after all minute-stealing is done, reset the affected CDRs
4023 foreach (values %reproc_cdrs) {
4024 $error ||= $_->set_status('');
4025 # XXX or should we just call $cdr->rate right here?
4026 # it's not like we can create a loop this way, since the min_charge
4027 # or call time has to go monotonically in one direction.
4028 # we COULD get some very deep recursions going, though...
4030 } # if $order and $minutes
4033 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4035 $dbh->commit if $oldAutoCommit;
4036 return $orig_minutes - $minutes;
4040 =item supplemental_pkgs
4042 Returns a list of all packages supplemental to this one.
4046 sub supplemental_pkgs {
4048 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4053 Returns the package that this one is supplemental to, if any.
4059 if ( $self->main_pkgnum ) {
4060 return FS::cust_pkg->by_key($self->main_pkgnum);
4067 =head1 CLASS METHODS
4073 Returns an SQL expression identifying recurring packages.
4077 sub recurring_sql { "
4078 '0' != ( select freq from part_pkg
4079 where cust_pkg.pkgpart = part_pkg.pkgpart )
4084 Returns an SQL expression identifying one-time packages.
4089 '0' = ( select freq from part_pkg
4090 where cust_pkg.pkgpart = part_pkg.pkgpart )
4095 Returns an SQL expression identifying ordered packages (recurring packages not
4101 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4106 Returns an SQL expression identifying active packages.
4111 $_[0]->recurring_sql. "
4112 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4113 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4114 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4117 =item not_yet_billed_sql
4119 Returns an SQL expression identifying packages which have not yet been billed.
4123 sub not_yet_billed_sql { "
4124 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4125 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4126 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4131 Returns an SQL expression identifying inactive packages (one-time packages
4132 that are otherwise unsuspended/uncancelled).
4136 sub inactive_sql { "
4137 ". $_[0]->onetime_sql(). "
4138 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4139 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4140 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4146 Returns an SQL expression identifying suspended packages.
4150 sub suspended_sql { susp_sql(@_); }
4152 #$_[0]->recurring_sql(). ' AND '.
4154 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4155 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4162 Returns an SQL exprression identifying cancelled packages.
4166 sub cancelled_sql { cancel_sql(@_); }
4168 #$_[0]->recurring_sql(). ' AND '.
4169 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4174 Returns an SQL expression to give the package status as a string.
4180 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4181 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4182 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4183 WHEN ".onetime_sql()." THEN 'one-time charge'
4188 =item search HASHREF
4192 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4193 Valid parameters are
4201 active, inactive, suspended, cancel (or cancelled)
4205 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
4209 boolean selects custom packages
4215 pkgpart or arrayref or hashref of pkgparts
4219 arrayref of beginning and ending epoch date
4223 arrayref of beginning and ending epoch date
4227 arrayref of beginning and ending epoch date
4231 arrayref of beginning and ending epoch date
4235 arrayref of beginning and ending epoch date
4239 arrayref of beginning and ending epoch date
4243 arrayref of beginning and ending epoch date
4247 pkgnum or APKG_pkgnum
4251 a value suited to passing to FS::UI::Web::cust_header
4255 specifies the user for agent virtualization
4259 boolean; if true, returns only packages with more than 0 FCC phone lines.
4261 =item state, country
4263 Limit to packages with a service location in the specified state and country.
4264 For FCC 477 reporting, mostly.
4268 Limit to packages whose service locations are the same as the customer's
4269 default service location.
4271 =item location_nocust
4273 Limit to packages whose service locations are not the customer's default
4276 =item location_census
4278 Limit to packages whose service locations have census tracts.
4280 =item location_nocensus
4282 Limit to packages whose service locations do not have a census tract.
4284 =item location_geocode
4286 Limit to packages whose locations have geocodes.
4288 =item location_geocode
4290 Limit to packages whose locations do not have geocodes.
4297 my ($class, $params) = @_;
4304 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4306 "cust_main.agentnum = $1";
4313 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4314 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4318 # parse customer sales person
4321 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4322 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4323 : 'cust_main.salesnum IS NULL';
4328 # parse sales person
4331 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4332 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4333 : 'cust_pkg.salesnum IS NULL';
4340 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4342 "cust_pkg.custnum = $1";
4349 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4351 "cust_pkg.pkgbatch = '$1'";
4358 if ( $params->{'magic'} eq 'active'
4359 || $params->{'status'} eq 'active' ) {
4361 push @where, FS::cust_pkg->active_sql();
4363 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4364 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4366 push @where, FS::cust_pkg->not_yet_billed_sql();
4368 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4369 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4371 push @where, FS::cust_pkg->inactive_sql();
4373 } elsif ( $params->{'magic'} eq 'suspended'
4374 || $params->{'status'} eq 'suspended' ) {
4376 push @where, FS::cust_pkg->suspended_sql();
4378 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4379 || $params->{'status'} =~ /^cancell?ed$/ ) {
4381 push @where, FS::cust_pkg->cancelled_sql();
4386 # parse package class
4389 if ( exists($params->{'classnum'}) ) {
4392 if ( ref($params->{'classnum'}) ) {
4394 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4395 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4396 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4397 @classnum = @{ $params->{'classnum'} };
4399 die 'unhandled classnum ref '. $params->{'classnum'};
4403 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4410 my @nums = grep $_, @classnum;
4411 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4412 my $null = scalar( grep { $_ eq '' } @classnum );
4413 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4415 if ( scalar(@c_where) == 1 ) {
4416 push @where, @c_where;
4417 } elsif ( @c_where ) {
4418 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4427 # parse package report options
4430 my @report_option = ();
4431 if ( exists($params->{'report_option'}) ) {
4432 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4433 @report_option = @{ $params->{'report_option'} };
4434 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4435 @report_option = split(',', $1);
4440 if (@report_option) {
4441 # this will result in the empty set for the dangling comma case as it should
4443 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4444 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4445 AND optionname = 'report_option_$_'
4446 AND optionvalue = '1' )"
4450 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4452 my @report_option_any = ();
4453 if ( ref($params->{$any}) eq 'ARRAY' ) {
4454 @report_option_any = @{ $params->{$any} };
4455 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4456 @report_option_any = split(',', $1);
4459 if (@report_option_any) {
4460 # this will result in the empty set for the dangling comma case as it should
4461 push @where, ' ( '. join(' OR ',
4462 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4463 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4464 AND optionname = 'report_option_$_'
4465 AND optionvalue = '1' )"
4466 } @report_option_any
4476 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4482 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4483 if $params->{fcc_line};
4489 if ( exists($params->{'censustract'}) ) {
4490 $params->{'censustract'} =~ /^([.\d]*)$/;
4491 my $censustract = "cust_location.censustract = '$1'";
4492 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4493 push @where, "( $censustract )";
4497 # parse censustract2
4499 if ( exists($params->{'censustract2'})
4500 && $params->{'censustract2'} =~ /^(\d*)$/
4504 push @where, "cust_location.censustract LIKE '$1%'";
4507 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4512 # parse country/state
4514 for (qw(state country)) { # parsing rules are the same for these
4515 if ( exists($params->{$_})
4516 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4518 # XXX post-2.3 only--before that, state/country may be in cust_main
4519 push @where, "cust_location.$_ = '$1'";
4526 if ( $params->{location_cust} xor $params->{location_nocust} ) {
4527 my $op = $params->{location_cust} ? '=' : '!=';
4528 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
4530 if ( $params->{location_census} xor $params->{location_nocensus} ) {
4531 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
4532 push @where, "cust_location.censustract $op";
4534 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
4535 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
4536 push @where, "cust_location.geocode $op";
4543 if ( ref($params->{'pkgpart'}) ) {
4546 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4547 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4548 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4549 @pkgpart = @{ $params->{'pkgpart'} };
4551 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4554 @pkgpart = grep /^(\d+)$/, @pkgpart;
4556 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4558 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4559 push @where, "pkgpart = $1";
4568 #false laziness w/report_cust_pkg.html
4571 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4572 'active' => { 'susp'=>1, 'cancel'=>1 },
4573 'suspended' => { 'cancel' => 1 },
4578 if( exists($params->{'active'} ) ) {
4579 # This overrides all the other date-related fields
4580 my($beginning, $ending) = @{$params->{'active'}};
4582 "cust_pkg.setup IS NOT NULL",
4583 "cust_pkg.setup <= $ending",
4584 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4585 "NOT (".FS::cust_pkg->onetime_sql . ")";
4588 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4590 next unless exists($params->{$field});
4592 my($beginning, $ending) = @{$params->{$field}};
4594 next if $beginning == 0 && $ending == 4294967295;
4597 "cust_pkg.$field IS NOT NULL",
4598 "cust_pkg.$field >= $beginning",
4599 "cust_pkg.$field <= $ending";
4601 $orderby ||= "ORDER BY cust_pkg.$field";
4606 $orderby ||= 'ORDER BY bill';
4609 # parse magic, legacy, etc.
4612 if ( $params->{'magic'} &&
4613 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4616 $orderby = 'ORDER BY pkgnum';
4618 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4619 push @where, "pkgpart = $1";
4622 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4624 $orderby = 'ORDER BY pkgnum';
4626 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4628 $orderby = 'ORDER BY pkgnum';
4631 SELECT count(*) FROM pkg_svc
4632 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4633 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4634 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4635 AND cust_svc.svcpart = pkg_svc.svcpart
4642 # setup queries, links, subs, etc. for the search
4645 # here is the agent virtualization
4646 if ($params->{CurrentUser}) {
4648 qsearchs('access_user', { username => $params->{CurrentUser} });
4651 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4656 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4659 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4661 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4662 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4663 'LEFT JOIN cust_location USING ( locationnum ) '.
4664 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4668 if ( $params->{'select_zip5'} ) {
4669 my $zip = 'cust_location.zip';
4671 $select = "DISTINCT substr($zip,1,5) as zip";
4672 $orderby = "ORDER BY substr($zip,1,5)";
4673 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4675 $select = join(', ',
4677 ( map "part_pkg.$_", qw( pkg freq ) ),
4678 'pkg_class.classname',
4679 'cust_main.custnum AS cust_main_custnum',
4680 FS::UI::Web::cust_sql_fields(
4681 $params->{'cust_fields'}
4684 $count_query = 'SELECT COUNT(*)';
4687 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4690 'table' => 'cust_pkg',
4692 'select' => $select,
4693 'extra_sql' => $extra_sql,
4694 'order_by' => $orderby,
4695 'addl_from' => $addl_from,
4696 'count_query' => $count_query,
4703 Returns a list of two package counts. The first is a count of packages
4704 based on the supplied criteria and the second is the count of residential
4705 packages with those same criteria. Criteria are specified as in the search
4711 my ($class, $params) = @_;
4713 my $sql_query = $class->search( $params );
4715 my $count_sql = delete($sql_query->{'count_query'});
4716 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4717 or die "couldn't parse count_sql";
4719 my $count_sth = dbh->prepare($count_sql)
4720 or die "Error preparing $count_sql: ". dbh->errstr;
4722 or die "Error executing $count_sql: ". $count_sth->errstr;
4723 my $count_arrayref = $count_sth->fetchrow_arrayref;
4725 return ( @$count_arrayref );
4729 =item tax_locationnum_sql
4731 Returns an SQL expression for the tax location for a package, based
4732 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4736 sub tax_locationnum_sql {
4737 my $conf = FS::Conf->new;
4738 if ( $conf->exists('tax-pkg_address') ) {
4739 'cust_pkg.locationnum';
4741 elsif ( $conf->exists('tax-ship_address') ) {
4742 'cust_main.ship_locationnum';
4745 'cust_main.bill_locationnum';
4751 Returns a list: the first item is an SQL fragment identifying matching
4752 packages/customers via location (taking into account shipping and package
4753 address taxation, if enabled), and subsequent items are the parameters to
4754 substitute for the placeholders in that fragment.
4759 my($class, %opt) = @_;
4760 my $ornull = $opt{'ornull'};
4762 my $conf = new FS::Conf;
4764 # '?' placeholders in _location_sql_where
4765 my $x = $ornull ? 3 : 2;
4776 if ( $conf->exists('tax-ship_address') ) {
4779 ( ( ship_last IS NULL OR ship_last = '' )
4780 AND ". _location_sql_where('cust_main', '', $ornull ). "
4782 OR ( ship_last IS NOT NULL AND ship_last != ''
4783 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4786 # AND payby != 'COMP'
4788 @main_param = ( @bill_param, @bill_param );
4792 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4793 @main_param = @bill_param;
4799 if ( $conf->exists('tax-pkg_address') ) {
4801 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4804 ( cust_pkg.locationnum IS NULL AND $main_where )
4805 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4808 @param = ( @main_param, @bill_param );
4812 $where = $main_where;
4813 @param = @main_param;
4821 #subroutine, helper for location_sql
4822 sub _location_sql_where {
4824 my $prefix = @_ ? shift : '';
4825 my $ornull = @_ ? shift : '';
4827 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4829 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4831 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4832 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4833 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4835 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4837 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4839 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4840 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4841 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4842 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4843 AND $table.${prefix}country = ?
4848 my( $self, $what ) = @_;
4850 my $what_show_zero = $what. '_show_zero';
4851 length($self->$what_show_zero())
4852 ? ($self->$what_show_zero() eq 'Y')
4853 : $self->part_pkg->$what_show_zero();
4860 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4862 CUSTNUM is a customer (see L<FS::cust_main>)
4864 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4865 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4868 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4869 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4870 new billing items. An error is returned if this is not possible (see
4871 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4874 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4875 newly-created cust_pkg objects.
4877 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4878 and inserted. Multiple FS::pkg_referral records can be created by
4879 setting I<refnum> to an array reference of refnums or a hash reference with
4880 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4881 record will be created corresponding to cust_main.refnum.
4886 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4888 my $conf = new FS::Conf;
4890 # Transactionize this whole mess
4891 my $oldAutoCommit = $FS::UID::AutoCommit;
4892 local $FS::UID::AutoCommit = 0;
4896 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4897 # return "Customer not found: $custnum" unless $cust_main;
4899 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4902 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4905 my $change = scalar(@old_cust_pkg) != 0;
4908 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4910 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4911 " to pkgpart ". $pkgparts->[0]. "\n"
4914 my $err_or_cust_pkg =
4915 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4916 'refnum' => $refnum,
4919 unless (ref($err_or_cust_pkg)) {
4920 $dbh->rollback if $oldAutoCommit;
4921 return $err_or_cust_pkg;
4924 push @$return_cust_pkg, $err_or_cust_pkg;
4925 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4930 # Create the new packages.
4931 foreach my $pkgpart (@$pkgparts) {
4933 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4935 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4936 pkgpart => $pkgpart,
4940 $error = $cust_pkg->insert( 'change' => $change );
4941 push @$return_cust_pkg, $cust_pkg;
4943 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4944 my $supp_pkg = FS::cust_pkg->new({
4945 custnum => $custnum,
4946 pkgpart => $link->dst_pkgpart,
4948 main_pkgnum => $cust_pkg->pkgnum,
4951 $error ||= $supp_pkg->insert( 'change' => $change );
4952 push @$return_cust_pkg, $supp_pkg;
4956 $dbh->rollback if $oldAutoCommit;
4961 # $return_cust_pkg now contains refs to all of the newly
4964 # Transfer services and cancel old packages.
4965 foreach my $old_pkg (@old_cust_pkg) {
4967 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4970 foreach my $new_pkg (@$return_cust_pkg) {
4971 $error = $old_pkg->transfer($new_pkg);
4972 if ($error and $error == 0) {
4973 # $old_pkg->transfer failed.
4974 $dbh->rollback if $oldAutoCommit;
4979 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4980 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4981 foreach my $new_pkg (@$return_cust_pkg) {
4982 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4983 if ($error and $error == 0) {
4984 # $old_pkg->transfer failed.
4985 $dbh->rollback if $oldAutoCommit;
4992 # Transfers were successful, but we went through all of the
4993 # new packages and still had services left on the old package.
4994 # We can't cancel the package under the circumstances, so abort.
4995 $dbh->rollback if $oldAutoCommit;
4996 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4998 $error = $old_pkg->cancel( quiet=>1 );
5004 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5008 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5010 A bulk change method to change packages for multiple customers.
5012 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5013 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5016 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5017 replace. The services (see L<FS::cust_svc>) are moved to the
5018 new billing items. An error is returned if this is not possible (see
5021 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5022 newly-created cust_pkg objects.
5027 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5029 # Transactionize this whole mess
5030 my $oldAutoCommit = $FS::UID::AutoCommit;
5031 local $FS::UID::AutoCommit = 0;
5035 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5038 while(scalar(@old_cust_pkg)) {
5040 my $custnum = $old_cust_pkg[0]->custnum;
5041 my (@remove) = map { $_->pkgnum }
5042 grep { $_->custnum == $custnum } @old_cust_pkg;
5043 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5045 my $error = order $custnum, $pkgparts, \@remove, \@return;
5047 push @errors, $error
5049 push @$return_cust_pkg, @return;
5052 if (scalar(@errors)) {
5053 $dbh->rollback if $oldAutoCommit;
5054 return join(' / ', @errors);
5057 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5061 # Used by FS::Upgrade to migrate to a new database.
5062 sub _upgrade_data { # class method
5063 my ($class, %opts) = @_;
5064 $class->_upgrade_otaker(%opts);
5066 # RT#10139, bug resulting in contract_end being set when it shouldn't
5067 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5068 # RT#10830, bad calculation of prorate date near end of year
5069 # the date range for bill is December 2009, and we move it forward
5070 # one year if it's before the previous bill date (which it should
5072 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5073 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5074 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5075 # RT6628, add order_date to cust_pkg
5076 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5077 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5078 history_action = \'insert\') where order_date is null',
5080 foreach my $sql (@statements) {
5081 my $sth = dbh->prepare($sql);
5082 $sth->execute or die $sth->errstr;
5090 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5092 In sub order, the @pkgparts array (passed by reference) is clobbered.
5094 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5095 method to pass dates to the recur_prog expression, it should do so.
5097 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5098 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5099 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5100 configuration values. Probably need a subroutine which decides what to do
5101 based on whether or not we've fetched the user yet, rather than a hash. See
5102 FS::UID and the TODO.
5104 Now that things are transactional should the check in the insert method be
5109 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5110 L<FS::pkg_svc>, schema.html from the base documentation