4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common );
6 use vars qw($disable_agentcheck $DEBUG $me);
8 use Scalar::Util qw( blessed );
9 use List::Util qw(max);
11 use Time::Local qw( timelocal timelocal_nocheck );
13 use FS::UID qw( getotaker dbh );
14 use FS::Misc qw( send_email );
15 use FS::Record qw( qsearch qsearchs );
20 use FS::cust_location;
22 use FS::cust_bill_pkg;
23 use FS::cust_pkg_detail;
28 use FS::cust_pkg_reason;
30 use FS::cust_pkg_discount;
35 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
37 # because they load configuration by setting FS::UID::callback (see TODO)
43 # for sending cancel emails in sub cancel
47 $me = '[FS::cust_pkg]';
49 $disable_agentcheck = 0;
53 my ( $hashref, $cache ) = @_;
54 #if ( $hashref->{'pkgpart'} ) {
55 if ( $hashref->{'pkg'} ) {
56 # #@{ $self->{'_pkgnum'} } = ();
57 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
58 # $self->{'_pkgpart'} = $subcache;
59 # #push @{ $self->{'_pkgnum'} },
60 # FS::part_pkg->new_or_cached($hashref, $subcache);
61 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
63 if ( exists $hashref->{'svcnum'} ) {
64 #@{ $self->{'_pkgnum'} } = ();
65 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
66 $self->{'_svcnum'} = $subcache;
67 #push @{ $self->{'_pkgnum'} },
68 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
74 FS::cust_pkg - Object methods for cust_pkg objects
80 $record = new FS::cust_pkg \%hash;
81 $record = new FS::cust_pkg { 'column' => 'value' };
83 $error = $record->insert;
85 $error = $new_record->replace($old_record);
87 $error = $record->delete;
89 $error = $record->check;
91 $error = $record->cancel;
93 $error = $record->suspend;
95 $error = $record->unsuspend;
97 $part_pkg = $record->part_pkg;
99 @labels = $record->labels;
101 $seconds = $record->seconds_since($timestamp);
103 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
104 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
108 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
109 inherits from FS::Record. The following fields are currently supported:
115 Primary key (assigned automatically for new billing items)
119 Customer (see L<FS::cust_main>)
123 Billing item definition (see L<FS::part_pkg>)
127 Optional link to package location (see L<FS::location>)
131 date package was ordered (also remains same on changes)
143 date (next bill date)
171 order taker (see L<FS::access_user>)
175 If this field is set to 1, disables the automatic
176 unsuspension of this package when using the B<unsuspendauto> config option.
180 If not set, defaults to 1
184 Date of change from previous package
194 =item change_locationnum
202 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
203 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
204 L<Time::Local> and L<Date::Parse> for conversion functions.
212 Create a new billing item. To add the item to the database, see L<"insert">.
216 sub table { 'cust_pkg'; }
217 sub cust_linked { $_[0]->cust_main_custnum; }
218 sub cust_unlinked_msg {
220 "WARNING: can't find cust_main.custnum ". $self->custnum.
221 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
224 =item insert [ OPTION => VALUE ... ]
226 Adds this billing item to the database ("Orders" the item). If there is an
227 error, returns the error, otherwise returns false.
229 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
230 will be used to look up the package definition and agent restrictions will be
233 If the additional field I<refnum> is defined, an FS::pkg_referral record will
234 be created and inserted. Multiple FS::pkg_referral records can be created by
235 setting I<refnum> to an array reference of refnums or a hash reference with
236 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
237 record will be created corresponding to cust_main.refnum.
239 The following options are available:
245 If set true, supresses any referral credit to a referring customer.
249 cust_pkg_option records will be created
253 a ticket will be added to this customer with this subject
257 an optional queue name for ticket additions
264 my( $self, %options ) = @_;
266 my $error = $self->check_pkgpart;
267 return $error if $error;
269 my $part_pkg = $self->part_pkg;
271 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
272 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
273 $mon += 1 unless $mday == 1;
274 until ( $mon < 12 ) { $mon -= 12; $year++; }
275 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
278 foreach my $action ( qw(expire adjourn contract_end) ) {
279 my $months = $part_pkg->option("${action}_months",1);
280 if($months and !$self->$action) {
281 my $start = $self->start_date || $self->setup || time;
282 $self->$action( $part_pkg->add_freq($start, $months) );
286 my $free_days = $part_pkg->option('free_days',1);
287 if ( $free_days && $part_pkg->option('delay_setup',1) ) { #&& !$self->start_date
288 my ($mday,$mon,$year) = (localtime(time) )[3,4,5];
289 #my $start_date = ($self->start_date || timelocal(0,0,0,$mday,$mon,$year)) + 86400 * $free_days;
290 my $start_date = timelocal(0,0,0,$mday,$mon,$year) + 86400 * $free_days;
291 $self->start_date($start_date);
294 $self->order_date(time);
296 local $SIG{HUP} = 'IGNORE';
297 local $SIG{INT} = 'IGNORE';
298 local $SIG{QUIT} = 'IGNORE';
299 local $SIG{TERM} = 'IGNORE';
300 local $SIG{TSTP} = 'IGNORE';
301 local $SIG{PIPE} = 'IGNORE';
303 my $oldAutoCommit = $FS::UID::AutoCommit;
304 local $FS::UID::AutoCommit = 0;
307 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
309 $dbh->rollback if $oldAutoCommit;
313 $self->refnum($self->cust_main->refnum) unless $self->refnum;
314 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
315 $self->process_m2m( 'link_table' => 'pkg_referral',
316 'target_table' => 'part_referral',
317 'params' => $self->refnum,
320 if ( $self->discountnum ) {
321 my $error = $self->insert_discount();
323 $dbh->rollback if $oldAutoCommit;
328 #if ( $self->reg_code ) {
329 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
330 # $error = $reg_code->delete;
332 # $dbh->rollback if $oldAutoCommit;
337 my $conf = new FS::Conf;
339 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
342 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
349 use FS::TicketSystem;
350 FS::TicketSystem->init();
352 my $q = new RT::Queue($RT::SystemUser);
353 $q->Load($options{ticket_queue}) if $options{ticket_queue};
354 my $t = new RT::Ticket($RT::SystemUser);
355 my $mime = new MIME::Entity;
356 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
357 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
358 Subject => $options{ticket_subject},
361 $t->AddLink( Type => 'MemberOf',
362 Target => 'freeside://freeside/cust_main/'. $self->custnum,
366 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
367 my $queue = new FS::queue {
368 'job' => 'FS::cust_main::queueable_print',
370 $error = $queue->insert(
371 'custnum' => $self->custnum,
372 'template' => 'welcome_letter',
376 warn "can't send welcome letter: $error";
381 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
388 This method now works but you probably shouldn't use it.
390 You don't want to delete packages, because there would then be no record
391 the customer ever purchased the package. Instead, see the cancel method and
392 hide cancelled packages.
399 local $SIG{HUP} = 'IGNORE';
400 local $SIG{INT} = 'IGNORE';
401 local $SIG{QUIT} = 'IGNORE';
402 local $SIG{TERM} = 'IGNORE';
403 local $SIG{TSTP} = 'IGNORE';
404 local $SIG{PIPE} = 'IGNORE';
406 my $oldAutoCommit = $FS::UID::AutoCommit;
407 local $FS::UID::AutoCommit = 0;
410 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
411 my $error = $cust_pkg_discount->delete;
413 $dbh->rollback if $oldAutoCommit;
417 #cust_bill_pkg_discount?
419 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
420 my $error = $cust_pkg_detail->delete;
422 $dbh->rollback if $oldAutoCommit;
427 foreach my $cust_pkg_reason (
429 'table' => 'cust_pkg_reason',
430 'hashref' => { 'pkgnum' => $self->pkgnum },
434 my $error = $cust_pkg_reason->delete;
436 $dbh->rollback if $oldAutoCommit;
443 my $error = $self->SUPER::delete(@_);
445 $dbh->rollback if $oldAutoCommit;
449 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
455 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
457 Replaces the OLD_RECORD with this one in the database. If there is an error,
458 returns the error, otherwise returns false.
460 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
462 Changing pkgpart may have disasterous effects. See the order subroutine.
464 setup and bill are normally updated by calling the bill method of a customer
465 object (see L<FS::cust_main>).
467 suspend is normally updated by the suspend and unsuspend methods.
469 cancel is normally updated by the cancel method (and also the order subroutine
472 Available options are:
478 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.
482 the access_user (see L<FS::access_user>) providing the reason
486 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
495 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
500 ( ref($_[0]) eq 'HASH' )
504 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
505 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
508 #return "Can't change setup once it exists!"
509 # if $old->getfield('setup') &&
510 # $old->getfield('setup') != $new->getfield('setup');
512 #some logic for bill, susp, cancel?
514 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
516 local $SIG{HUP} = 'IGNORE';
517 local $SIG{INT} = 'IGNORE';
518 local $SIG{QUIT} = 'IGNORE';
519 local $SIG{TERM} = 'IGNORE';
520 local $SIG{TSTP} = 'IGNORE';
521 local $SIG{PIPE} = 'IGNORE';
523 my $oldAutoCommit = $FS::UID::AutoCommit;
524 local $FS::UID::AutoCommit = 0;
527 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
528 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
529 my $error = $new->insert_reason(
530 'reason' => $options->{'reason'},
531 'date' => $new->$method,
533 'reason_otaker' => $options->{'reason_otaker'},
536 dbh->rollback if $oldAutoCommit;
537 return "Error inserting cust_pkg_reason: $error";
542 #save off and freeze RADIUS attributes for any associated svc_acct records
544 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
546 #also check for specific exports?
547 # to avoid spurious modify export events
548 @svc_acct = map { $_->svc_x }
549 grep { $_->part_svc->svcdb eq 'svc_acct' }
552 $_->snapshot foreach @svc_acct;
556 my $error = $new->SUPER::replace($old,
557 $options->{options} ? $options->{options} : ()
560 $dbh->rollback if $oldAutoCommit;
564 #for prepaid packages,
565 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
566 foreach my $old_svc_acct ( @svc_acct ) {
567 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
569 $new_svc_acct->replace( $old_svc_acct,
570 'depend_jobnum' => $options->{depend_jobnum},
573 $dbh->rollback if $oldAutoCommit;
578 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
585 Checks all fields to make sure this is a valid billing item. If there is an
586 error, returns the error, otherwise returns false. Called by the insert and
594 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
597 $self->ut_numbern('pkgnum')
598 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
599 || $self->ut_numbern('pkgpart')
600 || $self->check_pkgpart
601 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
602 || $self->ut_numbern('start_date')
603 || $self->ut_numbern('setup')
604 || $self->ut_numbern('bill')
605 || $self->ut_numbern('susp')
606 || $self->ut_numbern('cancel')
607 || $self->ut_numbern('adjourn')
608 || $self->ut_numbern('resume')
609 || $self->ut_numbern('expire')
610 || $self->ut_numbern('dundate')
611 || $self->ut_enum('no_auto', [ '', 'Y' ])
612 || $self->ut_enum('waive_setup', [ '', 'Y' ])
613 || $self->ut_numbern('agent_pkgid')
614 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
615 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
617 return $error if $error;
619 return "A package with both start date (future start) and setup date (already started) will never bill"
620 if $self->start_date && $self->setup;
622 return "A future unsuspend date can only be set for a package with a suspend date"
623 if $self->resume and !$self->susp and !$self->adjourn;
625 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
627 if ( $self->dbdef_table->column('manual_flag') ) {
628 $self->manual_flag('') if $self->manual_flag eq ' ';
629 $self->manual_flag =~ /^([01]?)$/
630 or return "Illegal manual_flag ". $self->manual_flag;
631 $self->manual_flag($1);
644 my $error = $self->ut_numbern('pkgpart');
645 return $error if $error;
647 if ( $self->reg_code ) {
649 unless ( grep { $self->pkgpart == $_->pkgpart }
650 map { $_->reg_code_pkg }
651 qsearchs( 'reg_code', { 'code' => $self->reg_code,
652 'agentnum' => $self->cust_main->agentnum })
654 return "Unknown registration code";
657 } elsif ( $self->promo_code ) {
660 qsearchs('part_pkg', {
661 'pkgpart' => $self->pkgpart,
662 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
664 return 'Unknown promotional code' unless $promo_part_pkg;
668 unless ( $disable_agentcheck ) {
670 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
671 return "agent ". $agent->agentnum. ':'. $agent->agent.
672 " can't purchase pkgpart ". $self->pkgpart
673 unless $agent->pkgpart_hashref->{ $self->pkgpart }
674 || $agent->agentnum == $self->part_pkg->agentnum;
677 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
678 return $error if $error;
686 =item cancel [ OPTION => VALUE ... ]
688 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
689 in this package, then cancels the package itself (sets the cancel field to
692 Available options are:
696 =item quiet - can be set true to supress email cancellation notices.
698 =item time - can be set to cancel the package based on a specific future or historical date. Using time ensures that the remaining amount is calculated correctly. Note however that this is an immediate cancel and just changes the date. You are PROBABLY looking to expire the account instead of using this.
700 =item reason - 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.
702 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
704 =item nobill - can be set true to skip billing if it might otherwise be done.
706 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
707 not credit it. This must be set (by change()) when changing the package
708 to a different pkgpart or location, and probably shouldn't be in any other
709 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
714 If there is an error, returns the error, otherwise returns false.
719 my( $self, %options ) = @_;
722 my $conf = new FS::Conf;
724 warn "cust_pkg::cancel called with options".
725 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
728 local $SIG{HUP} = 'IGNORE';
729 local $SIG{INT} = 'IGNORE';
730 local $SIG{QUIT} = 'IGNORE';
731 local $SIG{TERM} = 'IGNORE';
732 local $SIG{TSTP} = 'IGNORE';
733 local $SIG{PIPE} = 'IGNORE';
735 my $oldAutoCommit = $FS::UID::AutoCommit;
736 local $FS::UID::AutoCommit = 0;
739 my $old = $self->select_for_update;
741 if ( $old->get('cancel') || $self->get('cancel') ) {
742 dbh->rollback if $oldAutoCommit;
743 return ""; # no error
746 my $date = $options{date} if $options{date}; # expire/cancel later
747 $date = '' if ($date && $date <= time); # complain instead?
749 #race condition: usage could be ongoing until unprovisioned
750 #resolved by performing a change package instead (which unprovisions) and
752 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
753 my $copy = $self->new({$self->hash});
755 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
756 warn "Error billing during cancel, custnum ".
757 #$self->cust_main->custnum. ": $error"
762 my $cancel_time = $options{'time'} || time;
764 if ( $options{'reason'} ) {
765 $error = $self->insert_reason( 'reason' => $options{'reason'},
766 'action' => $date ? 'expire' : 'cancel',
767 'date' => $date ? $date : $cancel_time,
768 'reason_otaker' => $options{'reason_otaker'},
771 dbh->rollback if $oldAutoCommit;
772 return "Error inserting cust_pkg_reason: $error";
776 my %svc_cancel_opt = ();
777 $svc_cancel_opt{'date'} = $date if $date;
778 foreach my $cust_svc (
781 sort { $a->[1] <=> $b->[1] }
782 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
783 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
785 my $part_svc = $cust_svc->part_svc;
786 next if ( defined($part_svc) and $part_svc->preserve );
787 my $error = $cust_svc->cancel( %svc_cancel_opt );
790 $dbh->rollback if $oldAutoCommit;
791 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
798 # Add a credit for remaining service
799 my $last_bill = $self->getfield('last_bill') || 0;
800 my $next_bill = $self->getfield('bill') || 0;
802 if ( exists($options{'unused_credit'}) ) {
803 $do_credit = $options{'unused_credit'};
806 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
809 and $last_bill > 0 # the package has been billed
810 and $next_bill > 0 # the package has a next bill date
811 and $next_bill >= $cancel_time # which is in the future
813 my $remaining_value = $self->calc_remain('time' => $cancel_time);
814 if ( $remaining_value > 0 ) {
815 my $error = $self->cust_main->credit(
817 'Credit for unused time on '. $self->part_pkg->pkg,
818 'reason_type' => $conf->config('cancel_credit_type'),
821 $dbh->rollback if $oldAutoCommit;
822 return "Error crediting customer \$$remaining_value for unused time".
823 " on ". $self->part_pkg->pkg. ": $error";
825 } #if $remaining_value
830 my %hash = $self->hash;
831 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
832 my $new = new FS::cust_pkg ( \%hash );
833 $error = $new->replace( $self, options => { $self->options } );
835 $dbh->rollback if $oldAutoCommit;
839 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
840 return '' if $date; #no errors
842 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
843 if ( !$options{'quiet'} &&
844 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
846 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
849 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
850 $error = $msg_template->send( 'cust_main' => $self->cust_main,
855 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
856 'to' => \@invoicing_list,
857 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
858 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
861 #should this do something on errors?
868 =item cancel_if_expired [ NOW_TIMESTAMP ]
870 Cancels this package if its expire date has been reached.
874 sub cancel_if_expired {
876 my $time = shift || time;
877 return '' unless $self->expire && $self->expire <= $time;
878 my $error = $self->cancel;
880 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
881 $self->custnum. ": $error";
888 Cancels any pending expiration (sets the expire field to null).
890 If there is an error, returns the error, otherwise returns false.
895 my( $self, %options ) = @_;
898 local $SIG{HUP} = 'IGNORE';
899 local $SIG{INT} = 'IGNORE';
900 local $SIG{QUIT} = 'IGNORE';
901 local $SIG{TERM} = 'IGNORE';
902 local $SIG{TSTP} = 'IGNORE';
903 local $SIG{PIPE} = 'IGNORE';
905 my $oldAutoCommit = $FS::UID::AutoCommit;
906 local $FS::UID::AutoCommit = 0;
909 my $old = $self->select_for_update;
911 my $pkgnum = $old->pkgnum;
912 if ( $old->get('cancel') || $self->get('cancel') ) {
913 dbh->rollback if $oldAutoCommit;
914 return "Can't unexpire cancelled package $pkgnum";
915 # or at least it's pointless
918 unless ( $old->get('expire') && $self->get('expire') ) {
919 dbh->rollback if $oldAutoCommit;
920 return ""; # no error
923 my %hash = $self->hash;
924 $hash{'expire'} = '';
925 my $new = new FS::cust_pkg ( \%hash );
926 $error = $new->replace( $self, options => { $self->options } );
928 $dbh->rollback if $oldAutoCommit;
932 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
938 =item suspend [ OPTION => VALUE ... ]
940 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
941 package, then suspends the package itself (sets the susp field to now).
943 Available options are:
947 =item reason - can be set to a cancellation reason (see L<FS:reason>),
948 either a reasonnum of an existing reason, or passing a hashref will create
949 a new reason. The hashref should have the following keys:
950 - typenum - Reason type (see L<FS::reason_type>
951 - reason - Text of the new reason.
953 =item date - can be set to a unix style timestamp to specify when to
956 =item time - can be set to override the current time, for calculation
957 of final invoices or unused-time credits
959 =item resume_date - can be set to a time when the package should be
960 unsuspended. This may be more convenient than calling C<unsuspend()>
965 If there is an error, returns the error, otherwise returns false.
970 my( $self, %options ) = @_;
973 local $SIG{HUP} = 'IGNORE';
974 local $SIG{INT} = 'IGNORE';
975 local $SIG{QUIT} = 'IGNORE';
976 local $SIG{TERM} = 'IGNORE';
977 local $SIG{TSTP} = 'IGNORE';
978 local $SIG{PIPE} = 'IGNORE';
980 my $oldAutoCommit = $FS::UID::AutoCommit;
981 local $FS::UID::AutoCommit = 0;
984 my $old = $self->select_for_update;
986 my $pkgnum = $old->pkgnum;
987 if ( $old->get('cancel') || $self->get('cancel') ) {
988 dbh->rollback if $oldAutoCommit;
989 return "Can't suspend cancelled package $pkgnum";
992 if ( $old->get('susp') || $self->get('susp') ) {
993 dbh->rollback if $oldAutoCommit;
994 return ""; # no error # complain on adjourn?
997 my $suspend_time = $options{'time'} || time;
999 my $date = $options{date} if $options{date}; # adjourn/suspend later
1000 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1002 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1003 dbh->rollback if $oldAutoCommit;
1004 return "Package $pkgnum expires before it would be suspended.";
1007 if ( $options{'reason'} ) {
1008 $error = $self->insert_reason( 'reason' => $options{'reason'},
1009 'action' => $date ? 'adjourn' : 'suspend',
1010 'date' => $date ? $date : $suspend_time,
1011 'reason_otaker' => $options{'reason_otaker'},
1014 dbh->rollback if $oldAutoCommit;
1015 return "Error inserting cust_pkg_reason: $error";
1019 my %hash = $self->hash;
1021 $hash{'adjourn'} = $date;
1023 $hash{'susp'} = $suspend_time;
1026 my $resume_date = $options{'resume_date'} || 0;
1027 if ( $resume_date > ($date || $suspend_time) ) {
1028 $hash{'resume'} = $resume_date;
1031 my $new = new FS::cust_pkg ( \%hash );
1032 $error = $new->replace( $self, options => { $self->options } );
1034 $dbh->rollback if $oldAutoCommit;
1042 foreach my $cust_svc (
1043 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1045 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1047 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1048 $dbh->rollback if $oldAutoCommit;
1049 return "Illegal svcdb value in part_svc!";
1052 require "FS/$svcdb.pm";
1054 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1056 $error = $svc->suspend;
1058 $dbh->rollback if $oldAutoCommit;
1061 my( $label, $value ) = $cust_svc->label;
1062 push @labels, "$label: $value";
1066 my $conf = new FS::Conf;
1067 if ( $conf->config('suspend_email_admin') ) {
1069 my $error = send_email(
1070 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1071 #invoice_from ??? well as good as any
1072 'to' => $conf->config('suspend_email_admin'),
1073 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1075 "This is an automatic message from your Freeside installation\n",
1076 "informing you that the following customer package has been suspended:\n",
1078 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1079 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1080 ( map { "Service : $_\n" } @labels ),
1085 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1093 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1098 =item unsuspend [ OPTION => VALUE ... ]
1100 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1101 package, then unsuspends the package itself (clears the susp field and the
1102 adjourn field if it is in the past).
1104 Available options are:
1110 Can be set to a date to unsuspend the package in the future (the 'resume'
1113 =item adjust_next_bill
1115 Can be set true to adjust the next bill date forward by
1116 the amount of time the account was inactive. This was set true by default
1117 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1118 explicitly requested. Price plans for which this makes sense (anniversary-date
1119 based than prorate or subscription) could have an option to enable this
1124 If there is an error, returns the error, otherwise returns false.
1129 my( $self, %opt ) = @_;
1132 local $SIG{HUP} = 'IGNORE';
1133 local $SIG{INT} = 'IGNORE';
1134 local $SIG{QUIT} = 'IGNORE';
1135 local $SIG{TERM} = 'IGNORE';
1136 local $SIG{TSTP} = 'IGNORE';
1137 local $SIG{PIPE} = 'IGNORE';
1139 my $oldAutoCommit = $FS::UID::AutoCommit;
1140 local $FS::UID::AutoCommit = 0;
1143 my $old = $self->select_for_update;
1145 my $pkgnum = $old->pkgnum;
1146 if ( $old->get('cancel') || $self->get('cancel') ) {
1147 $dbh->rollback if $oldAutoCommit;
1148 return "Can't unsuspend cancelled package $pkgnum";
1151 unless ( $old->get('susp') && $self->get('susp') ) {
1152 $dbh->rollback if $oldAutoCommit;
1153 return ""; # no error # complain instead?
1156 my $date = $opt{'date'};
1157 if ( $date and $date > time ) { # return an error if $date <= time?
1159 if ( $old->get('expire') && $old->get('expire') < $date ) {
1160 $dbh->rollback if $oldAutoCommit;
1161 return "Package $pkgnum expires before it would be unsuspended.";
1164 my $new = new FS::cust_pkg { $self->hash };
1165 $new->set('resume', $date);
1166 $error = $new->replace($self, options => $self->options);
1169 $dbh->rollback if $oldAutoCommit;
1173 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1179 foreach my $cust_svc (
1180 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1182 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1184 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1185 $dbh->rollback if $oldAutoCommit;
1186 return "Illegal svcdb value in part_svc!";
1189 require "FS/$svcdb.pm";
1191 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1193 $error = $svc->unsuspend;
1195 $dbh->rollback if $oldAutoCommit;
1202 my %hash = $self->hash;
1203 my $inactive = time - $hash{'susp'};
1205 my $conf = new FS::Conf;
1207 if ( $inactive > 0 &&
1208 ( $hash{'bill'} || $hash{'setup'} ) &&
1209 ( $opt{'adjust_next_bill'} ||
1210 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1211 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1214 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1219 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1220 $hash{'resume'} = '' if !$hash{'adjourn'};
1221 my $new = new FS::cust_pkg ( \%hash );
1222 $error = $new->replace( $self, options => { $self->options } );
1224 $dbh->rollback if $oldAutoCommit;
1228 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1235 Cancels any pending suspension (sets the adjourn field to null).
1237 If there is an error, returns the error, otherwise returns false.
1242 my( $self, %options ) = @_;
1245 local $SIG{HUP} = 'IGNORE';
1246 local $SIG{INT} = 'IGNORE';
1247 local $SIG{QUIT} = 'IGNORE';
1248 local $SIG{TERM} = 'IGNORE';
1249 local $SIG{TSTP} = 'IGNORE';
1250 local $SIG{PIPE} = 'IGNORE';
1252 my $oldAutoCommit = $FS::UID::AutoCommit;
1253 local $FS::UID::AutoCommit = 0;
1256 my $old = $self->select_for_update;
1258 my $pkgnum = $old->pkgnum;
1259 if ( $old->get('cancel') || $self->get('cancel') ) {
1260 dbh->rollback if $oldAutoCommit;
1261 return "Can't unadjourn cancelled package $pkgnum";
1262 # or at least it's pointless
1265 if ( $old->get('susp') || $self->get('susp') ) {
1266 dbh->rollback if $oldAutoCommit;
1267 return "Can't unadjourn suspended package $pkgnum";
1268 # perhaps this is arbitrary
1271 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1272 dbh->rollback if $oldAutoCommit;
1273 return ""; # no error
1276 my %hash = $self->hash;
1277 $hash{'adjourn'} = '';
1278 $hash{'resume'} = '';
1279 my $new = new FS::cust_pkg ( \%hash );
1280 $error = $new->replace( $self, options => { $self->options } );
1282 $dbh->rollback if $oldAutoCommit;
1286 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1293 =item change HASHREF | OPTION => VALUE ...
1295 Changes this package: cancels it and creates a new one, with a different
1296 pkgpart or locationnum or both. All services are transferred to the new
1297 package (no change will be made if this is not possible).
1299 Options may be passed as a list of key/value pairs or as a hash reference.
1306 New locationnum, to change the location for this package.
1310 New FS::cust_location object, to create a new location and assign it
1315 New pkgpart (see L<FS::part_pkg>).
1319 New refnum (see L<FS::part_referral>).
1323 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1324 susp, adjourn, cancel, expire, and contract_end) to the new package.
1328 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1329 (otherwise, what's the point?)
1331 Returns either the new FS::cust_pkg object or a scalar error.
1335 my $err_or_new_cust_pkg = $old_cust_pkg->change
1339 #some false laziness w/order
1342 my $opt = ref($_[0]) ? shift : { @_ };
1344 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1347 my $conf = new FS::Conf;
1349 # Transactionize this whole mess
1350 local $SIG{HUP} = 'IGNORE';
1351 local $SIG{INT} = 'IGNORE';
1352 local $SIG{QUIT} = 'IGNORE';
1353 local $SIG{TERM} = 'IGNORE';
1354 local $SIG{TSTP} = 'IGNORE';
1355 local $SIG{PIPE} = 'IGNORE';
1357 my $oldAutoCommit = $FS::UID::AutoCommit;
1358 local $FS::UID::AutoCommit = 0;
1367 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1369 #$hash{$_} = $self->$_() foreach qw( setup );
1371 $hash{'setup'} = $time if $self->setup;
1373 $hash{'change_date'} = $time;
1374 $hash{"change_$_"} = $self->$_()
1375 foreach qw( pkgnum pkgpart locationnum );
1377 if ( $opt->{'cust_location'} &&
1378 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1379 $error = $opt->{'cust_location'}->insert;
1381 $dbh->rollback if $oldAutoCommit;
1382 return "inserting cust_location (transaction rolled back): $error";
1384 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1387 my $unused_credit = 0;
1388 if ( $opt->{'keep_dates'} ) {
1389 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1390 resume start_date contract_end ) ) {
1391 $hash{$date} = $self->getfield($date);
1394 # Special case. If the pkgpart is changing, and the customer is
1395 # going to be credited for remaining time, don't keep setup, bill,
1396 # or last_bill dates, and DO pass the flag to cancel() to credit
1398 if ( $opt->{'pkgpart'}
1399 and $opt->{'pkgpart'} != $self->pkgpart
1400 and $self->part_pkg->option('unused_credit_change', 1) ) {
1402 $hash{$_} = '' foreach qw(setup bill last_bill);
1405 # allow $opt->{'locationnum'} = '' to specifically set it to null
1406 # (i.e. customer default location)
1407 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1409 # Create the new package.
1410 my $cust_pkg = new FS::cust_pkg {
1411 custnum => $self->custnum,
1412 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1413 refnum => ( $opt->{'refnum'} || $self->refnum ),
1414 locationnum => ( $opt->{'locationnum'} ),
1418 $error = $cust_pkg->insert( 'change' => 1 );
1420 $dbh->rollback if $oldAutoCommit;
1424 # Transfer services and cancel old package.
1426 $error = $self->transfer($cust_pkg);
1427 if ($error and $error == 0) {
1428 # $old_pkg->transfer failed.
1429 $dbh->rollback if $oldAutoCommit;
1433 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1434 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1435 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1436 if ($error and $error == 0) {
1437 # $old_pkg->transfer failed.
1438 $dbh->rollback if $oldAutoCommit;
1444 # Transfers were successful, but we still had services left on the old
1445 # package. We can't change the package under this circumstances, so abort.
1446 $dbh->rollback if $oldAutoCommit;
1447 return "Unable to transfer all services from package ". $self->pkgnum;
1450 #reset usage if changing pkgpart
1451 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1452 if ($self->pkgpart != $cust_pkg->pkgpart) {
1453 my $part_pkg = $cust_pkg->part_pkg;
1454 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1458 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1461 $dbh->rollback if $oldAutoCommit;
1462 return "Error setting usage values: $error";
1466 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1468 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1470 $dbh->rollback if $oldAutoCommit;
1474 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1476 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1478 $dbh->rollback if $oldAutoCommit;
1483 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1489 use Storable 'thaw';
1491 sub process_bulk_cust_pkg {
1493 my $param = thaw(decode_base64(shift));
1494 warn Dumper($param) if $DEBUG;
1496 my $old_part_pkg = qsearchs('part_pkg',
1497 { pkgpart => $param->{'old_pkgpart'} });
1498 my $new_part_pkg = qsearchs('part_pkg',
1499 { pkgpart => $param->{'new_pkgpart'} });
1500 die "Must select a new package type\n" unless $new_part_pkg;
1501 #my $keep_dates = $param->{'keep_dates'} || 0;
1502 my $keep_dates = 1; # there is no good reason to turn this off
1504 local $SIG{HUP} = 'IGNORE';
1505 local $SIG{INT} = 'IGNORE';
1506 local $SIG{QUIT} = 'IGNORE';
1507 local $SIG{TERM} = 'IGNORE';
1508 local $SIG{TSTP} = 'IGNORE';
1509 local $SIG{PIPE} = 'IGNORE';
1511 my $oldAutoCommit = $FS::UID::AutoCommit;
1512 local $FS::UID::AutoCommit = 0;
1515 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1518 foreach my $old_cust_pkg ( @cust_pkgs ) {
1520 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1521 if ( $old_cust_pkg->getfield('cancel') ) {
1522 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1523 $old_cust_pkg->pkgnum."\n"
1527 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1529 my $error = $old_cust_pkg->change(
1530 'pkgpart' => $param->{'new_pkgpart'},
1531 'keep_dates' => $keep_dates
1533 if ( !ref($error) ) { # change returns the cust_pkg on success
1535 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1538 $dbh->commit if $oldAutoCommit;
1544 Returns the last bill date, or if there is no last bill date, the setup date.
1545 Useful for billing metered services.
1551 return $self->setfield('last_bill', $_[0]) if @_;
1552 return $self->getfield('last_bill') if $self->getfield('last_bill');
1553 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1554 'edate' => $self->bill, } );
1555 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1558 =item last_cust_pkg_reason ACTION
1560 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1561 Returns false if there is no reason or the package is not currenly ACTION'd
1562 ACTION is one of adjourn, susp, cancel, or expire.
1566 sub last_cust_pkg_reason {
1567 my ( $self, $action ) = ( shift, shift );
1568 my $date = $self->get($action);
1570 'table' => 'cust_pkg_reason',
1571 'hashref' => { 'pkgnum' => $self->pkgnum,
1572 'action' => substr(uc($action), 0, 1),
1575 'order_by' => 'ORDER BY num DESC LIMIT 1',
1579 =item last_reason ACTION
1581 Returns the most recent ACTION FS::reason associated with the package.
1582 Returns false if there is no reason or the package is not currenly ACTION'd
1583 ACTION is one of adjourn, susp, cancel, or expire.
1588 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1589 $cust_pkg_reason->reason
1590 if $cust_pkg_reason;
1595 Returns the definition for this billing item, as an FS::part_pkg object (see
1602 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1603 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1604 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1609 Returns the cancelled package this package was changed from, if any.
1615 return '' unless $self->change_pkgnum;
1616 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1621 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1628 $self->part_pkg->calc_setup($self, @_);
1633 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1640 $self->part_pkg->calc_recur($self, @_);
1645 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1652 $self->part_pkg->base_recur($self, @_);
1657 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1664 $self->part_pkg->calc_remain($self, @_);
1669 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1676 $self->part_pkg->calc_cancel($self, @_);
1681 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1687 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1690 =item cust_pkg_detail [ DETAILTYPE ]
1692 Returns any customer package details for this package (see
1693 L<FS::cust_pkg_detail>).
1695 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1699 sub cust_pkg_detail {
1701 my %hash = ( 'pkgnum' => $self->pkgnum );
1702 $hash{detailtype} = shift if @_;
1704 'table' => 'cust_pkg_detail',
1705 'hashref' => \%hash,
1706 'order_by' => 'ORDER BY weight, pkgdetailnum',
1710 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1712 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1714 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1716 If there is an error, returns the error, otherwise returns false.
1720 sub set_cust_pkg_detail {
1721 my( $self, $detailtype, @details ) = @_;
1723 local $SIG{HUP} = 'IGNORE';
1724 local $SIG{INT} = 'IGNORE';
1725 local $SIG{QUIT} = 'IGNORE';
1726 local $SIG{TERM} = 'IGNORE';
1727 local $SIG{TSTP} = 'IGNORE';
1728 local $SIG{PIPE} = 'IGNORE';
1730 my $oldAutoCommit = $FS::UID::AutoCommit;
1731 local $FS::UID::AutoCommit = 0;
1734 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1735 my $error = $current->delete;
1737 $dbh->rollback if $oldAutoCommit;
1738 return "error removing old detail: $error";
1742 foreach my $detail ( @details ) {
1743 my $cust_pkg_detail = new FS::cust_pkg_detail {
1744 'pkgnum' => $self->pkgnum,
1745 'detailtype' => $detailtype,
1746 'detail' => $detail,
1748 my $error = $cust_pkg_detail->insert;
1750 $dbh->rollback if $oldAutoCommit;
1751 return "error adding new detail: $error";
1756 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1763 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1767 #false laziness w/cust_bill.pm
1771 'table' => 'cust_event',
1772 'addl_from' => 'JOIN part_event USING ( eventpart )',
1773 'hashref' => { 'tablenum' => $self->pkgnum },
1774 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1778 =item num_cust_event
1780 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1784 #false laziness w/cust_bill.pm
1785 sub num_cust_event {
1788 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1789 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1790 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1791 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1792 $sth->fetchrow_arrayref->[0];
1795 =item cust_svc [ SVCPART ] (old, deprecated usage)
1797 =item cust_svc [ OPTION => VALUE ... ] (current usage)
1799 Returns the services for this package, as FS::cust_svc objects (see
1800 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
1801 spcififed, returns only the matching services.
1808 return () unless $self->num_cust_svc(@_);
1811 if ( @_ && $_[0] =~ /^\d+/ ) {
1812 $opt{svcpart} = shift;
1813 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
1820 'table' => 'cust_svc',
1821 'hashref' => { 'pkgnum' => $self->pkgnum },
1823 if ( $opt{svcpart} ) {
1824 $search{hashref}->{svcpart} = $opt{'svcpart'};
1826 if ( $opt{'svcdb'} ) {
1827 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
1828 $search{hashref}->{svcdb} = $opt{'svcdb'};
1831 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1833 #if ( $self->{'_svcnum'} ) {
1834 # values %{ $self->{'_svcnum'}->cache };
1836 $self->_sort_cust_svc( [ qsearch(\%search) ] );
1841 =item overlimit [ SVCPART ]
1843 Returns the services for this package which have exceeded their
1844 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1845 is specified, return only the matching services.
1851 return () unless $self->num_cust_svc(@_);
1852 grep { $_->overlimit } $self->cust_svc(@_);
1855 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1857 Returns historical services for this package created before END TIMESTAMP and
1858 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1859 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1860 I<pkg_svc.hidden> flag will be omitted.
1866 warn "$me _h_cust_svc called on $self\n"
1869 my ($end, $start, $mode) = @_;
1870 my @cust_svc = $self->_sort_cust_svc(
1871 [ qsearch( 'h_cust_svc',
1872 { 'pkgnum' => $self->pkgnum, },
1873 FS::h_cust_svc->sql_h_search(@_),
1876 if ( defined($mode) && $mode eq 'I' ) {
1877 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1878 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1884 sub _sort_cust_svc {
1885 my( $self, $arrayref ) = @_;
1888 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1893 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1894 'svcpart' => $_->svcpart } );
1896 $pkg_svc ? $pkg_svc->primary_svc : '',
1897 $pkg_svc ? $pkg_svc->quantity : 0,
1904 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
1906 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
1908 Returns the number of services for this package. Available options are svcpart
1909 and svcdb. If either is spcififed, returns only the matching services.
1916 return $self->{'_num_cust_svc'}
1918 && exists($self->{'_num_cust_svc'})
1919 && $self->{'_num_cust_svc'} =~ /\d/;
1921 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1925 if ( @_ && $_[0] =~ /^\d+/ ) {
1926 $opt{svcpart} = shift;
1927 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
1933 my $select = 'SELECT COUNT(*) FROM cust_svc ';
1934 my $where = ' WHERE pkgnum = ? ';
1935 my @param = ($self->pkgnum);
1937 if ( $opt{'svcpart'} ) {
1938 $where .= ' AND svcpart = ? ';
1939 push @param, $opt{'svcpart'};
1941 if ( $opt{'svcdb'} ) {
1942 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
1943 $where .= ' AND svcdb = ? ';
1944 push @param, $opt{'svcdb'};
1947 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
1948 $sth->execute(@param) or die $sth->errstr;
1949 $sth->fetchrow_arrayref->[0];
1952 =item available_part_svc
1954 Returns a list of FS::part_svc objects representing services included in this
1955 package but not yet provisioned. Each FS::part_svc object also has an extra
1956 field, I<num_avail>, which specifies the number of available services.
1960 sub available_part_svc {
1962 grep { $_->num_avail > 0 }
1964 my $part_svc = $_->part_svc;
1965 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1966 $_->quantity - $self->num_cust_svc($_->svcpart);
1968 # more evil encapsulation breakage
1969 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1970 my @exports = $part_svc->part_export_did;
1971 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1976 $self->part_pkg->pkg_svc;
1979 =item part_svc [ OPTION => VALUE ... ]
1981 Returns a list of FS::part_svc objects representing provisioned and available
1982 services included in this package. Each FS::part_svc object also has the
1983 following extra fields:
1987 =item num_cust_svc (count)
1989 =item num_avail (quantity - count)
1991 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1995 Accepts one option: summarize_size. If specified and non-zero, will omit the
1996 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2002 #label -> ($cust_svc->label)[1]
2008 #XXX some sort of sort order besides numeric by svcpart...
2009 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2011 my $part_svc = $pkg_svc->part_svc;
2012 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2013 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2014 $part_svc->{'Hash'}{'num_avail'} =
2015 max( 0, $pkg_svc->quantity - $num_cust_svc );
2016 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2017 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2018 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2019 && $num_cust_svc >= $opt{summarize_size};
2020 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2022 } $self->part_pkg->pkg_svc;
2025 push @part_svc, map {
2027 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2028 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2029 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2030 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2031 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2033 } $self->extra_part_svc;
2039 =item extra_part_svc
2041 Returns a list of FS::part_svc objects corresponding to services in this
2042 package which are still provisioned but not (any longer) available in the
2047 sub extra_part_svc {
2050 my $pkgnum = $self->pkgnum;
2051 #my $pkgpart = $self->pkgpart;
2054 # 'table' => 'part_svc',
2057 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2058 # WHERE pkg_svc.svcpart = part_svc.svcpart
2059 # AND pkg_svc.pkgpart = ?
2062 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2063 # LEFT JOIN cust_pkg USING ( pkgnum )
2064 # WHERE cust_svc.svcpart = part_svc.svcpart
2067 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2070 #seems to benchmark slightly faster... (or did?)
2072 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2073 my $pkgparts = join(',', @pkgparts);
2076 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2077 #MySQL doesn't grok DISINCT ON
2078 'select' => 'DISTINCT part_svc.*',
2079 'table' => 'part_svc',
2081 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2082 AND pkg_svc.pkgpart IN ($pkgparts)
2085 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2086 LEFT JOIN cust_pkg USING ( pkgnum )
2089 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2090 'extra_param' => [ [$self->pkgnum=>'int'] ],
2096 Returns a short status string for this package, currently:
2100 =item not yet billed
2102 =item one-time charge
2117 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2119 return 'cancelled' if $self->get('cancel');
2120 return 'suspended' if $self->susp;
2121 return 'not yet billed' unless $self->setup;
2122 return 'one-time charge' if $freq =~ /^(0|$)/;
2126 =item ucfirst_status
2128 Returns the status with the first character capitalized.
2132 sub ucfirst_status {
2133 ucfirst(shift->status);
2138 Class method that returns the list of possible status strings for packages
2139 (see L<the status method|/status>). For example:
2141 @statuses = FS::cust_pkg->statuses();
2145 tie my %statuscolor, 'Tie::IxHash',
2146 'not yet billed' => '009999', #teal? cyan?
2147 'one-time charge' => '000000',
2148 'active' => '00CC00',
2149 'suspended' => 'FF9900',
2150 'cancelled' => 'FF0000',
2154 my $self = shift; #could be class...
2155 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2156 # # mayble split btw one-time vs. recur
2162 Returns a hex triplet color string for this package's status.
2168 $statuscolor{$self->status};
2173 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2174 "pkg-comment" depending on user preference).
2180 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2181 $label = $self->pkgnum. ": $label"
2182 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2186 =item pkg_label_long
2188 Returns a long label for this package, adding the primary service's label to
2193 sub pkg_label_long {
2195 my $label = $self->pkg_label;
2196 my $cust_svc = $self->primary_cust_svc;
2197 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2201 =item primary_cust_svc
2203 Returns a primary service (as FS::cust_svc object) if one can be identified.
2207 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2209 sub primary_cust_svc {
2212 my @cust_svc = $self->cust_svc;
2214 return '' unless @cust_svc; #no serivces - irrelevant then
2216 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2218 # primary service as specified in the package definition
2219 # or exactly one service definition with quantity one
2220 my $svcpart = $self->part_pkg->svcpart;
2221 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2222 return $cust_svc[0] if scalar(@cust_svc) == 1;
2224 #couldn't identify one thing..
2230 Returns a list of lists, calling the label method for all services
2231 (see L<FS::cust_svc>) of this billing item.
2237 map { [ $_->label ] } $self->cust_svc;
2240 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2242 Like the labels method, but returns historical information on services that
2243 were active as of END_TIMESTAMP and (optionally) not cancelled before
2244 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2245 I<pkg_svc.hidden> flag will be omitted.
2247 Returns a list of lists, calling the label method for all (historical) services
2248 (see L<FS::h_cust_svc>) of this billing item.
2254 warn "$me _h_labels called on $self\n"
2256 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2261 Like labels, except returns a simple flat list, and shortens long
2262 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2263 identical services to one line that lists the service label and the number of
2264 individual services rather than individual items.
2269 shift->_labels_short( 'labels', @_ );
2272 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2274 Like h_labels, except returns a simple flat list, and shortens long
2275 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2276 identical services to one line that lists the service label and the number of
2277 individual services rather than individual items.
2281 sub h_labels_short {
2282 shift->_labels_short( 'h_labels', @_ );
2286 my( $self, $method ) = ( shift, shift );
2288 warn "$me _labels_short called on $self with $method method\n"
2291 my $conf = new FS::Conf;
2292 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2294 warn "$me _labels_short populating \%labels\n"
2298 #tie %labels, 'Tie::IxHash';
2299 push @{ $labels{$_->[0]} }, $_->[1]
2300 foreach $self->$method(@_);
2302 warn "$me _labels_short populating \@labels\n"
2306 foreach my $label ( keys %labels ) {
2308 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2309 my $num = scalar(@values);
2310 warn "$me _labels_short $num items for $label\n"
2313 if ( $num > $max_same_services ) {
2314 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2316 push @labels, "$label ($num)";
2318 if ( $conf->exists('cust_bill-consolidate_services') ) {
2319 warn "$me _labels_short consolidating services\n"
2321 # push @labels, "$label: ". join(', ', @values);
2323 my $detail = "$label: ";
2324 $detail .= shift(@values). ', '
2326 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2328 push @labels, $detail;
2330 warn "$me _labels_short done consolidating services\n"
2333 warn "$me _labels_short adding service data\n"
2335 push @labels, map { "$label: $_" } @values;
2346 Returns the parent customer object (see L<FS::cust_main>).
2352 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2355 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2359 Returns the location object, if any (see L<FS::cust_location>).
2361 =item cust_location_or_main
2363 If this package is associated with a location, returns the locaiton (see
2364 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2366 =item location_label [ OPTION => VALUE ... ]
2368 Returns the label of the location object (see L<FS::cust_location>).
2372 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2374 =item seconds_since TIMESTAMP
2376 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2377 package have been online since TIMESTAMP, according to the session monitor.
2379 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2380 L<Time::Local> and L<Date::Parse> for conversion functions.
2385 my($self, $since) = @_;
2388 foreach my $cust_svc (
2389 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2391 $seconds += $cust_svc->seconds_since($since);
2398 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2400 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2401 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2404 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2405 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2411 sub seconds_since_sqlradacct {
2412 my($self, $start, $end) = @_;
2416 foreach my $cust_svc (
2418 my $part_svc = $_->part_svc;
2419 $part_svc->svcdb eq 'svc_acct'
2420 && scalar($part_svc->part_export('sqlradius'));
2423 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2430 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2432 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2433 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2437 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2438 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2443 sub attribute_since_sqlradacct {
2444 my($self, $start, $end, $attrib) = @_;
2448 foreach my $cust_svc (
2450 my $part_svc = $_->part_svc;
2451 $part_svc->svcdb eq 'svc_acct'
2452 && scalar($part_svc->part_export('sqlradius'));
2455 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2467 my( $self, $value ) = @_;
2468 if ( defined($value) ) {
2469 $self->setfield('quantity', $value);
2471 $self->getfield('quantity') || 1;
2474 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2476 Transfers as many services as possible from this package to another package.
2478 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2479 object. The destination package must already exist.
2481 Services are moved only if the destination allows services with the correct
2482 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2483 this option with caution! No provision is made for export differences
2484 between the old and new service definitions. Probably only should be used
2485 when your exports for all service definitions of a given svcdb are identical.
2486 (attempt a transfer without it first, to move all possible svcpart-matching
2489 Any services that can't be moved remain in the original package.
2491 Returns an error, if there is one; otherwise, returns the number of services
2492 that couldn't be moved.
2497 my ($self, $dest_pkgnum, %opt) = @_;
2503 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2504 $dest = $dest_pkgnum;
2505 $dest_pkgnum = $dest->pkgnum;
2507 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2510 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2512 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2513 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2516 foreach my $cust_svc ($dest->cust_svc) {
2517 $target{$cust_svc->svcpart}--;
2520 my %svcpart2svcparts = ();
2521 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2522 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2523 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2524 next if exists $svcpart2svcparts{$svcpart};
2525 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2526 $svcpart2svcparts{$svcpart} = [
2528 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2530 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2531 'svcpart' => $_ } );
2533 $pkg_svc ? $pkg_svc->primary_svc : '',
2534 $pkg_svc ? $pkg_svc->quantity : 0,
2538 grep { $_ != $svcpart }
2540 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2542 warn "alternates for svcpart $svcpart: ".
2543 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2548 foreach my $cust_svc ($self->cust_svc) {
2549 if($target{$cust_svc->svcpart} > 0) {
2550 $target{$cust_svc->svcpart}--;
2551 my $new = new FS::cust_svc { $cust_svc->hash };
2552 $new->pkgnum($dest_pkgnum);
2553 my $error = $new->replace($cust_svc);
2554 return $error if $error;
2555 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2557 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2558 warn "alternates to consider: ".
2559 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2561 my @alternate = grep {
2562 warn "considering alternate svcpart $_: ".
2563 "$target{$_} available in new package\n"
2566 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2568 warn "alternate(s) found\n" if $DEBUG;
2569 my $change_svcpart = $alternate[0];
2570 $target{$change_svcpart}--;
2571 my $new = new FS::cust_svc { $cust_svc->hash };
2572 $new->svcpart($change_svcpart);
2573 $new->pkgnum($dest_pkgnum);
2574 my $error = $new->replace($cust_svc);
2575 return $error if $error;
2588 This method is deprecated. See the I<depend_jobnum> option to the insert and
2589 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2596 local $SIG{HUP} = 'IGNORE';
2597 local $SIG{INT} = 'IGNORE';
2598 local $SIG{QUIT} = 'IGNORE';
2599 local $SIG{TERM} = 'IGNORE';
2600 local $SIG{TSTP} = 'IGNORE';
2601 local $SIG{PIPE} = 'IGNORE';
2603 my $oldAutoCommit = $FS::UID::AutoCommit;
2604 local $FS::UID::AutoCommit = 0;
2607 foreach my $cust_svc ( $self->cust_svc ) {
2608 #false laziness w/svc_Common::insert
2609 my $svc_x = $cust_svc->svc_x;
2610 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2611 my $error = $part_export->export_insert($svc_x);
2613 $dbh->rollback if $oldAutoCommit;
2619 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2626 Associates this package with a (suspension or cancellation) reason (see
2627 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2630 Available options are:
2636 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.
2640 the access_user (see L<FS::access_user>) providing the reason
2648 the action (cancel, susp, adjourn, expire) associated with the reason
2652 If there is an error, returns the error, otherwise returns false.
2657 my ($self, %options) = @_;
2659 my $otaker = $options{reason_otaker} ||
2660 $FS::CurrentUser::CurrentUser->username;
2663 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2667 } elsif ( ref($options{'reason'}) ) {
2669 return 'Enter a new reason (or select an existing one)'
2670 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2672 my $reason = new FS::reason({
2673 'reason_type' => $options{'reason'}->{'typenum'},
2674 'reason' => $options{'reason'}->{'reason'},
2676 my $error = $reason->insert;
2677 return $error if $error;
2679 $reasonnum = $reason->reasonnum;
2682 return "Unparsable reason: ". $options{'reason'};
2685 my $cust_pkg_reason =
2686 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2687 'reasonnum' => $reasonnum,
2688 'otaker' => $otaker,
2689 'action' => substr(uc($options{'action'}),0,1),
2690 'date' => $options{'date'}
2695 $cust_pkg_reason->insert;
2698 =item insert_discount
2700 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2701 inserting a new discount on the fly (see L<FS::discount>).
2703 Available options are:
2711 If there is an error, returns the error, otherwise returns false.
2715 sub insert_discount {
2716 #my ($self, %options) = @_;
2719 my $cust_pkg_discount = new FS::cust_pkg_discount {
2720 'pkgnum' => $self->pkgnum,
2721 'discountnum' => $self->discountnum,
2723 'end_date' => '', #XXX
2724 #for the create a new discount case
2725 '_type' => $self->discountnum__type,
2726 'amount' => $self->discountnum_amount,
2727 'percent' => $self->discountnum_percent,
2728 'months' => $self->discountnum_months,
2729 'setup' => $self->discountnum_setup,
2730 #'disabled' => $self->discountnum_disabled,
2733 $cust_pkg_discount->insert;
2736 =item set_usage USAGE_VALUE_HASHREF
2738 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2739 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2740 upbytes, downbytes, and totalbytes are appropriate keys.
2742 All svc_accts which are part of this package have their values reset.
2747 my ($self, $valueref, %opt) = @_;
2749 #only svc_acct can set_usage for now
2750 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
2751 my $svc_x = $cust_svc->svc_x;
2752 $svc_x->set_usage($valueref, %opt)
2753 if $svc_x->can("set_usage");
2757 =item recharge USAGE_VALUE_HASHREF
2759 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2760 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2761 upbytes, downbytes, and totalbytes are appropriate keys.
2763 All svc_accts which are part of this package have their values incremented.
2768 my ($self, $valueref) = @_;
2770 #only svc_acct can set_usage for now
2771 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
2772 my $svc_x = $cust_svc->svc_x;
2773 $svc_x->recharge($valueref)
2774 if $svc_x->can("recharge");
2778 =item cust_pkg_discount
2782 sub cust_pkg_discount {
2784 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2787 =item cust_pkg_discount_active
2791 sub cust_pkg_discount_active {
2793 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2798 =head1 CLASS METHODS
2804 Returns an SQL expression identifying recurring packages.
2808 sub recurring_sql { "
2809 '0' != ( select freq from part_pkg
2810 where cust_pkg.pkgpart = part_pkg.pkgpart )
2815 Returns an SQL expression identifying one-time packages.
2820 '0' = ( select freq from part_pkg
2821 where cust_pkg.pkgpart = part_pkg.pkgpart )
2826 Returns an SQL expression identifying ordered packages (recurring packages not
2832 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2837 Returns an SQL expression identifying active packages.
2842 $_[0]->recurring_sql. "
2843 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2844 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2845 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2848 =item not_yet_billed_sql
2850 Returns an SQL expression identifying packages which have not yet been billed.
2854 sub not_yet_billed_sql { "
2855 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2856 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2857 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2862 Returns an SQL expression identifying inactive packages (one-time packages
2863 that are otherwise unsuspended/uncancelled).
2867 sub inactive_sql { "
2868 ". $_[0]->onetime_sql(). "
2869 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2870 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2871 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2877 Returns an SQL expression identifying suspended packages.
2881 sub suspended_sql { susp_sql(@_); }
2883 #$_[0]->recurring_sql(). ' AND '.
2885 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2886 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2893 Returns an SQL exprression identifying cancelled packages.
2897 sub cancelled_sql { cancel_sql(@_); }
2899 #$_[0]->recurring_sql(). ' AND '.
2900 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2905 Returns an SQL expression to give the package status as a string.
2911 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2912 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2913 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2914 WHEN ".onetime_sql()." THEN 'one-time charge'
2919 =item search HASHREF
2923 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2924 Valid parameters are
2932 active, inactive, suspended, cancel (or cancelled)
2936 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2940 boolean selects custom packages
2946 pkgpart or arrayref or hashref of pkgparts
2950 arrayref of beginning and ending epoch date
2954 arrayref of beginning and ending epoch date
2958 arrayref of beginning and ending epoch date
2962 arrayref of beginning and ending epoch date
2966 arrayref of beginning and ending epoch date
2970 arrayref of beginning and ending epoch date
2974 arrayref of beginning and ending epoch date
2978 pkgnum or APKG_pkgnum
2982 a value suited to passing to FS::UI::Web::cust_header
2986 specifies the user for agent virtualization
2990 boolean selects packages containing fcc form 477 telco lines
2997 my ($class, $params) = @_;
3004 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3006 "cust_main.agentnum = $1";
3013 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3015 "cust_pkg.custnum = $1";
3022 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3024 "cust_pkg.pkgbatch = '$1'";
3031 if ( $params->{'magic'} eq 'active'
3032 || $params->{'status'} eq 'active' ) {
3034 push @where, FS::cust_pkg->active_sql();
3036 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3037 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3039 push @where, FS::cust_pkg->not_yet_billed_sql();
3041 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3042 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3044 push @where, FS::cust_pkg->inactive_sql();
3046 } elsif ( $params->{'magic'} eq 'suspended'
3047 || $params->{'status'} eq 'suspended' ) {
3049 push @where, FS::cust_pkg->suspended_sql();
3051 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3052 || $params->{'status'} =~ /^cancell?ed$/ ) {
3054 push @where, FS::cust_pkg->cancelled_sql();
3059 # parse package class
3062 if ( exists($params->{'classnum'}) ) {
3065 if ( ref($params->{'classnum'}) ) {
3067 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3068 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3069 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3070 @classnum = @{ $params->{'classnum'} };
3072 die 'unhandled classnum ref '. $params->{'classnum'};
3076 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3083 my @nums = grep $_, @classnum;
3084 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3085 my $null = scalar( grep { $_ eq '' } @classnum );
3086 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3088 if ( scalar(@c_where) == 1 ) {
3089 push @where, @c_where;
3090 } elsif ( @c_where ) {
3091 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3100 # parse package report options
3103 my @report_option = ();
3104 if ( exists($params->{'report_option'}) ) {
3105 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3106 @report_option = @{ $params->{'report_option'} };
3107 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3108 @report_option = split(',', $1);
3113 if (@report_option) {
3114 # this will result in the empty set for the dangling comma case as it should
3116 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3117 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3118 AND optionname = 'report_option_$_'
3119 AND optionvalue = '1' )"
3123 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3125 my @report_option_any = ();
3126 if ( ref($params->{$any}) eq 'ARRAY' ) {
3127 @report_option_any = @{ $params->{$any} };
3128 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3129 @report_option_any = split(',', $1);
3132 if (@report_option_any) {
3133 # this will result in the empty set for the dangling comma case as it should
3134 push @where, ' ( '. join(' OR ',
3135 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3136 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3137 AND optionname = 'report_option_$_'
3138 AND optionvalue = '1' )"
3139 } @report_option_any
3149 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3155 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3156 if $params->{fcc_line};
3162 if ( exists($params->{'censustract'}) ) {
3163 $params->{'censustract'} =~ /^([.\d]*)$/;
3164 my $censustract = "cust_main.censustract = '$1'";
3165 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3166 push @where, "( $censustract )";
3170 # parse censustract2
3172 if ( exists($params->{'censustract2'})
3173 && $params->{'censustract2'} =~ /^(\d*)$/
3177 push @where, "cust_main.censustract LIKE '$1%'";
3180 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3188 if ( ref($params->{'pkgpart'}) ) {
3191 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3192 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3193 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3194 @pkgpart = @{ $params->{'pkgpart'} };
3196 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3199 @pkgpart = grep /^(\d+)$/, @pkgpart;
3201 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3203 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3204 push @where, "pkgpart = $1";
3213 #false laziness w/report_cust_pkg.html
3216 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3217 'active' => { 'susp'=>1, 'cancel'=>1 },
3218 'suspended' => { 'cancel' => 1 },
3223 if( exists($params->{'active'} ) ) {
3224 # This overrides all the other date-related fields
3225 my($beginning, $ending) = @{$params->{'active'}};
3227 "cust_pkg.setup IS NOT NULL",
3228 "cust_pkg.setup <= $ending",
3229 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3230 "NOT (".FS::cust_pkg->onetime_sql . ")";
3233 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3235 next unless exists($params->{$field});
3237 my($beginning, $ending) = @{$params->{$field}};
3239 next if $beginning == 0 && $ending == 4294967295;
3242 "cust_pkg.$field IS NOT NULL",
3243 "cust_pkg.$field >= $beginning",
3244 "cust_pkg.$field <= $ending";
3246 $orderby ||= "ORDER BY cust_pkg.$field";
3251 $orderby ||= 'ORDER BY bill';
3254 # parse magic, legacy, etc.
3257 if ( $params->{'magic'} &&
3258 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3261 $orderby = 'ORDER BY pkgnum';
3263 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3264 push @where, "pkgpart = $1";
3267 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3269 $orderby = 'ORDER BY pkgnum';
3271 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3273 $orderby = 'ORDER BY pkgnum';
3276 SELECT count(*) FROM pkg_svc
3277 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3278 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3279 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3280 AND cust_svc.svcpart = pkg_svc.svcpart
3287 # setup queries, links, subs, etc. for the search
3290 # here is the agent virtualization
3291 if ($params->{CurrentUser}) {
3293 qsearchs('access_user', { username => $params->{CurrentUser} });
3296 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3301 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3304 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3306 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3307 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3308 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3310 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3313 'table' => 'cust_pkg',
3315 'select' => join(', ',
3317 ( map "part_pkg.$_", qw( pkg freq ) ),
3318 'pkg_class.classname',
3319 'cust_main.custnum AS cust_main_custnum',
3320 FS::UI::Web::cust_sql_fields(
3321 $params->{'cust_fields'}
3324 'extra_sql' => $extra_sql,
3325 'order_by' => $orderby,
3326 'addl_from' => $addl_from,
3327 'count_query' => $count_query,
3334 Returns a list of two package counts. The first is a count of packages
3335 based on the supplied criteria and the second is the count of residential
3336 packages with those same criteria. Criteria are specified as in the search
3342 my ($class, $params) = @_;
3344 my $sql_query = $class->search( $params );
3346 my $count_sql = delete($sql_query->{'count_query'});
3347 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3348 or die "couldn't parse count_sql";
3350 my $count_sth = dbh->prepare($count_sql)
3351 or die "Error preparing $count_sql: ". dbh->errstr;
3353 or die "Error executing $count_sql: ". $count_sth->errstr;
3354 my $count_arrayref = $count_sth->fetchrow_arrayref;
3356 return ( @$count_arrayref );
3363 Returns a list: the first item is an SQL fragment identifying matching
3364 packages/customers via location (taking into account shipping and package
3365 address taxation, if enabled), and subsequent items are the parameters to
3366 substitute for the placeholders in that fragment.
3371 my($class, %opt) = @_;
3372 my $ornull = $opt{'ornull'};
3374 my $conf = new FS::Conf;
3376 # '?' placeholders in _location_sql_where
3377 my $x = $ornull ? 3 : 2;
3378 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3382 if ( $conf->exists('tax-ship_address') ) {
3385 ( ( ship_last IS NULL OR ship_last = '' )
3386 AND ". _location_sql_where('cust_main', '', $ornull ). "
3388 OR ( ship_last IS NOT NULL AND ship_last != ''
3389 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3392 # AND payby != 'COMP'
3394 @main_param = ( @bill_param, @bill_param );
3398 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3399 @main_param = @bill_param;
3405 if ( $conf->exists('tax-pkg_address') ) {
3407 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3410 ( cust_pkg.locationnum IS NULL AND $main_where )
3411 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3414 @param = ( @main_param, @bill_param );
3418 $where = $main_where;
3419 @param = @main_param;
3427 #subroutine, helper for location_sql
3428 sub _location_sql_where {
3430 my $prefix = @_ ? shift : '';
3431 my $ornull = @_ ? shift : '';
3433 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3435 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3437 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3438 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3439 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3441 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3443 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3444 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3445 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3446 AND $table.${prefix}country = ?
3451 my( $self, $what ) = @_;
3453 my $what_show_zero = $what. '_show_zero';
3454 length($self->$what_show_zero())
3455 ? ($self->$what_show_zero() eq 'Y')
3456 : $self->part_pkg->$what_show_zero();
3463 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3465 CUSTNUM is a customer (see L<FS::cust_main>)
3467 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3468 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3471 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3472 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3473 new billing items. An error is returned if this is not possible (see
3474 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3477 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3478 newly-created cust_pkg objects.
3480 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3481 and inserted. Multiple FS::pkg_referral records can be created by
3482 setting I<refnum> to an array reference of refnums or a hash reference with
3483 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3484 record will be created corresponding to cust_main.refnum.
3489 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3491 my $conf = new FS::Conf;
3493 # Transactionize this whole mess
3494 local $SIG{HUP} = 'IGNORE';
3495 local $SIG{INT} = 'IGNORE';
3496 local $SIG{QUIT} = 'IGNORE';
3497 local $SIG{TERM} = 'IGNORE';
3498 local $SIG{TSTP} = 'IGNORE';
3499 local $SIG{PIPE} = 'IGNORE';
3501 my $oldAutoCommit = $FS::UID::AutoCommit;
3502 local $FS::UID::AutoCommit = 0;
3506 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3507 # return "Customer not found: $custnum" unless $cust_main;
3509 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3512 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3515 my $change = scalar(@old_cust_pkg) != 0;
3518 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3520 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3521 " to pkgpart ". $pkgparts->[0]. "\n"
3524 my $err_or_cust_pkg =
3525 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3526 'refnum' => $refnum,
3529 unless (ref($err_or_cust_pkg)) {
3530 $dbh->rollback if $oldAutoCommit;
3531 return $err_or_cust_pkg;
3534 push @$return_cust_pkg, $err_or_cust_pkg;
3535 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3540 # Create the new packages.
3541 foreach my $pkgpart (@$pkgparts) {
3543 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3545 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3546 pkgpart => $pkgpart,
3550 $error = $cust_pkg->insert( 'change' => $change );
3552 $dbh->rollback if $oldAutoCommit;
3555 push @$return_cust_pkg, $cust_pkg;
3557 # $return_cust_pkg now contains refs to all of the newly
3560 # Transfer services and cancel old packages.
3561 foreach my $old_pkg (@old_cust_pkg) {
3563 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3566 foreach my $new_pkg (@$return_cust_pkg) {
3567 $error = $old_pkg->transfer($new_pkg);
3568 if ($error and $error == 0) {
3569 # $old_pkg->transfer failed.
3570 $dbh->rollback if $oldAutoCommit;
3575 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3576 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3577 foreach my $new_pkg (@$return_cust_pkg) {
3578 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3579 if ($error and $error == 0) {
3580 # $old_pkg->transfer failed.
3581 $dbh->rollback if $oldAutoCommit;
3588 # Transfers were successful, but we went through all of the
3589 # new packages and still had services left on the old package.
3590 # We can't cancel the package under the circumstances, so abort.
3591 $dbh->rollback if $oldAutoCommit;
3592 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3594 $error = $old_pkg->cancel( quiet=>1 );
3600 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3604 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3606 A bulk change method to change packages for multiple customers.
3608 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3609 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3612 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3613 replace. The services (see L<FS::cust_svc>) are moved to the
3614 new billing items. An error is returned if this is not possible (see
3617 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3618 newly-created cust_pkg objects.
3623 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3625 # Transactionize this whole mess
3626 local $SIG{HUP} = 'IGNORE';
3627 local $SIG{INT} = 'IGNORE';
3628 local $SIG{QUIT} = 'IGNORE';
3629 local $SIG{TERM} = 'IGNORE';
3630 local $SIG{TSTP} = 'IGNORE';
3631 local $SIG{PIPE} = 'IGNORE';
3633 my $oldAutoCommit = $FS::UID::AutoCommit;
3634 local $FS::UID::AutoCommit = 0;
3638 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3641 while(scalar(@old_cust_pkg)) {
3643 my $custnum = $old_cust_pkg[0]->custnum;
3644 my (@remove) = map { $_->pkgnum }
3645 grep { $_->custnum == $custnum } @old_cust_pkg;
3646 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3648 my $error = order $custnum, $pkgparts, \@remove, \@return;
3650 push @errors, $error
3652 push @$return_cust_pkg, @return;
3655 if (scalar(@errors)) {
3656 $dbh->rollback if $oldAutoCommit;
3657 return join(' / ', @errors);
3660 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3664 # Used by FS::Upgrade to migrate to a new database.
3665 sub _upgrade_data { # class method
3666 my ($class, %opts) = @_;
3667 $class->_upgrade_otaker(%opts);
3669 # RT#10139, bug resulting in contract_end being set when it shouldn't
3670 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3671 # RT#10830, bad calculation of prorate date near end of year
3672 # the date range for bill is December 2009, and we move it forward
3673 # one year if it's before the previous bill date (which it should
3675 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3676 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3677 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3678 # RT6628, add order_date to cust_pkg
3679 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3680 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3681 history_action = \'insert\') where order_date is null',
3683 foreach my $sql (@statements) {
3684 my $sth = dbh->prepare($sql);
3685 $sth->execute or die $sth->errstr;
3693 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3695 In sub order, the @pkgparts array (passed by reference) is clobbered.
3697 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3698 method to pass dates to the recur_prog expression, it should do so.
3700 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3701 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3702 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3703 configuration values. Probably need a subroutine which decides what to do
3704 based on whether or not we've fetched the user yet, rather than a hash. See
3705 FS::UID and the TODO.
3707 Now that things are transactional should the check in the insert method be
3712 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3713 L<FS::pkg_svc>, schema.html from the base documentation