4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common );
6 use vars qw($disable_agentcheck $DEBUG $me);
8 use Scalar::Util qw( blessed );
9 use List::Util qw(max);
11 use Time::Local qw( timelocal timelocal_nocheck );
13 use FS::UID qw( getotaker dbh );
14 use FS::Misc qw( send_email );
15 use FS::Record qw( qsearch qsearchs fields );
20 use FS::cust_location;
22 use FS::cust_bill_pkg;
23 use FS::cust_pkg_detail;
28 use FS::cust_pkg_reason;
30 use FS::cust_pkg_discount;
35 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
37 # because they load configuration by setting FS::UID::callback (see TODO)
43 # for sending cancel emails in sub cancel
47 $me = '[FS::cust_pkg]';
49 $disable_agentcheck = 0;
53 my ( $hashref, $cache ) = @_;
54 #if ( $hashref->{'pkgpart'} ) {
55 if ( $hashref->{'pkg'} ) {
56 # #@{ $self->{'_pkgnum'} } = ();
57 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
58 # $self->{'_pkgpart'} = $subcache;
59 # #push @{ $self->{'_pkgnum'} },
60 # FS::part_pkg->new_or_cached($hashref, $subcache);
61 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
63 if ( exists $hashref->{'svcnum'} ) {
64 #@{ $self->{'_pkgnum'} } = ();
65 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
66 $self->{'_svcnum'} = $subcache;
67 #push @{ $self->{'_pkgnum'} },
68 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
74 FS::cust_pkg - Object methods for cust_pkg objects
80 $record = new FS::cust_pkg \%hash;
81 $record = new FS::cust_pkg { 'column' => 'value' };
83 $error = $record->insert;
85 $error = $new_record->replace($old_record);
87 $error = $record->delete;
89 $error = $record->check;
91 $error = $record->cancel;
93 $error = $record->suspend;
95 $error = $record->unsuspend;
97 $part_pkg = $record->part_pkg;
99 @labels = $record->labels;
101 $seconds = $record->seconds_since($timestamp);
103 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
104 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
108 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
109 inherits from FS::Record. The following fields are currently supported:
115 Primary key (assigned automatically for new billing items)
119 Customer (see L<FS::cust_main>)
123 Billing item definition (see L<FS::part_pkg>)
127 Optional link to package location (see L<FS::location>)
131 date package was ordered (also remains same on changes)
143 date (next bill date)
171 order taker (see L<FS::access_user>)
175 If this field is set to 1, disables the automatic
176 unsuspension of this package when using the B<unsuspendauto> config option.
180 If not set, defaults to 1
184 Date of change from previous package
194 =item change_locationnum
202 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
203 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
204 L<Time::Local> and L<Date::Parse> for conversion functions.
212 Create a new billing item. To add the item to the database, see L<"insert">.
216 sub table { 'cust_pkg'; }
217 sub cust_linked { $_[0]->cust_main_custnum; }
218 sub cust_unlinked_msg {
220 "WARNING: can't find cust_main.custnum ". $self->custnum.
221 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
224 =item insert [ OPTION => VALUE ... ]
226 Adds this billing item to the database ("Orders" the item). If there is an
227 error, returns the error, otherwise returns false.
229 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
230 will be used to look up the package definition and agent restrictions will be
233 If the additional field I<refnum> is defined, an FS::pkg_referral record will
234 be created and inserted. Multiple FS::pkg_referral records can be created by
235 setting I<refnum> to an array reference of refnums or a hash reference with
236 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
237 record will be created corresponding to cust_main.refnum.
239 The following options are available:
245 If set true, supresses any referral credit to a referring customer.
249 cust_pkg_option records will be created
253 a ticket will be added to this customer with this subject
257 an optional queue name for ticket additions
264 my( $self, %options ) = @_;
266 my $error = $self->check_pkgpart;
267 return $error if $error;
269 my $part_pkg = $self->part_pkg;
271 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
272 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
273 $mon += 1 unless $mday == 1;
274 until ( $mon < 12 ) { $mon -= 12; $year++; }
275 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
278 foreach my $action ( qw(expire adjourn contract_end) ) {
279 my $months = $part_pkg->option("${action}_months",1);
280 if($months and !$self->$action) {
281 my $start = $self->start_date || $self->setup || time;
282 $self->$action( $part_pkg->add_freq($start, $months) );
286 my $free_days = $part_pkg->option('free_days',1);
287 if ( $free_days && $part_pkg->option('delay_setup',1) ) { #&& !$self->start_date
288 my ($mday,$mon,$year) = (localtime(time) )[3,4,5];
289 #my $start_date = ($self->start_date || timelocal(0,0,0,$mday,$mon,$year)) + 86400 * $free_days;
290 my $start_date = timelocal(0,0,0,$mday,$mon,$year) + 86400 * $free_days;
291 $self->start_date($start_date);
294 $self->order_date(time);
296 local $SIG{HUP} = 'IGNORE';
297 local $SIG{INT} = 'IGNORE';
298 local $SIG{QUIT} = 'IGNORE';
299 local $SIG{TERM} = 'IGNORE';
300 local $SIG{TSTP} = 'IGNORE';
301 local $SIG{PIPE} = 'IGNORE';
303 my $oldAutoCommit = $FS::UID::AutoCommit;
304 local $FS::UID::AutoCommit = 0;
307 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
309 $dbh->rollback if $oldAutoCommit;
313 $self->refnum($self->cust_main->refnum) unless $self->refnum;
314 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
315 $self->process_m2m( 'link_table' => 'pkg_referral',
316 'target_table' => 'part_referral',
317 'params' => $self->refnum,
320 if ( $self->discountnum ) {
321 my $error = $self->insert_discount();
323 $dbh->rollback if $oldAutoCommit;
328 #if ( $self->reg_code ) {
329 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
330 # $error = $reg_code->delete;
332 # $dbh->rollback if $oldAutoCommit;
337 my $conf = new FS::Conf;
339 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
342 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
349 use FS::TicketSystem;
350 FS::TicketSystem->init();
352 my $q = new RT::Queue($RT::SystemUser);
353 $q->Load($options{ticket_queue}) if $options{ticket_queue};
354 my $t = new RT::Ticket($RT::SystemUser);
355 my $mime = new MIME::Entity;
356 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
357 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
358 Subject => $options{ticket_subject},
361 $t->AddLink( Type => 'MemberOf',
362 Target => 'freeside://freeside/cust_main/'. $self->custnum,
366 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
367 my $queue = new FS::queue {
368 'job' => 'FS::cust_main::queueable_print',
370 $error = $queue->insert(
371 'custnum' => $self->custnum,
372 'template' => 'welcome_letter',
376 warn "can't send welcome letter: $error";
381 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
388 This method now works but you probably shouldn't use it.
390 You don't want to delete packages, because there would then be no record
391 the customer ever purchased the package. Instead, see the cancel method and
392 hide cancelled packages.
399 local $SIG{HUP} = 'IGNORE';
400 local $SIG{INT} = 'IGNORE';
401 local $SIG{QUIT} = 'IGNORE';
402 local $SIG{TERM} = 'IGNORE';
403 local $SIG{TSTP} = 'IGNORE';
404 local $SIG{PIPE} = 'IGNORE';
406 my $oldAutoCommit = $FS::UID::AutoCommit;
407 local $FS::UID::AutoCommit = 0;
410 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
411 my $error = $cust_pkg_discount->delete;
413 $dbh->rollback if $oldAutoCommit;
417 #cust_bill_pkg_discount?
419 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
420 my $error = $cust_pkg_detail->delete;
422 $dbh->rollback if $oldAutoCommit;
427 foreach my $cust_pkg_reason (
429 'table' => 'cust_pkg_reason',
430 'hashref' => { 'pkgnum' => $self->pkgnum },
434 my $error = $cust_pkg_reason->delete;
436 $dbh->rollback if $oldAutoCommit;
443 my $error = $self->SUPER::delete(@_);
445 $dbh->rollback if $oldAutoCommit;
449 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
455 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
457 Replaces the OLD_RECORD with this one in the database. If there is an error,
458 returns the error, otherwise returns false.
460 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
462 Changing pkgpart may have disasterous effects. See the order subroutine.
464 setup and bill are normally updated by calling the bill method of a customer
465 object (see L<FS::cust_main>).
467 suspend is normally updated by the suspend and unsuspend methods.
469 cancel is normally updated by the cancel method (and also the order subroutine
472 Available options are:
478 can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
482 the access_user (see L<FS::access_user>) providing the reason
486 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
495 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
500 ( ref($_[0]) eq 'HASH' )
504 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
505 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
508 #return "Can't change setup once it exists!"
509 # if $old->getfield('setup') &&
510 # $old->getfield('setup') != $new->getfield('setup');
512 #some logic for bill, susp, cancel?
514 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
516 local $SIG{HUP} = 'IGNORE';
517 local $SIG{INT} = 'IGNORE';
518 local $SIG{QUIT} = 'IGNORE';
519 local $SIG{TERM} = 'IGNORE';
520 local $SIG{TSTP} = 'IGNORE';
521 local $SIG{PIPE} = 'IGNORE';
523 my $oldAutoCommit = $FS::UID::AutoCommit;
524 local $FS::UID::AutoCommit = 0;
527 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
528 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
529 my $error = $new->insert_reason(
530 'reason' => $options->{'reason'},
531 'date' => $new->$method,
533 'reason_otaker' => $options->{'reason_otaker'},
536 dbh->rollback if $oldAutoCommit;
537 return "Error inserting cust_pkg_reason: $error";
542 #save off and freeze RADIUS attributes for any associated svc_acct records
544 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
546 #also check for specific exports?
547 # to avoid spurious modify export events
548 @svc_acct = map { $_->svc_x }
549 grep { $_->part_svc->svcdb eq 'svc_acct' }
552 $_->snapshot foreach @svc_acct;
556 my $error = $new->SUPER::replace($old,
557 $options->{options} ? $options->{options} : ()
560 $dbh->rollback if $oldAutoCommit;
564 #for prepaid packages,
565 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
566 foreach my $old_svc_acct ( @svc_acct ) {
567 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
569 $new_svc_acct->replace( $old_svc_acct,
570 'depend_jobnum' => $options->{depend_jobnum},
573 $dbh->rollback if $oldAutoCommit;
578 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
585 Checks all fields to make sure this is a valid billing item. If there is an
586 error, returns the error, otherwise returns false. Called by the insert and
594 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
597 $self->ut_numbern('pkgnum')
598 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
599 || $self->ut_numbern('pkgpart')
600 || $self->check_pkgpart
601 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
602 || $self->ut_numbern('start_date')
603 || $self->ut_numbern('setup')
604 || $self->ut_numbern('bill')
605 || $self->ut_numbern('susp')
606 || $self->ut_numbern('cancel')
607 || $self->ut_numbern('adjourn')
608 || $self->ut_numbern('resume')
609 || $self->ut_numbern('expire')
610 || $self->ut_numbern('dundate')
611 || $self->ut_enum('no_auto', [ '', 'Y' ])
612 || $self->ut_enum('waive_setup', [ '', 'Y' ])
613 || $self->ut_numbern('agent_pkgid')
614 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
615 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
617 return $error if $error;
619 return "A package with both start date (future start) and setup date (already started) will never bill"
620 if $self->start_date && $self->setup;
622 return "A future unsuspend date can only be set for a package with a suspend date"
623 if $self->resume and !$self->susp and !$self->adjourn;
625 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
627 if ( $self->dbdef_table->column('manual_flag') ) {
628 $self->manual_flag('') if $self->manual_flag eq ' ';
629 $self->manual_flag =~ /^([01]?)$/
630 or return "Illegal manual_flag ". $self->manual_flag;
631 $self->manual_flag($1);
644 my $error = $self->ut_numbern('pkgpart');
645 return $error if $error;
647 if ( $self->reg_code ) {
649 unless ( grep { $self->pkgpart == $_->pkgpart }
650 map { $_->reg_code_pkg }
651 qsearchs( 'reg_code', { 'code' => $self->reg_code,
652 'agentnum' => $self->cust_main->agentnum })
654 return "Unknown registration code";
657 } elsif ( $self->promo_code ) {
660 qsearchs('part_pkg', {
661 'pkgpart' => $self->pkgpart,
662 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
664 return 'Unknown promotional code' unless $promo_part_pkg;
668 unless ( $disable_agentcheck ) {
670 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
671 return "agent ". $agent->agentnum. ':'. $agent->agent.
672 " can't purchase pkgpart ". $self->pkgpart
673 unless $agent->pkgpart_hashref->{ $self->pkgpart }
674 || $agent->agentnum == $self->part_pkg->agentnum;
677 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
678 return $error if $error;
686 =item cancel [ OPTION => VALUE ... ]
688 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
689 in this package, then cancels the package itself (sets the cancel field to
692 Available options are:
696 =item quiet - can be set true to supress email cancellation notices.
698 =item time - can be set to cancel the package based on a specific future or
699 historical date. Using time ensures that the remaining amount is calculated
700 correctly. Note however that this is an immediate cancel and just changes
701 the date. You are PROBABLY looking to expire the account instead of using
704 =item reason - can be set to a cancellation reason (see L<FS:reason>),
705 either a reasonnum of an existing reason, or passing a hashref will create
706 a new reason. The hashref should have the following keys: typenum - Reason
707 type (see L<FS::reason_type>, reason - Text of the new reason.
709 =item date - can be set to a unix style timestamp to specify when to
712 =item nobill - can be set true to skip billing if it might otherwise be done.
714 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
715 not credit it. This must be set (by change()) when changing the package
716 to a different pkgpart or location, and probably shouldn't be in any other
717 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
722 If there is an error, returns the error, otherwise returns false.
727 my( $self, %options ) = @_;
730 my $conf = new FS::Conf;
732 warn "cust_pkg::cancel called with options".
733 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
736 local $SIG{HUP} = 'IGNORE';
737 local $SIG{INT} = 'IGNORE';
738 local $SIG{QUIT} = 'IGNORE';
739 local $SIG{TERM} = 'IGNORE';
740 local $SIG{TSTP} = 'IGNORE';
741 local $SIG{PIPE} = 'IGNORE';
743 my $oldAutoCommit = $FS::UID::AutoCommit;
744 local $FS::UID::AutoCommit = 0;
747 my $old = $self->select_for_update;
749 if ( $old->get('cancel') || $self->get('cancel') ) {
750 dbh->rollback if $oldAutoCommit;
751 return ""; # no error
754 # XXX possibly set cancel_time to the expire date?
755 my $cancel_time = $options{'time'} || time;
756 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
757 $date = '' if ($date && $date <= $cancel_time); # complain instead?
759 #race condition: usage could be ongoing until unprovisioned
760 #resolved by performing a change package instead (which unprovisions) and
762 if ( !$options{nobill} && !$date ) {
763 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
764 my $copy = $self->new({$self->hash});
766 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
768 'time' => $cancel_time );
769 warn "Error billing during cancel, custnum ".
770 #$self->cust_main->custnum. ": $error"
775 if ( $options{'reason'} ) {
776 $error = $self->insert_reason( 'reason' => $options{'reason'},
777 'action' => $date ? 'expire' : 'cancel',
778 'date' => $date ? $date : $cancel_time,
779 'reason_otaker' => $options{'reason_otaker'},
782 dbh->rollback if $oldAutoCommit;
783 return "Error inserting cust_pkg_reason: $error";
787 my %svc_cancel_opt = ();
788 $svc_cancel_opt{'date'} = $date if $date;
789 foreach my $cust_svc (
792 sort { $a->[1] <=> $b->[1] }
793 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
794 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
796 my $part_svc = $cust_svc->part_svc;
797 next if ( defined($part_svc) and $part_svc->preserve );
798 my $error = $cust_svc->cancel( %svc_cancel_opt );
801 $dbh->rollback if $oldAutoCommit;
802 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
808 # credit remaining time if appropriate
810 if ( exists($options{'unused_credit'}) ) {
811 $do_credit = $options{'unused_credit'};
814 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
817 my $error = $self->credit_remaining('cancel', $cancel_time);
819 $dbh->rollback if $oldAutoCommit;
826 my %hash = $self->hash;
827 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
828 my $new = new FS::cust_pkg ( \%hash );
829 $error = $new->replace( $self, options => { $self->options } );
831 $dbh->rollback if $oldAutoCommit;
835 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
836 return '' if $date; #no errors
838 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
839 if ( !$options{'quiet'} &&
840 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
842 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
845 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
846 $error = $msg_template->send( 'cust_main' => $self->cust_main,
851 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
852 'to' => \@invoicing_list,
853 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
854 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
857 #should this do something on errors?
864 =item cancel_if_expired [ NOW_TIMESTAMP ]
866 Cancels this package if its expire date has been reached.
870 sub cancel_if_expired {
872 my $time = shift || time;
873 return '' unless $self->expire && $self->expire <= $time;
874 my $error = $self->cancel;
876 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
877 $self->custnum. ": $error";
884 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
885 locationnum, (other fields?). Attempts to re-provision cancelled services
886 using history information (errors at this stage are not fatal).
888 cust_pkg: pass a scalar reference, will be filled in with
890 svc_errors: pass an array reference, will be filled in with any provisioning errors
895 my( $self, %options ) = @_;
897 #in case you try do do $uncancel-date = $cust_pkg->uncacel
898 return '' unless $self->get('cancel');
904 local $SIG{HUP} = 'IGNORE';
905 local $SIG{INT} = 'IGNORE';
906 local $SIG{QUIT} = 'IGNORE';
907 local $SIG{TERM} = 'IGNORE';
908 local $SIG{TSTP} = 'IGNORE';
909 local $SIG{PIPE} = 'IGNORE';
911 my $oldAutoCommit = $FS::UID::AutoCommit;
912 local $FS::UID::AutoCommit = 0;
916 # insert the new package
919 my $cust_pkg = new FS::cust_pkg {
920 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
921 bill => ( $options{'bill'} || $self->get('bill') ),
923 uncancel_pkgnum => $self->pkgnum,
924 map { $_ => $self->get($_) } qw(
925 custnum pkgpart locationnum
927 susp adjourn resume expire start_date contract_end dundate
928 change_date change_pkgpart change_locationnum
929 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
933 my $error = $cust_pkg->insert(
934 'change' => 1, #supresses any referral credit to a referring customer
937 $dbh->rollback if $oldAutoCommit;
945 #find historical services within this timeframe before the package cancel
946 # (incompatible with "time" option to cust_pkg->cancel?)
947 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
948 # too little? (unprovisioing export delay?)
949 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
950 my @h_cust_svc = $self->h_cust_svc( $end, $start );
953 foreach my $h_cust_svc (@h_cust_svc) {
954 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
955 #next unless $h_svc_x; #should this happen?
956 (my $table = $h_svc_x->table) =~ s/^h_//;
957 require "FS/$table.pm";
958 my $class = "FS::$table";
959 my $svc_x = $class->new( {
960 'pkgnum' => $cust_pkg->pkgnum,
961 'svcpart' => $h_cust_svc->svcpart,
962 map { $_ => $h_svc_x->get($_) } fields($table)
966 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
967 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
970 my $svc_error = $svc_x->insert;
971 if ( $svc_error ) { #&& $options{svc_fatal} ) {
972 $dbh->rollback if $oldAutoCommit;
975 push @svc_errors, $svc_error if $svc_error;
978 #these are pretty rare, but should handle them
979 # - dsl_device (mac addresses)
980 # - phone_device (mac addresses)
981 # - dsl_note (ikano notes)
982 # - domain_record (i.e. restore DNS information w/domains)
983 # - inventory_item(?) (inventory w/un-cancelling service?)
984 # - nas (svc_broaband nas stuff)
985 #this stuff is unused in the wild afaik
986 # - mailinglistmember
988 # - svc_domain.parent_svcnum?
989 # - acct_snarf (ancient mail fetching config)
990 # - cgp_rule (communigate)
991 # - cust_svc_option (used by our Tron stuff)
992 # - acct_rt_transaction (used by our time worked stuff)
995 # also move over any services that didn't unprovision at cancellation
998 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
999 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1000 my $error = $cust_svc->replace;
1002 $dbh->rollback if $oldAutoCommit;
1011 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1013 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1014 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1021 Cancels any pending expiration (sets the expire field to null).
1023 If there is an error, returns the error, otherwise returns false.
1028 my( $self, %options ) = @_;
1031 local $SIG{HUP} = 'IGNORE';
1032 local $SIG{INT} = 'IGNORE';
1033 local $SIG{QUIT} = 'IGNORE';
1034 local $SIG{TERM} = 'IGNORE';
1035 local $SIG{TSTP} = 'IGNORE';
1036 local $SIG{PIPE} = 'IGNORE';
1038 my $oldAutoCommit = $FS::UID::AutoCommit;
1039 local $FS::UID::AutoCommit = 0;
1042 my $old = $self->select_for_update;
1044 my $pkgnum = $old->pkgnum;
1045 if ( $old->get('cancel') || $self->get('cancel') ) {
1046 dbh->rollback if $oldAutoCommit;
1047 return "Can't unexpire cancelled package $pkgnum";
1048 # or at least it's pointless
1051 unless ( $old->get('expire') && $self->get('expire') ) {
1052 dbh->rollback if $oldAutoCommit;
1053 return ""; # no error
1056 my %hash = $self->hash;
1057 $hash{'expire'} = '';
1058 my $new = new FS::cust_pkg ( \%hash );
1059 $error = $new->replace( $self, options => { $self->options } );
1061 $dbh->rollback if $oldAutoCommit;
1065 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1071 =item suspend [ OPTION => VALUE ... ]
1073 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1074 package, then suspends the package itself (sets the susp field to now).
1076 Available options are:
1080 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1081 either a reasonnum of an existing reason, or passing a hashref will create
1082 a new reason. The hashref should have the following keys:
1083 - typenum - Reason type (see L<FS::reason_type>
1084 - reason - Text of the new reason.
1086 =item date - can be set to a unix style timestamp to specify when to
1089 =item time - can be set to override the current time, for calculation
1090 of final invoices or unused-time credits
1092 =item resume_date - can be set to a time when the package should be
1093 unsuspended. This may be more convenient than calling C<unsuspend()>
1098 If there is an error, returns the error, otherwise returns false.
1103 my( $self, %options ) = @_;
1106 local $SIG{HUP} = 'IGNORE';
1107 local $SIG{INT} = 'IGNORE';
1108 local $SIG{QUIT} = 'IGNORE';
1109 local $SIG{TERM} = 'IGNORE';
1110 local $SIG{TSTP} = 'IGNORE';
1111 local $SIG{PIPE} = 'IGNORE';
1113 my $oldAutoCommit = $FS::UID::AutoCommit;
1114 local $FS::UID::AutoCommit = 0;
1117 my $old = $self->select_for_update;
1119 my $pkgnum = $old->pkgnum;
1120 if ( $old->get('cancel') || $self->get('cancel') ) {
1121 dbh->rollback if $oldAutoCommit;
1122 return "Can't suspend cancelled package $pkgnum";
1125 if ( $old->get('susp') || $self->get('susp') ) {
1126 dbh->rollback if $oldAutoCommit;
1127 return ""; # no error # complain on adjourn?
1130 my $suspend_time = $options{'time'} || time;
1131 my $date = $options{date} if $options{date}; # adjourn/suspend later
1132 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1134 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1135 dbh->rollback if $oldAutoCommit;
1136 return "Package $pkgnum expires before it would be suspended.";
1139 # some false laziness with sub cancel
1140 if ( !$options{nobill} && !$date &&
1141 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1142 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1143 # make the entire cust_main->bill path recognize 'suspend' and
1144 # 'cancel' separately.
1145 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1146 my $copy = $self->new({$self->hash});
1148 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1150 'time' => $suspend_time );
1151 warn "Error billing during suspend, custnum ".
1152 #$self->cust_main->custnum. ": $error"
1157 if ( $options{'reason'} ) {
1158 $error = $self->insert_reason( 'reason' => $options{'reason'},
1159 'action' => $date ? 'adjourn' : 'suspend',
1160 'date' => $date ? $date : $suspend_time,
1161 'reason_otaker' => $options{'reason_otaker'},
1164 dbh->rollback if $oldAutoCommit;
1165 return "Error inserting cust_pkg_reason: $error";
1169 my %hash = $self->hash;
1171 $hash{'adjourn'} = $date;
1173 $hash{'susp'} = $suspend_time;
1176 my $resume_date = $options{'resume_date'} || 0;
1177 if ( $resume_date > ($date || $suspend_time) ) {
1178 $hash{'resume'} = $resume_date;
1181 my $new = new FS::cust_pkg ( \%hash );
1182 $error = $new->replace( $self, options => { $self->options } );
1184 $dbh->rollback if $oldAutoCommit;
1189 # credit remaining time if appropriate
1190 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1191 my $error = $self->credit_remaining('suspend', $suspend_time);
1193 $dbh->rollback if $oldAutoCommit;
1200 foreach my $cust_svc (
1201 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1203 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1205 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1206 $dbh->rollback if $oldAutoCommit;
1207 return "Illegal svcdb value in part_svc!";
1210 require "FS/$svcdb.pm";
1212 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1214 $error = $svc->suspend;
1216 $dbh->rollback if $oldAutoCommit;
1219 my( $label, $value ) = $cust_svc->label;
1220 push @labels, "$label: $value";
1224 my $conf = new FS::Conf;
1225 if ( $conf->config('suspend_email_admin') ) {
1227 my $error = send_email(
1228 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1229 #invoice_from ??? well as good as any
1230 'to' => $conf->config('suspend_email_admin'),
1231 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1233 "This is an automatic message from your Freeside installation\n",
1234 "informing you that the following customer package has been suspended:\n",
1236 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1237 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1238 ( map { "Service : $_\n" } @labels ),
1243 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1251 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1256 =item credit_remaining MODE TIME
1258 Generate a credit for this package for the time remaining in the current
1259 billing period. MODE is either "suspend" or "cancel" (determines the
1260 credit type). TIME is the time of suspension/cancellation. Both arguments
1265 sub credit_remaining {
1266 # Add a credit for remaining service
1267 my ($self, $mode, $time) = @_;
1268 die 'credit_remaining requires suspend or cancel'
1269 unless $mode eq 'suspend' or $mode eq 'cancel';
1270 die 'no suspend/cancel time' unless $time > 0;
1272 my $conf = FS::Conf->new;
1273 my $reason_type = $conf->config($mode.'_credit_type');
1275 my $last_bill = $self->getfield('last_bill') || 0;
1276 my $next_bill = $self->getfield('bill') || 0;
1277 if ( $last_bill > 0 # the package has been billed
1278 and $next_bill > 0 # the package has a next bill date
1279 and $next_bill >= $time # which is in the future
1281 my $remaining_value = $self->calc_remain('time' => $time);
1282 if ( $remaining_value > 0 ) {
1283 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1285 my $error = $self->cust_main->credit(
1287 'Credit for unused time on '. $self->part_pkg->pkg,
1288 'reason_type' => $reason_type,
1290 return "Error crediting customer \$$remaining_value for unused time".
1291 " on ". $self->part_pkg->pkg. ": $error"
1293 } #if $remaining_value
1294 } #if $last_bill, etc.
1298 =item unsuspend [ OPTION => VALUE ... ]
1300 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1301 package, then unsuspends the package itself (clears the susp field and the
1302 adjourn field if it is in the past).
1304 Available options are:
1310 Can be set to a date to unsuspend the package in the future (the 'resume'
1313 =item adjust_next_bill
1315 Can be set true to adjust the next bill date forward by
1316 the amount of time the account was inactive. This was set true by default
1317 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1318 explicitly requested. Price plans for which this makes sense (anniversary-date
1319 based than prorate or subscription) could have an option to enable this
1324 If there is an error, returns the error, otherwise returns false.
1329 my( $self, %opt ) = @_;
1332 local $SIG{HUP} = 'IGNORE';
1333 local $SIG{INT} = 'IGNORE';
1334 local $SIG{QUIT} = 'IGNORE';
1335 local $SIG{TERM} = 'IGNORE';
1336 local $SIG{TSTP} = 'IGNORE';
1337 local $SIG{PIPE} = 'IGNORE';
1339 my $oldAutoCommit = $FS::UID::AutoCommit;
1340 local $FS::UID::AutoCommit = 0;
1343 my $old = $self->select_for_update;
1345 my $pkgnum = $old->pkgnum;
1346 if ( $old->get('cancel') || $self->get('cancel') ) {
1347 $dbh->rollback if $oldAutoCommit;
1348 return "Can't unsuspend cancelled package $pkgnum";
1351 unless ( $old->get('susp') && $self->get('susp') ) {
1352 $dbh->rollback if $oldAutoCommit;
1353 return ""; # no error # complain instead?
1356 my $date = $opt{'date'};
1357 if ( $date and $date > time ) { # return an error if $date <= time?
1359 if ( $old->get('expire') && $old->get('expire') < $date ) {
1360 $dbh->rollback if $oldAutoCommit;
1361 return "Package $pkgnum expires before it would be unsuspended.";
1364 my $new = new FS::cust_pkg { $self->hash };
1365 $new->set('resume', $date);
1366 $error = $new->replace($self, options => $self->options);
1369 $dbh->rollback if $oldAutoCommit;
1373 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1381 foreach my $cust_svc (
1382 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1384 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1386 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1387 $dbh->rollback if $oldAutoCommit;
1388 return "Illegal svcdb value in part_svc!";
1391 require "FS/$svcdb.pm";
1393 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1395 $error = $svc->unsuspend;
1397 $dbh->rollback if $oldAutoCommit;
1400 my( $label, $value ) = $cust_svc->label;
1401 push @labels, "$label: $value";
1406 my %hash = $self->hash;
1407 my $inactive = time - $hash{'susp'};
1409 my $conf = new FS::Conf;
1411 if ( $inactive > 0 &&
1412 ( $hash{'bill'} || $hash{'setup'} ) &&
1413 ( $opt{'adjust_next_bill'} ||
1414 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1415 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1418 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1423 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1424 $hash{'resume'} = '' if !$hash{'adjourn'};
1425 my $new = new FS::cust_pkg ( \%hash );
1426 $error = $new->replace( $self, options => { $self->options } );
1428 $dbh->rollback if $oldAutoCommit;
1432 if ( $conf->config('unsuspend_email_admin') ) {
1434 my $error = send_email(
1435 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1436 #invoice_from ??? well as good as any
1437 'to' => $conf->config('unsuspend_email_admin'),
1438 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1439 "This is an automatic message from your Freeside installation\n",
1440 "informing you that the following customer package has been unsuspended:\n",
1442 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1443 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1444 ( map { "Service : $_\n" } @labels ),
1449 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1455 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1462 Cancels any pending suspension (sets the adjourn field to null).
1464 If there is an error, returns the error, otherwise returns false.
1469 my( $self, %options ) = @_;
1472 local $SIG{HUP} = 'IGNORE';
1473 local $SIG{INT} = 'IGNORE';
1474 local $SIG{QUIT} = 'IGNORE';
1475 local $SIG{TERM} = 'IGNORE';
1476 local $SIG{TSTP} = 'IGNORE';
1477 local $SIG{PIPE} = 'IGNORE';
1479 my $oldAutoCommit = $FS::UID::AutoCommit;
1480 local $FS::UID::AutoCommit = 0;
1483 my $old = $self->select_for_update;
1485 my $pkgnum = $old->pkgnum;
1486 if ( $old->get('cancel') || $self->get('cancel') ) {
1487 dbh->rollback if $oldAutoCommit;
1488 return "Can't unadjourn cancelled package $pkgnum";
1489 # or at least it's pointless
1492 if ( $old->get('susp') || $self->get('susp') ) {
1493 dbh->rollback if $oldAutoCommit;
1494 return "Can't unadjourn suspended package $pkgnum";
1495 # perhaps this is arbitrary
1498 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1499 dbh->rollback if $oldAutoCommit;
1500 return ""; # no error
1503 my %hash = $self->hash;
1504 $hash{'adjourn'} = '';
1505 $hash{'resume'} = '';
1506 my $new = new FS::cust_pkg ( \%hash );
1507 $error = $new->replace( $self, options => { $self->options } );
1509 $dbh->rollback if $oldAutoCommit;
1513 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1520 =item change HASHREF | OPTION => VALUE ...
1522 Changes this package: cancels it and creates a new one, with a different
1523 pkgpart or locationnum or both. All services are transferred to the new
1524 package (no change will be made if this is not possible).
1526 Options may be passed as a list of key/value pairs or as a hash reference.
1533 New locationnum, to change the location for this package.
1537 New FS::cust_location object, to create a new location and assign it
1542 New pkgpart (see L<FS::part_pkg>).
1546 New refnum (see L<FS::part_referral>).
1550 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1551 susp, adjourn, cancel, expire, and contract_end) to the new package.
1555 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1556 (otherwise, what's the point?)
1558 Returns either the new FS::cust_pkg object or a scalar error.
1562 my $err_or_new_cust_pkg = $old_cust_pkg->change
1566 #some false laziness w/order
1569 my $opt = ref($_[0]) ? shift : { @_ };
1571 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1574 my $conf = new FS::Conf;
1576 # Transactionize this whole mess
1577 local $SIG{HUP} = 'IGNORE';
1578 local $SIG{INT} = 'IGNORE';
1579 local $SIG{QUIT} = 'IGNORE';
1580 local $SIG{TERM} = 'IGNORE';
1581 local $SIG{TSTP} = 'IGNORE';
1582 local $SIG{PIPE} = 'IGNORE';
1584 my $oldAutoCommit = $FS::UID::AutoCommit;
1585 local $FS::UID::AutoCommit = 0;
1594 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1596 #$hash{$_} = $self->$_() foreach qw( setup );
1598 $hash{'setup'} = $time if $self->setup;
1600 $hash{'change_date'} = $time;
1601 $hash{"change_$_"} = $self->$_()
1602 foreach qw( pkgnum pkgpart locationnum );
1604 if ( $opt->{'cust_location'} &&
1605 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1606 $error = $opt->{'cust_location'}->insert;
1608 $dbh->rollback if $oldAutoCommit;
1609 return "inserting cust_location (transaction rolled back): $error";
1611 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1614 my $unused_credit = 0;
1615 my $keep_dates = $opt->{'keep_dates'};
1616 # Special case. If the pkgpart is changing, and the customer is
1617 # going to be credited for remaining time, don't keep setup, bill,
1618 # or last_bill dates, and DO pass the flag to cancel() to credit
1620 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
1622 $unused_credit = 1 if $self->part_pkg->option('unused_credit_change', 1);
1623 $hash{$_} = '' foreach qw(setup bill last_bill);
1626 if ( $keep_dates ) {
1627 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1628 resume start_date contract_end ) ) {
1629 $hash{$date} = $self->getfield($date);
1632 # allow $opt->{'locationnum'} = '' to specifically set it to null
1633 # (i.e. customer default location)
1634 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1636 # Create the new package.
1637 my $cust_pkg = new FS::cust_pkg {
1638 custnum => $self->custnum,
1639 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1640 refnum => ( $opt->{'refnum'} || $self->refnum ),
1641 locationnum => ( $opt->{'locationnum'} ),
1645 $error = $cust_pkg->insert( 'change' => 1 );
1647 $dbh->rollback if $oldAutoCommit;
1651 # Transfer services and cancel old package.
1653 $error = $self->transfer($cust_pkg);
1654 if ($error and $error == 0) {
1655 # $old_pkg->transfer failed.
1656 $dbh->rollback if $oldAutoCommit;
1660 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1661 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1662 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1663 if ($error and $error == 0) {
1664 # $old_pkg->transfer failed.
1665 $dbh->rollback if $oldAutoCommit;
1671 # Transfers were successful, but we still had services left on the old
1672 # package. We can't change the package under this circumstances, so abort.
1673 $dbh->rollback if $oldAutoCommit;
1674 return "Unable to transfer all services from package ". $self->pkgnum;
1677 #reset usage if changing pkgpart
1678 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1679 if ($self->pkgpart != $cust_pkg->pkgpart) {
1680 my $part_pkg = $cust_pkg->part_pkg;
1681 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1685 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1688 $dbh->rollback if $oldAutoCommit;
1689 return "Error setting usage values: $error";
1693 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1695 #Don't allow billing the package (preceding period packages and/or
1696 #outstanding usage) if we are keeping dates (i.e. location changing),
1697 #because the new package will be billed for the same date range.
1698 $error = $self->cancel(
1700 unused_credit => $unused_credit,
1701 nobill => $keep_dates
1704 $dbh->rollback if $oldAutoCommit;
1708 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1710 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1712 $dbh->rollback if $oldAutoCommit;
1717 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1723 use Storable 'thaw';
1725 sub process_bulk_cust_pkg {
1727 my $param = thaw(decode_base64(shift));
1728 warn Dumper($param) if $DEBUG;
1730 my $old_part_pkg = qsearchs('part_pkg',
1731 { pkgpart => $param->{'old_pkgpart'} });
1732 my $new_part_pkg = qsearchs('part_pkg',
1733 { pkgpart => $param->{'new_pkgpart'} });
1734 die "Must select a new package type\n" unless $new_part_pkg;
1735 #my $keep_dates = $param->{'keep_dates'} || 0;
1736 my $keep_dates = 1; # there is no good reason to turn this off
1738 local $SIG{HUP} = 'IGNORE';
1739 local $SIG{INT} = 'IGNORE';
1740 local $SIG{QUIT} = 'IGNORE';
1741 local $SIG{TERM} = 'IGNORE';
1742 local $SIG{TSTP} = 'IGNORE';
1743 local $SIG{PIPE} = 'IGNORE';
1745 my $oldAutoCommit = $FS::UID::AutoCommit;
1746 local $FS::UID::AutoCommit = 0;
1749 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1752 foreach my $old_cust_pkg ( @cust_pkgs ) {
1754 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1755 if ( $old_cust_pkg->getfield('cancel') ) {
1756 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1757 $old_cust_pkg->pkgnum."\n"
1761 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1763 my $error = $old_cust_pkg->change(
1764 'pkgpart' => $param->{'new_pkgpart'},
1765 'keep_dates' => $keep_dates
1767 if ( !ref($error) ) { # change returns the cust_pkg on success
1769 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1772 $dbh->commit if $oldAutoCommit;
1778 Returns the last bill date, or if there is no last bill date, the setup date.
1779 Useful for billing metered services.
1785 return $self->setfield('last_bill', $_[0]) if @_;
1786 return $self->getfield('last_bill') if $self->getfield('last_bill');
1787 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1788 'edate' => $self->bill, } );
1789 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1792 =item last_cust_pkg_reason ACTION
1794 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1795 Returns false if there is no reason or the package is not currenly ACTION'd
1796 ACTION is one of adjourn, susp, cancel, or expire.
1800 sub last_cust_pkg_reason {
1801 my ( $self, $action ) = ( shift, shift );
1802 my $date = $self->get($action);
1804 'table' => 'cust_pkg_reason',
1805 'hashref' => { 'pkgnum' => $self->pkgnum,
1806 'action' => substr(uc($action), 0, 1),
1809 'order_by' => 'ORDER BY num DESC LIMIT 1',
1813 =item last_reason ACTION
1815 Returns the most recent ACTION FS::reason associated with the package.
1816 Returns false if there is no reason or the package is not currenly ACTION'd
1817 ACTION is one of adjourn, susp, cancel, or expire.
1822 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1823 $cust_pkg_reason->reason
1824 if $cust_pkg_reason;
1829 Returns the definition for this billing item, as an FS::part_pkg object (see
1836 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1837 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1838 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1843 Returns the cancelled package this package was changed from, if any.
1849 return '' unless $self->change_pkgnum;
1850 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1855 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1862 $self->part_pkg->calc_setup($self, @_);
1867 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1874 $self->part_pkg->calc_recur($self, @_);
1879 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1886 $self->part_pkg->base_recur($self, @_);
1891 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1898 $self->part_pkg->calc_remain($self, @_);
1903 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1910 $self->part_pkg->calc_cancel($self, @_);
1915 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1921 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1924 =item cust_pkg_detail [ DETAILTYPE ]
1926 Returns any customer package details for this package (see
1927 L<FS::cust_pkg_detail>).
1929 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1933 sub cust_pkg_detail {
1935 my %hash = ( 'pkgnum' => $self->pkgnum );
1936 $hash{detailtype} = shift if @_;
1938 'table' => 'cust_pkg_detail',
1939 'hashref' => \%hash,
1940 'order_by' => 'ORDER BY weight, pkgdetailnum',
1944 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1946 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1948 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1950 If there is an error, returns the error, otherwise returns false.
1954 sub set_cust_pkg_detail {
1955 my( $self, $detailtype, @details ) = @_;
1957 local $SIG{HUP} = 'IGNORE';
1958 local $SIG{INT} = 'IGNORE';
1959 local $SIG{QUIT} = 'IGNORE';
1960 local $SIG{TERM} = 'IGNORE';
1961 local $SIG{TSTP} = 'IGNORE';
1962 local $SIG{PIPE} = 'IGNORE';
1964 my $oldAutoCommit = $FS::UID::AutoCommit;
1965 local $FS::UID::AutoCommit = 0;
1968 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1969 my $error = $current->delete;
1971 $dbh->rollback if $oldAutoCommit;
1972 return "error removing old detail: $error";
1976 foreach my $detail ( @details ) {
1977 my $cust_pkg_detail = new FS::cust_pkg_detail {
1978 'pkgnum' => $self->pkgnum,
1979 'detailtype' => $detailtype,
1980 'detail' => $detail,
1982 my $error = $cust_pkg_detail->insert;
1984 $dbh->rollback if $oldAutoCommit;
1985 return "error adding new detail: $error";
1990 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1997 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2001 #false laziness w/cust_bill.pm
2005 'table' => 'cust_event',
2006 'addl_from' => 'JOIN part_event USING ( eventpart )',
2007 'hashref' => { 'tablenum' => $self->pkgnum },
2008 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2012 =item num_cust_event
2014 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2018 #false laziness w/cust_bill.pm
2019 sub num_cust_event {
2022 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2023 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2024 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2025 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2026 $sth->fetchrow_arrayref->[0];
2029 =item cust_svc [ SVCPART ] (old, deprecated usage)
2031 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2033 Returns the services for this package, as FS::cust_svc objects (see
2034 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2035 spcififed, returns only the matching services.
2042 return () unless $self->num_cust_svc(@_);
2045 if ( @_ && $_[0] =~ /^\d+/ ) {
2046 $opt{svcpart} = shift;
2047 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2054 'table' => 'cust_svc',
2055 'hashref' => { 'pkgnum' => $self->pkgnum },
2057 if ( $opt{svcpart} ) {
2058 $search{hashref}->{svcpart} = $opt{'svcpart'};
2060 if ( $opt{'svcdb'} ) {
2061 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2062 $search{hashref}->{svcdb} = $opt{'svcdb'};
2065 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2067 #if ( $self->{'_svcnum'} ) {
2068 # values %{ $self->{'_svcnum'}->cache };
2070 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2075 =item overlimit [ SVCPART ]
2077 Returns the services for this package which have exceeded their
2078 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2079 is specified, return only the matching services.
2085 return () unless $self->num_cust_svc(@_);
2086 grep { $_->overlimit } $self->cust_svc(@_);
2089 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2091 Returns historical services for this package created before END TIMESTAMP and
2092 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2093 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2094 I<pkg_svc.hidden> flag will be omitted.
2100 warn "$me _h_cust_svc called on $self\n"
2103 my ($end, $start, $mode) = @_;
2104 my @cust_svc = $self->_sort_cust_svc(
2105 [ qsearch( 'h_cust_svc',
2106 { 'pkgnum' => $self->pkgnum, },
2107 FS::h_cust_svc->sql_h_search(@_),
2110 if ( defined($mode) && $mode eq 'I' ) {
2111 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2112 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2118 sub _sort_cust_svc {
2119 my( $self, $arrayref ) = @_;
2122 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2127 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2128 'svcpart' => $_->svcpart } );
2130 $pkg_svc ? $pkg_svc->primary_svc : '',
2131 $pkg_svc ? $pkg_svc->quantity : 0,
2138 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2140 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2142 Returns the number of services for this package. Available options are svcpart
2143 and svcdb. If either is spcififed, returns only the matching services.
2150 return $self->{'_num_cust_svc'}
2152 && exists($self->{'_num_cust_svc'})
2153 && $self->{'_num_cust_svc'} =~ /\d/;
2155 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2159 if ( @_ && $_[0] =~ /^\d+/ ) {
2160 $opt{svcpart} = shift;
2161 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2167 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2168 my $where = ' WHERE pkgnum = ? ';
2169 my @param = ($self->pkgnum);
2171 if ( $opt{'svcpart'} ) {
2172 $where .= ' AND svcpart = ? ';
2173 push @param, $opt{'svcpart'};
2175 if ( $opt{'svcdb'} ) {
2176 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2177 $where .= ' AND svcdb = ? ';
2178 push @param, $opt{'svcdb'};
2181 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2182 $sth->execute(@param) or die $sth->errstr;
2183 $sth->fetchrow_arrayref->[0];
2186 =item available_part_svc
2188 Returns a list of FS::part_svc objects representing services included in this
2189 package but not yet provisioned. Each FS::part_svc object also has an extra
2190 field, I<num_avail>, which specifies the number of available services.
2194 sub available_part_svc {
2196 grep { $_->num_avail > 0 }
2198 my $part_svc = $_->part_svc;
2199 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2200 $_->quantity - $self->num_cust_svc($_->svcpart);
2202 # more evil encapsulation breakage
2203 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2204 my @exports = $part_svc->part_export_did;
2205 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2210 $self->part_pkg->pkg_svc;
2213 =item part_svc [ OPTION => VALUE ... ]
2215 Returns a list of FS::part_svc objects representing provisioned and available
2216 services included in this package. Each FS::part_svc object also has the
2217 following extra fields:
2221 =item num_cust_svc (count)
2223 =item num_avail (quantity - count)
2225 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2229 Accepts one option: summarize_size. If specified and non-zero, will omit the
2230 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2236 #label -> ($cust_svc->label)[1]
2242 #XXX some sort of sort order besides numeric by svcpart...
2243 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2245 my $part_svc = $pkg_svc->part_svc;
2246 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2247 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2248 $part_svc->{'Hash'}{'num_avail'} =
2249 max( 0, $pkg_svc->quantity - $num_cust_svc );
2250 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2251 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2252 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2253 && $num_cust_svc >= $opt{summarize_size};
2254 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2256 } $self->part_pkg->pkg_svc;
2259 push @part_svc, map {
2261 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2262 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2263 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2264 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2265 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2267 } $self->extra_part_svc;
2273 =item extra_part_svc
2275 Returns a list of FS::part_svc objects corresponding to services in this
2276 package which are still provisioned but not (any longer) available in the
2281 sub extra_part_svc {
2284 my $pkgnum = $self->pkgnum;
2285 #my $pkgpart = $self->pkgpart;
2288 # 'table' => 'part_svc',
2291 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2292 # WHERE pkg_svc.svcpart = part_svc.svcpart
2293 # AND pkg_svc.pkgpart = ?
2296 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2297 # LEFT JOIN cust_pkg USING ( pkgnum )
2298 # WHERE cust_svc.svcpart = part_svc.svcpart
2301 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2304 #seems to benchmark slightly faster... (or did?)
2306 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2307 my $pkgparts = join(',', @pkgparts);
2310 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2311 #MySQL doesn't grok DISINCT ON
2312 'select' => 'DISTINCT part_svc.*',
2313 'table' => 'part_svc',
2315 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2316 AND pkg_svc.pkgpart IN ($pkgparts)
2319 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2320 LEFT JOIN cust_pkg USING ( pkgnum )
2323 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2324 'extra_param' => [ [$self->pkgnum=>'int'] ],
2330 Returns a short status string for this package, currently:
2334 =item not yet billed
2336 =item one-time charge
2351 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2353 return 'cancelled' if $self->get('cancel');
2354 return 'suspended' if $self->susp;
2355 return 'not yet billed' unless $self->setup;
2356 return 'one-time charge' if $freq =~ /^(0|$)/;
2360 =item ucfirst_status
2362 Returns the status with the first character capitalized.
2366 sub ucfirst_status {
2367 ucfirst(shift->status);
2372 Class method that returns the list of possible status strings for packages
2373 (see L<the status method|/status>). For example:
2375 @statuses = FS::cust_pkg->statuses();
2379 tie my %statuscolor, 'Tie::IxHash',
2380 'not yet billed' => '009999', #teal? cyan?
2381 'one-time charge' => '000000',
2382 'active' => '00CC00',
2383 'suspended' => 'FF9900',
2384 'cancelled' => 'FF0000',
2388 my $self = shift; #could be class...
2389 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2390 # # mayble split btw one-time vs. recur
2396 Returns a hex triplet color string for this package's status.
2402 $statuscolor{$self->status};
2407 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2408 "pkg-comment" depending on user preference).
2414 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2415 $label = $self->pkgnum. ": $label"
2416 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2420 =item pkg_label_long
2422 Returns a long label for this package, adding the primary service's label to
2427 sub pkg_label_long {
2429 my $label = $self->pkg_label;
2430 my $cust_svc = $self->primary_cust_svc;
2431 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2435 =item primary_cust_svc
2437 Returns a primary service (as FS::cust_svc object) if one can be identified.
2441 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2443 sub primary_cust_svc {
2446 my @cust_svc = $self->cust_svc;
2448 return '' unless @cust_svc; #no serivces - irrelevant then
2450 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2452 # primary service as specified in the package definition
2453 # or exactly one service definition with quantity one
2454 my $svcpart = $self->part_pkg->svcpart;
2455 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2456 return $cust_svc[0] if scalar(@cust_svc) == 1;
2458 #couldn't identify one thing..
2464 Returns a list of lists, calling the label method for all services
2465 (see L<FS::cust_svc>) of this billing item.
2471 map { [ $_->label ] } $self->cust_svc;
2474 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2476 Like the labels method, but returns historical information on services that
2477 were active as of END_TIMESTAMP and (optionally) not cancelled before
2478 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2479 I<pkg_svc.hidden> flag will be omitted.
2481 Returns a list of lists, calling the label method for all (historical) services
2482 (see L<FS::h_cust_svc>) of this billing item.
2488 warn "$me _h_labels called on $self\n"
2490 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2495 Like labels, except returns a simple flat list, and shortens long
2496 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2497 identical services to one line that lists the service label and the number of
2498 individual services rather than individual items.
2503 shift->_labels_short( 'labels', @_ );
2506 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2508 Like h_labels, except returns a simple flat list, and shortens long
2509 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2510 identical services to one line that lists the service label and the number of
2511 individual services rather than individual items.
2515 sub h_labels_short {
2516 shift->_labels_short( 'h_labels', @_ );
2520 my( $self, $method ) = ( shift, shift );
2522 warn "$me _labels_short called on $self with $method method\n"
2525 my $conf = new FS::Conf;
2526 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2528 warn "$me _labels_short populating \%labels\n"
2532 #tie %labels, 'Tie::IxHash';
2533 push @{ $labels{$_->[0]} }, $_->[1]
2534 foreach $self->$method(@_);
2536 warn "$me _labels_short populating \@labels\n"
2540 foreach my $label ( keys %labels ) {
2542 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2543 my $num = scalar(@values);
2544 warn "$me _labels_short $num items for $label\n"
2547 if ( $num > $max_same_services ) {
2548 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2550 push @labels, "$label ($num)";
2552 if ( $conf->exists('cust_bill-consolidate_services') ) {
2553 warn "$me _labels_short consolidating services\n"
2555 # push @labels, "$label: ". join(', ', @values);
2557 my $detail = "$label: ";
2558 $detail .= shift(@values). ', '
2560 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2562 push @labels, $detail;
2564 warn "$me _labels_short done consolidating services\n"
2567 warn "$me _labels_short adding service data\n"
2569 push @labels, map { "$label: $_" } @values;
2580 Returns the parent customer object (see L<FS::cust_main>).
2586 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2589 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2593 Returns the location object, if any (see L<FS::cust_location>).
2595 =item cust_location_or_main
2597 If this package is associated with a location, returns the locaiton (see
2598 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2600 =item location_label [ OPTION => VALUE ... ]
2602 Returns the label of the location object (see L<FS::cust_location>).
2606 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2608 =item seconds_since TIMESTAMP
2610 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2611 package have been online since TIMESTAMP, according to the session monitor.
2613 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2614 L<Time::Local> and L<Date::Parse> for conversion functions.
2619 my($self, $since) = @_;
2622 foreach my $cust_svc (
2623 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2625 $seconds += $cust_svc->seconds_since($since);
2632 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2634 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2635 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2638 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2639 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2645 sub seconds_since_sqlradacct {
2646 my($self, $start, $end) = @_;
2650 foreach my $cust_svc (
2652 my $part_svc = $_->part_svc;
2653 $part_svc->svcdb eq 'svc_acct'
2654 && scalar($part_svc->part_export('sqlradius'));
2657 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2664 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2666 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2667 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2671 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2672 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2677 sub attribute_since_sqlradacct {
2678 my($self, $start, $end, $attrib) = @_;
2682 foreach my $cust_svc (
2684 my $part_svc = $_->part_svc;
2685 $part_svc->svcdb eq 'svc_acct'
2686 && scalar($part_svc->part_export('sqlradius'));
2689 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2701 my( $self, $value ) = @_;
2702 if ( defined($value) ) {
2703 $self->setfield('quantity', $value);
2705 $self->getfield('quantity') || 1;
2708 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2710 Transfers as many services as possible from this package to another package.
2712 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2713 object. The destination package must already exist.
2715 Services are moved only if the destination allows services with the correct
2716 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2717 this option with caution! No provision is made for export differences
2718 between the old and new service definitions. Probably only should be used
2719 when your exports for all service definitions of a given svcdb are identical.
2720 (attempt a transfer without it first, to move all possible svcpart-matching
2723 Any services that can't be moved remain in the original package.
2725 Returns an error, if there is one; otherwise, returns the number of services
2726 that couldn't be moved.
2731 my ($self, $dest_pkgnum, %opt) = @_;
2737 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2738 $dest = $dest_pkgnum;
2739 $dest_pkgnum = $dest->pkgnum;
2741 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2744 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2746 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2747 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2750 foreach my $cust_svc ($dest->cust_svc) {
2751 $target{$cust_svc->svcpart}--;
2754 my %svcpart2svcparts = ();
2755 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2756 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2757 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2758 next if exists $svcpart2svcparts{$svcpart};
2759 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2760 $svcpart2svcparts{$svcpart} = [
2762 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2764 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2765 'svcpart' => $_ } );
2767 $pkg_svc ? $pkg_svc->primary_svc : '',
2768 $pkg_svc ? $pkg_svc->quantity : 0,
2772 grep { $_ != $svcpart }
2774 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2776 warn "alternates for svcpart $svcpart: ".
2777 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2782 foreach my $cust_svc ($self->cust_svc) {
2783 if($target{$cust_svc->svcpart} > 0) {
2784 $target{$cust_svc->svcpart}--;
2785 my $new = new FS::cust_svc { $cust_svc->hash };
2786 $new->pkgnum($dest_pkgnum);
2787 my $error = $new->replace($cust_svc);
2788 return $error if $error;
2789 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2791 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2792 warn "alternates to consider: ".
2793 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2795 my @alternate = grep {
2796 warn "considering alternate svcpart $_: ".
2797 "$target{$_} available in new package\n"
2800 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2802 warn "alternate(s) found\n" if $DEBUG;
2803 my $change_svcpart = $alternate[0];
2804 $target{$change_svcpart}--;
2805 my $new = new FS::cust_svc { $cust_svc->hash };
2806 $new->svcpart($change_svcpart);
2807 $new->pkgnum($dest_pkgnum);
2808 my $error = $new->replace($cust_svc);
2809 return $error if $error;
2822 This method is deprecated. See the I<depend_jobnum> option to the insert and
2823 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2830 local $SIG{HUP} = 'IGNORE';
2831 local $SIG{INT} = 'IGNORE';
2832 local $SIG{QUIT} = 'IGNORE';
2833 local $SIG{TERM} = 'IGNORE';
2834 local $SIG{TSTP} = 'IGNORE';
2835 local $SIG{PIPE} = 'IGNORE';
2837 my $oldAutoCommit = $FS::UID::AutoCommit;
2838 local $FS::UID::AutoCommit = 0;
2841 foreach my $cust_svc ( $self->cust_svc ) {
2842 #false laziness w/svc_Common::insert
2843 my $svc_x = $cust_svc->svc_x;
2844 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2845 my $error = $part_export->export_insert($svc_x);
2847 $dbh->rollback if $oldAutoCommit;
2853 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2860 Associates this package with a (suspension or cancellation) reason (see
2861 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2864 Available options are:
2870 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.
2874 the access_user (see L<FS::access_user>) providing the reason
2882 the action (cancel, susp, adjourn, expire) associated with the reason
2886 If there is an error, returns the error, otherwise returns false.
2891 my ($self, %options) = @_;
2893 my $otaker = $options{reason_otaker} ||
2894 $FS::CurrentUser::CurrentUser->username;
2897 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2901 } elsif ( ref($options{'reason'}) ) {
2903 return 'Enter a new reason (or select an existing one)'
2904 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2906 my $reason = new FS::reason({
2907 'reason_type' => $options{'reason'}->{'typenum'},
2908 'reason' => $options{'reason'}->{'reason'},
2910 my $error = $reason->insert;
2911 return $error if $error;
2913 $reasonnum = $reason->reasonnum;
2916 return "Unparsable reason: ". $options{'reason'};
2919 my $cust_pkg_reason =
2920 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2921 'reasonnum' => $reasonnum,
2922 'otaker' => $otaker,
2923 'action' => substr(uc($options{'action'}),0,1),
2924 'date' => $options{'date'}
2929 $cust_pkg_reason->insert;
2932 =item insert_discount
2934 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2935 inserting a new discount on the fly (see L<FS::discount>).
2937 Available options are:
2945 If there is an error, returns the error, otherwise returns false.
2949 sub insert_discount {
2950 #my ($self, %options) = @_;
2953 my $cust_pkg_discount = new FS::cust_pkg_discount {
2954 'pkgnum' => $self->pkgnum,
2955 'discountnum' => $self->discountnum,
2957 'end_date' => '', #XXX
2958 #for the create a new discount case
2959 '_type' => $self->discountnum__type,
2960 'amount' => $self->discountnum_amount,
2961 'percent' => $self->discountnum_percent,
2962 'months' => $self->discountnum_months,
2963 'setup' => $self->discountnum_setup,
2964 #'disabled' => $self->discountnum_disabled,
2967 $cust_pkg_discount->insert;
2970 =item set_usage USAGE_VALUE_HASHREF
2972 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2973 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2974 upbytes, downbytes, and totalbytes are appropriate keys.
2976 All svc_accts which are part of this package have their values reset.
2981 my ($self, $valueref, %opt) = @_;
2983 #only svc_acct can set_usage for now
2984 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
2985 my $svc_x = $cust_svc->svc_x;
2986 $svc_x->set_usage($valueref, %opt)
2987 if $svc_x->can("set_usage");
2991 =item recharge USAGE_VALUE_HASHREF
2993 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2994 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2995 upbytes, downbytes, and totalbytes are appropriate keys.
2997 All svc_accts which are part of this package have their values incremented.
3002 my ($self, $valueref) = @_;
3004 #only svc_acct can set_usage for now
3005 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3006 my $svc_x = $cust_svc->svc_x;
3007 $svc_x->recharge($valueref)
3008 if $svc_x->can("recharge");
3012 =item cust_pkg_discount
3016 sub cust_pkg_discount {
3018 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3021 =item cust_pkg_discount_active
3025 sub cust_pkg_discount_active {
3027 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3032 =head1 CLASS METHODS
3038 Returns an SQL expression identifying recurring packages.
3042 sub recurring_sql { "
3043 '0' != ( select freq from part_pkg
3044 where cust_pkg.pkgpart = part_pkg.pkgpart )
3049 Returns an SQL expression identifying one-time packages.
3054 '0' = ( select freq from part_pkg
3055 where cust_pkg.pkgpart = part_pkg.pkgpart )
3060 Returns an SQL expression identifying ordered packages (recurring packages not
3066 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3071 Returns an SQL expression identifying active packages.
3076 $_[0]->recurring_sql. "
3077 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3078 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3079 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3082 =item not_yet_billed_sql
3084 Returns an SQL expression identifying packages which have not yet been billed.
3088 sub not_yet_billed_sql { "
3089 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3090 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3091 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3096 Returns an SQL expression identifying inactive packages (one-time packages
3097 that are otherwise unsuspended/uncancelled).
3101 sub inactive_sql { "
3102 ". $_[0]->onetime_sql(). "
3103 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3104 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3105 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3111 Returns an SQL expression identifying suspended packages.
3115 sub suspended_sql { susp_sql(@_); }
3117 #$_[0]->recurring_sql(). ' AND '.
3119 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3120 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3127 Returns an SQL exprression identifying cancelled packages.
3131 sub cancelled_sql { cancel_sql(@_); }
3133 #$_[0]->recurring_sql(). ' AND '.
3134 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3139 Returns an SQL expression to give the package status as a string.
3145 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3146 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3147 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3148 WHEN ".onetime_sql()." THEN 'one-time charge'
3153 =item search HASHREF
3157 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3158 Valid parameters are
3166 active, inactive, suspended, cancel (or cancelled)
3170 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3174 boolean selects custom packages
3180 pkgpart or arrayref or hashref of pkgparts
3184 arrayref of beginning and ending epoch date
3188 arrayref of beginning and ending epoch date
3192 arrayref of beginning and ending epoch date
3196 arrayref of beginning and ending epoch date
3200 arrayref of beginning and ending epoch date
3204 arrayref of beginning and ending epoch date
3208 arrayref of beginning and ending epoch date
3212 pkgnum or APKG_pkgnum
3216 a value suited to passing to FS::UI::Web::cust_header
3220 specifies the user for agent virtualization
3224 boolean selects packages containing fcc form 477 telco lines
3231 my ($class, $params) = @_;
3238 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3240 "cust_main.agentnum = $1";
3247 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3249 "cust_pkg.custnum = $1";
3256 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3258 "cust_pkg.pkgbatch = '$1'";
3265 if ( $params->{'magic'} eq 'active'
3266 || $params->{'status'} eq 'active' ) {
3268 push @where, FS::cust_pkg->active_sql();
3270 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3271 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3273 push @where, FS::cust_pkg->not_yet_billed_sql();
3275 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3276 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3278 push @where, FS::cust_pkg->inactive_sql();
3280 } elsif ( $params->{'magic'} eq 'suspended'
3281 || $params->{'status'} eq 'suspended' ) {
3283 push @where, FS::cust_pkg->suspended_sql();
3285 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3286 || $params->{'status'} =~ /^cancell?ed$/ ) {
3288 push @where, FS::cust_pkg->cancelled_sql();
3293 # parse package class
3296 if ( exists($params->{'classnum'}) ) {
3299 if ( ref($params->{'classnum'}) ) {
3301 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3302 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3303 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3304 @classnum = @{ $params->{'classnum'} };
3306 die 'unhandled classnum ref '. $params->{'classnum'};
3310 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3317 my @nums = grep $_, @classnum;
3318 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3319 my $null = scalar( grep { $_ eq '' } @classnum );
3320 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3322 if ( scalar(@c_where) == 1 ) {
3323 push @where, @c_where;
3324 } elsif ( @c_where ) {
3325 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3334 # parse package report options
3337 my @report_option = ();
3338 if ( exists($params->{'report_option'}) ) {
3339 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3340 @report_option = @{ $params->{'report_option'} };
3341 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3342 @report_option = split(',', $1);
3347 if (@report_option) {
3348 # this will result in the empty set for the dangling comma case as it should
3350 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3351 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3352 AND optionname = 'report_option_$_'
3353 AND optionvalue = '1' )"
3357 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3359 my @report_option_any = ();
3360 if ( ref($params->{$any}) eq 'ARRAY' ) {
3361 @report_option_any = @{ $params->{$any} };
3362 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3363 @report_option_any = split(',', $1);
3366 if (@report_option_any) {
3367 # this will result in the empty set for the dangling comma case as it should
3368 push @where, ' ( '. join(' OR ',
3369 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3370 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3371 AND optionname = 'report_option_$_'
3372 AND optionvalue = '1' )"
3373 } @report_option_any
3383 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3389 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3390 if $params->{fcc_line};
3396 if ( exists($params->{'censustract'}) ) {
3397 $params->{'censustract'} =~ /^([.\d]*)$/;
3398 my $censustract = "cust_main.censustract = '$1'";
3399 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3400 push @where, "( $censustract )";
3404 # parse censustract2
3406 if ( exists($params->{'censustract2'})
3407 && $params->{'censustract2'} =~ /^(\d*)$/
3411 push @where, "cust_main.censustract LIKE '$1%'";
3414 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3422 if ( ref($params->{'pkgpart'}) ) {
3425 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3426 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3427 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3428 @pkgpart = @{ $params->{'pkgpart'} };
3430 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3433 @pkgpart = grep /^(\d+)$/, @pkgpart;
3435 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3437 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3438 push @where, "pkgpart = $1";
3447 #false laziness w/report_cust_pkg.html
3450 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3451 'active' => { 'susp'=>1, 'cancel'=>1 },
3452 'suspended' => { 'cancel' => 1 },
3457 if( exists($params->{'active'} ) ) {
3458 # This overrides all the other date-related fields
3459 my($beginning, $ending) = @{$params->{'active'}};
3461 "cust_pkg.setup IS NOT NULL",
3462 "cust_pkg.setup <= $ending",
3463 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3464 "NOT (".FS::cust_pkg->onetime_sql . ")";
3467 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
3469 next unless exists($params->{$field});
3471 my($beginning, $ending) = @{$params->{$field}};
3473 next if $beginning == 0 && $ending == 4294967295;
3476 "cust_pkg.$field IS NOT NULL",
3477 "cust_pkg.$field >= $beginning",
3478 "cust_pkg.$field <= $ending";
3480 $orderby ||= "ORDER BY cust_pkg.$field";
3485 $orderby ||= 'ORDER BY bill';
3488 # parse magic, legacy, etc.
3491 if ( $params->{'magic'} &&
3492 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3495 $orderby = 'ORDER BY pkgnum';
3497 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3498 push @where, "pkgpart = $1";
3501 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3503 $orderby = 'ORDER BY pkgnum';
3505 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3507 $orderby = 'ORDER BY pkgnum';
3510 SELECT count(*) FROM pkg_svc
3511 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3512 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3513 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3514 AND cust_svc.svcpart = pkg_svc.svcpart
3521 # setup queries, links, subs, etc. for the search
3524 # here is the agent virtualization
3525 if ($params->{CurrentUser}) {
3527 qsearchs('access_user', { username => $params->{CurrentUser} });
3530 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3535 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3538 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3540 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3541 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3542 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3544 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3547 'table' => 'cust_pkg',
3549 'select' => join(', ',
3551 ( map "part_pkg.$_", qw( pkg freq ) ),
3552 'pkg_class.classname',
3553 'cust_main.custnum AS cust_main_custnum',
3554 FS::UI::Web::cust_sql_fields(
3555 $params->{'cust_fields'}
3558 'extra_sql' => $extra_sql,
3559 'order_by' => $orderby,
3560 'addl_from' => $addl_from,
3561 'count_query' => $count_query,
3568 Returns a list of two package counts. The first is a count of packages
3569 based on the supplied criteria and the second is the count of residential
3570 packages with those same criteria. Criteria are specified as in the search
3576 my ($class, $params) = @_;
3578 my $sql_query = $class->search( $params );
3580 my $count_sql = delete($sql_query->{'count_query'});
3581 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3582 or die "couldn't parse count_sql";
3584 my $count_sth = dbh->prepare($count_sql)
3585 or die "Error preparing $count_sql: ". dbh->errstr;
3587 or die "Error executing $count_sql: ". $count_sth->errstr;
3588 my $count_arrayref = $count_sth->fetchrow_arrayref;
3590 return ( @$count_arrayref );
3597 Returns a list: the first item is an SQL fragment identifying matching
3598 packages/customers via location (taking into account shipping and package
3599 address taxation, if enabled), and subsequent items are the parameters to
3600 substitute for the placeholders in that fragment.
3605 my($class, %opt) = @_;
3606 my $ornull = $opt{'ornull'};
3608 my $conf = new FS::Conf;
3610 # '?' placeholders in _location_sql_where
3611 my $x = $ornull ? 3 : 2;
3622 if ( $conf->exists('tax-ship_address') ) {
3625 ( ( ship_last IS NULL OR ship_last = '' )
3626 AND ". _location_sql_where('cust_main', '', $ornull ). "
3628 OR ( ship_last IS NOT NULL AND ship_last != ''
3629 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3632 # AND payby != 'COMP'
3634 @main_param = ( @bill_param, @bill_param );
3638 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3639 @main_param = @bill_param;
3645 if ( $conf->exists('tax-pkg_address') ) {
3647 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3650 ( cust_pkg.locationnum IS NULL AND $main_where )
3651 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3654 @param = ( @main_param, @bill_param );
3658 $where = $main_where;
3659 @param = @main_param;
3667 #subroutine, helper for location_sql
3668 sub _location_sql_where {
3670 my $prefix = @_ ? shift : '';
3671 my $ornull = @_ ? shift : '';
3673 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3675 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3677 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
3678 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
3679 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
3681 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3683 ( $table.${prefix}district = ? OR ? = '' OR CAST(? AS text) IS NULL )
3684 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3685 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3686 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3687 AND $table.${prefix}country = ?
3692 my( $self, $what ) = @_;
3694 my $what_show_zero = $what. '_show_zero';
3695 length($self->$what_show_zero())
3696 ? ($self->$what_show_zero() eq 'Y')
3697 : $self->part_pkg->$what_show_zero();
3704 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3706 CUSTNUM is a customer (see L<FS::cust_main>)
3708 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3709 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3712 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3713 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3714 new billing items. An error is returned if this is not possible (see
3715 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3718 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3719 newly-created cust_pkg objects.
3721 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3722 and inserted. Multiple FS::pkg_referral records can be created by
3723 setting I<refnum> to an array reference of refnums or a hash reference with
3724 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3725 record will be created corresponding to cust_main.refnum.
3730 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3732 my $conf = new FS::Conf;
3734 # Transactionize this whole mess
3735 local $SIG{HUP} = 'IGNORE';
3736 local $SIG{INT} = 'IGNORE';
3737 local $SIG{QUIT} = 'IGNORE';
3738 local $SIG{TERM} = 'IGNORE';
3739 local $SIG{TSTP} = 'IGNORE';
3740 local $SIG{PIPE} = 'IGNORE';
3742 my $oldAutoCommit = $FS::UID::AutoCommit;
3743 local $FS::UID::AutoCommit = 0;
3747 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3748 # return "Customer not found: $custnum" unless $cust_main;
3750 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3753 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3756 my $change = scalar(@old_cust_pkg) != 0;
3759 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3761 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3762 " to pkgpart ". $pkgparts->[0]. "\n"
3765 my $err_or_cust_pkg =
3766 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3767 'refnum' => $refnum,
3770 unless (ref($err_or_cust_pkg)) {
3771 $dbh->rollback if $oldAutoCommit;
3772 return $err_or_cust_pkg;
3775 push @$return_cust_pkg, $err_or_cust_pkg;
3776 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3781 # Create the new packages.
3782 foreach my $pkgpart (@$pkgparts) {
3784 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3786 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3787 pkgpart => $pkgpart,
3791 $error = $cust_pkg->insert( 'change' => $change );
3793 $dbh->rollback if $oldAutoCommit;
3796 push @$return_cust_pkg, $cust_pkg;
3798 # $return_cust_pkg now contains refs to all of the newly
3801 # Transfer services and cancel old packages.
3802 foreach my $old_pkg (@old_cust_pkg) {
3804 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3807 foreach my $new_pkg (@$return_cust_pkg) {
3808 $error = $old_pkg->transfer($new_pkg);
3809 if ($error and $error == 0) {
3810 # $old_pkg->transfer failed.
3811 $dbh->rollback if $oldAutoCommit;
3816 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3817 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3818 foreach my $new_pkg (@$return_cust_pkg) {
3819 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3820 if ($error and $error == 0) {
3821 # $old_pkg->transfer failed.
3822 $dbh->rollback if $oldAutoCommit;
3829 # Transfers were successful, but we went through all of the
3830 # new packages and still had services left on the old package.
3831 # We can't cancel the package under the circumstances, so abort.
3832 $dbh->rollback if $oldAutoCommit;
3833 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3835 $error = $old_pkg->cancel( quiet=>1 );
3841 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3845 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3847 A bulk change method to change packages for multiple customers.
3849 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3850 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3853 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3854 replace. The services (see L<FS::cust_svc>) are moved to the
3855 new billing items. An error is returned if this is not possible (see
3858 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3859 newly-created cust_pkg objects.
3864 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3866 # Transactionize this whole mess
3867 local $SIG{HUP} = 'IGNORE';
3868 local $SIG{INT} = 'IGNORE';
3869 local $SIG{QUIT} = 'IGNORE';
3870 local $SIG{TERM} = 'IGNORE';
3871 local $SIG{TSTP} = 'IGNORE';
3872 local $SIG{PIPE} = 'IGNORE';
3874 my $oldAutoCommit = $FS::UID::AutoCommit;
3875 local $FS::UID::AutoCommit = 0;
3879 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3882 while(scalar(@old_cust_pkg)) {
3884 my $custnum = $old_cust_pkg[0]->custnum;
3885 my (@remove) = map { $_->pkgnum }
3886 grep { $_->custnum == $custnum } @old_cust_pkg;
3887 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3889 my $error = order $custnum, $pkgparts, \@remove, \@return;
3891 push @errors, $error
3893 push @$return_cust_pkg, @return;
3896 if (scalar(@errors)) {
3897 $dbh->rollback if $oldAutoCommit;
3898 return join(' / ', @errors);
3901 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3905 # Used by FS::Upgrade to migrate to a new database.
3906 sub _upgrade_data { # class method
3907 my ($class, %opts) = @_;
3908 $class->_upgrade_otaker(%opts);
3910 # RT#10139, bug resulting in contract_end being set when it shouldn't
3911 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3912 # RT#10830, bad calculation of prorate date near end of year
3913 # the date range for bill is December 2009, and we move it forward
3914 # one year if it's before the previous bill date (which it should
3916 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3917 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3918 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3919 # RT6628, add order_date to cust_pkg
3920 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3921 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3922 history_action = \'insert\') where order_date is null',
3924 foreach my $sql (@statements) {
3925 my $sth = dbh->prepare($sql);
3926 $sth->execute or die $sth->errstr;
3934 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3936 In sub order, the @pkgparts array (passed by reference) is clobbered.
3938 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3939 method to pass dates to the recur_prog expression, it should do so.
3941 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3942 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3943 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3944 configuration values. Probably need a subroutine which decides what to do
3945 based on whether or not we've fetched the user yet, rather than a hash. See
3946 FS::UID and the TODO.
3948 Now that things are transactional should the check in the insert method be
3953 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3954 L<FS::pkg_svc>, schema.html from the base documentation