4 use vars qw(@ISA $disable_agentcheck $DEBUG);
5 use Scalar::Util qw( blessed );
6 use List::Util qw(max);
8 use FS::UID qw( getotaker dbh );
9 use FS::Misc qw( send_email );
10 use FS::Record qw( qsearch qsearchs );
12 use FS::cust_main_Mixin;
16 use FS::cust_location;
18 use FS::cust_bill_pkg;
19 use FS::cust_pkg_detail;
24 use FS::cust_pkg_reason;
28 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
30 # because they load configuration by setting FS::UID::callback (see TODO)
36 # for sending cancel emails in sub cancel
39 @ISA = qw( FS::m2m_Common FS::cust_main_Mixin FS::option_Common FS::Record );
43 $disable_agentcheck = 0;
47 my ( $hashref, $cache ) = @_;
48 #if ( $hashref->{'pkgpart'} ) {
49 if ( $hashref->{'pkg'} ) {
50 # #@{ $self->{'_pkgnum'} } = ();
51 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
52 # $self->{'_pkgpart'} = $subcache;
53 # #push @{ $self->{'_pkgnum'} },
54 # FS::part_pkg->new_or_cached($hashref, $subcache);
55 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
57 if ( exists $hashref->{'svcnum'} ) {
58 #@{ $self->{'_pkgnum'} } = ();
59 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
60 $self->{'_svcnum'} = $subcache;
61 #push @{ $self->{'_pkgnum'} },
62 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
68 FS::cust_pkg - Object methods for cust_pkg objects
74 $record = new FS::cust_pkg \%hash;
75 $record = new FS::cust_pkg { 'column' => 'value' };
77 $error = $record->insert;
79 $error = $new_record->replace($old_record);
81 $error = $record->delete;
83 $error = $record->check;
85 $error = $record->cancel;
87 $error = $record->suspend;
89 $error = $record->unsuspend;
91 $part_pkg = $record->part_pkg;
93 @labels = $record->labels;
95 $seconds = $record->seconds_since($timestamp);
97 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
98 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
102 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
103 inherits from FS::Record. The following fields are currently supported:
109 Primary key (assigned automatically for new billing items)
113 Customer (see L<FS::cust_main>)
117 Billing item definition (see L<FS::part_pkg>)
121 Optional link to package location (see L<FS::location>)
129 date (next bill date)
153 order taker (assigned automatically if null, see L<FS::UID>)
157 If this field is set to 1, disables the automatic
158 unsuspension of this package when using the B<unsuspendauto> config option.
162 If not set, defaults to 1
166 Date of change from previous package
176 =item change_locationnum
182 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
183 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
184 L<Time::Local> and L<Date::Parse> for conversion functions.
192 Create a new billing item. To add the item to the database, see L<"insert">.
196 sub table { 'cust_pkg'; }
197 sub cust_linked { $_[0]->cust_main_custnum; }
198 sub cust_unlinked_msg {
200 "WARNING: can't find cust_main.custnum ". $self->custnum.
201 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
204 =item insert [ OPTION => VALUE ... ]
206 Adds this billing item to the database ("Orders" the item). If there is an
207 error, returns the error, otherwise returns false.
209 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
210 will be used to look up the package definition and agent restrictions will be
213 If the additional field I<refnum> is defined, an FS::pkg_referral record will
214 be created and inserted. Multiple FS::pkg_referral records can be created by
215 setting I<refnum> to an array reference of refnums or a hash reference with
216 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
217 record will be created corresponding to cust_main.refnum.
219 The following options are available:
225 If set true, supresses any referral credit to a referring customer.
229 cust_pkg_option records will be created
236 my( $self, %options ) = @_;
238 local $SIG{HUP} = 'IGNORE';
239 local $SIG{INT} = 'IGNORE';
240 local $SIG{QUIT} = 'IGNORE';
241 local $SIG{TERM} = 'IGNORE';
242 local $SIG{TSTP} = 'IGNORE';
243 local $SIG{PIPE} = 'IGNORE';
245 my $oldAutoCommit = $FS::UID::AutoCommit;
246 local $FS::UID::AutoCommit = 0;
249 my $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
251 $dbh->rollback if $oldAutoCommit;
255 $self->refnum($self->cust_main->refnum) unless $self->refnum;
256 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
257 $self->process_m2m( 'link_table' => 'pkg_referral',
258 'target_table' => 'part_referral',
259 'params' => $self->refnum,
262 #if ( $self->reg_code ) {
263 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
264 # $error = $reg_code->delete;
266 # $dbh->rollback if $oldAutoCommit;
271 my $conf = new FS::Conf;
273 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
274 my $queue = new FS::queue {
275 'job' => 'FS::cust_main::queueable_print',
277 $error = $queue->insert(
278 'custnum' => $self->custnum,
279 'template' => 'welcome_letter',
283 warn "can't send welcome letter: $error";
288 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
295 This method now works but you probably shouldn't use it.
297 You don't want to delete billing items, because there would then be no record
298 the customer ever purchased the item. Instead, see the cancel method.
303 # return "Can't delete cust_pkg records!";
306 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
308 Replaces the OLD_RECORD with this one in the database. If there is an error,
309 returns the error, otherwise returns false.
311 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
313 Changing pkgpart may have disasterous effects. See the order subroutine.
315 setup and bill are normally updated by calling the bill method of a customer
316 object (see L<FS::cust_main>).
318 suspend is normally updated by the suspend and unsuspend methods.
320 cancel is normally updated by the cancel method (and also the order subroutine
323 Available options are:
329 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.
333 the access_user (see L<FS::access_user>) providing the reason
337 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
346 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
351 ( ref($_[0]) eq 'HASH' )
355 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
356 return "Can't change otaker!" if $old->otaker ne $new->otaker;
359 #return "Can't change setup once it exists!"
360 # if $old->getfield('setup') &&
361 # $old->getfield('setup') != $new->getfield('setup');
363 #some logic for bill, susp, cancel?
365 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
367 local $SIG{HUP} = 'IGNORE';
368 local $SIG{INT} = 'IGNORE';
369 local $SIG{QUIT} = 'IGNORE';
370 local $SIG{TERM} = 'IGNORE';
371 local $SIG{TSTP} = 'IGNORE';
372 local $SIG{PIPE} = 'IGNORE';
374 my $oldAutoCommit = $FS::UID::AutoCommit;
375 local $FS::UID::AutoCommit = 0;
378 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
379 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
380 my $error = $new->insert_reason(
381 'reason' => $options->{'reason'},
382 'date' => $new->$method,
384 'reason_otaker' => $options->{'reason_otaker'},
387 dbh->rollback if $oldAutoCommit;
388 return "Error inserting cust_pkg_reason: $error";
393 #save off and freeze RADIUS attributes for any associated svc_acct records
395 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
397 #also check for specific exports?
398 # to avoid spurious modify export events
399 @svc_acct = map { $_->svc_x }
400 grep { $_->part_svc->svcdb eq 'svc_acct' }
403 $_->snapshot foreach @svc_acct;
407 my $error = $new->SUPER::replace($old,
408 $options->{options} ? $options->{options} : ()
411 $dbh->rollback if $oldAutoCommit;
415 #for prepaid packages,
416 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
417 foreach my $old_svc_acct ( @svc_acct ) {
418 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
419 my $s_error = $new_svc_acct->replace($old_svc_acct);
421 $dbh->rollback if $oldAutoCommit;
426 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
433 Checks all fields to make sure this is a valid billing item. If there is an
434 error, returns the error, otherwise returns false. Called by the insert and
442 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
445 $self->ut_numbern('pkgnum')
446 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
447 || $self->ut_numbern('pkgpart')
448 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
449 || $self->ut_numbern('setup')
450 || $self->ut_numbern('bill')
451 || $self->ut_numbern('susp')
452 || $self->ut_numbern('cancel')
453 || $self->ut_numbern('adjourn')
454 || $self->ut_numbern('expire')
456 return $error if $error;
458 if ( $self->reg_code ) {
460 unless ( grep { $self->pkgpart == $_->pkgpart }
461 map { $_->reg_code_pkg }
462 qsearchs( 'reg_code', { 'code' => $self->reg_code,
463 'agentnum' => $self->cust_main->agentnum })
465 return "Unknown registration code";
468 } elsif ( $self->promo_code ) {
471 qsearchs('part_pkg', {
472 'pkgpart' => $self->pkgpart,
473 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
475 return 'Unknown promotional code' unless $promo_part_pkg;
479 unless ( $disable_agentcheck ) {
481 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
482 my $pkgpart_href = $agent->pkgpart_hashref;
483 return "agent ". $agent->agentnum.
484 " can't purchase pkgpart ". $self->pkgpart
485 unless $pkgpart_href->{ $self->pkgpart };
488 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
489 return $error if $error;
493 $self->otaker(getotaker) unless $self->otaker;
494 $self->otaker =~ /^(\w{1,32})$/ or return "Illegal otaker";
497 if ( $self->dbdef_table->column('manual_flag') ) {
498 $self->manual_flag('') if $self->manual_flag eq ' ';
499 $self->manual_flag =~ /^([01]?)$/
500 or return "Illegal manual_flag ". $self->manual_flag;
501 $self->manual_flag($1);
507 =item cancel [ OPTION => VALUE ... ]
509 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
510 in this package, then cancels the package itself (sets the cancel field to
513 Available options are:
517 =item quiet - can be set true to supress email cancellation notices.
519 =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.
521 =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.
523 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
527 If there is an error, returns the error, otherwise returns false.
532 my( $self, %options ) = @_;
535 warn "cust_pkg::cancel called with options".
536 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
539 local $SIG{HUP} = 'IGNORE';
540 local $SIG{INT} = 'IGNORE';
541 local $SIG{QUIT} = 'IGNORE';
542 local $SIG{TERM} = 'IGNORE';
543 local $SIG{TSTP} = 'IGNORE';
544 local $SIG{PIPE} = 'IGNORE';
546 my $oldAutoCommit = $FS::UID::AutoCommit;
547 local $FS::UID::AutoCommit = 0;
550 my $old = $self->select_for_update;
552 if ( $old->get('cancel') || $self->get('cancel') ) {
553 dbh->rollback if $oldAutoCommit;
554 return ""; # no error
557 my $date = $options{date} if $options{date}; # expire/cancel later
558 $date = '' if ($date && $date <= time); # complain instead?
560 my $cancel_time = $options{'time'} || time;
562 if ( $options{'reason'} ) {
563 $error = $self->insert_reason( 'reason' => $options{'reason'},
564 'action' => $date ? 'expire' : 'cancel',
565 'date' => $date ? $date : $cancel_time,
566 'reason_otaker' => $options{'reason_otaker'},
569 dbh->rollback if $oldAutoCommit;
570 return "Error inserting cust_pkg_reason: $error";
576 foreach my $cust_svc (
579 sort { $a->[1] <=> $b->[1] }
580 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
581 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
584 my $error = $cust_svc->cancel;
587 $dbh->rollback if $oldAutoCommit;
588 return "Error cancelling cust_svc: $error";
592 # Add a credit for remaining service
593 my $remaining_value = $self->calc_remain(time=>$cancel_time);
594 if ( $remaining_value > 0 && !$options{'no_credit'} ) {
595 my $conf = new FS::Conf;
596 my $error = $self->cust_main->credit(
598 'Credit for unused time on '. $self->part_pkg->pkg,
599 'reason_type' => $conf->config('cancel_credit_type'),
602 $dbh->rollback if $oldAutoCommit;
603 return "Error crediting customer \$$remaining_value for unused time on".
604 $self->part_pkg->pkg. ": $error";
609 my %hash = $self->hash;
610 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
611 my $new = new FS::cust_pkg ( \%hash );
612 $error = $new->replace( $self, options => { $self->options } );
614 $dbh->rollback if $oldAutoCommit;
618 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
619 return '' if $date; #no errors
621 my $conf = new FS::Conf;
622 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
623 if ( !$options{'quiet'} && $conf->exists('emailcancel') && @invoicing_list ) {
624 my $conf = new FS::Conf;
625 my $error = send_email(
626 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
627 'to' => \@invoicing_list,
628 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
629 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
631 #should this do something on errors?
638 =item cancel_if_expired [ NOW_TIMESTAMP ]
640 Cancels this package if its expire date has been reached.
644 sub cancel_if_expired {
646 my $time = shift || time;
647 return '' unless $self->expire && $self->expire <= $time;
648 my $error = $self->cancel;
650 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
651 $self->custnum. ": $error";
658 Cancels any pending expiration (sets the expire field to null).
660 If there is an error, returns the error, otherwise returns false.
665 my( $self, %options ) = @_;
668 local $SIG{HUP} = 'IGNORE';
669 local $SIG{INT} = 'IGNORE';
670 local $SIG{QUIT} = 'IGNORE';
671 local $SIG{TERM} = 'IGNORE';
672 local $SIG{TSTP} = 'IGNORE';
673 local $SIG{PIPE} = 'IGNORE';
675 my $oldAutoCommit = $FS::UID::AutoCommit;
676 local $FS::UID::AutoCommit = 0;
679 my $old = $self->select_for_update;
681 my $pkgnum = $old->pkgnum;
682 if ( $old->get('cancel') || $self->get('cancel') ) {
683 dbh->rollback if $oldAutoCommit;
684 return "Can't unexpire cancelled package $pkgnum";
685 # or at least it's pointless
688 unless ( $old->get('expire') && $self->get('expire') ) {
689 dbh->rollback if $oldAutoCommit;
690 return ""; # no error
693 my %hash = $self->hash;
694 $hash{'expire'} = '';
695 my $new = new FS::cust_pkg ( \%hash );
696 $error = $new->replace( $self, options => { $self->options } );
698 $dbh->rollback if $oldAutoCommit;
702 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
708 =item suspend [ OPTION => VALUE ... ]
710 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
711 package, then suspends the package itself (sets the susp field to now).
713 Available options are:
717 =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.
719 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
723 If there is an error, returns the error, otherwise returns false.
728 my( $self, %options ) = @_;
731 local $SIG{HUP} = 'IGNORE';
732 local $SIG{INT} = 'IGNORE';
733 local $SIG{QUIT} = 'IGNORE';
734 local $SIG{TERM} = 'IGNORE';
735 local $SIG{TSTP} = 'IGNORE';
736 local $SIG{PIPE} = 'IGNORE';
738 my $oldAutoCommit = $FS::UID::AutoCommit;
739 local $FS::UID::AutoCommit = 0;
742 my $old = $self->select_for_update;
744 my $pkgnum = $old->pkgnum;
745 if ( $old->get('cancel') || $self->get('cancel') ) {
746 dbh->rollback if $oldAutoCommit;
747 return "Can't suspend cancelled package $pkgnum";
750 if ( $old->get('susp') || $self->get('susp') ) {
751 dbh->rollback if $oldAutoCommit;
752 return ""; # no error # complain on adjourn?
755 my $date = $options{date} if $options{date}; # adjourn/suspend later
756 $date = '' if ($date && $date <= time); # complain instead?
758 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
759 dbh->rollback if $oldAutoCommit;
760 return "Package $pkgnum expires before it would be suspended.";
763 my $suspend_time = $options{'time'} || time;
765 if ( $options{'reason'} ) {
766 $error = $self->insert_reason( 'reason' => $options{'reason'},
767 'action' => $date ? 'adjourn' : 'suspend',
768 'date' => $date ? $date : $suspend_time,
769 'reason_otaker' => $options{'reason_otaker'},
772 dbh->rollback if $oldAutoCommit;
773 return "Error inserting cust_pkg_reason: $error";
781 foreach my $cust_svc (
782 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
784 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
786 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
787 $dbh->rollback if $oldAutoCommit;
788 return "Illegal svcdb value in part_svc!";
791 require "FS/$svcdb.pm";
793 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
795 $error = $svc->suspend;
797 $dbh->rollback if $oldAutoCommit;
800 my( $label, $value ) = $cust_svc->label;
801 push @labels, "$label: $value";
805 my $conf = new FS::Conf;
806 if ( $conf->config('suspend_email_admin') ) {
808 my $error = send_email(
809 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
810 #invoice_from ??? well as good as any
811 'to' => $conf->config('suspend_email_admin'),
812 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
814 "This is an automatic message from your Freeside installation\n",
815 "informing you that the following customer package has been suspended:\n",
817 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
818 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
819 ( map { "Service : $_\n" } @labels ),
824 warn "WARNING: can't send suspension admin email (suspending anyway): ".
832 my %hash = $self->hash;
834 $hash{'adjourn'} = $date;
836 $hash{'susp'} = $suspend_time;
838 my $new = new FS::cust_pkg ( \%hash );
839 $error = $new->replace( $self, options => { $self->options } );
841 $dbh->rollback if $oldAutoCommit;
845 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
850 =item unsuspend [ OPTION => VALUE ... ]
852 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
853 package, then unsuspends the package itself (clears the susp field and the
854 adjourn field if it is in the past).
856 Available options are:
860 =item adjust_next_bill
862 Can be set true to adjust the next bill date forward by
863 the amount of time the account was inactive. This was set true by default
864 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
865 explicitly requested. Price plans for which this makes sense (anniversary-date
866 based than prorate or subscription) could have an option to enable this
871 If there is an error, returns the error, otherwise returns false.
876 my( $self, %opt ) = @_;
879 local $SIG{HUP} = 'IGNORE';
880 local $SIG{INT} = 'IGNORE';
881 local $SIG{QUIT} = 'IGNORE';
882 local $SIG{TERM} = 'IGNORE';
883 local $SIG{TSTP} = 'IGNORE';
884 local $SIG{PIPE} = 'IGNORE';
886 my $oldAutoCommit = $FS::UID::AutoCommit;
887 local $FS::UID::AutoCommit = 0;
890 my $old = $self->select_for_update;
892 my $pkgnum = $old->pkgnum;
893 if ( $old->get('cancel') || $self->get('cancel') ) {
894 dbh->rollback if $oldAutoCommit;
895 return "Can't unsuspend cancelled package $pkgnum";
898 unless ( $old->get('susp') && $self->get('susp') ) {
899 dbh->rollback if $oldAutoCommit;
900 return ""; # no error # complain instead?
903 foreach my $cust_svc (
904 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
906 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
908 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
909 $dbh->rollback if $oldAutoCommit;
910 return "Illegal svcdb value in part_svc!";
913 require "FS/$svcdb.pm";
915 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
917 $error = $svc->unsuspend;
919 $dbh->rollback if $oldAutoCommit;
926 my %hash = $self->hash;
927 my $inactive = time - $hash{'susp'};
929 my $conf = new FS::Conf;
931 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive
932 if ( $opt{'adjust_next_bill'}
933 || $conf->exists('unsuspend-always_adjust_next_bill_date') )
934 && $inactive > 0 && ( $hash{'bill'} || $hash{'setup'} );
937 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
938 my $new = new FS::cust_pkg ( \%hash );
939 $error = $new->replace( $self, options => { $self->options } );
941 $dbh->rollback if $oldAutoCommit;
945 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
952 Cancels any pending suspension (sets the adjourn field to null).
954 If there is an error, returns the error, otherwise returns false.
959 my( $self, %options ) = @_;
962 local $SIG{HUP} = 'IGNORE';
963 local $SIG{INT} = 'IGNORE';
964 local $SIG{QUIT} = 'IGNORE';
965 local $SIG{TERM} = 'IGNORE';
966 local $SIG{TSTP} = 'IGNORE';
967 local $SIG{PIPE} = 'IGNORE';
969 my $oldAutoCommit = $FS::UID::AutoCommit;
970 local $FS::UID::AutoCommit = 0;
973 my $old = $self->select_for_update;
975 my $pkgnum = $old->pkgnum;
976 if ( $old->get('cancel') || $self->get('cancel') ) {
977 dbh->rollback if $oldAutoCommit;
978 return "Can't unadjourn cancelled package $pkgnum";
979 # or at least it's pointless
982 if ( $old->get('susp') || $self->get('susp') ) {
983 dbh->rollback if $oldAutoCommit;
984 return "Can't unadjourn suspended package $pkgnum";
985 # perhaps this is arbitrary
988 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
989 dbh->rollback if $oldAutoCommit;
990 return ""; # no error
993 my %hash = $self->hash;
994 $hash{'adjourn'} = '';
995 my $new = new FS::cust_pkg ( \%hash );
996 $error = $new->replace( $self, options => { $self->options } );
998 $dbh->rollback if $oldAutoCommit;
1002 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1009 =item change HASHREF | OPTION => VALUE ...
1011 Changes this package: cancels it and creates a new one, with a different
1012 pkgpart or locationnum or both. All services are transferred to the new
1013 package (no change will be made if this is not possible).
1015 Options may be passed as a list of key/value pairs or as a hash reference.
1022 New locationnum, to change the location for this package.
1026 New FS::cust_location object, to create a new location and assign it
1031 New pkgpart (see L<FS::part_pkg>).
1035 New refnum (see L<FS::part_referral>).
1039 At least one option must be specified (otherwise, what's the point?)
1041 Returns either the new FS::cust_pkg object or a scalar error.
1045 my $err_or_new_cust_pkg = $old_cust_pkg->change
1049 #some false laziness w/order
1052 my $opt = ref($_[0]) ? shift : { @_ };
1054 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1057 my $conf = new FS::Conf;
1059 # Transactionize this whole mess
1060 local $SIG{HUP} = 'IGNORE';
1061 local $SIG{INT} = 'IGNORE';
1062 local $SIG{QUIT} = 'IGNORE';
1063 local $SIG{TERM} = 'IGNORE';
1064 local $SIG{TSTP} = 'IGNORE';
1065 local $SIG{PIPE} = 'IGNORE';
1067 my $oldAutoCommit = $FS::UID::AutoCommit;
1068 local $FS::UID::AutoCommit = 0;
1077 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1079 #$hash{$_} = $self->$_() foreach qw( setup );
1081 $hash{'setup'} = $time if $self->setup;
1083 $hash{'change_date'} = $time;
1084 $hash{"change_$_"} = $self->$_()
1085 foreach qw( pkgnum pkgpart locationnum );
1087 if ( $opt->{'cust_location'} &&
1088 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1089 $error = $opt->{'cust_location'}->insert;
1091 $dbh->rollback if $oldAutoCommit;
1092 return "inserting cust_location (transaction rolled back): $error";
1094 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1097 # Create the new package.
1098 my $cust_pkg = new FS::cust_pkg {
1099 custnum => $self->custnum,
1100 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1101 refnum => ( $opt->{'refnum'} || $self->refnum ),
1102 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1106 $error = $cust_pkg->insert( 'change' => 1 );
1108 $dbh->rollback if $oldAutoCommit;
1112 # Transfer services and cancel old package.
1114 $error = $self->transfer($cust_pkg);
1115 if ($error and $error == 0) {
1116 # $old_pkg->transfer failed.
1117 $dbh->rollback if $oldAutoCommit;
1121 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1122 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1123 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1124 if ($error and $error == 0) {
1125 # $old_pkg->transfer failed.
1126 $dbh->rollback if $oldAutoCommit;
1132 # Transfers were successful, but we still had services left on the old
1133 # package. We can't change the package under this circumstances, so abort.
1134 $dbh->rollback if $oldAutoCommit;
1135 return "Unable to transfer all services from package ". $self->pkgnum;
1138 #Good to go, cancel old package.
1139 $error = $self->cancel( quiet=>1 );
1145 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1152 Returns the last bill date, or if there is no last bill date, the setup date.
1153 Useful for billing metered services.
1159 return $self->setfield('last_bill', $_[0]) if @_;
1160 return $self->getfield('last_bill') if $self->getfield('last_bill');
1161 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1162 'edate' => $self->bill, } );
1163 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1166 =item last_cust_pkg_reason ACTION
1168 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1169 Returns false if there is no reason or the package is not currenly ACTION'd
1170 ACTION is one of adjourn, susp, cancel, or expire.
1174 sub last_cust_pkg_reason {
1175 my ( $self, $action ) = ( shift, shift );
1176 my $date = $self->get($action);
1178 'table' => 'cust_pkg_reason',
1179 'hashref' => { 'pkgnum' => $self->pkgnum,
1180 'action' => substr(uc($action), 0, 1),
1183 'order_by' => 'ORDER BY num DESC LIMIT 1',
1187 =item last_reason ACTION
1189 Returns the most recent ACTION FS::reason associated with the package.
1190 Returns false if there is no reason or the package is not currenly ACTION'd
1191 ACTION is one of adjourn, susp, cancel, or expire.
1196 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1197 $cust_pkg_reason->reason
1198 if $cust_pkg_reason;
1203 Returns the definition for this billing item, as an FS::part_pkg object (see
1210 #exists( $self->{'_pkgpart'} )
1212 ? $self->{'_pkgpart'}
1213 : qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1218 Returns the cancelled package this package was changed from, if any.
1224 return '' unless $self->change_pkgnum;
1225 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1230 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1237 $self->part_pkg->calc_setup($self, @_);
1242 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1249 $self->part_pkg->calc_recur($self, @_);
1254 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1261 $self->part_pkg->calc_remain($self, @_);
1266 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1273 $self->part_pkg->calc_cancel($self, @_);
1278 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1284 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1287 =item cust_pkg_detail [ DETAILTYPE ]
1289 Returns any customer package details for this package (see
1290 L<FS::cust_pkg_detail>).
1292 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1296 sub cust_pkg_detail {
1298 my %hash = ( 'pkgnum' => $self->pkgnum );
1299 $hash{detailtype} = shift if @_;
1301 'table' => 'cust_pkg_detail',
1302 'hashref' => \%hash,
1303 'order_by' => 'ORDER BY weight, pkgdetailnum',
1307 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1309 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1311 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1313 If there is an error, returns the error, otherwise returns false.
1317 sub set_cust_pkg_detail {
1318 my( $self, $detailtype, @details ) = @_;
1320 local $SIG{HUP} = 'IGNORE';
1321 local $SIG{INT} = 'IGNORE';
1322 local $SIG{QUIT} = 'IGNORE';
1323 local $SIG{TERM} = 'IGNORE';
1324 local $SIG{TSTP} = 'IGNORE';
1325 local $SIG{PIPE} = 'IGNORE';
1327 my $oldAutoCommit = $FS::UID::AutoCommit;
1328 local $FS::UID::AutoCommit = 0;
1331 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1332 my $error = $current->delete;
1334 $dbh->rollback if $oldAutoCommit;
1335 return "error removing old detail: $error";
1339 foreach my $detail ( @details ) {
1340 my $cust_pkg_detail = new FS::cust_pkg_detail {
1341 'pkgnum' => $self->pkgnum,
1342 'detailtype' => $detailtype,
1343 'detail' => $detail,
1345 my $error = $cust_pkg_detail->insert;
1347 $dbh->rollback if $oldAutoCommit;
1348 return "error adding new detail: $error";
1353 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1360 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1364 #false laziness w/cust_bill.pm
1368 'table' => 'cust_event',
1369 'addl_from' => 'JOIN part_event USING ( eventpart )',
1370 'hashref' => { 'tablenum' => $self->pkgnum },
1371 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1375 =item num_cust_event
1377 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1381 #false laziness w/cust_bill.pm
1382 sub num_cust_event {
1385 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1386 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1387 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1388 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1389 $sth->fetchrow_arrayref->[0];
1392 =item cust_svc [ SVCPART ]
1394 Returns the services for this package, as FS::cust_svc objects (see
1395 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1404 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1405 'svcpart' => shift, } );
1408 #if ( $self->{'_svcnum'} ) {
1409 # values %{ $self->{'_svcnum'}->cache };
1411 $self->_sort_cust_svc(
1412 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1418 =item overlimit [ SVCPART ]
1420 Returns the services for this package which have exceeded their
1421 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1422 is specified, return only the matching services.
1428 grep { $_->overlimit } $self->cust_svc;
1431 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ]
1433 Returns historical services for this package created before END TIMESTAMP and
1434 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1435 (see L<FS::h_cust_svc>).
1442 $self->_sort_cust_svc(
1443 [ qsearch( 'h_cust_svc',
1444 { 'pkgnum' => $self->pkgnum, },
1445 FS::h_cust_svc->sql_h_search(@_),
1451 sub _sort_cust_svc {
1452 my( $self, $arrayref ) = @_;
1455 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
1457 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1458 'svcpart' => $_->svcpart } );
1460 $pkg_svc ? $pkg_svc->primary_svc : '',
1461 $pkg_svc ? $pkg_svc->quantity : 0,
1468 =item num_cust_svc [ SVCPART ]
1470 Returns the number of provisioned services for this package. If a svcpart is
1471 specified, counts only the matching services.
1477 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1478 $sql .= ' AND svcpart = ?' if @_;
1479 my $sth = dbh->prepare($sql) or die dbh->errstr;
1480 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1481 $sth->fetchrow_arrayref->[0];
1484 =item available_part_svc
1486 Returns a list of FS::part_svc objects representing services included in this
1487 package but not yet provisioned. Each FS::part_svc object also has an extra
1488 field, I<num_avail>, which specifies the number of available services.
1492 sub available_part_svc {
1494 grep { $_->num_avail > 0 }
1496 my $part_svc = $_->part_svc;
1497 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1498 $_->quantity - $self->num_cust_svc($_->svcpart);
1501 $self->part_pkg->pkg_svc;
1506 Returns a list of FS::part_svc objects representing provisioned and available
1507 services included in this package. Each FS::part_svc object also has the
1508 following extra fields:
1512 =item num_cust_svc (count)
1514 =item num_avail (quantity - count)
1516 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1519 label -> ($cust_svc->label)[1]
1528 #XXX some sort of sort order besides numeric by svcpart...
1529 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1531 my $part_svc = $pkg_svc->part_svc;
1532 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1533 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1534 $part_svc->{'Hash'}{'num_avail'} =
1535 max( 0, $pkg_svc->quantity - $num_cust_svc );
1536 $part_svc->{'Hash'}{'cust_pkg_svc'} = [ $self->cust_svc($part_svc->svcpart) ];
1538 } $self->part_pkg->pkg_svc;
1541 push @part_svc, map {
1543 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1544 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1545 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1546 $part_svc->{'Hash'}{'cust_pkg_svc'} = [ $self->cust_svc($part_svc->svcpart) ];
1548 } $self->extra_part_svc;
1554 =item extra_part_svc
1556 Returns a list of FS::part_svc objects corresponding to services in this
1557 package which are still provisioned but not (any longer) available in the
1562 sub extra_part_svc {
1565 my $pkgnum = $self->pkgnum;
1566 my $pkgpart = $self->pkgpart;
1569 'table' => 'part_svc',
1571 'extra_sql' => "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1572 WHERE pkg_svc.svcpart = part_svc.svcpart
1573 AND pkg_svc.pkgpart = $pkgpart
1576 AND 0 < ( SELECT count(*)
1578 LEFT JOIN cust_pkg using ( pkgnum )
1579 WHERE cust_svc.svcpart = part_svc.svcpart
1580 AND pkgnum = $pkgnum
1587 Returns a short status string for this package, currently:
1591 =item not yet billed
1593 =item one-time charge
1608 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1610 return 'cancelled' if $self->get('cancel');
1611 return 'suspended' if $self->susp;
1612 return 'not yet billed' unless $self->setup;
1613 return 'one-time charge' if $freq =~ /^(0|$)/;
1619 Class method that returns the list of possible status strings for packages
1620 (see L<the status method|/status>). For example:
1622 @statuses = FS::cust_pkg->statuses();
1626 tie my %statuscolor, 'Tie::IxHash',
1627 'not yet billed' => '000000',
1628 'one-time charge' => '000000',
1629 'active' => '00CC00',
1630 'suspended' => 'FF9900',
1631 'cancelled' => 'FF0000',
1635 my $self = shift; #could be class...
1636 grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
1637 # mayble split btw one-time vs. recur
1643 Returns a hex triplet color string for this package's status.
1649 $statuscolor{$self->status};
1654 Returns a list of lists, calling the label method for all services
1655 (see L<FS::cust_svc>) of this billing item.
1661 map { [ $_->label ] } $self->cust_svc;
1664 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ]
1666 Like the labels method, but returns historical information on services that
1667 were active as of END_TIMESTAMP and (optionally) not cancelled before
1670 Returns a list of lists, calling the label method for all (historical) services
1671 (see L<FS::h_cust_svc>) of this billing item.
1677 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
1680 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
1682 Like h_labels, except returns a simple flat list, and shortens long
1683 (currently >5 or the cust_bill-max_same_services configuration value) lists of
1684 identical services to one line that lists the service label and the number of
1685 individual services rather than individual items.
1689 sub h_labels_short {
1692 my $conf = new FS::Conf;
1693 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
1696 #tie %labels, 'Tie::IxHash';
1697 push @{ $labels{$_->[0]} }, $_->[1]
1698 foreach $self->h_labels(@_);
1700 foreach my $label ( keys %labels ) {
1702 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
1703 my $num = scalar(@values);
1704 if ( $num > $max_same_services ) {
1705 push @labels, "$label ($num)";
1707 push @labels, map { "$label: $_" } @values;
1717 Returns the parent customer object (see L<FS::cust_main>).
1723 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1728 Returns the location object, if any (see L<FS::cust_location>).
1734 return '' unless $self->locationnum;
1735 qsearchs( 'cust_location', { 'locationnum' => $self->locationnum } );
1738 =item cust_location_or_main
1740 If this package is associated with a location, returns the locaiton (see
1741 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
1745 sub cust_location_or_main {
1747 $self->cust_location || $self->cust_main;
1750 =item seconds_since TIMESTAMP
1752 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
1753 package have been online since TIMESTAMP, according to the session monitor.
1755 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1756 L<Time::Local> and L<Date::Parse> for conversion functions.
1761 my($self, $since) = @_;
1764 foreach my $cust_svc (
1765 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
1767 $seconds += $cust_svc->seconds_since($since);
1774 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
1776 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
1777 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
1780 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
1781 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
1787 sub seconds_since_sqlradacct {
1788 my($self, $start, $end) = @_;
1792 foreach my $cust_svc (
1794 my $part_svc = $_->part_svc;
1795 $part_svc->svcdb eq 'svc_acct'
1796 && scalar($part_svc->part_export('sqlradius'));
1799 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
1806 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
1808 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
1809 in this package for sessions ending between TIMESTAMP_START (inclusive) and
1813 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
1814 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
1819 sub attribute_since_sqlradacct {
1820 my($self, $start, $end, $attrib) = @_;
1824 foreach my $cust_svc (
1826 my $part_svc = $_->part_svc;
1827 $part_svc->svcdb eq 'svc_acct'
1828 && scalar($part_svc->part_export('sqlradius'));
1831 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
1843 my( $self, $value ) = @_;
1844 if ( defined($value) ) {
1845 $self->setfield('quantity', $value);
1847 $self->getfield('quantity') || 1;
1850 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
1852 Transfers as many services as possible from this package to another package.
1854 The destination package can be specified by pkgnum by passing an FS::cust_pkg
1855 object. The destination package must already exist.
1857 Services are moved only if the destination allows services with the correct
1858 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
1859 this option with caution! No provision is made for export differences
1860 between the old and new service definitions. Probably only should be used
1861 when your exports for all service definitions of a given svcdb are identical.
1862 (attempt a transfer without it first, to move all possible svcpart-matching
1865 Any services that can't be moved remain in the original package.
1867 Returns an error, if there is one; otherwise, returns the number of services
1868 that couldn't be moved.
1873 my ($self, $dest_pkgnum, %opt) = @_;
1879 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
1880 $dest = $dest_pkgnum;
1881 $dest_pkgnum = $dest->pkgnum;
1883 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
1886 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
1888 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
1889 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
1892 foreach my $cust_svc ($dest->cust_svc) {
1893 $target{$cust_svc->svcpart}--;
1896 my %svcpart2svcparts = ();
1897 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
1898 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
1899 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
1900 next if exists $svcpart2svcparts{$svcpart};
1901 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
1902 $svcpart2svcparts{$svcpart} = [
1904 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
1906 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
1907 'svcpart' => $_ } );
1909 $pkg_svc ? $pkg_svc->primary_svc : '',
1910 $pkg_svc ? $pkg_svc->quantity : 0,
1914 grep { $_ != $svcpart }
1916 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
1918 warn "alternates for svcpart $svcpart: ".
1919 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
1924 foreach my $cust_svc ($self->cust_svc) {
1925 if($target{$cust_svc->svcpart} > 0) {
1926 $target{$cust_svc->svcpart}--;
1927 my $new = new FS::cust_svc { $cust_svc->hash };
1928 $new->pkgnum($dest_pkgnum);
1929 my $error = $new->replace($cust_svc);
1930 return $error if $error;
1931 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
1933 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
1934 warn "alternates to consider: ".
1935 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
1937 my @alternate = grep {
1938 warn "considering alternate svcpart $_: ".
1939 "$target{$_} available in new package\n"
1942 } @{$svcpart2svcparts{$cust_svc->svcpart}};
1944 warn "alternate(s) found\n" if $DEBUG;
1945 my $change_svcpart = $alternate[0];
1946 $target{$change_svcpart}--;
1947 my $new = new FS::cust_svc { $cust_svc->hash };
1948 $new->svcpart($change_svcpart);
1949 $new->pkgnum($dest_pkgnum);
1950 my $error = $new->replace($cust_svc);
1951 return $error if $error;
1964 This method is deprecated. See the I<depend_jobnum> option to the insert and
1965 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
1972 local $SIG{HUP} = 'IGNORE';
1973 local $SIG{INT} = 'IGNORE';
1974 local $SIG{QUIT} = 'IGNORE';
1975 local $SIG{TERM} = 'IGNORE';
1976 local $SIG{TSTP} = 'IGNORE';
1977 local $SIG{PIPE} = 'IGNORE';
1979 my $oldAutoCommit = $FS::UID::AutoCommit;
1980 local $FS::UID::AutoCommit = 0;
1983 foreach my $cust_svc ( $self->cust_svc ) {
1984 #false laziness w/svc_Common::insert
1985 my $svc_x = $cust_svc->svc_x;
1986 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
1987 my $error = $part_export->export_insert($svc_x);
1989 $dbh->rollback if $oldAutoCommit;
1995 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2002 =head1 CLASS METHODS
2008 Returns an SQL expression identifying recurring packages.
2012 sub recurring_sql { "
2013 '0' != ( select freq from part_pkg
2014 where cust_pkg.pkgpart = part_pkg.pkgpart )
2019 Returns an SQL expression identifying one-time packages.
2024 '0' = ( select freq from part_pkg
2025 where cust_pkg.pkgpart = part_pkg.pkgpart )
2030 Returns an SQL expression identifying active packages.
2035 ". $_[0]->recurring_sql(). "
2036 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2037 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2042 Returns an SQL expression identifying inactive packages (one-time packages
2043 that are otherwise unsuspended/uncancelled).
2047 sub inactive_sql { "
2048 ". $_[0]->onetime_sql(). "
2049 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2050 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2056 Returns an SQL expression identifying suspended packages.
2060 sub suspended_sql { susp_sql(@_); }
2062 #$_[0]->recurring_sql(). ' AND '.
2064 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2065 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2072 Returns an SQL exprression identifying cancelled packages.
2076 sub cancelled_sql { cancel_sql(@_); }
2078 #$_[0]->recurring_sql(). ' AND '.
2079 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2082 =item search_sql HASHREF
2086 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2087 Valid parameters are
2095 active, inactive, suspended, cancel (or cancelled)
2099 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2109 arrayref of beginning and ending epoch date
2113 arrayref of beginning and ending epoch date
2117 arrayref of beginning and ending epoch date
2121 arrayref of beginning and ending epoch date
2125 arrayref of beginning and ending epoch date
2129 arrayref of beginning and ending epoch date
2133 arrayref of beginning and ending epoch date
2137 pkgnum or APKG_pkgnum
2141 a value suited to passing to FS::UI::Web::cust_header
2145 specifies the user for agent virtualization
2152 my ($class, $params) = @_;
2159 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2161 "cust_main.agentnum = $1";
2168 if ( $params->{'magic'} eq 'active'
2169 || $params->{'status'} eq 'active' ) {
2171 push @where, FS::cust_pkg->active_sql();
2173 } elsif ( $params->{'magic'} eq 'inactive'
2174 || $params->{'status'} eq 'inactive' ) {
2176 push @where, FS::cust_pkg->inactive_sql();
2178 } elsif ( $params->{'magic'} eq 'suspended'
2179 || $params->{'status'} eq 'suspended' ) {
2181 push @where, FS::cust_pkg->suspended_sql();
2183 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2184 || $params->{'status'} =~ /^cancell?ed$/ ) {
2186 push @where, FS::cust_pkg->cancelled_sql();
2188 } elsif ( $params->{'status'} =~ /^(one-time charge|inactive)$/ ) {
2190 push @where, FS::cust_pkg->inactive_sql();
2195 # parse package class
2198 #false lazinessish w/graph/cust_bill_pkg.cgi
2201 if ( exists($params->{'classnum'})
2202 && $params->{'classnum'} =~ /^(\d*)$/
2206 if ( $classnum ) { #a specific class
2207 push @where, "classnum = $classnum";
2209 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2210 #die "classnum $classnum not found!" unless $pkg_class[0];
2211 #$title .= $pkg_class[0]->classname.' ';
2213 } elsif ( $classnum eq '' ) { #the empty class
2215 push @where, "classnum IS NULL";
2216 #$title .= 'Empty class ';
2217 #@pkg_class = ( '(empty class)' );
2218 } elsif ( $classnum eq '0' ) {
2219 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2220 #push @pkg_class, '(empty class)';
2222 die "illegal classnum";
2231 my $pkgpart = join (' OR pkgpart=',
2232 grep {$_} map { /^(\d+)$/; } ($params->{'pkgpart'}));
2233 push @where, '(pkgpart=' . $pkgpart . ')' if $pkgpart;
2241 #false laziness w/report_cust_pkg.html
2244 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
2245 'active' => { 'susp'=>1, 'cancel'=>1 },
2246 'suspended' => { 'cancel' => 1 },
2251 foreach my $field (qw( setup last_bill bill adjourn susp expire cancel )) {
2253 next unless exists($params->{$field});
2255 my($beginning, $ending) = @{$params->{$field}};
2257 next if $beginning == 0 && $ending == 4294967295;
2260 "cust_pkg.$field IS NOT NULL",
2261 "cust_pkg.$field >= $beginning",
2262 "cust_pkg.$field <= $ending";
2264 $orderby ||= "ORDER BY cust_pkg.$field";
2268 $orderby ||= 'ORDER BY bill';
2271 # parse magic, legacy, etc.
2274 if ( $params->{'magic'} &&
2275 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
2278 $orderby = 'ORDER BY pkgnum';
2280 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2281 push @where, "pkgpart = $1";
2284 } elsif ( $params->{'query'} eq 'pkgnum' ) {
2286 $orderby = 'ORDER BY pkgnum';
2288 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
2290 $orderby = 'ORDER BY pkgnum';
2293 SELECT count(*) FROM pkg_svc
2294 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
2295 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
2296 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
2297 AND cust_svc.svcpart = pkg_svc.svcpart
2304 # setup queries, links, subs, etc. for the search
2307 # here is the agent virtualization
2308 if ($params->{CurrentUser}) {
2310 qsearchs('access_user', { username => $params->{CurrentUser} });
2313 push @where, $access_user->agentnums_sql('table'=>'cust_main');
2318 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
2321 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2323 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
2324 'LEFT JOIN part_pkg USING ( pkgpart ) '.
2325 'LEFT JOIN pkg_class USING ( classnum ) ';
2327 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
2330 'table' => 'cust_pkg',
2332 'select' => join(', ',
2334 ( map "part_pkg.$_", qw( pkg freq ) ),
2335 'pkg_class.classname',
2336 'cust_main.custnum as cust_main_custnum',
2337 FS::UI::Web::cust_sql_fields(
2338 $params->{'cust_fields'}
2341 'extra_sql' => "$extra_sql $orderby",
2342 'addl_from' => $addl_from,
2343 'count_query' => $count_query,
2350 Returns a list: the first item is an SQL fragment identifying matching
2351 packages/customers via location (taking into account shipping and package
2352 address taxation, if enabled), and subsequent items are the parameters to
2353 substitute for the placeholders in that fragment.
2358 my($class, %opt) = @_;
2359 my $ornull = $opt{'ornull'};
2361 my $conf = new FS::Conf;
2363 # '?' placeholders in _location_sql_where
2366 @bill_param = qw( county county state state state country );
2368 @bill_param = qw( county state state country );
2370 unshift @bill_param, 'county'; # unless $nec;
2374 if ( $conf->exists('tax-ship_address') ) {
2377 ( ( ship_last IS NULL OR ship_last = '' )
2378 AND ". _location_sql_where('cust_main', '', $ornull ). "
2380 OR ( ship_last IS NOT NULL AND ship_last != ''
2381 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
2384 # AND payby != 'COMP'
2386 @main_param = ( @bill_param, @bill_param );
2390 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
2391 @main_param = @bill_param;
2397 if ( $conf->exists('tax-pkg_address') ) {
2399 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
2402 ( cust_pkg.locationnum IS NULL AND $main_where )
2403 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
2406 @param = ( @main_param, @bill_param );
2410 $where = $main_where;
2411 @param = @main_param;
2419 #subroutine, helper for location_sql
2420 sub _location_sql_where {
2422 my $prefix = @_ ? shift : '';
2423 my $ornull = @_ ? shift : '';
2425 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
2427 $ornull = $ornull ? ' OR ? IS NULL ' : '';
2429 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
2430 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
2433 ( $table.${prefix}county = ? $or_empty_county $ornull )
2434 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
2435 AND $table.${prefix}country = ?
2443 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
2445 CUSTNUM is a customer (see L<FS::cust_main>)
2447 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
2448 L<FS::part_pkg>) to order for this customer. Duplicates are of course
2451 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
2452 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
2453 new billing items. An error is returned if this is not possible (see
2454 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
2457 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
2458 newly-created cust_pkg objects.
2460 REFNUM, if specified, will specify the FS::pkg_referral record to be created
2461 and inserted. Multiple FS::pkg_referral records can be created by
2462 setting I<refnum> to an array reference of refnums or a hash reference with
2463 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
2464 record will be created corresponding to cust_main.refnum.
2469 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
2471 my $conf = new FS::Conf;
2473 # Transactionize this whole mess
2474 local $SIG{HUP} = 'IGNORE';
2475 local $SIG{INT} = 'IGNORE';
2476 local $SIG{QUIT} = 'IGNORE';
2477 local $SIG{TERM} = 'IGNORE';
2478 local $SIG{TSTP} = 'IGNORE';
2479 local $SIG{PIPE} = 'IGNORE';
2481 my $oldAutoCommit = $FS::UID::AutoCommit;
2482 local $FS::UID::AutoCommit = 0;
2486 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
2487 # return "Customer not found: $custnum" unless $cust_main;
2489 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
2492 my $change = scalar(@old_cust_pkg) != 0;
2495 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
2497 my $err_or_cust_pkg =
2498 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
2499 'refnum' => $refnum,
2502 unless (ref($err_or_cust_pkg)) {
2503 $dbh->rollback if $oldAutoCommit;
2504 return $err_or_cust_pkg;
2507 push @$return_cust_pkg, $err_or_cust_pkg;
2512 # Create the new packages.
2513 foreach my $pkgpart (@$pkgparts) {
2514 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
2515 pkgpart => $pkgpart,
2519 $error = $cust_pkg->insert( 'change' => $change );
2521 $dbh->rollback if $oldAutoCommit;
2524 push @$return_cust_pkg, $cust_pkg;
2526 # $return_cust_pkg now contains refs to all of the newly
2529 # Transfer services and cancel old packages.
2530 foreach my $old_pkg (@old_cust_pkg) {
2532 foreach my $new_pkg (@$return_cust_pkg) {
2533 $error = $old_pkg->transfer($new_pkg);
2534 if ($error and $error == 0) {
2535 # $old_pkg->transfer failed.
2536 $dbh->rollback if $oldAutoCommit;
2541 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2542 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2543 foreach my $new_pkg (@$return_cust_pkg) {
2544 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
2545 if ($error and $error == 0) {
2546 # $old_pkg->transfer failed.
2547 $dbh->rollback if $oldAutoCommit;
2554 # Transfers were successful, but we went through all of the
2555 # new packages and still had services left on the old package.
2556 # We can't cancel the package under the circumstances, so abort.
2557 $dbh->rollback if $oldAutoCommit;
2558 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
2560 $error = $old_pkg->cancel( quiet=>1 );
2566 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2570 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
2572 A bulk change method to change packages for multiple customers.
2574 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
2575 L<FS::part_pkg>) to order for each customer. Duplicates are of course
2578 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
2579 replace. The services (see L<FS::cust_svc>) are moved to the
2580 new billing items. An error is returned if this is not possible (see
2583 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
2584 newly-created cust_pkg objects.
2589 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
2591 # Transactionize this whole mess
2592 local $SIG{HUP} = 'IGNORE';
2593 local $SIG{INT} = 'IGNORE';
2594 local $SIG{QUIT} = 'IGNORE';
2595 local $SIG{TERM} = 'IGNORE';
2596 local $SIG{TSTP} = 'IGNORE';
2597 local $SIG{PIPE} = 'IGNORE';
2599 my $oldAutoCommit = $FS::UID::AutoCommit;
2600 local $FS::UID::AutoCommit = 0;
2604 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
2607 while(scalar(@old_cust_pkg)) {
2609 my $custnum = $old_cust_pkg[0]->custnum;
2610 my (@remove) = map { $_->pkgnum }
2611 grep { $_->custnum == $custnum } @old_cust_pkg;
2612 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
2614 my $error = order $custnum, $pkgparts, \@remove, \@return;
2616 push @errors, $error
2618 push @$return_cust_pkg, @return;
2621 if (scalar(@errors)) {
2622 $dbh->rollback if $oldAutoCommit;
2623 return join(' / ', @errors);
2626 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2632 Associates this package with a (suspension or cancellation) reason (see
2633 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2636 Available options are:
2642 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.
2646 the access_user (see L<FS::access_user>) providing the reason
2654 the action (cancel, susp, adjourn, expire) associated with the reason
2658 If there is an error, returns the error, otherwise returns false.
2663 my ($self, %options) = @_;
2665 my $otaker = $options{reason_otaker} ||
2666 $FS::CurrentUser::CurrentUser->username;
2669 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2673 } elsif ( ref($options{'reason'}) ) {
2675 return 'Enter a new reason (or select an existing one)'
2676 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2678 my $reason = new FS::reason({
2679 'reason_type' => $options{'reason'}->{'typenum'},
2680 'reason' => $options{'reason'}->{'reason'},
2682 my $error = $reason->insert;
2683 return $error if $error;
2685 $reasonnum = $reason->reasonnum;
2688 return "Unparsable reason: ". $options{'reason'};
2691 my $cust_pkg_reason =
2692 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2693 'reasonnum' => $reasonnum,
2694 'otaker' => $otaker,
2695 'action' => substr(uc($options{'action'}),0,1),
2696 'date' => $options{'date'}
2701 $cust_pkg_reason->insert;
2704 =item set_usage USAGE_VALUE_HASHREF
2706 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2707 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2708 upbytes, downbytes, and totalbytes are appropriate keys.
2710 All svc_accts which are part of this package have their values reset.
2715 my ($self, $valueref) = @_;
2717 foreach my $cust_svc ($self->cust_svc){
2718 my $svc_x = $cust_svc->svc_x;
2719 $svc_x->set_usage($valueref)
2720 if $svc_x->can("set_usage");
2724 =item recharge USAGE_VALUE_HASHREF
2726 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2727 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2728 upbytes, downbytes, and totalbytes are appropriate keys.
2730 All svc_accts which are part of this package have their values incremented.
2735 my ($self, $valueref) = @_;
2737 foreach my $cust_svc ($self->cust_svc){
2738 my $svc_x = $cust_svc->svc_x;
2739 $svc_x->recharge($valueref)
2740 if $svc_x->can("recharge");
2748 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
2750 In sub order, the @pkgparts array (passed by reference) is clobbered.
2752 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
2753 method to pass dates to the recur_prog expression, it should do so.
2755 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
2756 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
2757 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
2758 configuration values. Probably need a subroutine which decides what to do
2759 based on whether or not we've fetched the user yet, rather than a hash. See
2760 FS::UID and the TODO.
2762 Now that things are transactional should the check in the insert method be
2767 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
2768 L<FS::pkg_svc>, schema.html from the base documentation