4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common );
6 use vars qw($disable_agentcheck $DEBUG $me);
8 use Scalar::Util qw( blessed );
9 use List::Util qw(max);
11 use Time::Local qw( timelocal_nocheck );
13 use FS::UID qw( getotaker dbh );
14 use FS::Misc qw( send_email );
15 use FS::Record qw( qsearch qsearchs );
20 use FS::cust_location;
22 use FS::cust_bill_pkg;
23 use FS::cust_pkg_detail;
28 use FS::cust_pkg_reason;
30 use FS::cust_pkg_discount;
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)
166 order taker (see L<FS::access_user>)
170 If this field is set to 1, disables the automatic
171 unsuspension of this package when using the B<unsuspendauto> config option.
175 If not set, defaults to 1
179 Date of change from previous package
189 =item change_locationnum
195 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
196 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
197 L<Time::Local> and L<Date::Parse> for conversion functions.
205 Create a new billing item. To add the item to the database, see L<"insert">.
209 sub table { 'cust_pkg'; }
210 sub cust_linked { $_[0]->cust_main_custnum; }
211 sub cust_unlinked_msg {
213 "WARNING: can't find cust_main.custnum ". $self->custnum.
214 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
217 =item insert [ OPTION => VALUE ... ]
219 Adds this billing item to the database ("Orders" the item). If there is an
220 error, returns the error, otherwise returns false.
222 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
223 will be used to look up the package definition and agent restrictions will be
226 If the additional field I<refnum> is defined, an FS::pkg_referral record will
227 be created and inserted. Multiple FS::pkg_referral records can be created by
228 setting I<refnum> to an array reference of refnums or a hash reference with
229 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
230 record will be created corresponding to cust_main.refnum.
232 The following options are available:
238 If set true, supresses any referral credit to a referring customer.
242 cust_pkg_option records will be created
246 a ticket will be added to this customer with this subject
250 an optional queue name for ticket additions
257 my( $self, %options ) = @_;
259 if ( $self->part_pkg->option('start_1st', 1) && !$self->start_date ) {
260 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
261 $mon += 1 unless $mday == 1;
262 until ( $mon < 12 ) { $mon -= 12; $year++; }
263 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
266 foreach my $action ( qw(expire adjourn contract_end) ) {
267 my $months = $self->part_pkg->option("${action}_months",1);
268 if($months and !$self->$action) {
269 my $start = $self->start_date || $self->setup || time;
270 $self->$action( $self->part_pkg->add_freq($start, $months) );
274 local $SIG{HUP} = 'IGNORE';
275 local $SIG{INT} = 'IGNORE';
276 local $SIG{QUIT} = 'IGNORE';
277 local $SIG{TERM} = 'IGNORE';
278 local $SIG{TSTP} = 'IGNORE';
279 local $SIG{PIPE} = 'IGNORE';
281 my $oldAutoCommit = $FS::UID::AutoCommit;
282 local $FS::UID::AutoCommit = 0;
285 my $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
287 $dbh->rollback if $oldAutoCommit;
291 $self->refnum($self->cust_main->refnum) unless $self->refnum;
292 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
293 $self->process_m2m( 'link_table' => 'pkg_referral',
294 'target_table' => 'part_referral',
295 'params' => $self->refnum,
298 if ( $self->discountnum ) {
299 my $error = $self->insert_discount();
301 $dbh->rollback if $oldAutoCommit;
306 #if ( $self->reg_code ) {
307 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
308 # $error = $reg_code->delete;
310 # $dbh->rollback if $oldAutoCommit;
315 my $conf = new FS::Conf;
317 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
320 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
327 use FS::TicketSystem;
328 FS::TicketSystem->init();
330 my $q = new RT::Queue($RT::SystemUser);
331 $q->Load($options{ticket_queue}) if $options{ticket_queue};
332 my $t = new RT::Ticket($RT::SystemUser);
333 my $mime = new MIME::Entity;
334 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
335 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
336 Subject => $options{ticket_subject},
339 $t->AddLink( Type => 'MemberOf',
340 Target => 'freeside://freeside/cust_main/'. $self->custnum,
344 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
345 my $queue = new FS::queue {
346 'job' => 'FS::cust_main::queueable_print',
348 $error = $queue->insert(
349 'custnum' => $self->custnum,
350 'template' => 'welcome_letter',
354 warn "can't send welcome letter: $error";
359 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
366 This method now works but you probably shouldn't use it.
368 You don't want to delete billing items, because there would then be no record
369 the customer ever purchased the item. Instead, see the cancel method.
374 # return "Can't delete cust_pkg records!";
377 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
379 Replaces the OLD_RECORD with this one in the database. If there is an error,
380 returns the error, otherwise returns false.
382 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
384 Changing pkgpart may have disasterous effects. See the order subroutine.
386 setup and bill are normally updated by calling the bill method of a customer
387 object (see L<FS::cust_main>).
389 suspend is normally updated by the suspend and unsuspend methods.
391 cancel is normally updated by the cancel method (and also the order subroutine
394 Available options are:
400 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.
404 the access_user (see L<FS::access_user>) providing the reason
408 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
417 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
422 ( ref($_[0]) eq 'HASH' )
426 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
427 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
430 #return "Can't change setup once it exists!"
431 # if $old->getfield('setup') &&
432 # $old->getfield('setup') != $new->getfield('setup');
434 #some logic for bill, susp, cancel?
436 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
438 local $SIG{HUP} = 'IGNORE';
439 local $SIG{INT} = 'IGNORE';
440 local $SIG{QUIT} = 'IGNORE';
441 local $SIG{TERM} = 'IGNORE';
442 local $SIG{TSTP} = 'IGNORE';
443 local $SIG{PIPE} = 'IGNORE';
445 my $oldAutoCommit = $FS::UID::AutoCommit;
446 local $FS::UID::AutoCommit = 0;
449 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
450 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
451 my $error = $new->insert_reason(
452 'reason' => $options->{'reason'},
453 'date' => $new->$method,
455 'reason_otaker' => $options->{'reason_otaker'},
458 dbh->rollback if $oldAutoCommit;
459 return "Error inserting cust_pkg_reason: $error";
464 #save off and freeze RADIUS attributes for any associated svc_acct records
466 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
468 #also check for specific exports?
469 # to avoid spurious modify export events
470 @svc_acct = map { $_->svc_x }
471 grep { $_->part_svc->svcdb eq 'svc_acct' }
474 $_->snapshot foreach @svc_acct;
478 my $error = $new->SUPER::replace($old,
479 $options->{options} ? $options->{options} : ()
482 $dbh->rollback if $oldAutoCommit;
486 #for prepaid packages,
487 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
488 foreach my $old_svc_acct ( @svc_acct ) {
489 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
490 my $s_error = $new_svc_acct->replace($old_svc_acct);
492 $dbh->rollback if $oldAutoCommit;
497 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
504 Checks all fields to make sure this is a valid billing item. If there is an
505 error, returns the error, otherwise returns false. Called by the insert and
513 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
516 $self->ut_numbern('pkgnum')
517 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
518 || $self->ut_numbern('pkgpart')
519 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
520 || $self->ut_numbern('start_date')
521 || $self->ut_numbern('setup')
522 || $self->ut_numbern('bill')
523 || $self->ut_numbern('susp')
524 || $self->ut_numbern('cancel')
525 || $self->ut_numbern('adjourn')
526 || $self->ut_numbern('expire')
527 || $self->ut_enum('no_auto', [ '', 'Y' ])
529 return $error if $error;
531 if ( $self->reg_code ) {
533 unless ( grep { $self->pkgpart == $_->pkgpart }
534 map { $_->reg_code_pkg }
535 qsearchs( 'reg_code', { 'code' => $self->reg_code,
536 'agentnum' => $self->cust_main->agentnum })
538 return "Unknown registration code";
541 } elsif ( $self->promo_code ) {
544 qsearchs('part_pkg', {
545 'pkgpart' => $self->pkgpart,
546 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
548 return 'Unknown promotional code' unless $promo_part_pkg;
552 unless ( $disable_agentcheck ) {
554 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
555 return "agent ". $agent->agentnum. ':'. $agent->agent.
556 " can't purchase pkgpart ". $self->pkgpart
557 unless $agent->pkgpart_hashref->{ $self->pkgpart }
558 || $agent->agentnum == $self->part_pkg->agentnum;
561 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
562 return $error if $error;
566 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
568 if ( $self->dbdef_table->column('manual_flag') ) {
569 $self->manual_flag('') if $self->manual_flag eq ' ';
570 $self->manual_flag =~ /^([01]?)$/
571 or return "Illegal manual_flag ". $self->manual_flag;
572 $self->manual_flag($1);
578 =item cancel [ OPTION => VALUE ... ]
580 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
581 in this package, then cancels the package itself (sets the cancel field to
584 Available options are:
588 =item quiet - can be set true to supress email cancellation notices.
590 =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.
592 =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.
594 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
596 =item nobill - can be set true to skip billing if it might otherwise be done.
600 If there is an error, returns the error, otherwise returns false.
605 my( $self, %options ) = @_;
608 my $conf = new FS::Conf;
610 warn "cust_pkg::cancel called with options".
611 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
614 local $SIG{HUP} = 'IGNORE';
615 local $SIG{INT} = 'IGNORE';
616 local $SIG{QUIT} = 'IGNORE';
617 local $SIG{TERM} = 'IGNORE';
618 local $SIG{TSTP} = 'IGNORE';
619 local $SIG{PIPE} = 'IGNORE';
621 my $oldAutoCommit = $FS::UID::AutoCommit;
622 local $FS::UID::AutoCommit = 0;
625 my $old = $self->select_for_update;
627 if ( $old->get('cancel') || $self->get('cancel') ) {
628 dbh->rollback if $oldAutoCommit;
629 return ""; # no error
632 my $date = $options{date} if $options{date}; # expire/cancel later
633 $date = '' if ($date && $date <= time); # complain instead?
635 #race condition: usage could be ongoing until unprovisioned
636 #resolved by performing a change package instead (which unprovisions) and
638 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
639 my $copy = $self->new({$self->hash});
641 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
642 warn "Error billing during cancel, custnum ".
643 #$self->cust_main->custnum. ": $error"
649 my $cancel_time = $options{'time'} || time;
651 if ( $options{'reason'} ) {
652 $error = $self->insert_reason( 'reason' => $options{'reason'},
653 'action' => $date ? 'expire' : 'cancel',
654 'date' => $date ? $date : $cancel_time,
655 'reason_otaker' => $options{'reason_otaker'},
658 dbh->rollback if $oldAutoCommit;
659 return "Error inserting cust_pkg_reason: $error";
665 foreach my $cust_svc (
668 sort { $a->[1] <=> $b->[1] }
669 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
670 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
673 my $error = $cust_svc->cancel;
676 $dbh->rollback if $oldAutoCommit;
677 return "Error cancelling cust_svc: $error";
681 # Add a credit for remaining service
682 my $remaining_value = $self->calc_remain(time=>$cancel_time);
683 if ( $remaining_value > 0 && !$options{'no_credit'} ) {
684 my $error = $self->cust_main->credit(
686 'Credit for unused time on '. $self->part_pkg->pkg,
687 'reason_type' => $conf->config('cancel_credit_type'),
690 $dbh->rollback if $oldAutoCommit;
691 return "Error crediting customer \$$remaining_value for unused time on".
692 $self->part_pkg->pkg. ": $error";
697 my %hash = $self->hash;
698 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
699 my $new = new FS::cust_pkg ( \%hash );
700 $error = $new->replace( $self, options => { $self->options } );
702 $dbh->rollback if $oldAutoCommit;
706 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
707 return '' if $date; #no errors
709 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
710 if ( !$options{'quiet'} &&
711 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
713 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
716 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
717 $error = $msg_template->send( 'cust_main' => $self->cust_main,
722 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
723 'to' => \@invoicing_list,
724 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
725 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
728 #should this do something on errors?
735 =item cancel_if_expired [ NOW_TIMESTAMP ]
737 Cancels this package if its expire date has been reached.
741 sub cancel_if_expired {
743 my $time = shift || time;
744 return '' unless $self->expire && $self->expire <= $time;
745 my $error = $self->cancel;
747 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
748 $self->custnum. ": $error";
755 Cancels any pending expiration (sets the expire field to null).
757 If there is an error, returns the error, otherwise returns false.
762 my( $self, %options ) = @_;
765 local $SIG{HUP} = 'IGNORE';
766 local $SIG{INT} = 'IGNORE';
767 local $SIG{QUIT} = 'IGNORE';
768 local $SIG{TERM} = 'IGNORE';
769 local $SIG{TSTP} = 'IGNORE';
770 local $SIG{PIPE} = 'IGNORE';
772 my $oldAutoCommit = $FS::UID::AutoCommit;
773 local $FS::UID::AutoCommit = 0;
776 my $old = $self->select_for_update;
778 my $pkgnum = $old->pkgnum;
779 if ( $old->get('cancel') || $self->get('cancel') ) {
780 dbh->rollback if $oldAutoCommit;
781 return "Can't unexpire cancelled package $pkgnum";
782 # or at least it's pointless
785 unless ( $old->get('expire') && $self->get('expire') ) {
786 dbh->rollback if $oldAutoCommit;
787 return ""; # no error
790 my %hash = $self->hash;
791 $hash{'expire'} = '';
792 my $new = new FS::cust_pkg ( \%hash );
793 $error = $new->replace( $self, options => { $self->options } );
795 $dbh->rollback if $oldAutoCommit;
799 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
805 =item suspend [ OPTION => VALUE ... ]
807 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
808 package, then suspends the package itself (sets the susp field to now).
810 Available options are:
814 =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.
816 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
820 If there is an error, returns the error, otherwise returns false.
825 my( $self, %options ) = @_;
828 local $SIG{HUP} = 'IGNORE';
829 local $SIG{INT} = 'IGNORE';
830 local $SIG{QUIT} = 'IGNORE';
831 local $SIG{TERM} = 'IGNORE';
832 local $SIG{TSTP} = 'IGNORE';
833 local $SIG{PIPE} = 'IGNORE';
835 my $oldAutoCommit = $FS::UID::AutoCommit;
836 local $FS::UID::AutoCommit = 0;
839 my $old = $self->select_for_update;
841 my $pkgnum = $old->pkgnum;
842 if ( $old->get('cancel') || $self->get('cancel') ) {
843 dbh->rollback if $oldAutoCommit;
844 return "Can't suspend cancelled package $pkgnum";
847 if ( $old->get('susp') || $self->get('susp') ) {
848 dbh->rollback if $oldAutoCommit;
849 return ""; # no error # complain on adjourn?
852 my $date = $options{date} if $options{date}; # adjourn/suspend later
853 $date = '' if ($date && $date <= time); # complain instead?
855 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
856 dbh->rollback if $oldAutoCommit;
857 return "Package $pkgnum expires before it would be suspended.";
860 my $suspend_time = $options{'time'} || time;
862 if ( $options{'reason'} ) {
863 $error = $self->insert_reason( 'reason' => $options{'reason'},
864 'action' => $date ? 'adjourn' : 'suspend',
865 'date' => $date ? $date : $suspend_time,
866 'reason_otaker' => $options{'reason_otaker'},
869 dbh->rollback if $oldAutoCommit;
870 return "Error inserting cust_pkg_reason: $error";
878 foreach my $cust_svc (
879 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
881 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
883 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
884 $dbh->rollback if $oldAutoCommit;
885 return "Illegal svcdb value in part_svc!";
888 require "FS/$svcdb.pm";
890 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
892 $error = $svc->suspend;
894 $dbh->rollback if $oldAutoCommit;
897 my( $label, $value ) = $cust_svc->label;
898 push @labels, "$label: $value";
902 my $conf = new FS::Conf;
903 if ( $conf->config('suspend_email_admin') ) {
905 my $error = send_email(
906 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
907 #invoice_from ??? well as good as any
908 'to' => $conf->config('suspend_email_admin'),
909 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
911 "This is an automatic message from your Freeside installation\n",
912 "informing you that the following customer package has been suspended:\n",
914 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
915 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
916 ( map { "Service : $_\n" } @labels ),
921 warn "WARNING: can't send suspension admin email (suspending anyway): ".
929 my %hash = $self->hash;
931 $hash{'adjourn'} = $date;
933 $hash{'susp'} = $suspend_time;
935 my $new = new FS::cust_pkg ( \%hash );
936 $error = $new->replace( $self, options => { $self->options } );
938 $dbh->rollback if $oldAutoCommit;
942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
947 =item unsuspend [ OPTION => VALUE ... ]
949 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
950 package, then unsuspends the package itself (clears the susp field and the
951 adjourn field if it is in the past).
953 Available options are:
957 =item adjust_next_bill
959 Can be set true to adjust the next bill date forward by
960 the amount of time the account was inactive. This was set true by default
961 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
962 explicitly requested. Price plans for which this makes sense (anniversary-date
963 based than prorate or subscription) could have an option to enable this
968 If there is an error, returns the error, otherwise returns false.
973 my( $self, %opt ) = @_;
976 local $SIG{HUP} = 'IGNORE';
977 local $SIG{INT} = 'IGNORE';
978 local $SIG{QUIT} = 'IGNORE';
979 local $SIG{TERM} = 'IGNORE';
980 local $SIG{TSTP} = 'IGNORE';
981 local $SIG{PIPE} = 'IGNORE';
983 my $oldAutoCommit = $FS::UID::AutoCommit;
984 local $FS::UID::AutoCommit = 0;
987 my $old = $self->select_for_update;
989 my $pkgnum = $old->pkgnum;
990 if ( $old->get('cancel') || $self->get('cancel') ) {
991 dbh->rollback if $oldAutoCommit;
992 return "Can't unsuspend cancelled package $pkgnum";
995 unless ( $old->get('susp') && $self->get('susp') ) {
996 dbh->rollback if $oldAutoCommit;
997 return ""; # no error # complain instead?
1000 foreach my $cust_svc (
1001 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1003 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1005 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1006 $dbh->rollback if $oldAutoCommit;
1007 return "Illegal svcdb value in part_svc!";
1010 require "FS/$svcdb.pm";
1012 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1014 $error = $svc->unsuspend;
1016 $dbh->rollback if $oldAutoCommit;
1023 my %hash = $self->hash;
1024 my $inactive = time - $hash{'susp'};
1026 my $conf = new FS::Conf;
1028 if ( $inactive > 0 &&
1029 ( $hash{'bill'} || $hash{'setup'} ) &&
1030 ( $opt{'adjust_next_bill'} ||
1031 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1032 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1035 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1040 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1041 my $new = new FS::cust_pkg ( \%hash );
1042 $error = $new->replace( $self, options => { $self->options } );
1044 $dbh->rollback if $oldAutoCommit;
1048 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1055 Cancels any pending suspension (sets the adjourn field to null).
1057 If there is an error, returns the error, otherwise returns false.
1062 my( $self, %options ) = @_;
1065 local $SIG{HUP} = 'IGNORE';
1066 local $SIG{INT} = 'IGNORE';
1067 local $SIG{QUIT} = 'IGNORE';
1068 local $SIG{TERM} = 'IGNORE';
1069 local $SIG{TSTP} = 'IGNORE';
1070 local $SIG{PIPE} = 'IGNORE';
1072 my $oldAutoCommit = $FS::UID::AutoCommit;
1073 local $FS::UID::AutoCommit = 0;
1076 my $old = $self->select_for_update;
1078 my $pkgnum = $old->pkgnum;
1079 if ( $old->get('cancel') || $self->get('cancel') ) {
1080 dbh->rollback if $oldAutoCommit;
1081 return "Can't unadjourn cancelled package $pkgnum";
1082 # or at least it's pointless
1085 if ( $old->get('susp') || $self->get('susp') ) {
1086 dbh->rollback if $oldAutoCommit;
1087 return "Can't unadjourn suspended package $pkgnum";
1088 # perhaps this is arbitrary
1091 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1092 dbh->rollback if $oldAutoCommit;
1093 return ""; # no error
1096 my %hash = $self->hash;
1097 $hash{'adjourn'} = '';
1098 my $new = new FS::cust_pkg ( \%hash );
1099 $error = $new->replace( $self, options => { $self->options } );
1101 $dbh->rollback if $oldAutoCommit;
1105 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1112 =item change HASHREF | OPTION => VALUE ...
1114 Changes this package: cancels it and creates a new one, with a different
1115 pkgpart or locationnum or both. All services are transferred to the new
1116 package (no change will be made if this is not possible).
1118 Options may be passed as a list of key/value pairs or as a hash reference.
1125 New locationnum, to change the location for this package.
1129 New FS::cust_location object, to create a new location and assign it
1134 New pkgpart (see L<FS::part_pkg>).
1138 New refnum (see L<FS::part_referral>).
1142 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1143 susp, adjourn, cancel, expire, and contract_end) to the new package.
1147 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1148 (otherwise, what's the point?)
1150 Returns either the new FS::cust_pkg object or a scalar error.
1154 my $err_or_new_cust_pkg = $old_cust_pkg->change
1158 #some false laziness w/order
1161 my $opt = ref($_[0]) ? shift : { @_ };
1163 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1166 my $conf = new FS::Conf;
1168 # Transactionize this whole mess
1169 local $SIG{HUP} = 'IGNORE';
1170 local $SIG{INT} = 'IGNORE';
1171 local $SIG{QUIT} = 'IGNORE';
1172 local $SIG{TERM} = 'IGNORE';
1173 local $SIG{TSTP} = 'IGNORE';
1174 local $SIG{PIPE} = 'IGNORE';
1176 my $oldAutoCommit = $FS::UID::AutoCommit;
1177 local $FS::UID::AutoCommit = 0;
1186 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1188 #$hash{$_} = $self->$_() foreach qw( setup );
1190 $hash{'setup'} = $time if $self->setup;
1192 $hash{'change_date'} = $time;
1193 $hash{"change_$_"} = $self->$_()
1194 foreach qw( pkgnum pkgpart locationnum );
1196 if ( $opt->{'cust_location'} &&
1197 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1198 $error = $opt->{'cust_location'}->insert;
1200 $dbh->rollback if $oldAutoCommit;
1201 return "inserting cust_location (transaction rolled back): $error";
1203 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1206 if ( $opt->{'keep_dates'} ) {
1207 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1208 start_date contract_end ) ) {
1209 $hash{$date} = $self->getfield($date);
1213 # Create the new package.
1214 my $cust_pkg = new FS::cust_pkg {
1215 custnum => $self->custnum,
1216 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1217 refnum => ( $opt->{'refnum'} || $self->refnum ),
1218 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1222 $error = $cust_pkg->insert( 'change' => 1 );
1224 $dbh->rollback if $oldAutoCommit;
1228 # Transfer services and cancel old package.
1230 $error = $self->transfer($cust_pkg);
1231 if ($error and $error == 0) {
1232 # $old_pkg->transfer failed.
1233 $dbh->rollback if $oldAutoCommit;
1237 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1238 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1239 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1240 if ($error and $error == 0) {
1241 # $old_pkg->transfer failed.
1242 $dbh->rollback if $oldAutoCommit;
1248 # Transfers were successful, but we still had services left on the old
1249 # package. We can't change the package under this circumstances, so abort.
1250 $dbh->rollback if $oldAutoCommit;
1251 return "Unable to transfer all services from package ". $self->pkgnum;
1254 #reset usage if changing pkgpart
1255 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1256 if ($self->pkgpart != $cust_pkg->pkgpart) {
1257 my $part_pkg = $cust_pkg->part_pkg;
1258 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1262 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1265 $dbh->rollback if $oldAutoCommit;
1266 return "Error setting usage values: $error";
1270 #Good to go, cancel old package.
1271 $error = $self->cancel( quiet=>1 );
1273 $dbh->rollback if $oldAutoCommit;
1277 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1279 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1281 $dbh->rollback if $oldAutoCommit;
1286 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1293 use Storable 'thaw';
1295 sub process_bulk_cust_pkg {
1297 my $param = thaw(decode_base64(shift));
1298 warn Dumper($param) if $DEBUG;
1300 my $old_part_pkg = qsearchs('part_pkg',
1301 { pkgpart => $param->{'old_pkgpart'} });
1302 my $new_part_pkg = qsearchs('part_pkg',
1303 { pkgpart => $param->{'new_pkgpart'} });
1304 die "Must select a new package type\n" unless $new_part_pkg;
1305 #my $keep_dates = $param->{'keep_dates'} || 0;
1306 my $keep_dates = 1; # there is no good reason to turn this off
1308 local $SIG{HUP} = 'IGNORE';
1309 local $SIG{INT} = 'IGNORE';
1310 local $SIG{QUIT} = 'IGNORE';
1311 local $SIG{TERM} = 'IGNORE';
1312 local $SIG{TSTP} = 'IGNORE';
1313 local $SIG{PIPE} = 'IGNORE';
1315 my $oldAutoCommit = $FS::UID::AutoCommit;
1316 local $FS::UID::AutoCommit = 0;
1319 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1322 foreach my $old_cust_pkg ( @cust_pkgs ) {
1324 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1325 if ( $old_cust_pkg->getfield('cancel') ) {
1326 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1327 $old_cust_pkg->pkgnum."\n"
1331 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1333 my $error = $old_cust_pkg->change(
1334 'pkgpart' => $param->{'new_pkgpart'},
1335 'keep_dates' => $keep_dates
1337 if ( !ref($error) ) { # change returns the cust_pkg on success
1339 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1342 $dbh->commit if $oldAutoCommit;
1348 Returns the last bill date, or if there is no last bill date, the setup date.
1349 Useful for billing metered services.
1355 return $self->setfield('last_bill', $_[0]) if @_;
1356 return $self->getfield('last_bill') if $self->getfield('last_bill');
1357 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1358 'edate' => $self->bill, } );
1359 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1362 =item last_cust_pkg_reason ACTION
1364 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1365 Returns false if there is no reason or the package is not currenly ACTION'd
1366 ACTION is one of adjourn, susp, cancel, or expire.
1370 sub last_cust_pkg_reason {
1371 my ( $self, $action ) = ( shift, shift );
1372 my $date = $self->get($action);
1374 'table' => 'cust_pkg_reason',
1375 'hashref' => { 'pkgnum' => $self->pkgnum,
1376 'action' => substr(uc($action), 0, 1),
1379 'order_by' => 'ORDER BY num DESC LIMIT 1',
1383 =item last_reason ACTION
1385 Returns the most recent ACTION FS::reason associated with the package.
1386 Returns false if there is no reason or the package is not currenly ACTION'd
1387 ACTION is one of adjourn, susp, cancel, or expire.
1392 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1393 $cust_pkg_reason->reason
1394 if $cust_pkg_reason;
1399 Returns the definition for this billing item, as an FS::part_pkg object (see
1406 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1407 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1408 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1413 Returns the cancelled package this package was changed from, if any.
1419 return '' unless $self->change_pkgnum;
1420 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1425 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1432 $self->part_pkg->calc_setup($self, @_);
1437 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1444 $self->part_pkg->calc_recur($self, @_);
1449 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1456 $self->part_pkg->base_recur($self, @_);
1461 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1468 $self->part_pkg->calc_remain($self, @_);
1473 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1480 $self->part_pkg->calc_cancel($self, @_);
1485 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1491 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1494 =item cust_pkg_detail [ DETAILTYPE ]
1496 Returns any customer package details for this package (see
1497 L<FS::cust_pkg_detail>).
1499 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1503 sub cust_pkg_detail {
1505 my %hash = ( 'pkgnum' => $self->pkgnum );
1506 $hash{detailtype} = shift if @_;
1508 'table' => 'cust_pkg_detail',
1509 'hashref' => \%hash,
1510 'order_by' => 'ORDER BY weight, pkgdetailnum',
1514 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1516 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1518 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1520 If there is an error, returns the error, otherwise returns false.
1524 sub set_cust_pkg_detail {
1525 my( $self, $detailtype, @details ) = @_;
1527 local $SIG{HUP} = 'IGNORE';
1528 local $SIG{INT} = 'IGNORE';
1529 local $SIG{QUIT} = 'IGNORE';
1530 local $SIG{TERM} = 'IGNORE';
1531 local $SIG{TSTP} = 'IGNORE';
1532 local $SIG{PIPE} = 'IGNORE';
1534 my $oldAutoCommit = $FS::UID::AutoCommit;
1535 local $FS::UID::AutoCommit = 0;
1538 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1539 my $error = $current->delete;
1541 $dbh->rollback if $oldAutoCommit;
1542 return "error removing old detail: $error";
1546 foreach my $detail ( @details ) {
1547 my $cust_pkg_detail = new FS::cust_pkg_detail {
1548 'pkgnum' => $self->pkgnum,
1549 'detailtype' => $detailtype,
1550 'detail' => $detail,
1552 my $error = $cust_pkg_detail->insert;
1554 $dbh->rollback if $oldAutoCommit;
1555 return "error adding new detail: $error";
1560 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1567 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1571 #false laziness w/cust_bill.pm
1575 'table' => 'cust_event',
1576 'addl_from' => 'JOIN part_event USING ( eventpart )',
1577 'hashref' => { 'tablenum' => $self->pkgnum },
1578 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1582 =item num_cust_event
1584 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1588 #false laziness w/cust_bill.pm
1589 sub num_cust_event {
1592 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1593 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1594 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1595 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1596 $sth->fetchrow_arrayref->[0];
1599 =item cust_svc [ SVCPART ]
1601 Returns the services for this package, as FS::cust_svc objects (see
1602 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1610 return () unless $self->num_cust_svc(@_);
1613 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1614 'svcpart' => shift, } );
1617 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1619 #if ( $self->{'_svcnum'} ) {
1620 # values %{ $self->{'_svcnum'}->cache };
1622 $self->_sort_cust_svc(
1623 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1629 =item overlimit [ SVCPART ]
1631 Returns the services for this package which have exceeded their
1632 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1633 is specified, return only the matching services.
1639 return () unless $self->num_cust_svc(@_);
1640 grep { $_->overlimit } $self->cust_svc(@_);
1643 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1645 Returns historical services for this package created before END TIMESTAMP and
1646 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1647 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1648 I<pkg_svc.hidden> flag will be omitted.
1654 my ($end, $start, $mode) = @_;
1655 my @cust_svc = $self->_sort_cust_svc(
1656 [ qsearch( 'h_cust_svc',
1657 { 'pkgnum' => $self->pkgnum, },
1658 FS::h_cust_svc->sql_h_search(@_),
1661 if ( $mode eq 'I' ) {
1662 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1663 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1670 sub _sort_cust_svc {
1671 my( $self, $arrayref ) = @_;
1674 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1679 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1680 'svcpart' => $_->svcpart } );
1682 $pkg_svc ? $pkg_svc->primary_svc : '',
1683 $pkg_svc ? $pkg_svc->quantity : 0,
1690 =item num_cust_svc [ SVCPART ]
1692 Returns the number of provisioned services for this package. If a svcpart is
1693 specified, counts only the matching services.
1700 return $self->{'_num_cust_svc'}
1702 && exists($self->{'_num_cust_svc'})
1703 && $self->{'_num_cust_svc'} =~ /\d/;
1705 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1708 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1709 $sql .= ' AND svcpart = ?' if @_;
1711 my $sth = dbh->prepare($sql) or die dbh->errstr;
1712 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1713 $sth->fetchrow_arrayref->[0];
1716 =item available_part_svc
1718 Returns a list of FS::part_svc objects representing services included in this
1719 package but not yet provisioned. Each FS::part_svc object also has an extra
1720 field, I<num_avail>, which specifies the number of available services.
1724 sub available_part_svc {
1726 grep { $_->num_avail > 0 }
1728 my $part_svc = $_->part_svc;
1729 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1730 $_->quantity - $self->num_cust_svc($_->svcpart);
1733 $self->part_pkg->pkg_svc;
1738 Returns a list of FS::part_svc objects representing provisioned and available
1739 services included in this package. Each FS::part_svc object also has the
1740 following extra fields:
1744 =item num_cust_svc (count)
1746 =item num_avail (quantity - count)
1748 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1751 label -> ($cust_svc->label)[1]
1760 #XXX some sort of sort order besides numeric by svcpart...
1761 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1763 my $part_svc = $pkg_svc->part_svc;
1764 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1765 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1766 $part_svc->{'Hash'}{'num_avail'} =
1767 max( 0, $pkg_svc->quantity - $num_cust_svc );
1768 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1769 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1770 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1772 } $self->part_pkg->pkg_svc;
1775 push @part_svc, map {
1777 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1778 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1779 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1780 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1781 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1783 } $self->extra_part_svc;
1789 =item extra_part_svc
1791 Returns a list of FS::part_svc objects corresponding to services in this
1792 package which are still provisioned but not (any longer) available in the
1797 sub extra_part_svc {
1800 my $pkgnum = $self->pkgnum;
1801 my $pkgpart = $self->pkgpart;
1804 # 'table' => 'part_svc',
1807 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1808 # WHERE pkg_svc.svcpart = part_svc.svcpart
1809 # AND pkg_svc.pkgpart = ?
1812 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1813 # LEFT JOIN cust_pkg USING ( pkgnum )
1814 # WHERE cust_svc.svcpart = part_svc.svcpart
1817 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1820 #seems to benchmark slightly faster...
1822 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1823 #MySQL doesn't grok DISINCT ON
1824 'select' => 'DISTINCT part_svc.*',
1825 'table' => 'part_svc',
1827 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1828 AND pkg_svc.pkgpart = ?
1831 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1832 LEFT JOIN cust_pkg USING ( pkgnum )
1835 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1836 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1842 Returns a short status string for this package, currently:
1846 =item not yet billed
1848 =item one-time charge
1863 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1865 return 'cancelled' if $self->get('cancel');
1866 return 'suspended' if $self->susp;
1867 return 'not yet billed' unless $self->setup;
1868 return 'one-time charge' if $freq =~ /^(0|$)/;
1872 =item ucfirst_status
1874 Returns the status with the first character capitalized.
1878 sub ucfirst_status {
1879 ucfirst(shift->status);
1884 Class method that returns the list of possible status strings for packages
1885 (see L<the status method|/status>). For example:
1887 @statuses = FS::cust_pkg->statuses();
1891 tie my %statuscolor, 'Tie::IxHash',
1892 'not yet billed' => '009999', #teal? cyan?
1893 'one-time charge' => '000000',
1894 'active' => '00CC00',
1895 'suspended' => 'FF9900',
1896 'cancelled' => 'FF0000',
1900 my $self = shift; #could be class...
1901 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
1902 # # mayble split btw one-time vs. recur
1908 Returns a hex triplet color string for this package's status.
1914 $statuscolor{$self->status};
1919 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
1920 "pkg-comment" depending on user preference).
1926 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
1927 $label = $self->pkgnum. ": $label"
1928 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
1932 =item pkg_label_long
1934 Returns a long label for this package, adding the primary service's label to
1939 sub pkg_label_long {
1941 my $label = $self->pkg_label;
1942 my $cust_svc = $self->primary_cust_svc;
1943 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
1947 =item primary_cust_svc
1949 Returns a primary service (as FS::cust_svc object) if one can be identified.
1953 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
1955 sub primary_cust_svc {
1958 my @cust_svc = $self->cust_svc;
1960 return '' unless @cust_svc; #no serivces - irrelevant then
1962 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
1964 # primary service as specified in the package definition
1965 # or exactly one service definition with quantity one
1966 my $svcpart = $self->part_pkg->svcpart;
1967 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
1968 return $cust_svc[0] if scalar(@cust_svc) == 1;
1970 #couldn't identify one thing..
1976 Returns a list of lists, calling the label method for all services
1977 (see L<FS::cust_svc>) of this billing item.
1983 map { [ $_->label ] } $self->cust_svc;
1986 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1988 Like the labels method, but returns historical information on services that
1989 were active as of END_TIMESTAMP and (optionally) not cancelled before
1990 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
1991 I<pkg_svc.hidden> flag will be omitted.
1993 Returns a list of lists, calling the label method for all (historical) services
1994 (see L<FS::h_cust_svc>) of this billing item.
2000 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2005 Like labels, except returns a simple flat list, and shortens long
2006 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2007 identical services to one line that lists the service label and the number of
2008 individual services rather than individual items.
2013 shift->_labels_short( 'labels', @_ );
2016 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2018 Like h_labels, except returns a simple flat list, and shortens long
2019 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2020 identical services to one line that lists the service label and the number of
2021 individual services rather than individual items.
2025 sub h_labels_short {
2026 shift->_labels_short( 'h_labels', @_ );
2030 my( $self, $method ) = ( shift, shift );
2032 my $conf = new FS::Conf;
2033 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2036 #tie %labels, 'Tie::IxHash';
2037 push @{ $labels{$_->[0]} }, $_->[1]
2038 foreach $self->$method(@_);
2040 foreach my $label ( keys %labels ) {
2042 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2043 my $num = scalar(@values);
2044 if ( $num > $max_same_services ) {
2045 push @labels, "$label ($num)";
2047 if ( $conf->exists('cust_bill-consolidate_services') ) {
2048 # push @labels, "$label: ". join(', ', @values);
2050 my $detail = "$label: ";
2051 $detail .= shift(@values). ', '
2052 while @values && length($detail.$values[0]) < 78;
2054 push @labels, $detail;
2057 push @labels, map { "$label: $_" } @values;
2068 Returns the parent customer object (see L<FS::cust_main>).
2074 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2077 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2081 Returns the location object, if any (see L<FS::cust_location>).
2083 =item cust_location_or_main
2085 If this package is associated with a location, returns the locaiton (see
2086 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2088 =item location_label [ OPTION => VALUE ... ]
2090 Returns the label of the location object (see L<FS::cust_location>).
2094 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2096 =item seconds_since TIMESTAMP
2098 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2099 package have been online since TIMESTAMP, according to the session monitor.
2101 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2102 L<Time::Local> and L<Date::Parse> for conversion functions.
2107 my($self, $since) = @_;
2110 foreach my $cust_svc (
2111 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2113 $seconds += $cust_svc->seconds_since($since);
2120 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2122 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2123 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2126 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2127 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2133 sub seconds_since_sqlradacct {
2134 my($self, $start, $end) = @_;
2138 foreach my $cust_svc (
2140 my $part_svc = $_->part_svc;
2141 $part_svc->svcdb eq 'svc_acct'
2142 && scalar($part_svc->part_export('sqlradius'));
2145 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2152 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2154 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2155 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2159 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2160 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2165 sub attribute_since_sqlradacct {
2166 my($self, $start, $end, $attrib) = @_;
2170 foreach my $cust_svc (
2172 my $part_svc = $_->part_svc;
2173 $part_svc->svcdb eq 'svc_acct'
2174 && scalar($part_svc->part_export('sqlradius'));
2177 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2189 my( $self, $value ) = @_;
2190 if ( defined($value) ) {
2191 $self->setfield('quantity', $value);
2193 $self->getfield('quantity') || 1;
2196 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2198 Transfers as many services as possible from this package to another package.
2200 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2201 object. The destination package must already exist.
2203 Services are moved only if the destination allows services with the correct
2204 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2205 this option with caution! No provision is made for export differences
2206 between the old and new service definitions. Probably only should be used
2207 when your exports for all service definitions of a given svcdb are identical.
2208 (attempt a transfer without it first, to move all possible svcpart-matching
2211 Any services that can't be moved remain in the original package.
2213 Returns an error, if there is one; otherwise, returns the number of services
2214 that couldn't be moved.
2219 my ($self, $dest_pkgnum, %opt) = @_;
2225 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2226 $dest = $dest_pkgnum;
2227 $dest_pkgnum = $dest->pkgnum;
2229 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2232 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2234 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2235 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2238 foreach my $cust_svc ($dest->cust_svc) {
2239 $target{$cust_svc->svcpart}--;
2242 my %svcpart2svcparts = ();
2243 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2244 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2245 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2246 next if exists $svcpart2svcparts{$svcpart};
2247 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2248 $svcpart2svcparts{$svcpart} = [
2250 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2252 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2253 'svcpart' => $_ } );
2255 $pkg_svc ? $pkg_svc->primary_svc : '',
2256 $pkg_svc ? $pkg_svc->quantity : 0,
2260 grep { $_ != $svcpart }
2262 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2264 warn "alternates for svcpart $svcpart: ".
2265 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2270 foreach my $cust_svc ($self->cust_svc) {
2271 if($target{$cust_svc->svcpart} > 0) {
2272 $target{$cust_svc->svcpart}--;
2273 my $new = new FS::cust_svc { $cust_svc->hash };
2274 $new->pkgnum($dest_pkgnum);
2275 my $error = $new->replace($cust_svc);
2276 return $error if $error;
2277 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2279 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2280 warn "alternates to consider: ".
2281 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2283 my @alternate = grep {
2284 warn "considering alternate svcpart $_: ".
2285 "$target{$_} available in new package\n"
2288 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2290 warn "alternate(s) found\n" if $DEBUG;
2291 my $change_svcpart = $alternate[0];
2292 $target{$change_svcpart}--;
2293 my $new = new FS::cust_svc { $cust_svc->hash };
2294 $new->svcpart($change_svcpart);
2295 $new->pkgnum($dest_pkgnum);
2296 my $error = $new->replace($cust_svc);
2297 return $error if $error;
2310 This method is deprecated. See the I<depend_jobnum> option to the insert and
2311 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2318 local $SIG{HUP} = 'IGNORE';
2319 local $SIG{INT} = 'IGNORE';
2320 local $SIG{QUIT} = 'IGNORE';
2321 local $SIG{TERM} = 'IGNORE';
2322 local $SIG{TSTP} = 'IGNORE';
2323 local $SIG{PIPE} = 'IGNORE';
2325 my $oldAutoCommit = $FS::UID::AutoCommit;
2326 local $FS::UID::AutoCommit = 0;
2329 foreach my $cust_svc ( $self->cust_svc ) {
2330 #false laziness w/svc_Common::insert
2331 my $svc_x = $cust_svc->svc_x;
2332 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2333 my $error = $part_export->export_insert($svc_x);
2335 $dbh->rollback if $oldAutoCommit;
2341 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2348 Associates this package with a (suspension or cancellation) reason (see
2349 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2352 Available options are:
2358 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.
2362 the access_user (see L<FS::access_user>) providing the reason
2370 the action (cancel, susp, adjourn, expire) associated with the reason
2374 If there is an error, returns the error, otherwise returns false.
2379 my ($self, %options) = @_;
2381 my $otaker = $options{reason_otaker} ||
2382 $FS::CurrentUser::CurrentUser->username;
2385 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2389 } elsif ( ref($options{'reason'}) ) {
2391 return 'Enter a new reason (or select an existing one)'
2392 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2394 my $reason = new FS::reason({
2395 'reason_type' => $options{'reason'}->{'typenum'},
2396 'reason' => $options{'reason'}->{'reason'},
2398 my $error = $reason->insert;
2399 return $error if $error;
2401 $reasonnum = $reason->reasonnum;
2404 return "Unparsable reason: ". $options{'reason'};
2407 my $cust_pkg_reason =
2408 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2409 'reasonnum' => $reasonnum,
2410 'otaker' => $otaker,
2411 'action' => substr(uc($options{'action'}),0,1),
2412 'date' => $options{'date'}
2417 $cust_pkg_reason->insert;
2420 =item insert_discount
2422 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2423 inserting a new discount on the fly (see L<FS::discount>).
2425 Available options are:
2433 If there is an error, returns the error, otherwise returns false.
2437 sub insert_discount {
2438 #my ($self, %options) = @_;
2441 my $cust_pkg_discount = new FS::cust_pkg_discount {
2442 'pkgnum' => $self->pkgnum,
2443 'discountnum' => $self->discountnum,
2445 'end_date' => '', #XXX
2446 'otaker' => $self->otaker,
2447 #for the create a new discount case
2448 '_type' => $self->discountnum__type,
2449 'amount' => $self->discountnum_amount,
2450 'percent' => $self->discountnum_percent,
2451 'months' => $self->discountnum_months,
2452 #'disabled' => $self->discountnum_disabled,
2455 $cust_pkg_discount->insert;
2458 =item set_usage USAGE_VALUE_HASHREF
2460 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2461 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2462 upbytes, downbytes, and totalbytes are appropriate keys.
2464 All svc_accts which are part of this package have their values reset.
2469 my ($self, $valueref, %opt) = @_;
2471 foreach my $cust_svc ($self->cust_svc){
2472 my $svc_x = $cust_svc->svc_x;
2473 $svc_x->set_usage($valueref, %opt)
2474 if $svc_x->can("set_usage");
2478 =item recharge USAGE_VALUE_HASHREF
2480 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2481 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2482 upbytes, downbytes, and totalbytes are appropriate keys.
2484 All svc_accts which are part of this package have their values incremented.
2489 my ($self, $valueref) = @_;
2491 foreach my $cust_svc ($self->cust_svc){
2492 my $svc_x = $cust_svc->svc_x;
2493 $svc_x->recharge($valueref)
2494 if $svc_x->can("recharge");
2498 =item cust_pkg_discount
2502 sub cust_pkg_discount {
2504 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2507 =item cust_pkg_discount_active
2511 sub cust_pkg_discount_active {
2513 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2518 =head1 CLASS METHODS
2524 Returns an SQL expression identifying recurring packages.
2528 sub recurring_sql { "
2529 '0' != ( select freq from part_pkg
2530 where cust_pkg.pkgpart = part_pkg.pkgpart )
2535 Returns an SQL expression identifying one-time packages.
2540 '0' = ( select freq from part_pkg
2541 where cust_pkg.pkgpart = part_pkg.pkgpart )
2546 Returns an SQL expression identifying ordered packages (recurring packages not
2552 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2557 Returns an SQL expression identifying active packages.
2562 $_[0]->recurring_sql. "
2563 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2564 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2565 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2568 =item not_yet_billed_sql
2570 Returns an SQL expression identifying packages which have not yet been billed.
2574 sub not_yet_billed_sql { "
2575 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2576 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2577 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2582 Returns an SQL expression identifying inactive packages (one-time packages
2583 that are otherwise unsuspended/uncancelled).
2587 sub inactive_sql { "
2588 ". $_[0]->onetime_sql(). "
2589 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2590 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2591 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2597 Returns an SQL expression identifying suspended packages.
2601 sub suspended_sql { susp_sql(@_); }
2603 #$_[0]->recurring_sql(). ' AND '.
2605 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2606 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2613 Returns an SQL exprression identifying cancelled packages.
2617 sub cancelled_sql { cancel_sql(@_); }
2619 #$_[0]->recurring_sql(). ' AND '.
2620 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2625 Returns an SQL expression to give the package status as a string.
2631 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2632 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2633 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2634 WHEN ".onetime_sql()." THEN 'one-time charge'
2639 =item search HASHREF
2643 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2644 Valid parameters are
2652 active, inactive, suspended, cancel (or cancelled)
2656 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2660 boolean selects custom packages
2666 pkgpart or arrayref or hashref of pkgparts
2670 arrayref of beginning and ending epoch date
2674 arrayref of beginning and ending epoch date
2678 arrayref of beginning and ending epoch date
2682 arrayref of beginning and ending epoch date
2686 arrayref of beginning and ending epoch date
2690 arrayref of beginning and ending epoch date
2694 arrayref of beginning and ending epoch date
2698 pkgnum or APKG_pkgnum
2702 a value suited to passing to FS::UI::Web::cust_header
2706 specifies the user for agent virtualization
2710 boolean selects packages containing fcc form 477 telco lines
2717 my ($class, $params) = @_;
2724 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2726 "cust_main.agentnum = $1";
2733 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2735 "cust_pkg.custnum = $1";
2742 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2744 "cust_pkg.pkgbatch = '$1'";
2751 if ( $params->{'magic'} eq 'active'
2752 || $params->{'status'} eq 'active' ) {
2754 push @where, FS::cust_pkg->active_sql();
2756 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2757 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2759 push @where, FS::cust_pkg->not_yet_billed_sql();
2761 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2762 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2764 push @where, FS::cust_pkg->inactive_sql();
2766 } elsif ( $params->{'magic'} eq 'suspended'
2767 || $params->{'status'} eq 'suspended' ) {
2769 push @where, FS::cust_pkg->suspended_sql();
2771 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2772 || $params->{'status'} =~ /^cancell?ed$/ ) {
2774 push @where, FS::cust_pkg->cancelled_sql();
2779 # parse package class
2782 #false lazinessish w/graph/cust_bill_pkg.cgi
2785 if ( exists($params->{'classnum'})
2786 && $params->{'classnum'} =~ /^(\d*)$/
2790 if ( $classnum ) { #a specific class
2791 push @where, "part_pkg.classnum = $classnum";
2793 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2794 #die "classnum $classnum not found!" unless $pkg_class[0];
2795 #$title .= $pkg_class[0]->classname.' ';
2797 } elsif ( $classnum eq '' ) { #the empty class
2799 push @where, "part_pkg.classnum IS NULL";
2800 #$title .= 'Empty class ';
2801 #@pkg_class = ( '(empty class)' );
2802 } elsif ( $classnum eq '0' ) {
2803 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2804 #push @pkg_class, '(empty class)';
2806 die "illegal classnum";
2812 # parse package report options
2815 my @report_option = ();
2816 if ( exists($params->{'report_option'})
2817 && $params->{'report_option'} =~ /^([,\d]*)$/
2820 @report_option = split(',', $1);
2823 if (@report_option) {
2824 # this will result in the empty set for the dangling comma case as it should
2826 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2827 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2828 AND optionname = 'report_option_$_'
2829 AND optionvalue = '1' )"
2839 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
2845 push @where, "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
2851 if ( exists($params->{'censustract'}) ) {
2852 $params->{'censustract'} =~ /^([.\d]*)$/;
2853 my $censustract = "cust_main.censustract = '$1'";
2854 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
2855 push @where, "( $censustract )";
2862 if ( ref($params->{'pkgpart'}) ) {
2865 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
2866 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
2867 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
2868 @pkgpart = @{ $params->{'pkgpart'} };
2870 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
2873 @pkgpart = grep /^(\d+)$/, @pkgpart;
2875 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
2877 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2878 push @where, "pkgpart = $1";
2887 #false laziness w/report_cust_pkg.html
2890 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
2891 'active' => { 'susp'=>1, 'cancel'=>1 },
2892 'suspended' => { 'cancel' => 1 },
2897 if( exists($params->{'active'} ) ) {
2898 # This overrides all the other date-related fields
2899 my($beginning, $ending) = @{$params->{'active'}};
2901 "cust_pkg.setup IS NOT NULL",
2902 "cust_pkg.setup <= $ending",
2903 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
2904 "NOT (".FS::cust_pkg->onetime_sql . ")";
2907 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
2909 next unless exists($params->{$field});
2911 my($beginning, $ending) = @{$params->{$field}};
2913 next if $beginning == 0 && $ending == 4294967295;
2916 "cust_pkg.$field IS NOT NULL",
2917 "cust_pkg.$field >= $beginning",
2918 "cust_pkg.$field <= $ending";
2920 $orderby ||= "ORDER BY cust_pkg.$field";
2925 $orderby ||= 'ORDER BY bill';
2928 # parse magic, legacy, etc.
2931 if ( $params->{'magic'} &&
2932 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
2935 $orderby = 'ORDER BY pkgnum';
2937 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2938 push @where, "pkgpart = $1";
2941 } elsif ( $params->{'query'} eq 'pkgnum' ) {
2943 $orderby = 'ORDER BY pkgnum';
2945 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
2947 $orderby = 'ORDER BY pkgnum';
2950 SELECT count(*) FROM pkg_svc
2951 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
2952 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
2953 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
2954 AND cust_svc.svcpart = pkg_svc.svcpart
2961 # setup queries, links, subs, etc. for the search
2964 # here is the agent virtualization
2965 if ($params->{CurrentUser}) {
2967 qsearchs('access_user', { username => $params->{CurrentUser} });
2970 push @where, $access_user->agentnums_sql('table'=>'cust_main');
2975 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
2978 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
2980 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
2981 'LEFT JOIN part_pkg USING ( pkgpart ) '.
2982 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
2984 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
2987 'table' => 'cust_pkg',
2989 'select' => join(', ',
2991 ( map "part_pkg.$_", qw( pkg freq ) ),
2992 'pkg_class.classname',
2993 'cust_main.custnum AS cust_main_custnum',
2994 FS::UI::Web::cust_sql_fields(
2995 $params->{'cust_fields'}
2998 'extra_sql' => "$extra_sql $orderby",
2999 'addl_from' => $addl_from,
3000 'count_query' => $count_query,
3007 Returns a list of two package counts. The first is a count of packages
3008 based on the supplied criteria and the second is the count of residential
3009 packages with those same criteria. Criteria are specified as in the search
3015 my ($class, $params) = @_;
3017 my $sql_query = $class->search( $params );
3019 my $count_sql = delete($sql_query->{'count_query'});
3020 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3021 or die "couldn't parse count_sql";
3023 my $count_sth = dbh->prepare($count_sql)
3024 or die "Error preparing $count_sql: ". dbh->errstr;
3026 or die "Error executing $count_sql: ". $count_sth->errstr;
3027 my $count_arrayref = $count_sth->fetchrow_arrayref;
3029 return ( @$count_arrayref );
3036 Returns a list: the first item is an SQL fragment identifying matching
3037 packages/customers via location (taking into account shipping and package
3038 address taxation, if enabled), and subsequent items are the parameters to
3039 substitute for the placeholders in that fragment.
3044 my($class, %opt) = @_;
3045 my $ornull = $opt{'ornull'};
3047 my $conf = new FS::Conf;
3049 # '?' placeholders in _location_sql_where
3050 my $x = $ornull ? 3 : 2;
3051 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3055 if ( $conf->exists('tax-ship_address') ) {
3058 ( ( ship_last IS NULL OR ship_last = '' )
3059 AND ". _location_sql_where('cust_main', '', $ornull ). "
3061 OR ( ship_last IS NOT NULL AND ship_last != ''
3062 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3065 # AND payby != 'COMP'
3067 @main_param = ( @bill_param, @bill_param );
3071 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3072 @main_param = @bill_param;
3078 if ( $conf->exists('tax-pkg_address') ) {
3080 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3083 ( cust_pkg.locationnum IS NULL AND $main_where )
3084 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3087 @param = ( @main_param, @bill_param );
3091 $where = $main_where;
3092 @param = @main_param;
3100 #subroutine, helper for location_sql
3101 sub _location_sql_where {
3103 my $prefix = @_ ? shift : '';
3104 my $ornull = @_ ? shift : '';
3106 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3108 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3110 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3111 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3112 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3114 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3116 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3117 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3118 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3119 AND $table.${prefix}country = ?
3127 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3129 CUSTNUM is a customer (see L<FS::cust_main>)
3131 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3132 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3135 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3136 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3137 new billing items. An error is returned if this is not possible (see
3138 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3141 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3142 newly-created cust_pkg objects.
3144 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3145 and inserted. Multiple FS::pkg_referral records can be created by
3146 setting I<refnum> to an array reference of refnums or a hash reference with
3147 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3148 record will be created corresponding to cust_main.refnum.
3153 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3155 my $conf = new FS::Conf;
3157 # Transactionize this whole mess
3158 local $SIG{HUP} = 'IGNORE';
3159 local $SIG{INT} = 'IGNORE';
3160 local $SIG{QUIT} = 'IGNORE';
3161 local $SIG{TERM} = 'IGNORE';
3162 local $SIG{TSTP} = 'IGNORE';
3163 local $SIG{PIPE} = 'IGNORE';
3165 my $oldAutoCommit = $FS::UID::AutoCommit;
3166 local $FS::UID::AutoCommit = 0;
3170 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3171 # return "Customer not found: $custnum" unless $cust_main;
3173 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3176 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3179 my $change = scalar(@old_cust_pkg) != 0;
3182 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3184 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3185 " to pkgpart ". $pkgparts->[0]. "\n"
3188 my $err_or_cust_pkg =
3189 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3190 'refnum' => $refnum,
3193 unless (ref($err_or_cust_pkg)) {
3194 $dbh->rollback if $oldAutoCommit;
3195 return $err_or_cust_pkg;
3198 push @$return_cust_pkg, $err_or_cust_pkg;
3199 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3204 # Create the new packages.
3205 foreach my $pkgpart (@$pkgparts) {
3207 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3209 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3210 pkgpart => $pkgpart,
3214 $error = $cust_pkg->insert( 'change' => $change );
3216 $dbh->rollback if $oldAutoCommit;
3219 push @$return_cust_pkg, $cust_pkg;
3221 # $return_cust_pkg now contains refs to all of the newly
3224 # Transfer services and cancel old packages.
3225 foreach my $old_pkg (@old_cust_pkg) {
3227 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3230 foreach my $new_pkg (@$return_cust_pkg) {
3231 $error = $old_pkg->transfer($new_pkg);
3232 if ($error and $error == 0) {
3233 # $old_pkg->transfer failed.
3234 $dbh->rollback if $oldAutoCommit;
3239 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3240 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3241 foreach my $new_pkg (@$return_cust_pkg) {
3242 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3243 if ($error and $error == 0) {
3244 # $old_pkg->transfer failed.
3245 $dbh->rollback if $oldAutoCommit;
3252 # Transfers were successful, but we went through all of the
3253 # new packages and still had services left on the old package.
3254 # We can't cancel the package under the circumstances, so abort.
3255 $dbh->rollback if $oldAutoCommit;
3256 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3258 $error = $old_pkg->cancel( quiet=>1 );
3264 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3268 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3270 A bulk change method to change packages for multiple customers.
3272 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3273 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3276 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3277 replace. The services (see L<FS::cust_svc>) are moved to the
3278 new billing items. An error is returned if this is not possible (see
3281 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3282 newly-created cust_pkg objects.
3287 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3289 # Transactionize this whole mess
3290 local $SIG{HUP} = 'IGNORE';
3291 local $SIG{INT} = 'IGNORE';
3292 local $SIG{QUIT} = 'IGNORE';
3293 local $SIG{TERM} = 'IGNORE';
3294 local $SIG{TSTP} = 'IGNORE';
3295 local $SIG{PIPE} = 'IGNORE';
3297 my $oldAutoCommit = $FS::UID::AutoCommit;
3298 local $FS::UID::AutoCommit = 0;
3302 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3305 while(scalar(@old_cust_pkg)) {
3307 my $custnum = $old_cust_pkg[0]->custnum;
3308 my (@remove) = map { $_->pkgnum }
3309 grep { $_->custnum == $custnum } @old_cust_pkg;
3310 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3312 my $error = order $custnum, $pkgparts, \@remove, \@return;
3314 push @errors, $error
3316 push @$return_cust_pkg, @return;
3319 if (scalar(@errors)) {
3320 $dbh->rollback if $oldAutoCommit;
3321 return join(' / ', @errors);
3324 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3328 # Used by FS::Upgrade to migrate to a new database.
3329 sub _upgrade_data { # class method
3330 my ($class, %opts) = @_;
3331 $class->_upgrade_otaker(%opts);
3332 my $sql =('UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1');
3333 my $sth = dbh->prepare($sql);
3334 $sth->execute or die $sth->errstr;
3341 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3343 In sub order, the @pkgparts array (passed by reference) is clobbered.
3345 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3346 method to pass dates to the recur_prog expression, it should do so.
3348 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3349 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3350 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3351 configuration values. Probably need a subroutine which decides what to do
3352 based on whether or not we've fetched the user yet, rather than a hash. See
3353 FS::UID and the TODO.
3355 Now that things are transactional should the check in the insert method be
3360 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3361 L<FS::pkg_svc>, schema.html from the base documentation