4 use base qw( FS::cust_main_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common FS::Record
7 use vars qw(@ISA $disable_agentcheck $DEBUG $me);
9 use Scalar::Util qw( blessed );
10 use List::Util qw(max);
12 use Time::Local qw( timelocal_nocheck );
14 use FS::UID qw( getotaker dbh );
15 use FS::Misc qw( send_email );
16 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;
34 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
36 # because they load configuration by setting FS::UID::callback (see TODO)
42 # for sending cancel emails in sub cancel
46 $me = '[FS::cust_pkg]';
48 $disable_agentcheck = 0;
52 my ( $hashref, $cache ) = @_;
53 #if ( $hashref->{'pkgpart'} ) {
54 if ( $hashref->{'pkg'} ) {
55 # #@{ $self->{'_pkgnum'} } = ();
56 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
57 # $self->{'_pkgpart'} = $subcache;
58 # #push @{ $self->{'_pkgnum'} },
59 # FS::part_pkg->new_or_cached($hashref, $subcache);
60 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
62 if ( exists $hashref->{'svcnum'} ) {
63 #@{ $self->{'_pkgnum'} } = ();
64 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
65 $self->{'_svcnum'} = $subcache;
66 #push @{ $self->{'_pkgnum'} },
67 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
73 FS::cust_pkg - Object methods for cust_pkg objects
79 $record = new FS::cust_pkg \%hash;
80 $record = new FS::cust_pkg { 'column' => 'value' };
82 $error = $record->insert;
84 $error = $new_record->replace($old_record);
86 $error = $record->delete;
88 $error = $record->check;
90 $error = $record->cancel;
92 $error = $record->suspend;
94 $error = $record->unsuspend;
96 $part_pkg = $record->part_pkg;
98 @labels = $record->labels;
100 $seconds = $record->seconds_since($timestamp);
102 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
103 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
107 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
108 inherits from FS::Record. The following fields are currently supported:
114 Primary key (assigned automatically for new billing items)
118 Customer (see L<FS::cust_main>)
122 Billing item definition (see L<FS::part_pkg>)
126 Optional link to package location (see L<FS::location>)
138 date (next bill date)
162 order taker (assigned automatically if null, see L<FS::UID>)
166 If this field is set to 1, disables the automatic
167 unsuspension of this package when using the B<unsuspendauto> config option.
171 If not set, defaults to 1
175 Date of change from previous package
185 =item change_locationnum
191 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
192 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
193 L<Time::Local> and L<Date::Parse> for conversion functions.
201 Create a new billing item. To add the item to the database, see L<"insert">.
205 sub table { 'cust_pkg'; }
206 sub cust_linked { $_[0]->cust_main_custnum; }
207 sub cust_unlinked_msg {
209 "WARNING: can't find cust_main.custnum ". $self->custnum.
210 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
213 =item insert [ OPTION => VALUE ... ]
215 Adds this billing item to the database ("Orders" the item). If there is an
216 error, returns the error, otherwise returns false.
218 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
219 will be used to look up the package definition and agent restrictions will be
222 If the additional field I<refnum> is defined, an FS::pkg_referral record will
223 be created and inserted. Multiple FS::pkg_referral records can be created by
224 setting I<refnum> to an array reference of refnums or a hash reference with
225 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
226 record will be created corresponding to cust_main.refnum.
228 The following options are available:
234 If set true, supresses any referral credit to a referring customer.
238 cust_pkg_option records will be created
242 a ticket will be added to this customer with this subject
246 an optional queue name for ticket additions
253 my( $self, %options ) = @_;
255 if ( $self->part_pkg->option('start_1st', 1) && !$self->start_date ) {
256 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
257 $mon += 1 unless $mday == 1;
258 until ( $mon < 12 ) { $mon -= 12; $year++; }
259 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
262 my $expire_months = $self->part_pkg->option('expire_months', 1);
263 if ( $expire_months && !$self->expire ) {
264 my $start = $self->start_date || $self->setup || time;
266 #false laziness w/part_pkg::add_freq
267 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($start) )[0,1,2,3,4,5];
268 $mon += $expire_months;
269 until ( $mon < 12 ) { $mon -= 12; $year++; }
271 #$self->expire( timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year) );
272 $self->expire( timelocal_nocheck(0,0,0,$mday,$mon,$year) );
275 local $SIG{HUP} = 'IGNORE';
276 local $SIG{INT} = 'IGNORE';
277 local $SIG{QUIT} = 'IGNORE';
278 local $SIG{TERM} = 'IGNORE';
279 local $SIG{TSTP} = 'IGNORE';
280 local $SIG{PIPE} = 'IGNORE';
282 my $oldAutoCommit = $FS::UID::AutoCommit;
283 local $FS::UID::AutoCommit = 0;
286 my $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
288 $dbh->rollback if $oldAutoCommit;
292 $self->refnum($self->cust_main->refnum) unless $self->refnum;
293 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
294 $self->process_m2m( 'link_table' => 'pkg_referral',
295 'target_table' => 'part_referral',
296 'params' => $self->refnum,
299 if ( $self->discountnum ) {
300 my $error = $self->insert_discount();
302 $dbh->rollback if $oldAutoCommit;
307 #if ( $self->reg_code ) {
308 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
309 # $error = $reg_code->delete;
311 # $dbh->rollback if $oldAutoCommit;
316 my $conf = new FS::Conf;
318 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
321 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
328 use FS::TicketSystem;
329 FS::TicketSystem->init();
331 my $q = new RT::Queue($RT::SystemUser);
332 $q->Load($options{ticket_queue}) if $options{ticket_queue};
333 my $t = new RT::Ticket($RT::SystemUser);
334 my $mime = new MIME::Entity;
335 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
336 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
337 Subject => $options{ticket_subject},
340 $t->AddLink( Type => 'MemberOf',
341 Target => 'freeside://freeside/cust_main/'. $self->custnum,
345 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
346 my $queue = new FS::queue {
347 'job' => 'FS::cust_main::queueable_print',
349 $error = $queue->insert(
350 'custnum' => $self->custnum,
351 'template' => 'welcome_letter',
355 warn "can't send welcome letter: $error";
360 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
367 This method now works but you probably shouldn't use it.
369 You don't want to delete billing items, because there would then be no record
370 the customer ever purchased the item. Instead, see the cancel method.
375 # return "Can't delete cust_pkg records!";
378 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
380 Replaces the OLD_RECORD with this one in the database. If there is an error,
381 returns the error, otherwise returns false.
383 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
385 Changing pkgpart may have disasterous effects. See the order subroutine.
387 setup and bill are normally updated by calling the bill method of a customer
388 object (see L<FS::cust_main>).
390 suspend is normally updated by the suspend and unsuspend methods.
392 cancel is normally updated by the cancel method (and also the order subroutine
395 Available options are:
401 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.
405 the access_user (see L<FS::access_user>) providing the reason
409 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
418 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
423 ( ref($_[0]) eq 'HASH' )
427 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
428 return "Can't change otaker!" if $old->otaker ne $new->otaker;
431 #return "Can't change setup once it exists!"
432 # if $old->getfield('setup') &&
433 # $old->getfield('setup') != $new->getfield('setup');
435 #some logic for bill, susp, cancel?
437 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
439 local $SIG{HUP} = 'IGNORE';
440 local $SIG{INT} = 'IGNORE';
441 local $SIG{QUIT} = 'IGNORE';
442 local $SIG{TERM} = 'IGNORE';
443 local $SIG{TSTP} = 'IGNORE';
444 local $SIG{PIPE} = 'IGNORE';
446 my $oldAutoCommit = $FS::UID::AutoCommit;
447 local $FS::UID::AutoCommit = 0;
450 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
451 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
452 my $error = $new->insert_reason(
453 'reason' => $options->{'reason'},
454 'date' => $new->$method,
456 'reason_otaker' => $options->{'reason_otaker'},
459 dbh->rollback if $oldAutoCommit;
460 return "Error inserting cust_pkg_reason: $error";
465 #save off and freeze RADIUS attributes for any associated svc_acct records
467 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
469 #also check for specific exports?
470 # to avoid spurious modify export events
471 @svc_acct = map { $_->svc_x }
472 grep { $_->part_svc->svcdb eq 'svc_acct' }
475 $_->snapshot foreach @svc_acct;
479 my $error = $new->SUPER::replace($old,
480 $options->{options} ? $options->{options} : ()
483 $dbh->rollback if $oldAutoCommit;
487 #for prepaid packages,
488 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
489 foreach my $old_svc_acct ( @svc_acct ) {
490 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
491 my $s_error = $new_svc_acct->replace($old_svc_acct);
493 $dbh->rollback if $oldAutoCommit;
498 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
505 Checks all fields to make sure this is a valid billing item. If there is an
506 error, returns the error, otherwise returns false. Called by the insert and
514 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
517 $self->ut_numbern('pkgnum')
518 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
519 || $self->ut_numbern('pkgpart')
520 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
521 || $self->ut_numbern('start_date')
522 || $self->ut_numbern('setup')
523 || $self->ut_numbern('bill')
524 || $self->ut_numbern('susp')
525 || $self->ut_numbern('cancel')
526 || $self->ut_numbern('adjourn')
527 || $self->ut_numbern('expire')
528 || $self->ut_enum('no_auto', [ '', 'Y' ])
530 return $error if $error;
532 if ( $self->reg_code ) {
534 unless ( grep { $self->pkgpart == $_->pkgpart }
535 map { $_->reg_code_pkg }
536 qsearchs( 'reg_code', { 'code' => $self->reg_code,
537 'agentnum' => $self->cust_main->agentnum })
539 return "Unknown registration code";
542 } elsif ( $self->promo_code ) {
545 qsearchs('part_pkg', {
546 'pkgpart' => $self->pkgpart,
547 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
549 return 'Unknown promotional code' unless $promo_part_pkg;
553 unless ( $disable_agentcheck ) {
555 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
556 return "agent ". $agent->agentnum. ':'. $agent->agent.
557 " can't purchase pkgpart ". $self->pkgpart
558 unless $agent->pkgpart_hashref->{ $self->pkgpart }
559 || $agent->agentnum == $self->part_pkg->agentnum;
562 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
563 return $error if $error;
567 $self->otaker(getotaker) unless $self->otaker;
568 $self->otaker =~ /^(\w{1,32})$/ or return "Illegal otaker";
571 if ( $self->dbdef_table->column('manual_flag') ) {
572 $self->manual_flag('') if $self->manual_flag eq ' ';
573 $self->manual_flag =~ /^([01]?)$/
574 or return "Illegal manual_flag ". $self->manual_flag;
575 $self->manual_flag($1);
581 =item cancel [ OPTION => VALUE ... ]
583 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
584 in this package, then cancels the package itself (sets the cancel field to
587 Available options are:
591 =item quiet - can be set true to supress email cancellation notices.
593 =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.
595 =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.
597 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
599 =item nobill - can be set true to skip billing if it might otherwise be done.
603 If there is an error, returns the error, otherwise returns false.
608 my( $self, %options ) = @_;
611 my $conf = new FS::Conf;
613 warn "cust_pkg::cancel called with options".
614 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
617 local $SIG{HUP} = 'IGNORE';
618 local $SIG{INT} = 'IGNORE';
619 local $SIG{QUIT} = 'IGNORE';
620 local $SIG{TERM} = 'IGNORE';
621 local $SIG{TSTP} = 'IGNORE';
622 local $SIG{PIPE} = 'IGNORE';
624 my $oldAutoCommit = $FS::UID::AutoCommit;
625 local $FS::UID::AutoCommit = 0;
628 my $old = $self->select_for_update;
630 if ( $old->get('cancel') || $self->get('cancel') ) {
631 dbh->rollback if $oldAutoCommit;
632 return ""; # no error
635 my $date = $options{date} if $options{date}; # expire/cancel later
636 $date = '' if ($date && $date <= time); # complain instead?
638 #race condition: usage could be ongoing until unprovisioned
639 #resolved by performing a change package instead (which unprovisions) and
641 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
642 my $copy = $self->new({$self->hash});
644 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
645 warn "Error billing during cancel, custnum ".
646 #$self->cust_main->custnum. ": $error"
652 my $cancel_time = $options{'time'} || time;
654 if ( $options{'reason'} ) {
655 $error = $self->insert_reason( 'reason' => $options{'reason'},
656 'action' => $date ? 'expire' : 'cancel',
657 'date' => $date ? $date : $cancel_time,
658 'reason_otaker' => $options{'reason_otaker'},
661 dbh->rollback if $oldAutoCommit;
662 return "Error inserting cust_pkg_reason: $error";
668 foreach my $cust_svc (
671 sort { $a->[1] <=> $b->[1] }
672 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
673 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
676 my $error = $cust_svc->cancel;
679 $dbh->rollback if $oldAutoCommit;
680 return "Error cancelling cust_svc: $error";
684 # Add a credit for remaining service
685 my $remaining_value = $self->calc_remain(time=>$cancel_time);
686 if ( $remaining_value > 0 && !$options{'no_credit'} ) {
687 my $error = $self->cust_main->credit(
689 'Credit for unused time on '. $self->part_pkg->pkg,
690 'reason_type' => $conf->config('cancel_credit_type'),
693 $dbh->rollback if $oldAutoCommit;
694 return "Error crediting customer \$$remaining_value for unused time on".
695 $self->part_pkg->pkg. ": $error";
700 my %hash = $self->hash;
701 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
702 my $new = new FS::cust_pkg ( \%hash );
703 $error = $new->replace( $self, options => { $self->options } );
705 $dbh->rollback if $oldAutoCommit;
709 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
710 return '' if $date; #no errors
712 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
713 if ( !$options{'quiet'} && $conf->exists('emailcancel') && @invoicing_list ) {
714 my $error = send_email(
715 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
716 'to' => \@invoicing_list,
717 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
718 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
720 #should this do something on errors?
727 =item cancel_if_expired [ NOW_TIMESTAMP ]
729 Cancels this package if its expire date has been reached.
733 sub cancel_if_expired {
735 my $time = shift || time;
736 return '' unless $self->expire && $self->expire <= $time;
737 my $error = $self->cancel;
739 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
740 $self->custnum. ": $error";
747 Cancels any pending expiration (sets the expire field to null).
749 If there is an error, returns the error, otherwise returns false.
754 my( $self, %options ) = @_;
757 local $SIG{HUP} = 'IGNORE';
758 local $SIG{INT} = 'IGNORE';
759 local $SIG{QUIT} = 'IGNORE';
760 local $SIG{TERM} = 'IGNORE';
761 local $SIG{TSTP} = 'IGNORE';
762 local $SIG{PIPE} = 'IGNORE';
764 my $oldAutoCommit = $FS::UID::AutoCommit;
765 local $FS::UID::AutoCommit = 0;
768 my $old = $self->select_for_update;
770 my $pkgnum = $old->pkgnum;
771 if ( $old->get('cancel') || $self->get('cancel') ) {
772 dbh->rollback if $oldAutoCommit;
773 return "Can't unexpire cancelled package $pkgnum";
774 # or at least it's pointless
777 unless ( $old->get('expire') && $self->get('expire') ) {
778 dbh->rollback if $oldAutoCommit;
779 return ""; # no error
782 my %hash = $self->hash;
783 $hash{'expire'} = '';
784 my $new = new FS::cust_pkg ( \%hash );
785 $error = $new->replace( $self, options => { $self->options } );
787 $dbh->rollback if $oldAutoCommit;
791 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
797 =item suspend [ OPTION => VALUE ... ]
799 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
800 package, then suspends the package itself (sets the susp field to now).
802 Available options are:
806 =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.
808 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
812 If there is an error, returns the error, otherwise returns false.
817 my( $self, %options ) = @_;
820 local $SIG{HUP} = 'IGNORE';
821 local $SIG{INT} = 'IGNORE';
822 local $SIG{QUIT} = 'IGNORE';
823 local $SIG{TERM} = 'IGNORE';
824 local $SIG{TSTP} = 'IGNORE';
825 local $SIG{PIPE} = 'IGNORE';
827 my $oldAutoCommit = $FS::UID::AutoCommit;
828 local $FS::UID::AutoCommit = 0;
831 my $old = $self->select_for_update;
833 my $pkgnum = $old->pkgnum;
834 if ( $old->get('cancel') || $self->get('cancel') ) {
835 dbh->rollback if $oldAutoCommit;
836 return "Can't suspend cancelled package $pkgnum";
839 if ( $old->get('susp') || $self->get('susp') ) {
840 dbh->rollback if $oldAutoCommit;
841 return ""; # no error # complain on adjourn?
844 my $date = $options{date} if $options{date}; # adjourn/suspend later
845 $date = '' if ($date && $date <= time); # complain instead?
847 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
848 dbh->rollback if $oldAutoCommit;
849 return "Package $pkgnum expires before it would be suspended.";
852 my $suspend_time = $options{'time'} || time;
854 if ( $options{'reason'} ) {
855 $error = $self->insert_reason( 'reason' => $options{'reason'},
856 'action' => $date ? 'adjourn' : 'suspend',
857 'date' => $date ? $date : $suspend_time,
858 'reason_otaker' => $options{'reason_otaker'},
861 dbh->rollback if $oldAutoCommit;
862 return "Error inserting cust_pkg_reason: $error";
870 foreach my $cust_svc (
871 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
873 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
875 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
876 $dbh->rollback if $oldAutoCommit;
877 return "Illegal svcdb value in part_svc!";
880 require "FS/$svcdb.pm";
882 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
884 $error = $svc->suspend;
886 $dbh->rollback if $oldAutoCommit;
889 my( $label, $value ) = $cust_svc->label;
890 push @labels, "$label: $value";
894 my $conf = new FS::Conf;
895 if ( $conf->config('suspend_email_admin') ) {
897 my $error = send_email(
898 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
899 #invoice_from ??? well as good as any
900 'to' => $conf->config('suspend_email_admin'),
901 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
903 "This is an automatic message from your Freeside installation\n",
904 "informing you that the following customer package has been suspended:\n",
906 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
907 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
908 ( map { "Service : $_\n" } @labels ),
913 warn "WARNING: can't send suspension admin email (suspending anyway): ".
921 my %hash = $self->hash;
923 $hash{'adjourn'} = $date;
925 $hash{'susp'} = $suspend_time;
927 my $new = new FS::cust_pkg ( \%hash );
928 $error = $new->replace( $self, options => { $self->options } );
930 $dbh->rollback if $oldAutoCommit;
934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
939 =item unsuspend [ OPTION => VALUE ... ]
941 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
942 package, then unsuspends the package itself (clears the susp field and the
943 adjourn field if it is in the past).
945 Available options are:
949 =item adjust_next_bill
951 Can be set true to adjust the next bill date forward by
952 the amount of time the account was inactive. This was set true by default
953 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
954 explicitly requested. Price plans for which this makes sense (anniversary-date
955 based than prorate or subscription) could have an option to enable this
960 If there is an error, returns the error, otherwise returns false.
965 my( $self, %opt ) = @_;
968 local $SIG{HUP} = 'IGNORE';
969 local $SIG{INT} = 'IGNORE';
970 local $SIG{QUIT} = 'IGNORE';
971 local $SIG{TERM} = 'IGNORE';
972 local $SIG{TSTP} = 'IGNORE';
973 local $SIG{PIPE} = 'IGNORE';
975 my $oldAutoCommit = $FS::UID::AutoCommit;
976 local $FS::UID::AutoCommit = 0;
979 my $old = $self->select_for_update;
981 my $pkgnum = $old->pkgnum;
982 if ( $old->get('cancel') || $self->get('cancel') ) {
983 dbh->rollback if $oldAutoCommit;
984 return "Can't unsuspend cancelled package $pkgnum";
987 unless ( $old->get('susp') && $self->get('susp') ) {
988 dbh->rollback if $oldAutoCommit;
989 return ""; # no error # complain instead?
992 foreach my $cust_svc (
993 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
995 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
997 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
998 $dbh->rollback if $oldAutoCommit;
999 return "Illegal svcdb value in part_svc!";
1002 require "FS/$svcdb.pm";
1004 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1006 $error = $svc->unsuspend;
1008 $dbh->rollback if $oldAutoCommit;
1015 my %hash = $self->hash;
1016 my $inactive = time - $hash{'susp'};
1018 my $conf = new FS::Conf;
1020 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive
1021 if ( $opt{'adjust_next_bill'}
1022 || $conf->exists('unsuspend-always_adjust_next_bill_date') )
1023 && $inactive > 0 && ( $hash{'bill'} || $hash{'setup'} );
1026 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1027 my $new = new FS::cust_pkg ( \%hash );
1028 $error = $new->replace( $self, options => { $self->options } );
1030 $dbh->rollback if $oldAutoCommit;
1034 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1041 Cancels any pending suspension (sets the adjourn field to null).
1043 If there is an error, returns the error, otherwise returns false.
1048 my( $self, %options ) = @_;
1051 local $SIG{HUP} = 'IGNORE';
1052 local $SIG{INT} = 'IGNORE';
1053 local $SIG{QUIT} = 'IGNORE';
1054 local $SIG{TERM} = 'IGNORE';
1055 local $SIG{TSTP} = 'IGNORE';
1056 local $SIG{PIPE} = 'IGNORE';
1058 my $oldAutoCommit = $FS::UID::AutoCommit;
1059 local $FS::UID::AutoCommit = 0;
1062 my $old = $self->select_for_update;
1064 my $pkgnum = $old->pkgnum;
1065 if ( $old->get('cancel') || $self->get('cancel') ) {
1066 dbh->rollback if $oldAutoCommit;
1067 return "Can't unadjourn cancelled package $pkgnum";
1068 # or at least it's pointless
1071 if ( $old->get('susp') || $self->get('susp') ) {
1072 dbh->rollback if $oldAutoCommit;
1073 return "Can't unadjourn suspended package $pkgnum";
1074 # perhaps this is arbitrary
1077 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1078 dbh->rollback if $oldAutoCommit;
1079 return ""; # no error
1082 my %hash = $self->hash;
1083 $hash{'adjourn'} = '';
1084 my $new = new FS::cust_pkg ( \%hash );
1085 $error = $new->replace( $self, options => { $self->options } );
1087 $dbh->rollback if $oldAutoCommit;
1091 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1098 =item change HASHREF | OPTION => VALUE ...
1100 Changes this package: cancels it and creates a new one, with a different
1101 pkgpart or locationnum or both. All services are transferred to the new
1102 package (no change will be made if this is not possible).
1104 Options may be passed as a list of key/value pairs or as a hash reference.
1111 New locationnum, to change the location for this package.
1115 New FS::cust_location object, to create a new location and assign it
1120 New pkgpart (see L<FS::part_pkg>).
1124 New refnum (see L<FS::part_referral>).
1128 At least one option must be specified (otherwise, what's the point?)
1130 Returns either the new FS::cust_pkg object or a scalar error.
1134 my $err_or_new_cust_pkg = $old_cust_pkg->change
1138 #some false laziness w/order
1141 my $opt = ref($_[0]) ? shift : { @_ };
1143 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1146 my $conf = new FS::Conf;
1148 # Transactionize this whole mess
1149 local $SIG{HUP} = 'IGNORE';
1150 local $SIG{INT} = 'IGNORE';
1151 local $SIG{QUIT} = 'IGNORE';
1152 local $SIG{TERM} = 'IGNORE';
1153 local $SIG{TSTP} = 'IGNORE';
1154 local $SIG{PIPE} = 'IGNORE';
1156 my $oldAutoCommit = $FS::UID::AutoCommit;
1157 local $FS::UID::AutoCommit = 0;
1166 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1168 #$hash{$_} = $self->$_() foreach qw( setup );
1170 $hash{'setup'} = $time if $self->setup;
1172 $hash{'change_date'} = $time;
1173 $hash{"change_$_"} = $self->$_()
1174 foreach qw( pkgnum pkgpart locationnum );
1176 if ( $opt->{'cust_location'} &&
1177 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1178 $error = $opt->{'cust_location'}->insert;
1180 $dbh->rollback if $oldAutoCommit;
1181 return "inserting cust_location (transaction rolled back): $error";
1183 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1186 # Create the new package.
1187 my $cust_pkg = new FS::cust_pkg {
1188 custnum => $self->custnum,
1189 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1190 refnum => ( $opt->{'refnum'} || $self->refnum ),
1191 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1195 $error = $cust_pkg->insert( 'change' => 1 );
1197 $dbh->rollback if $oldAutoCommit;
1201 # Transfer services and cancel old package.
1203 $error = $self->transfer($cust_pkg);
1204 if ($error and $error == 0) {
1205 # $old_pkg->transfer failed.
1206 $dbh->rollback if $oldAutoCommit;
1210 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1211 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1212 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1213 if ($error and $error == 0) {
1214 # $old_pkg->transfer failed.
1215 $dbh->rollback if $oldAutoCommit;
1221 # Transfers were successful, but we still had services left on the old
1222 # package. We can't change the package under this circumstances, so abort.
1223 $dbh->rollback if $oldAutoCommit;
1224 return "Unable to transfer all services from package ". $self->pkgnum;
1227 #reset usage if changing pkgpart
1228 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1229 if ($self->pkgpart != $cust_pkg->pkgpart) {
1230 my $part_pkg = $cust_pkg->part_pkg;
1231 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1235 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover');
1238 $dbh->rollback if $oldAutoCommit;
1239 return "Error setting usage values: $error";
1243 #Good to go, cancel old package.
1244 $error = $self->cancel( quiet=>1 );
1246 $dbh->rollback if $oldAutoCommit;
1250 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1252 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1254 $dbh->rollback if $oldAutoCommit;
1259 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1267 Returns the last bill date, or if there is no last bill date, the setup date.
1268 Useful for billing metered services.
1274 return $self->setfield('last_bill', $_[0]) if @_;
1275 return $self->getfield('last_bill') if $self->getfield('last_bill');
1276 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1277 'edate' => $self->bill, } );
1278 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1281 =item last_cust_pkg_reason ACTION
1283 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1284 Returns false if there is no reason or the package is not currenly ACTION'd
1285 ACTION is one of adjourn, susp, cancel, or expire.
1289 sub last_cust_pkg_reason {
1290 my ( $self, $action ) = ( shift, shift );
1291 my $date = $self->get($action);
1293 'table' => 'cust_pkg_reason',
1294 'hashref' => { 'pkgnum' => $self->pkgnum,
1295 'action' => substr(uc($action), 0, 1),
1298 'order_by' => 'ORDER BY num DESC LIMIT 1',
1302 =item last_reason ACTION
1304 Returns the most recent ACTION FS::reason associated with the package.
1305 Returns false if there is no reason or the package is not currenly ACTION'd
1306 ACTION is one of adjourn, susp, cancel, or expire.
1311 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1312 $cust_pkg_reason->reason
1313 if $cust_pkg_reason;
1318 Returns the definition for this billing item, as an FS::part_pkg object (see
1325 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1326 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1327 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1332 Returns the cancelled package this package was changed from, if any.
1338 return '' unless $self->change_pkgnum;
1339 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1344 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1351 $self->part_pkg->calc_setup($self, @_);
1356 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1363 $self->part_pkg->calc_recur($self, @_);
1368 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1375 $self->part_pkg->calc_remain($self, @_);
1380 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1387 $self->part_pkg->calc_cancel($self, @_);
1392 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1398 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1401 =item cust_pkg_detail [ DETAILTYPE ]
1403 Returns any customer package details for this package (see
1404 L<FS::cust_pkg_detail>).
1406 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1410 sub cust_pkg_detail {
1412 my %hash = ( 'pkgnum' => $self->pkgnum );
1413 $hash{detailtype} = shift if @_;
1415 'table' => 'cust_pkg_detail',
1416 'hashref' => \%hash,
1417 'order_by' => 'ORDER BY weight, pkgdetailnum',
1421 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1423 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1425 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1427 If there is an error, returns the error, otherwise returns false.
1431 sub set_cust_pkg_detail {
1432 my( $self, $detailtype, @details ) = @_;
1434 local $SIG{HUP} = 'IGNORE';
1435 local $SIG{INT} = 'IGNORE';
1436 local $SIG{QUIT} = 'IGNORE';
1437 local $SIG{TERM} = 'IGNORE';
1438 local $SIG{TSTP} = 'IGNORE';
1439 local $SIG{PIPE} = 'IGNORE';
1441 my $oldAutoCommit = $FS::UID::AutoCommit;
1442 local $FS::UID::AutoCommit = 0;
1445 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1446 my $error = $current->delete;
1448 $dbh->rollback if $oldAutoCommit;
1449 return "error removing old detail: $error";
1453 foreach my $detail ( @details ) {
1454 my $cust_pkg_detail = new FS::cust_pkg_detail {
1455 'pkgnum' => $self->pkgnum,
1456 'detailtype' => $detailtype,
1457 'detail' => $detail,
1459 my $error = $cust_pkg_detail->insert;
1461 $dbh->rollback if $oldAutoCommit;
1462 return "error adding new detail: $error";
1467 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1474 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1478 #false laziness w/cust_bill.pm
1482 'table' => 'cust_event',
1483 'addl_from' => 'JOIN part_event USING ( eventpart )',
1484 'hashref' => { 'tablenum' => $self->pkgnum },
1485 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1489 =item num_cust_event
1491 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1495 #false laziness w/cust_bill.pm
1496 sub num_cust_event {
1499 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1500 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1501 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1502 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1503 $sth->fetchrow_arrayref->[0];
1506 =item cust_svc [ SVCPART ]
1508 Returns the services for this package, as FS::cust_svc objects (see
1509 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1517 return () unless $self->num_cust_svc(@_);
1520 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1521 'svcpart' => shift, } );
1524 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1526 #if ( $self->{'_svcnum'} ) {
1527 # values %{ $self->{'_svcnum'}->cache };
1529 $self->_sort_cust_svc(
1530 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1536 =item overlimit [ SVCPART ]
1538 Returns the services for this package which have exceeded their
1539 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1540 is specified, return only the matching services.
1546 return () unless $self->num_cust_svc(@_);
1547 grep { $_->overlimit } $self->cust_svc(@_);
1550 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ]
1552 Returns historical services for this package created before END TIMESTAMP and
1553 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1554 (see L<FS::h_cust_svc>).
1561 $self->_sort_cust_svc(
1562 [ qsearch( 'h_cust_svc',
1563 { 'pkgnum' => $self->pkgnum, },
1564 FS::h_cust_svc->sql_h_search(@_),
1570 sub _sort_cust_svc {
1571 my( $self, $arrayref ) = @_;
1574 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1579 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1580 'svcpart' => $_->svcpart } );
1582 $pkg_svc ? $pkg_svc->primary_svc : '',
1583 $pkg_svc ? $pkg_svc->quantity : 0,
1590 =item num_cust_svc [ SVCPART ]
1592 Returns the number of provisioned services for this package. If a svcpart is
1593 specified, counts only the matching services.
1600 return $self->{'_num_cust_svc'}
1602 && exists($self->{'_num_cust_svc'})
1603 && $self->{'_num_cust_svc'} =~ /\d/;
1605 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1608 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1609 $sql .= ' AND svcpart = ?' if @_;
1611 my $sth = dbh->prepare($sql) or die dbh->errstr;
1612 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1613 $sth->fetchrow_arrayref->[0];
1616 =item available_part_svc
1618 Returns a list of FS::part_svc objects representing services included in this
1619 package but not yet provisioned. Each FS::part_svc object also has an extra
1620 field, I<num_avail>, which specifies the number of available services.
1624 sub available_part_svc {
1626 grep { $_->num_avail > 0 }
1628 my $part_svc = $_->part_svc;
1629 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1630 $_->quantity - $self->num_cust_svc($_->svcpart);
1633 $self->part_pkg->pkg_svc;
1638 Returns a list of FS::part_svc objects representing provisioned and available
1639 services included in this package. Each FS::part_svc object also has the
1640 following extra fields:
1644 =item num_cust_svc (count)
1646 =item num_avail (quantity - count)
1648 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1651 label -> ($cust_svc->label)[1]
1660 #XXX some sort of sort order besides numeric by svcpart...
1661 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1663 my $part_svc = $pkg_svc->part_svc;
1664 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1665 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1666 $part_svc->{'Hash'}{'num_avail'} =
1667 max( 0, $pkg_svc->quantity - $num_cust_svc );
1668 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1669 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1671 } $self->part_pkg->pkg_svc;
1674 push @part_svc, map {
1676 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1677 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1678 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1679 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1680 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1682 } $self->extra_part_svc;
1688 =item extra_part_svc
1690 Returns a list of FS::part_svc objects corresponding to services in this
1691 package which are still provisioned but not (any longer) available in the
1696 sub extra_part_svc {
1699 my $pkgnum = $self->pkgnum;
1700 my $pkgpart = $self->pkgpart;
1703 # 'table' => 'part_svc',
1706 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1707 # WHERE pkg_svc.svcpart = part_svc.svcpart
1708 # AND pkg_svc.pkgpart = ?
1711 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1712 # LEFT JOIN cust_pkg USING ( pkgnum )
1713 # WHERE cust_svc.svcpart = part_svc.svcpart
1716 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1719 #seems to benchmark slightly faster...
1721 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1722 #MySQL doesn't grok DISINCT ON
1723 'select' => 'DISTINCT part_svc.*',
1724 'table' => 'part_svc',
1726 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1727 AND pkg_svc.pkgpart = ?
1730 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1731 LEFT JOIN cust_pkg USING ( pkgnum )
1734 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1735 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1741 Returns a short status string for this package, currently:
1745 =item not yet billed
1747 =item one-time charge
1762 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1764 return 'cancelled' if $self->get('cancel');
1765 return 'suspended' if $self->susp;
1766 return 'not yet billed' unless $self->setup;
1767 return 'one-time charge' if $freq =~ /^(0|$)/;
1773 Class method that returns the list of possible status strings for packages
1774 (see L<the status method|/status>). For example:
1776 @statuses = FS::cust_pkg->statuses();
1780 tie my %statuscolor, 'Tie::IxHash',
1781 'not yet billed' => '000000',
1782 'one-time charge' => '000000',
1783 'active' => '00CC00',
1784 'suspended' => 'FF9900',
1785 'cancelled' => 'FF0000',
1789 my $self = shift; #could be class...
1790 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
1791 # # mayble split btw one-time vs. recur
1797 Returns a hex triplet color string for this package's status.
1803 $statuscolor{$self->status};
1808 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
1809 "pkg-comment" depending on user preference).
1815 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
1816 $label = $self->pkgnum. ": $label"
1817 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
1821 =item pkg_label_long
1823 Returns a long label for this package, adding the primary service's label to
1828 sub pkg_label_long {
1830 my $label = $self->pkg_label;
1831 my $cust_svc = $self->primary_cust_svc;
1832 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
1836 =item primary_cust_svc
1838 Returns a primary service (as FS::cust_svc object) if one can be identified.
1842 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
1844 sub primary_cust_svc {
1847 my @cust_svc = $self->cust_svc;
1849 return '' unless @cust_svc; #no serivces - irrelevant then
1851 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
1853 # primary service as specified in the package definition
1854 # or exactly one service definition with quantity one
1855 my $svcpart = $self->part_pkg->svcpart;
1856 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
1857 return $cust_svc[0] if scalar(@cust_svc) == 1;
1859 #couldn't identify one thing..
1865 Returns a list of lists, calling the label method for all services
1866 (see L<FS::cust_svc>) of this billing item.
1872 map { [ $_->label ] } $self->cust_svc;
1875 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ]
1877 Like the labels method, but returns historical information on services that
1878 were active as of END_TIMESTAMP and (optionally) not cancelled before
1881 Returns a list of lists, calling the label method for all (historical) services
1882 (see L<FS::h_cust_svc>) of this billing item.
1888 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
1893 Like labels, except returns a simple flat list, and shortens long
1894 (currently >5 or the cust_bill-max_same_services configuration value) lists of
1895 identical services to one line that lists the service label and the number of
1896 individual services rather than individual items.
1901 shift->_labels_short( 'labels', @_ );
1904 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
1906 Like h_labels, except returns a simple flat list, and shortens long
1907 (currently >5 or the cust_bill-max_same_services configuration value) lists of
1908 identical services to one line that lists the service label and the number of
1909 individual services rather than individual items.
1913 sub h_labels_short {
1914 shift->_labels_short( 'h_labels', @_ );
1918 my( $self, $method ) = ( shift, shift );
1920 my $conf = new FS::Conf;
1921 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
1924 #tie %labels, 'Tie::IxHash';
1925 push @{ $labels{$_->[0]} }, $_->[1]
1926 foreach $self->h_labels(@_);
1928 foreach my $label ( keys %labels ) {
1930 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
1931 my $num = scalar(@values);
1932 if ( $num > $max_same_services ) {
1933 push @labels, "$label ($num)";
1935 if ( $conf->exists('cust_bill-consolidate_services') ) {
1936 # push @labels, "$label: ". join(', ', @values);
1938 my $detail = "$label: ";
1939 $detail .= shift(@values). ', '
1940 while @values && length($detail.$values[0]) < 78;
1942 push @labels, $detail;
1945 push @labels, map { "$label: $_" } @values;
1956 Returns the parent customer object (see L<FS::cust_main>).
1962 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1965 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
1969 Returns the location object, if any (see L<FS::cust_location>).
1971 =item cust_location_or_main
1973 If this package is associated with a location, returns the locaiton (see
1974 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
1976 =item location_label [ OPTION => VALUE ... ]
1978 Returns the label of the location object (see L<FS::cust_location>).
1982 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
1984 =item seconds_since TIMESTAMP
1986 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
1987 package have been online since TIMESTAMP, according to the session monitor.
1989 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1990 L<Time::Local> and L<Date::Parse> for conversion functions.
1995 my($self, $since) = @_;
1998 foreach my $cust_svc (
1999 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2001 $seconds += $cust_svc->seconds_since($since);
2008 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2010 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2011 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2014 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2015 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2021 sub seconds_since_sqlradacct {
2022 my($self, $start, $end) = @_;
2026 foreach my $cust_svc (
2028 my $part_svc = $_->part_svc;
2029 $part_svc->svcdb eq 'svc_acct'
2030 && scalar($part_svc->part_export('sqlradius'));
2033 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2040 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2042 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2043 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2047 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2048 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2053 sub attribute_since_sqlradacct {
2054 my($self, $start, $end, $attrib) = @_;
2058 foreach my $cust_svc (
2060 my $part_svc = $_->part_svc;
2061 $part_svc->svcdb eq 'svc_acct'
2062 && scalar($part_svc->part_export('sqlradius'));
2065 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2077 my( $self, $value ) = @_;
2078 if ( defined($value) ) {
2079 $self->setfield('quantity', $value);
2081 $self->getfield('quantity') || 1;
2084 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2086 Transfers as many services as possible from this package to another package.
2088 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2089 object. The destination package must already exist.
2091 Services are moved only if the destination allows services with the correct
2092 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2093 this option with caution! No provision is made for export differences
2094 between the old and new service definitions. Probably only should be used
2095 when your exports for all service definitions of a given svcdb are identical.
2096 (attempt a transfer without it first, to move all possible svcpart-matching
2099 Any services that can't be moved remain in the original package.
2101 Returns an error, if there is one; otherwise, returns the number of services
2102 that couldn't be moved.
2107 my ($self, $dest_pkgnum, %opt) = @_;
2113 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2114 $dest = $dest_pkgnum;
2115 $dest_pkgnum = $dest->pkgnum;
2117 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2120 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2122 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2123 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2126 foreach my $cust_svc ($dest->cust_svc) {
2127 $target{$cust_svc->svcpart}--;
2130 my %svcpart2svcparts = ();
2131 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2132 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2133 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2134 next if exists $svcpart2svcparts{$svcpart};
2135 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2136 $svcpart2svcparts{$svcpart} = [
2138 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2140 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2141 'svcpart' => $_ } );
2143 $pkg_svc ? $pkg_svc->primary_svc : '',
2144 $pkg_svc ? $pkg_svc->quantity : 0,
2148 grep { $_ != $svcpart }
2150 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2152 warn "alternates for svcpart $svcpart: ".
2153 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2158 foreach my $cust_svc ($self->cust_svc) {
2159 if($target{$cust_svc->svcpart} > 0) {
2160 $target{$cust_svc->svcpart}--;
2161 my $new = new FS::cust_svc { $cust_svc->hash };
2162 $new->pkgnum($dest_pkgnum);
2163 my $error = $new->replace($cust_svc);
2164 return $error if $error;
2165 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2167 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2168 warn "alternates to consider: ".
2169 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2171 my @alternate = grep {
2172 warn "considering alternate svcpart $_: ".
2173 "$target{$_} available in new package\n"
2176 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2178 warn "alternate(s) found\n" if $DEBUG;
2179 my $change_svcpart = $alternate[0];
2180 $target{$change_svcpart}--;
2181 my $new = new FS::cust_svc { $cust_svc->hash };
2182 $new->svcpart($change_svcpart);
2183 $new->pkgnum($dest_pkgnum);
2184 my $error = $new->replace($cust_svc);
2185 return $error if $error;
2198 This method is deprecated. See the I<depend_jobnum> option to the insert and
2199 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2206 local $SIG{HUP} = 'IGNORE';
2207 local $SIG{INT} = 'IGNORE';
2208 local $SIG{QUIT} = 'IGNORE';
2209 local $SIG{TERM} = 'IGNORE';
2210 local $SIG{TSTP} = 'IGNORE';
2211 local $SIG{PIPE} = 'IGNORE';
2213 my $oldAutoCommit = $FS::UID::AutoCommit;
2214 local $FS::UID::AutoCommit = 0;
2217 foreach my $cust_svc ( $self->cust_svc ) {
2218 #false laziness w/svc_Common::insert
2219 my $svc_x = $cust_svc->svc_x;
2220 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2221 my $error = $part_export->export_insert($svc_x);
2223 $dbh->rollback if $oldAutoCommit;
2229 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2236 Associates this package with a (suspension or cancellation) reason (see
2237 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2240 Available options are:
2246 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.
2250 the access_user (see L<FS::access_user>) providing the reason
2258 the action (cancel, susp, adjourn, expire) associated with the reason
2262 If there is an error, returns the error, otherwise returns false.
2267 my ($self, %options) = @_;
2269 my $otaker = $options{reason_otaker} ||
2270 $FS::CurrentUser::CurrentUser->username;
2273 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2277 } elsif ( ref($options{'reason'}) ) {
2279 return 'Enter a new reason (or select an existing one)'
2280 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2282 my $reason = new FS::reason({
2283 'reason_type' => $options{'reason'}->{'typenum'},
2284 'reason' => $options{'reason'}->{'reason'},
2286 my $error = $reason->insert;
2287 return $error if $error;
2289 $reasonnum = $reason->reasonnum;
2292 return "Unparsable reason: ". $options{'reason'};
2295 my $cust_pkg_reason =
2296 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2297 'reasonnum' => $reasonnum,
2298 'otaker' => $otaker,
2299 'action' => substr(uc($options{'action'}),0,1),
2300 'date' => $options{'date'}
2305 $cust_pkg_reason->insert;
2308 =item insert_discount
2310 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2311 inserting a new discount on the fly (see L<FS::discount>).
2313 Available options are:
2321 If there is an error, returns the error, otherwise returns false.
2325 sub insert_discount {
2326 #my ($self, %options) = @_;
2329 my $cust_pkg_discount = new FS::cust_pkg_discount {
2330 'pkgnum' => $self->pkgnum,
2331 'discountnum' => $self->discountnum,
2333 'end_date' => '', #XXX
2334 'otaker' => $self->otaker,
2335 #for the create a new discount case
2336 '_type' => $self->discountnum__type,
2337 'amount' => $self->discountnum_amount,
2338 'percent' => $self->discountnum_percent,
2339 'months' => $self->discountnum_months,
2340 #'disabled' => $self->discountnum_disabled,
2343 $cust_pkg_discount->insert;
2346 =item set_usage USAGE_VALUE_HASHREF
2348 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2349 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2350 upbytes, downbytes, and totalbytes are appropriate keys.
2352 All svc_accts which are part of this package have their values reset.
2357 my ($self, $valueref, %opt) = @_;
2359 foreach my $cust_svc ($self->cust_svc){
2360 my $svc_x = $cust_svc->svc_x;
2361 $svc_x->set_usage($valueref, %opt)
2362 if $svc_x->can("set_usage");
2366 =item recharge USAGE_VALUE_HASHREF
2368 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2369 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2370 upbytes, downbytes, and totalbytes are appropriate keys.
2372 All svc_accts which are part of this package have their values incremented.
2377 my ($self, $valueref) = @_;
2379 foreach my $cust_svc ($self->cust_svc){
2380 my $svc_x = $cust_svc->svc_x;
2381 $svc_x->recharge($valueref)
2382 if $svc_x->can("recharge");
2386 =item cust_pkg_discount
2390 sub cust_pkg_discount {
2392 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2395 =item cust_pkg_discount_active
2399 sub cust_pkg_discount_active {
2401 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2406 =head1 CLASS METHODS
2412 Returns an SQL expression identifying recurring packages.
2416 sub recurring_sql { "
2417 '0' != ( select freq from part_pkg
2418 where cust_pkg.pkgpart = part_pkg.pkgpart )
2423 Returns an SQL expression identifying one-time packages.
2428 '0' = ( select freq from part_pkg
2429 where cust_pkg.pkgpart = part_pkg.pkgpart )
2434 Returns an SQL expression identifying active packages.
2439 ". $_[0]->recurring_sql(). "
2440 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2441 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2442 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2445 =item not_yet_billed_sql
2447 Returns an SQL expression identifying packages which have not yet been billed.
2451 sub not_yet_billed_sql { "
2452 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2453 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2454 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2459 Returns an SQL expression identifying inactive packages (one-time packages
2460 that are otherwise unsuspended/uncancelled).
2464 sub inactive_sql { "
2465 ". $_[0]->onetime_sql(). "
2466 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2467 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2468 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2474 Returns an SQL expression identifying suspended packages.
2478 sub suspended_sql { susp_sql(@_); }
2480 #$_[0]->recurring_sql(). ' AND '.
2482 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2483 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2490 Returns an SQL exprression identifying cancelled packages.
2494 sub cancelled_sql { cancel_sql(@_); }
2496 #$_[0]->recurring_sql(). ' AND '.
2497 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2500 =item search HASHREF
2504 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2505 Valid parameters are
2513 active, inactive, suspended, cancel (or cancelled)
2517 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2521 boolean selects custom packages
2527 pkgpart or arrayref or hashref of pkgparts
2531 arrayref of beginning and ending epoch date
2535 arrayref of beginning and ending epoch date
2539 arrayref of beginning and ending epoch date
2543 arrayref of beginning and ending epoch date
2547 arrayref of beginning and ending epoch date
2551 arrayref of beginning and ending epoch date
2555 arrayref of beginning and ending epoch date
2559 pkgnum or APKG_pkgnum
2563 a value suited to passing to FS::UI::Web::cust_header
2567 specifies the user for agent virtualization
2574 my ($class, $params) = @_;
2581 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2583 "cust_main.agentnum = $1";
2590 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2592 "cust_pkg.custnum = $1";
2599 if ( $params->{'magic'} eq 'active'
2600 || $params->{'status'} eq 'active' ) {
2602 push @where, FS::cust_pkg->active_sql();
2604 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2605 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2607 push @where, FS::cust_pkg->not_yet_billed_sql();
2609 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2610 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2612 push @where, FS::cust_pkg->inactive_sql();
2614 } elsif ( $params->{'magic'} eq 'suspended'
2615 || $params->{'status'} eq 'suspended' ) {
2617 push @where, FS::cust_pkg->suspended_sql();
2619 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2620 || $params->{'status'} =~ /^cancell?ed$/ ) {
2622 push @where, FS::cust_pkg->cancelled_sql();
2627 # parse package class
2630 #false lazinessish w/graph/cust_bill_pkg.cgi
2633 if ( exists($params->{'classnum'})
2634 && $params->{'classnum'} =~ /^(\d*)$/
2638 if ( $classnum ) { #a specific class
2639 push @where, "part_pkg.classnum = $classnum";
2641 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2642 #die "classnum $classnum not found!" unless $pkg_class[0];
2643 #$title .= $pkg_class[0]->classname.' ';
2645 } elsif ( $classnum eq '' ) { #the empty class
2647 push @where, "part_pkg.classnum IS NULL";
2648 #$title .= 'Empty class ';
2649 #@pkg_class = ( '(empty class)' );
2650 } elsif ( $classnum eq '0' ) {
2651 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2652 #push @pkg_class, '(empty class)';
2654 die "illegal classnum";
2660 # parse package report options
2663 my @report_option = ();
2664 if ( exists($params->{'report_option'})
2665 && $params->{'report_option'} =~ /^([,\d]*)$/
2668 @report_option = split(',', $1);
2671 if (@report_option) {
2672 # this will result in the empty set for the dangling comma case as it should
2674 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2675 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2676 AND optionname = 'report_option_$_'
2677 AND optionvalue = '1' )"
2687 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
2693 if ( exists($params->{'censustract'}) ) {
2694 $params->{'censustract'} =~ /^([.\d]*)$/;
2695 my $censustract = "cust_main.censustract = '$1'";
2696 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
2697 push @where, "( $censustract )";
2704 if ( ref($params->{'pkgpart'}) ) {
2707 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
2708 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
2709 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
2710 @pkgpart = @{ $params->{'pkgpart'} };
2712 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
2715 @pkgpart = grep /^(\d+)$/, @pkgpart;
2717 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
2719 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2720 push @where, "pkgpart = $1";
2729 #false laziness w/report_cust_pkg.html
2732 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
2733 'active' => { 'susp'=>1, 'cancel'=>1 },
2734 'suspended' => { 'cancel' => 1 },
2739 foreach my $field (qw( setup last_bill bill adjourn susp expire cancel )) {
2741 next unless exists($params->{$field});
2743 my($beginning, $ending) = @{$params->{$field}};
2745 next if $beginning == 0 && $ending == 4294967295;
2748 "cust_pkg.$field IS NOT NULL",
2749 "cust_pkg.$field >= $beginning",
2750 "cust_pkg.$field <= $ending";
2752 $orderby ||= "ORDER BY cust_pkg.$field";
2756 $orderby ||= 'ORDER BY bill';
2759 # parse magic, legacy, etc.
2762 if ( $params->{'magic'} &&
2763 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
2766 $orderby = 'ORDER BY pkgnum';
2768 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2769 push @where, "pkgpart = $1";
2772 } elsif ( $params->{'query'} eq 'pkgnum' ) {
2774 $orderby = 'ORDER BY pkgnum';
2776 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
2778 $orderby = 'ORDER BY pkgnum';
2781 SELECT count(*) FROM pkg_svc
2782 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
2783 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
2784 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
2785 AND cust_svc.svcpart = pkg_svc.svcpart
2792 # setup queries, links, subs, etc. for the search
2795 # here is the agent virtualization
2796 if ($params->{CurrentUser}) {
2798 qsearchs('access_user', { username => $params->{CurrentUser} });
2801 push @where, $access_user->agentnums_sql('table'=>'cust_main');
2806 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
2809 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2811 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
2812 'LEFT JOIN part_pkg USING ( pkgpart ) '.
2813 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
2815 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
2818 'table' => 'cust_pkg',
2820 'select' => join(', ',
2822 ( map "part_pkg.$_", qw( pkg freq ) ),
2823 'pkg_class.classname',
2824 'cust_main.custnum AS cust_main_custnum',
2825 FS::UI::Web::cust_sql_fields(
2826 $params->{'cust_fields'}
2829 'extra_sql' => "$extra_sql $orderby",
2830 'addl_from' => $addl_from,
2831 'count_query' => $count_query,
2838 Returns a list: the first item is an SQL fragment identifying matching
2839 packages/customers via location (taking into account shipping and package
2840 address taxation, if enabled), and subsequent items are the parameters to
2841 substitute for the placeholders in that fragment.
2846 my($class, %opt) = @_;
2847 my $ornull = $opt{'ornull'};
2849 my $conf = new FS::Conf;
2851 # '?' placeholders in _location_sql_where
2852 my $x = $ornull ? 3 : 2;
2853 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
2857 if ( $conf->exists('tax-ship_address') ) {
2860 ( ( ship_last IS NULL OR ship_last = '' )
2861 AND ". _location_sql_where('cust_main', '', $ornull ). "
2863 OR ( ship_last IS NOT NULL AND ship_last != ''
2864 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
2867 # AND payby != 'COMP'
2869 @main_param = ( @bill_param, @bill_param );
2873 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
2874 @main_param = @bill_param;
2880 if ( $conf->exists('tax-pkg_address') ) {
2882 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
2885 ( cust_pkg.locationnum IS NULL AND $main_where )
2886 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
2889 @param = ( @main_param, @bill_param );
2893 $where = $main_where;
2894 @param = @main_param;
2902 #subroutine, helper for location_sql
2903 sub _location_sql_where {
2905 my $prefix = @_ ? shift : '';
2906 my $ornull = @_ ? shift : '';
2908 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
2910 $ornull = $ornull ? ' OR ? IS NULL ' : '';
2912 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
2913 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
2914 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
2916 # ( $table.${prefix}city = ? $or_empty_city $ornull )
2918 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
2919 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
2920 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
2921 AND $table.${prefix}country = ?
2929 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
2931 CUSTNUM is a customer (see L<FS::cust_main>)
2933 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
2934 L<FS::part_pkg>) to order for this customer. Duplicates are of course
2937 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
2938 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
2939 new billing items. An error is returned if this is not possible (see
2940 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
2943 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
2944 newly-created cust_pkg objects.
2946 REFNUM, if specified, will specify the FS::pkg_referral record to be created
2947 and inserted. Multiple FS::pkg_referral records can be created by
2948 setting I<refnum> to an array reference of refnums or a hash reference with
2949 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
2950 record will be created corresponding to cust_main.refnum.
2955 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
2957 my $conf = new FS::Conf;
2959 # Transactionize this whole mess
2960 local $SIG{HUP} = 'IGNORE';
2961 local $SIG{INT} = 'IGNORE';
2962 local $SIG{QUIT} = 'IGNORE';
2963 local $SIG{TERM} = 'IGNORE';
2964 local $SIG{TSTP} = 'IGNORE';
2965 local $SIG{PIPE} = 'IGNORE';
2967 my $oldAutoCommit = $FS::UID::AutoCommit;
2968 local $FS::UID::AutoCommit = 0;
2972 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
2973 # return "Customer not found: $custnum" unless $cust_main;
2975 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
2978 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
2981 my $change = scalar(@old_cust_pkg) != 0;
2984 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
2986 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
2987 " to pkgpart ". $pkgparts->[0]. "\n"
2990 my $err_or_cust_pkg =
2991 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
2992 'refnum' => $refnum,
2995 unless (ref($err_or_cust_pkg)) {
2996 $dbh->rollback if $oldAutoCommit;
2997 return $err_or_cust_pkg;
3000 push @$return_cust_pkg, $err_or_cust_pkg;
3001 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3006 # Create the new packages.
3007 foreach my $pkgpart (@$pkgparts) {
3009 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3011 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3012 pkgpart => $pkgpart,
3016 $error = $cust_pkg->insert( 'change' => $change );
3018 $dbh->rollback if $oldAutoCommit;
3021 push @$return_cust_pkg, $cust_pkg;
3023 # $return_cust_pkg now contains refs to all of the newly
3026 # Transfer services and cancel old packages.
3027 foreach my $old_pkg (@old_cust_pkg) {
3029 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3032 foreach my $new_pkg (@$return_cust_pkg) {
3033 $error = $old_pkg->transfer($new_pkg);
3034 if ($error and $error == 0) {
3035 # $old_pkg->transfer failed.
3036 $dbh->rollback if $oldAutoCommit;
3041 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3042 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3043 foreach my $new_pkg (@$return_cust_pkg) {
3044 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3045 if ($error and $error == 0) {
3046 # $old_pkg->transfer failed.
3047 $dbh->rollback if $oldAutoCommit;
3054 # Transfers were successful, but we went through all of the
3055 # new packages and still had services left on the old package.
3056 # We can't cancel the package under the circumstances, so abort.
3057 $dbh->rollback if $oldAutoCommit;
3058 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3060 $error = $old_pkg->cancel( quiet=>1 );
3066 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3070 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3072 A bulk change method to change packages for multiple customers.
3074 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3075 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3078 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3079 replace. The services (see L<FS::cust_svc>) are moved to the
3080 new billing items. An error is returned if this is not possible (see
3083 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3084 newly-created cust_pkg objects.
3089 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3091 # Transactionize this whole mess
3092 local $SIG{HUP} = 'IGNORE';
3093 local $SIG{INT} = 'IGNORE';
3094 local $SIG{QUIT} = 'IGNORE';
3095 local $SIG{TERM} = 'IGNORE';
3096 local $SIG{TSTP} = 'IGNORE';
3097 local $SIG{PIPE} = 'IGNORE';
3099 my $oldAutoCommit = $FS::UID::AutoCommit;
3100 local $FS::UID::AutoCommit = 0;
3104 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3107 while(scalar(@old_cust_pkg)) {
3109 my $custnum = $old_cust_pkg[0]->custnum;
3110 my (@remove) = map { $_->pkgnum }
3111 grep { $_->custnum == $custnum } @old_cust_pkg;
3112 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3114 my $error = order $custnum, $pkgparts, \@remove, \@return;
3116 push @errors, $error
3118 push @$return_cust_pkg, @return;
3121 if (scalar(@errors)) {
3122 $dbh->rollback if $oldAutoCommit;
3123 return join(' / ', @errors);
3126 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3134 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3136 In sub order, the @pkgparts array (passed by reference) is clobbered.
3138 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3139 method to pass dates to the recur_prog expression, it should do so.
3141 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3142 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3143 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3144 configuration values. Probably need a subroutine which decides what to do
3145 based on whether or not we've fetched the user yet, rather than a hash. See
3146 FS::UID and the TODO.
3148 Now that things are transactional should the check in the insert method be
3153 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3154 L<FS::pkg_svc>, schema.html from the base documentation