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 driver_name );
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 historical date. Using time ensures that the remaining amount is calculated correctly. Note however that this is an immediate cancel and just changes the date. You are PROBABLY looking to expire the account instead of using this.
700 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
702 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
704 =item nobill - can be set true to skip billing if it might otherwise be done.
706 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
707 not credit it. This must be set (by change()) when changing the package
708 to a different pkgpart or location, and probably shouldn't be in any other
709 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
714 If there is an error, returns the error, otherwise returns false.
719 my( $self, %options ) = @_;
722 my $conf = new FS::Conf;
724 warn "cust_pkg::cancel called with options".
725 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
728 local $SIG{HUP} = 'IGNORE';
729 local $SIG{INT} = 'IGNORE';
730 local $SIG{QUIT} = 'IGNORE';
731 local $SIG{TERM} = 'IGNORE';
732 local $SIG{TSTP} = 'IGNORE';
733 local $SIG{PIPE} = 'IGNORE';
735 my $oldAutoCommit = $FS::UID::AutoCommit;
736 local $FS::UID::AutoCommit = 0;
739 my $old = $self->select_for_update;
741 if ( $old->get('cancel') || $self->get('cancel') ) {
742 dbh->rollback if $oldAutoCommit;
743 return ""; # no error
746 my $date = $options{date} if $options{date}; # expire/cancel later
747 $date = '' if ($date && $date <= time); # complain instead?
749 #race condition: usage could be ongoing until unprovisioned
750 #resolved by performing a change package instead (which unprovisions) and
752 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
753 my $copy = $self->new({$self->hash});
755 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
756 warn "Error billing during cancel, custnum ".
757 #$self->cust_main->custnum. ": $error"
762 my $cancel_time = $options{'time'} || time;
764 if ( $options{'reason'} ) {
765 $error = $self->insert_reason( 'reason' => $options{'reason'},
766 'action' => $date ? 'expire' : 'cancel',
767 'date' => $date ? $date : $cancel_time,
768 'reason_otaker' => $options{'reason_otaker'},
771 dbh->rollback if $oldAutoCommit;
772 return "Error inserting cust_pkg_reason: $error";
776 my %svc_cancel_opt = ();
777 $svc_cancel_opt{'date'} = $date if $date;
778 foreach my $cust_svc (
781 sort { $a->[1] <=> $b->[1] }
782 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
783 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
785 my $part_svc = $cust_svc->part_svc;
786 next if ( defined($part_svc) and $part_svc->preserve );
787 my $error = $cust_svc->cancel( %svc_cancel_opt );
790 $dbh->rollback if $oldAutoCommit;
791 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
798 # Add a credit for remaining service
799 my $last_bill = $self->getfield('last_bill') || 0;
800 my $next_bill = $self->getfield('bill') || 0;
802 if ( exists($options{'unused_credit'}) ) {
803 $do_credit = $options{'unused_credit'};
806 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
809 and $last_bill > 0 # the package has been billed
810 and $next_bill > 0 # the package has a next bill date
811 and $next_bill >= $cancel_time # which is in the future
813 my $remaining_value = $self->calc_remain('time' => $cancel_time);
814 if ( $remaining_value > 0 ) {
815 my $error = $self->cust_main->credit(
817 'Credit for unused time on '. $self->part_pkg->pkg,
818 'reason_type' => $conf->config('cancel_credit_type'),
821 $dbh->rollback if $oldAutoCommit;
822 return "Error crediting customer \$$remaining_value for unused time".
823 " on ". $self->part_pkg->pkg. ": $error";
825 } #if $remaining_value
830 my %hash = $self->hash;
831 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
832 my $new = new FS::cust_pkg ( \%hash );
833 $error = $new->replace( $self, options => { $self->options } );
835 $dbh->rollback if $oldAutoCommit;
839 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
840 return '' if $date; #no errors
842 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
843 if ( !$options{'quiet'} &&
844 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
846 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
849 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
850 $error = $msg_template->send( 'cust_main' => $self->cust_main,
855 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
856 'to' => \@invoicing_list,
857 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
858 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
861 #should this do something on errors?
868 =item cancel_if_expired [ NOW_TIMESTAMP ]
870 Cancels this package if its expire date has been reached.
874 sub cancel_if_expired {
876 my $time = shift || time;
877 return '' unless $self->expire && $self->expire <= $time;
878 my $error = $self->cancel;
880 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
881 $self->custnum. ": $error";
888 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
889 locationnum, (other fields?). Attempts to re-provision cancelled services
890 using history information (errors at this stage are not fatal).
892 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
894 svc_fatal: service provisioning errors are fatal
896 svc_errors: pass an array reference, will be filled in with any provisioning errors
901 my( $self, %options ) = @_;
903 #in case you try do do $uncancel-date = $cust_pkg->uncacel
904 return '' unless $self->get('cancel');
910 local $SIG{HUP} = 'IGNORE';
911 local $SIG{INT} = 'IGNORE';
912 local $SIG{QUIT} = 'IGNORE';
913 local $SIG{TERM} = 'IGNORE';
914 local $SIG{TSTP} = 'IGNORE';
915 local $SIG{PIPE} = 'IGNORE';
917 my $oldAutoCommit = $FS::UID::AutoCommit;
918 local $FS::UID::AutoCommit = 0;
922 # insert the new package
925 my $cust_pkg = new FS::cust_pkg {
926 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
927 bill => ( $options{'bill'} || $self->get('bill') ),
929 uncancel_pkgnum => $self->pkgnum,
930 map { $_ => $self->get($_) } qw(
931 custnum pkgpart locationnum
933 susp adjourn resume expire start_date contract_end dundate
934 change_date change_pkgpart change_locationnum
935 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
939 my $error = $cust_pkg->insert(
940 'change' => 1, #supresses any referral credit to a referring customer
943 $dbh->rollback if $oldAutoCommit;
951 #find historical services within this timeframe before the package cancel
952 # (incompatible with "time" option to cust_pkg->cancel?)
953 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
954 # too little? (unprovisioing export delay?)
955 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
956 my @h_cust_svc = $self->h_cust_svc( $end, $start );
959 foreach my $h_cust_svc (@h_cust_svc) {
960 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
961 #next unless $h_svc_x; #should this happen?
962 (my $table = $h_svc_x->table) =~ s/^h_//;
963 require "FS/$table.pm";
964 my $class = "FS::$table";
965 my $svc_x = $class->new( {
966 'pkgnum' => $cust_pkg->pkgnum,
967 'svcpart' => $h_cust_svc->svcpart,
968 map { $_ => $h_svc_x->get($_) } fields($table)
972 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
973 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
976 my $svc_error = $svc_x->insert;
978 if ( $options{svc_fatal} ) {
979 $dbh->rollback if $oldAutoCommit;
982 push @svc_errors, $svc_error;
983 # is this necessary? svc_Common::insert already deletes the
984 # cust_svc if inserting svc_x fails.
985 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
987 my $cs_error = $cust_svc->delete;
989 $dbh->rollback if $oldAutoCommit;
995 } #foreach $h_cust_svc
997 #these are pretty rare, but should handle them
998 # - dsl_device (mac addresses)
999 # - phone_device (mac addresses)
1000 # - dsl_note (ikano notes)
1001 # - domain_record (i.e. restore DNS information w/domains)
1002 # - inventory_item(?) (inventory w/un-cancelling service?)
1003 # - nas (svc_broaband nas stuff)
1004 #this stuff is unused in the wild afaik
1005 # - mailinglistmember
1007 # - svc_domain.parent_svcnum?
1008 # - acct_snarf (ancient mail fetching config)
1009 # - cgp_rule (communigate)
1010 # - cust_svc_option (used by our Tron stuff)
1011 # - acct_rt_transaction (used by our time worked stuff)
1014 # also move over any services that didn't unprovision at cancellation
1017 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1018 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1019 my $error = $cust_svc->replace;
1021 $dbh->rollback if $oldAutoCommit;
1030 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1032 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1033 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1040 Cancels any pending expiration (sets the expire field to null).
1042 If there is an error, returns the error, otherwise returns false.
1047 my( $self, %options ) = @_;
1050 local $SIG{HUP} = 'IGNORE';
1051 local $SIG{INT} = 'IGNORE';
1052 local $SIG{QUIT} = 'IGNORE';
1053 local $SIG{TERM} = 'IGNORE';
1054 local $SIG{TSTP} = 'IGNORE';
1055 local $SIG{PIPE} = 'IGNORE';
1057 my $oldAutoCommit = $FS::UID::AutoCommit;
1058 local $FS::UID::AutoCommit = 0;
1061 my $old = $self->select_for_update;
1063 my $pkgnum = $old->pkgnum;
1064 if ( $old->get('cancel') || $self->get('cancel') ) {
1065 dbh->rollback if $oldAutoCommit;
1066 return "Can't unexpire cancelled package $pkgnum";
1067 # or at least it's pointless
1070 unless ( $old->get('expire') && $self->get('expire') ) {
1071 dbh->rollback if $oldAutoCommit;
1072 return ""; # no error
1075 my %hash = $self->hash;
1076 $hash{'expire'} = '';
1077 my $new = new FS::cust_pkg ( \%hash );
1078 $error = $new->replace( $self, options => { $self->options } );
1080 $dbh->rollback if $oldAutoCommit;
1084 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1090 =item suspend [ OPTION => VALUE ... ]
1092 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1093 package, then suspends the package itself (sets the susp field to now).
1095 Available options are:
1099 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1100 either a reasonnum of an existing reason, or passing a hashref will create
1101 a new reason. The hashref should have the following keys:
1102 - typenum - Reason type (see L<FS::reason_type>
1103 - reason - Text of the new reason.
1105 =item date - can be set to a unix style timestamp to specify when to
1108 =item time - can be set to override the current time, for calculation
1109 of final invoices or unused-time credits
1111 =item resume_date - can be set to a time when the package should be
1112 unsuspended. This may be more convenient than calling C<unsuspend()>
1117 If there is an error, returns the error, otherwise returns false.
1122 my( $self, %options ) = @_;
1125 local $SIG{HUP} = 'IGNORE';
1126 local $SIG{INT} = 'IGNORE';
1127 local $SIG{QUIT} = 'IGNORE';
1128 local $SIG{TERM} = 'IGNORE';
1129 local $SIG{TSTP} = 'IGNORE';
1130 local $SIG{PIPE} = 'IGNORE';
1132 my $oldAutoCommit = $FS::UID::AutoCommit;
1133 local $FS::UID::AutoCommit = 0;
1136 my $old = $self->select_for_update;
1138 my $pkgnum = $old->pkgnum;
1139 if ( $old->get('cancel') || $self->get('cancel') ) {
1140 dbh->rollback if $oldAutoCommit;
1141 return "Can't suspend cancelled package $pkgnum";
1144 if ( $old->get('susp') || $self->get('susp') ) {
1145 dbh->rollback if $oldAutoCommit;
1146 return ""; # no error # complain on adjourn?
1149 my $suspend_time = $options{'time'} || time;
1151 my $date = $options{date} if $options{date}; # adjourn/suspend later
1152 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1154 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1155 dbh->rollback if $oldAutoCommit;
1156 return "Package $pkgnum expires before it would be suspended.";
1159 if ( $options{'reason'} ) {
1160 $error = $self->insert_reason( 'reason' => $options{'reason'},
1161 'action' => $date ? 'adjourn' : 'suspend',
1162 'date' => $date ? $date : $suspend_time,
1163 'reason_otaker' => $options{'reason_otaker'},
1166 dbh->rollback if $oldAutoCommit;
1167 return "Error inserting cust_pkg_reason: $error";
1171 my %hash = $self->hash;
1173 $hash{'adjourn'} = $date;
1175 $hash{'susp'} = $suspend_time;
1178 my $resume_date = $options{'resume_date'} || 0;
1179 if ( $resume_date > ($date || $suspend_time) ) {
1180 $hash{'resume'} = $resume_date;
1183 $options{options} ||= {};
1185 my $new = new FS::cust_pkg ( \%hash );
1186 $error = $new->replace( $self, options => { $self->options,
1187 %{ $options{options} },
1191 $dbh->rollback if $oldAutoCommit;
1199 foreach my $cust_svc (
1200 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1202 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1204 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1205 $dbh->rollback if $oldAutoCommit;
1206 return "Illegal svcdb value in part_svc!";
1209 require "FS/$svcdb.pm";
1211 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1213 $error = $svc->suspend;
1215 $dbh->rollback if $oldAutoCommit;
1218 my( $label, $value ) = $cust_svc->label;
1219 push @labels, "$label: $value";
1223 my $conf = new FS::Conf;
1224 if ( $conf->config('suspend_email_admin') ) {
1226 my $error = send_email(
1227 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1228 #invoice_from ??? well as good as any
1229 'to' => $conf->config('suspend_email_admin'),
1230 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1232 "This is an automatic message from your Freeside installation\n",
1233 "informing you that the following customer package has been suspended:\n",
1235 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1236 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1237 ( map { "Service : $_\n" } @labels ),
1242 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1250 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1255 =item unsuspend [ OPTION => VALUE ... ]
1257 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1258 package, then unsuspends the package itself (clears the susp field and the
1259 adjourn field if it is in the past). If the suspend reason includes an
1260 unsuspension package, that package will be ordered.
1262 Available options are:
1268 Can be set to a date to unsuspend the package in the future (the 'resume'
1271 =item adjust_next_bill
1273 Can be set true to adjust the next bill date forward by
1274 the amount of time the account was inactive. This was set true by default
1275 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1276 explicitly requested. Price plans for which this makes sense (anniversary-date
1277 based than prorate or subscription) could have an option to enable this
1282 If there is an error, returns the error, otherwise returns false.
1287 my( $self, %opt ) = @_;
1290 local $SIG{HUP} = 'IGNORE';
1291 local $SIG{INT} = 'IGNORE';
1292 local $SIG{QUIT} = 'IGNORE';
1293 local $SIG{TERM} = 'IGNORE';
1294 local $SIG{TSTP} = 'IGNORE';
1295 local $SIG{PIPE} = 'IGNORE';
1297 my $oldAutoCommit = $FS::UID::AutoCommit;
1298 local $FS::UID::AutoCommit = 0;
1301 my $old = $self->select_for_update;
1303 my $pkgnum = $old->pkgnum;
1304 if ( $old->get('cancel') || $self->get('cancel') ) {
1305 $dbh->rollback if $oldAutoCommit;
1306 return "Can't unsuspend cancelled package $pkgnum";
1309 unless ( $old->get('susp') && $self->get('susp') ) {
1310 $dbh->rollback if $oldAutoCommit;
1311 return ""; # no error # complain instead?
1314 my $date = $opt{'date'};
1315 if ( $date and $date > time ) { # return an error if $date <= time?
1317 if ( $old->get('expire') && $old->get('expire') < $date ) {
1318 $dbh->rollback if $oldAutoCommit;
1319 return "Package $pkgnum expires before it would be unsuspended.";
1322 my $new = new FS::cust_pkg { $self->hash };
1323 $new->set('resume', $date);
1324 $error = $new->replace($self, options => $self->options);
1327 $dbh->rollback if $oldAutoCommit;
1331 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1339 foreach my $cust_svc (
1340 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1342 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1344 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1345 $dbh->rollback if $oldAutoCommit;
1346 return "Illegal svcdb value in part_svc!";
1349 require "FS/$svcdb.pm";
1351 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1353 $error = $svc->unsuspend;
1355 $dbh->rollback if $oldAutoCommit;
1358 my( $label, $value ) = $cust_svc->label;
1359 push @labels, "$label: $value";
1364 my $reason = $self->last_cust_pkg_reason('susp')->reason;
1366 my %hash = $self->hash;
1367 my $inactive = time - $hash{'susp'};
1369 my $conf = new FS::Conf;
1371 if ( $inactive > 0 &&
1372 ( $hash{'bill'} || $hash{'setup'} ) &&
1373 ( $opt{'adjust_next_bill'} ||
1374 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1375 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1378 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1383 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1384 $hash{'resume'} = '' if !$hash{'adjourn'};
1385 my $new = new FS::cust_pkg ( \%hash );
1386 $error = $new->replace( $self, options => { $self->options } );
1388 $dbh->rollback if $oldAutoCommit;
1394 if ( $reason->unsuspend_pkgpart ) {
1395 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1396 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1398 my $start_date = $self->cust_main->next_bill_date
1399 if $reason->unsuspend_hold;
1402 my $unsusp_pkg = FS::cust_pkg->new({
1403 'custnum' => $self->custnum,
1404 'pkgpart' => $reason->unsuspend_pkgpart,
1405 'start_date' => $start_date,
1406 'locationnum' => $self->locationnum,
1407 # discount? probably not...
1410 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1414 $dbh->rollback if $oldAutoCommit;
1419 if ( $conf->config('unsuspend_email_admin') ) {
1421 my $error = send_email(
1422 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1423 #invoice_from ??? well as good as any
1424 'to' => $conf->config('unsuspend_email_admin'),
1425 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1426 "This is an automatic message from your Freeside installation\n",
1427 "informing you that the following customer package has been unsuspended:\n",
1429 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1430 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1431 ( map { "Service : $_\n" } @labels ),
1433 "An unsuspension fee was charged: Package #".$unsusp_pkg->pkgnum.".\n"
1440 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1446 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1453 Cancels any pending suspension (sets the adjourn field to null).
1455 If there is an error, returns the error, otherwise returns false.
1460 my( $self, %options ) = @_;
1463 local $SIG{HUP} = 'IGNORE';
1464 local $SIG{INT} = 'IGNORE';
1465 local $SIG{QUIT} = 'IGNORE';
1466 local $SIG{TERM} = 'IGNORE';
1467 local $SIG{TSTP} = 'IGNORE';
1468 local $SIG{PIPE} = 'IGNORE';
1470 my $oldAutoCommit = $FS::UID::AutoCommit;
1471 local $FS::UID::AutoCommit = 0;
1474 my $old = $self->select_for_update;
1476 my $pkgnum = $old->pkgnum;
1477 if ( $old->get('cancel') || $self->get('cancel') ) {
1478 dbh->rollback if $oldAutoCommit;
1479 return "Can't unadjourn cancelled package $pkgnum";
1480 # or at least it's pointless
1483 if ( $old->get('susp') || $self->get('susp') ) {
1484 dbh->rollback if $oldAutoCommit;
1485 return "Can't unadjourn suspended package $pkgnum";
1486 # perhaps this is arbitrary
1489 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1490 dbh->rollback if $oldAutoCommit;
1491 return ""; # no error
1494 my %hash = $self->hash;
1495 $hash{'adjourn'} = '';
1496 $hash{'resume'} = '';
1497 my $new = new FS::cust_pkg ( \%hash );
1498 $error = $new->replace( $self, options => { $self->options } );
1500 $dbh->rollback if $oldAutoCommit;
1504 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1511 =item change HASHREF | OPTION => VALUE ...
1513 Changes this package: cancels it and creates a new one, with a different
1514 pkgpart or locationnum or both. All services are transferred to the new
1515 package (no change will be made if this is not possible).
1517 Options may be passed as a list of key/value pairs or as a hash reference.
1524 New locationnum, to change the location for this package.
1528 New FS::cust_location object, to create a new location and assign it
1533 New pkgpart (see L<FS::part_pkg>).
1537 New refnum (see L<FS::part_referral>).
1541 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1542 susp, adjourn, cancel, expire, and contract_end) to the new package.
1546 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1547 (otherwise, what's the point?)
1549 Returns either the new FS::cust_pkg object or a scalar error.
1553 my $err_or_new_cust_pkg = $old_cust_pkg->change
1557 #some false laziness w/order
1560 my $opt = ref($_[0]) ? shift : { @_ };
1562 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1565 my $conf = new FS::Conf;
1567 # Transactionize this whole mess
1568 local $SIG{HUP} = 'IGNORE';
1569 local $SIG{INT} = 'IGNORE';
1570 local $SIG{QUIT} = 'IGNORE';
1571 local $SIG{TERM} = 'IGNORE';
1572 local $SIG{TSTP} = 'IGNORE';
1573 local $SIG{PIPE} = 'IGNORE';
1575 my $oldAutoCommit = $FS::UID::AutoCommit;
1576 local $FS::UID::AutoCommit = 0;
1585 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1587 #$hash{$_} = $self->$_() foreach qw( setup );
1589 $hash{'setup'} = $time if $self->setup;
1591 $hash{'change_date'} = $time;
1592 $hash{"change_$_"} = $self->$_()
1593 foreach qw( pkgnum pkgpart locationnum );
1595 if ( $opt->{'cust_location'} &&
1596 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1597 $error = $opt->{'cust_location'}->insert;
1599 $dbh->rollback if $oldAutoCommit;
1600 return "inserting cust_location (transaction rolled back): $error";
1602 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1605 my $unused_credit = 0;
1606 if ( $opt->{'keep_dates'} ) {
1607 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1608 resume start_date contract_end ) ) {
1609 $hash{$date} = $self->getfield($date);
1612 # Special case. If the pkgpart is changing, and the customer is
1613 # going to be credited for remaining time, don't keep setup, bill,
1614 # or last_bill dates, and DO pass the flag to cancel() to credit
1616 if ( $opt->{'pkgpart'}
1617 and $opt->{'pkgpart'} != $self->pkgpart
1618 and $self->part_pkg->option('unused_credit_change', 1) ) {
1620 $hash{$_} = '' foreach qw(setup bill last_bill);
1623 # allow $opt->{'locationnum'} = '' to specifically set it to null
1624 # (i.e. customer default location)
1625 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1627 # Create the new package.
1628 my $cust_pkg = new FS::cust_pkg {
1629 custnum => $self->custnum,
1630 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1631 refnum => ( $opt->{'refnum'} || $self->refnum ),
1632 locationnum => ( $opt->{'locationnum'} ),
1636 $error = $cust_pkg->insert( 'change' => 1 );
1638 $dbh->rollback if $oldAutoCommit;
1642 # Transfer services and cancel old package.
1644 $error = $self->transfer($cust_pkg);
1645 if ($error and $error == 0) {
1646 # $old_pkg->transfer failed.
1647 $dbh->rollback if $oldAutoCommit;
1651 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1652 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1653 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1654 if ($error and $error == 0) {
1655 # $old_pkg->transfer failed.
1656 $dbh->rollback if $oldAutoCommit;
1662 # Transfers were successful, but we still had services left on the old
1663 # package. We can't change the package under this circumstances, so abort.
1664 $dbh->rollback if $oldAutoCommit;
1665 return "Unable to transfer all services from package ". $self->pkgnum;
1668 #reset usage if changing pkgpart
1669 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1670 if ($self->pkgpart != $cust_pkg->pkgpart) {
1671 my $part_pkg = $cust_pkg->part_pkg;
1672 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1676 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1679 $dbh->rollback if $oldAutoCommit;
1680 return "Error setting usage values: $error";
1684 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1686 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1688 $dbh->rollback if $oldAutoCommit;
1692 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1694 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1696 $dbh->rollback if $oldAutoCommit;
1701 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1707 use Storable 'thaw';
1709 sub process_bulk_cust_pkg {
1711 my $param = thaw(decode_base64(shift));
1712 warn Dumper($param) if $DEBUG;
1714 my $old_part_pkg = qsearchs('part_pkg',
1715 { pkgpart => $param->{'old_pkgpart'} });
1716 my $new_part_pkg = qsearchs('part_pkg',
1717 { pkgpart => $param->{'new_pkgpart'} });
1718 die "Must select a new package type\n" unless $new_part_pkg;
1719 #my $keep_dates = $param->{'keep_dates'} || 0;
1720 my $keep_dates = 1; # there is no good reason to turn this off
1722 local $SIG{HUP} = 'IGNORE';
1723 local $SIG{INT} = 'IGNORE';
1724 local $SIG{QUIT} = 'IGNORE';
1725 local $SIG{TERM} = 'IGNORE';
1726 local $SIG{TSTP} = 'IGNORE';
1727 local $SIG{PIPE} = 'IGNORE';
1729 my $oldAutoCommit = $FS::UID::AutoCommit;
1730 local $FS::UID::AutoCommit = 0;
1733 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1736 foreach my $old_cust_pkg ( @cust_pkgs ) {
1738 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1739 if ( $old_cust_pkg->getfield('cancel') ) {
1740 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1741 $old_cust_pkg->pkgnum."\n"
1745 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1747 my $error = $old_cust_pkg->change(
1748 'pkgpart' => $param->{'new_pkgpart'},
1749 'keep_dates' => $keep_dates
1751 if ( !ref($error) ) { # change returns the cust_pkg on success
1753 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1756 $dbh->commit if $oldAutoCommit;
1762 Returns the last bill date, or if there is no last bill date, the setup date.
1763 Useful for billing metered services.
1769 return $self->setfield('last_bill', $_[0]) if @_;
1770 return $self->getfield('last_bill') if $self->getfield('last_bill');
1771 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1772 'edate' => $self->bill, } );
1773 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1776 =item last_cust_pkg_reason ACTION
1778 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1779 Returns false if there is no reason or the package is not currenly ACTION'd
1780 ACTION is one of adjourn, susp, cancel, or expire.
1784 sub last_cust_pkg_reason {
1785 my ( $self, $action ) = ( shift, shift );
1786 my $date = $self->get($action);
1788 'table' => 'cust_pkg_reason',
1789 'hashref' => { 'pkgnum' => $self->pkgnum,
1790 'action' => substr(uc($action), 0, 1),
1793 'order_by' => 'ORDER BY num DESC LIMIT 1',
1797 =item last_reason ACTION
1799 Returns the most recent ACTION FS::reason associated with the package.
1800 Returns false if there is no reason or the package is not currenly ACTION'd
1801 ACTION is one of adjourn, susp, cancel, or expire.
1806 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1807 $cust_pkg_reason->reason
1808 if $cust_pkg_reason;
1813 Returns the definition for this billing item, as an FS::part_pkg object (see
1820 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1821 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1822 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1827 Returns the cancelled package this package was changed from, if any.
1833 return '' unless $self->change_pkgnum;
1834 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1839 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1846 $self->part_pkg->calc_setup($self, @_);
1851 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1858 $self->part_pkg->calc_recur($self, @_);
1863 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1870 $self->part_pkg->base_recur($self, @_);
1875 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1882 $self->part_pkg->calc_remain($self, @_);
1887 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1894 $self->part_pkg->calc_cancel($self, @_);
1899 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1905 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1908 =item cust_pkg_detail [ DETAILTYPE ]
1910 Returns any customer package details for this package (see
1911 L<FS::cust_pkg_detail>).
1913 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1917 sub cust_pkg_detail {
1919 my %hash = ( 'pkgnum' => $self->pkgnum );
1920 $hash{detailtype} = shift if @_;
1922 'table' => 'cust_pkg_detail',
1923 'hashref' => \%hash,
1924 'order_by' => 'ORDER BY weight, pkgdetailnum',
1928 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1930 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1932 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1934 If there is an error, returns the error, otherwise returns false.
1938 sub set_cust_pkg_detail {
1939 my( $self, $detailtype, @details ) = @_;
1941 local $SIG{HUP} = 'IGNORE';
1942 local $SIG{INT} = 'IGNORE';
1943 local $SIG{QUIT} = 'IGNORE';
1944 local $SIG{TERM} = 'IGNORE';
1945 local $SIG{TSTP} = 'IGNORE';
1946 local $SIG{PIPE} = 'IGNORE';
1948 my $oldAutoCommit = $FS::UID::AutoCommit;
1949 local $FS::UID::AutoCommit = 0;
1952 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1953 my $error = $current->delete;
1955 $dbh->rollback if $oldAutoCommit;
1956 return "error removing old detail: $error";
1960 foreach my $detail ( @details ) {
1961 my $cust_pkg_detail = new FS::cust_pkg_detail {
1962 'pkgnum' => $self->pkgnum,
1963 'detailtype' => $detailtype,
1964 'detail' => $detail,
1966 my $error = $cust_pkg_detail->insert;
1968 $dbh->rollback if $oldAutoCommit;
1969 return "error adding new detail: $error";
1974 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1981 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1985 #false laziness w/cust_bill.pm
1989 'table' => 'cust_event',
1990 'addl_from' => 'JOIN part_event USING ( eventpart )',
1991 'hashref' => { 'tablenum' => $self->pkgnum },
1992 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1996 =item num_cust_event
1998 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2002 #false laziness w/cust_bill.pm
2003 sub num_cust_event {
2006 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2007 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2008 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2009 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2010 $sth->fetchrow_arrayref->[0];
2013 =item cust_svc [ SVCPART ] (old, deprecated usage)
2015 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2017 Returns the services for this package, as FS::cust_svc objects (see
2018 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2019 spcififed, returns only the matching services.
2026 return () unless $self->num_cust_svc(@_);
2029 if ( @_ && $_[0] =~ /^\d+/ ) {
2030 $opt{svcpart} = shift;
2031 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2038 'table' => 'cust_svc',
2039 'hashref' => { 'pkgnum' => $self->pkgnum },
2041 if ( $opt{svcpart} ) {
2042 $search{hashref}->{svcpart} = $opt{'svcpart'};
2044 if ( $opt{'svcdb'} ) {
2045 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2046 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2049 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2051 #if ( $self->{'_svcnum'} ) {
2052 # values %{ $self->{'_svcnum'}->cache };
2054 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2059 =item overlimit [ SVCPART ]
2061 Returns the services for this package which have exceeded their
2062 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2063 is specified, return only the matching services.
2069 return () unless $self->num_cust_svc(@_);
2070 grep { $_->overlimit } $self->cust_svc(@_);
2073 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2075 Returns historical services for this package created before END TIMESTAMP and
2076 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2077 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2078 I<pkg_svc.hidden> flag will be omitted.
2084 warn "$me _h_cust_svc called on $self\n"
2087 my ($end, $start, $mode) = @_;
2088 my @cust_svc = $self->_sort_cust_svc(
2089 [ qsearch( 'h_cust_svc',
2090 { 'pkgnum' => $self->pkgnum, },
2091 FS::h_cust_svc->sql_h_search(@_),
2094 if ( defined($mode) && $mode eq 'I' ) {
2095 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2096 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2102 sub _sort_cust_svc {
2103 my( $self, $arrayref ) = @_;
2106 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2111 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2112 'svcpart' => $_->svcpart } );
2114 $pkg_svc ? $pkg_svc->primary_svc : '',
2115 $pkg_svc ? $pkg_svc->quantity : 0,
2122 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2124 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2126 Returns the number of services for this package. Available options are svcpart
2127 and svcdb. If either is spcififed, returns only the matching services.
2134 return $self->{'_num_cust_svc'}
2136 && exists($self->{'_num_cust_svc'})
2137 && $self->{'_num_cust_svc'} =~ /\d/;
2139 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2143 if ( @_ && $_[0] =~ /^\d+/ ) {
2144 $opt{svcpart} = shift;
2145 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2151 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2152 my $where = ' WHERE pkgnum = ? ';
2153 my @param = ($self->pkgnum);
2155 if ( $opt{'svcpart'} ) {
2156 $where .= ' AND svcpart = ? ';
2157 push @param, $opt{'svcpart'};
2159 if ( $opt{'svcdb'} ) {
2160 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2161 $where .= ' AND svcdb = ? ';
2162 push @param, $opt{'svcdb'};
2165 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2166 $sth->execute(@param) or die $sth->errstr;
2167 $sth->fetchrow_arrayref->[0];
2170 =item available_part_svc
2172 Returns a list of FS::part_svc objects representing services included in this
2173 package but not yet provisioned. Each FS::part_svc object also has an extra
2174 field, I<num_avail>, which specifies the number of available services.
2178 sub available_part_svc {
2180 grep { $_->num_avail > 0 }
2182 my $part_svc = $_->part_svc;
2183 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2184 $_->quantity - $self->num_cust_svc($_->svcpart);
2186 # more evil encapsulation breakage
2187 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2188 my @exports = $part_svc->part_export_did;
2189 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2194 $self->part_pkg->pkg_svc;
2197 =item part_svc [ OPTION => VALUE ... ]
2199 Returns a list of FS::part_svc objects representing provisioned and available
2200 services included in this package. Each FS::part_svc object also has the
2201 following extra fields:
2205 =item num_cust_svc (count)
2207 =item num_avail (quantity - count)
2209 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2213 Accepts one option: summarize_size. If specified and non-zero, will omit the
2214 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2220 #label -> ($cust_svc->label)[1]
2226 #XXX some sort of sort order besides numeric by svcpart...
2227 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2229 my $part_svc = $pkg_svc->part_svc;
2230 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2231 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2232 $part_svc->{'Hash'}{'num_avail'} =
2233 max( 0, $pkg_svc->quantity - $num_cust_svc );
2234 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2235 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2236 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2237 && $num_cust_svc >= $opt{summarize_size};
2238 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2240 } $self->part_pkg->pkg_svc;
2243 push @part_svc, map {
2245 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2246 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2247 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2248 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2249 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2251 } $self->extra_part_svc;
2257 =item extra_part_svc
2259 Returns a list of FS::part_svc objects corresponding to services in this
2260 package which are still provisioned but not (any longer) available in the
2265 sub extra_part_svc {
2268 my $pkgnum = $self->pkgnum;
2269 #my $pkgpart = $self->pkgpart;
2272 # 'table' => 'part_svc',
2275 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2276 # WHERE pkg_svc.svcpart = part_svc.svcpart
2277 # AND pkg_svc.pkgpart = ?
2280 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2281 # LEFT JOIN cust_pkg USING ( pkgnum )
2282 # WHERE cust_svc.svcpart = part_svc.svcpart
2285 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2288 #seems to benchmark slightly faster... (or did?)
2290 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2291 my $pkgparts = join(',', @pkgparts);
2294 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2295 #MySQL doesn't grok DISINCT ON
2296 'select' => 'DISTINCT part_svc.*',
2297 'table' => 'part_svc',
2299 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2300 AND pkg_svc.pkgpart IN ($pkgparts)
2303 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2304 LEFT JOIN cust_pkg USING ( pkgnum )
2307 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2308 'extra_param' => [ [$self->pkgnum=>'int'] ],
2314 Returns a short status string for this package, currently:
2318 =item not yet billed
2320 =item one-time charge
2335 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2337 return 'cancelled' if $self->get('cancel');
2338 return 'suspended' if $self->susp;
2339 return 'not yet billed' unless $self->setup;
2340 return 'one-time charge' if $freq =~ /^(0|$)/;
2344 =item ucfirst_status
2346 Returns the status with the first character capitalized.
2350 sub ucfirst_status {
2351 ucfirst(shift->status);
2356 Class method that returns the list of possible status strings for packages
2357 (see L<the status method|/status>). For example:
2359 @statuses = FS::cust_pkg->statuses();
2363 tie my %statuscolor, 'Tie::IxHash',
2364 'not yet billed' => '009999', #teal? cyan?
2365 'one-time charge' => '000000',
2366 'active' => '00CC00',
2367 'suspended' => 'FF9900',
2368 'cancelled' => 'FF0000',
2372 my $self = shift; #could be class...
2373 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2374 # # mayble split btw one-time vs. recur
2380 Returns a hex triplet color string for this package's status.
2386 $statuscolor{$self->status};
2391 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2392 "pkg-comment" depending on user preference).
2398 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2399 $label = $self->pkgnum. ": $label"
2400 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2404 =item pkg_label_long
2406 Returns a long label for this package, adding the primary service's label to
2411 sub pkg_label_long {
2413 my $label = $self->pkg_label;
2414 my $cust_svc = $self->primary_cust_svc;
2415 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2419 =item primary_cust_svc
2421 Returns a primary service (as FS::cust_svc object) if one can be identified.
2425 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2427 sub primary_cust_svc {
2430 my @cust_svc = $self->cust_svc;
2432 return '' unless @cust_svc; #no serivces - irrelevant then
2434 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2436 # primary service as specified in the package definition
2437 # or exactly one service definition with quantity one
2438 my $svcpart = $self->part_pkg->svcpart;
2439 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2440 return $cust_svc[0] if scalar(@cust_svc) == 1;
2442 #couldn't identify one thing..
2448 Returns a list of lists, calling the label method for all services
2449 (see L<FS::cust_svc>) of this billing item.
2455 map { [ $_->label ] } $self->cust_svc;
2458 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2460 Like the labels method, but returns historical information on services that
2461 were active as of END_TIMESTAMP and (optionally) not cancelled before
2462 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2463 I<pkg_svc.hidden> flag will be omitted.
2465 Returns a list of lists, calling the label method for all (historical) services
2466 (see L<FS::h_cust_svc>) of this billing item.
2472 warn "$me _h_labels called on $self\n"
2474 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2479 Like labels, except returns a simple flat list, and shortens long
2480 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2481 identical services to one line that lists the service label and the number of
2482 individual services rather than individual items.
2487 shift->_labels_short( 'labels', @_ );
2490 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2492 Like h_labels, except returns a simple flat list, and shortens long
2493 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2494 identical services to one line that lists the service label and the number of
2495 individual services rather than individual items.
2499 sub h_labels_short {
2500 shift->_labels_short( 'h_labels', @_ );
2504 my( $self, $method ) = ( shift, shift );
2506 warn "$me _labels_short called on $self with $method method\n"
2509 my $conf = new FS::Conf;
2510 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2512 warn "$me _labels_short populating \%labels\n"
2516 #tie %labels, 'Tie::IxHash';
2517 push @{ $labels{$_->[0]} }, $_->[1]
2518 foreach $self->$method(@_);
2520 warn "$me _labels_short populating \@labels\n"
2524 foreach my $label ( keys %labels ) {
2526 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2527 my $num = scalar(@values);
2528 warn "$me _labels_short $num items for $label\n"
2531 if ( $num > $max_same_services ) {
2532 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2534 push @labels, "$label ($num)";
2536 if ( $conf->exists('cust_bill-consolidate_services') ) {
2537 warn "$me _labels_short consolidating services\n"
2539 # push @labels, "$label: ". join(', ', @values);
2541 my $detail = "$label: ";
2542 $detail .= shift(@values). ', '
2544 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2546 push @labels, $detail;
2548 warn "$me _labels_short done consolidating services\n"
2551 warn "$me _labels_short adding service data\n"
2553 push @labels, map { "$label: $_" } @values;
2564 Returns the parent customer object (see L<FS::cust_main>).
2570 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2573 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2577 Returns the location object, if any (see L<FS::cust_location>).
2579 =item cust_location_or_main
2581 If this package is associated with a location, returns the locaiton (see
2582 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2584 =item location_label [ OPTION => VALUE ... ]
2586 Returns the label of the location object (see L<FS::cust_location>).
2590 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2592 =item seconds_since TIMESTAMP
2594 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2595 package have been online since TIMESTAMP, according to the session monitor.
2597 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2598 L<Time::Local> and L<Date::Parse> for conversion functions.
2603 my($self, $since) = @_;
2606 foreach my $cust_svc (
2607 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2609 $seconds += $cust_svc->seconds_since($since);
2616 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2618 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2619 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2622 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2623 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2629 sub seconds_since_sqlradacct {
2630 my($self, $start, $end) = @_;
2634 foreach my $cust_svc (
2636 my $part_svc = $_->part_svc;
2637 $part_svc->svcdb eq 'svc_acct'
2638 && scalar($part_svc->part_export_usage);
2641 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2648 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2650 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2651 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2655 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2656 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2661 sub attribute_since_sqlradacct {
2662 my($self, $start, $end, $attrib) = @_;
2666 foreach my $cust_svc (
2668 my $part_svc = $_->part_svc;
2669 $part_svc->svcdb eq 'svc_acct'
2670 && scalar($part_svc->part_export_usage);
2673 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2685 my( $self, $value ) = @_;
2686 if ( defined($value) ) {
2687 $self->setfield('quantity', $value);
2689 $self->getfield('quantity') || 1;
2692 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2694 Transfers as many services as possible from this package to another package.
2696 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2697 object. The destination package must already exist.
2699 Services are moved only if the destination allows services with the correct
2700 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2701 this option with caution! No provision is made for export differences
2702 between the old and new service definitions. Probably only should be used
2703 when your exports for all service definitions of a given svcdb are identical.
2704 (attempt a transfer without it first, to move all possible svcpart-matching
2707 Any services that can't be moved remain in the original package.
2709 Returns an error, if there is one; otherwise, returns the number of services
2710 that couldn't be moved.
2715 my ($self, $dest_pkgnum, %opt) = @_;
2721 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2722 $dest = $dest_pkgnum;
2723 $dest_pkgnum = $dest->pkgnum;
2725 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2728 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2730 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2731 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2734 foreach my $cust_svc ($dest->cust_svc) {
2735 $target{$cust_svc->svcpart}--;
2738 my %svcpart2svcparts = ();
2739 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2740 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2741 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2742 next if exists $svcpart2svcparts{$svcpart};
2743 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2744 $svcpart2svcparts{$svcpart} = [
2746 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2748 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2749 'svcpart' => $_ } );
2751 $pkg_svc ? $pkg_svc->primary_svc : '',
2752 $pkg_svc ? $pkg_svc->quantity : 0,
2756 grep { $_ != $svcpart }
2758 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2760 warn "alternates for svcpart $svcpart: ".
2761 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2766 foreach my $cust_svc ($self->cust_svc) {
2767 if($target{$cust_svc->svcpart} > 0) {
2768 $target{$cust_svc->svcpart}--;
2769 my $new = new FS::cust_svc { $cust_svc->hash };
2770 $new->pkgnum($dest_pkgnum);
2771 my $error = $new->replace($cust_svc);
2772 return $error if $error;
2773 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2775 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2776 warn "alternates to consider: ".
2777 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2779 my @alternate = grep {
2780 warn "considering alternate svcpart $_: ".
2781 "$target{$_} available in new package\n"
2784 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2786 warn "alternate(s) found\n" if $DEBUG;
2787 my $change_svcpart = $alternate[0];
2788 $target{$change_svcpart}--;
2789 my $new = new FS::cust_svc { $cust_svc->hash };
2790 $new->svcpart($change_svcpart);
2791 $new->pkgnum($dest_pkgnum);
2792 my $error = $new->replace($cust_svc);
2793 return $error if $error;
2806 This method is deprecated. See the I<depend_jobnum> option to the insert and
2807 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2814 local $SIG{HUP} = 'IGNORE';
2815 local $SIG{INT} = 'IGNORE';
2816 local $SIG{QUIT} = 'IGNORE';
2817 local $SIG{TERM} = 'IGNORE';
2818 local $SIG{TSTP} = 'IGNORE';
2819 local $SIG{PIPE} = 'IGNORE';
2821 my $oldAutoCommit = $FS::UID::AutoCommit;
2822 local $FS::UID::AutoCommit = 0;
2825 foreach my $cust_svc ( $self->cust_svc ) {
2826 #false laziness w/svc_Common::insert
2827 my $svc_x = $cust_svc->svc_x;
2828 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2829 my $error = $part_export->export_insert($svc_x);
2831 $dbh->rollback if $oldAutoCommit;
2837 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2844 Associates this package with a (suspension or cancellation) reason (see
2845 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2848 Available options are:
2854 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.
2858 the access_user (see L<FS::access_user>) providing the reason
2866 the action (cancel, susp, adjourn, expire) associated with the reason
2870 If there is an error, returns the error, otherwise returns false.
2875 my ($self, %options) = @_;
2877 my $otaker = $options{reason_otaker} ||
2878 $FS::CurrentUser::CurrentUser->username;
2881 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2885 } elsif ( ref($options{'reason'}) ) {
2887 return 'Enter a new reason (or select an existing one)'
2888 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2890 my $reason = new FS::reason({
2891 'reason_type' => $options{'reason'}->{'typenum'},
2892 'reason' => $options{'reason'}->{'reason'},
2894 my $error = $reason->insert;
2895 return $error if $error;
2897 $reasonnum = $reason->reasonnum;
2900 return "Unparsable reason: ". $options{'reason'};
2903 my $cust_pkg_reason =
2904 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2905 'reasonnum' => $reasonnum,
2906 'otaker' => $otaker,
2907 'action' => substr(uc($options{'action'}),0,1),
2908 'date' => $options{'date'}
2913 $cust_pkg_reason->insert;
2916 =item insert_discount
2918 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2919 inserting a new discount on the fly (see L<FS::discount>).
2921 Available options are:
2929 If there is an error, returns the error, otherwise returns false.
2933 sub insert_discount {
2934 #my ($self, %options) = @_;
2937 my $cust_pkg_discount = new FS::cust_pkg_discount {
2938 'pkgnum' => $self->pkgnum,
2939 'discountnum' => $self->discountnum,
2941 'end_date' => '', #XXX
2942 #for the create a new discount case
2943 '_type' => $self->discountnum__type,
2944 'amount' => $self->discountnum_amount,
2945 'percent' => $self->discountnum_percent,
2946 'months' => $self->discountnum_months,
2947 'setup' => $self->discountnum_setup,
2948 #'disabled' => $self->discountnum_disabled,
2951 $cust_pkg_discount->insert;
2954 =item set_usage USAGE_VALUE_HASHREF
2956 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2957 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2958 upbytes, downbytes, and totalbytes are appropriate keys.
2960 All svc_accts which are part of this package have their values reset.
2965 my ($self, $valueref, %opt) = @_;
2967 #only svc_acct can set_usage for now
2968 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
2969 my $svc_x = $cust_svc->svc_x;
2970 $svc_x->set_usage($valueref, %opt)
2971 if $svc_x->can("set_usage");
2975 =item recharge USAGE_VALUE_HASHREF
2977 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2978 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2979 upbytes, downbytes, and totalbytes are appropriate keys.
2981 All svc_accts which are part of this package have their values incremented.
2986 my ($self, $valueref) = @_;
2988 #only svc_acct can set_usage for now
2989 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
2990 my $svc_x = $cust_svc->svc_x;
2991 $svc_x->recharge($valueref)
2992 if $svc_x->can("recharge");
2996 =item cust_pkg_discount
3000 sub cust_pkg_discount {
3002 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3005 =item cust_pkg_discount_active
3009 sub cust_pkg_discount_active {
3011 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3016 =head1 CLASS METHODS
3022 Returns an SQL expression identifying recurring packages.
3026 sub recurring_sql { "
3027 '0' != ( select freq from part_pkg
3028 where cust_pkg.pkgpart = part_pkg.pkgpart )
3033 Returns an SQL expression identifying one-time packages.
3038 '0' = ( select freq from part_pkg
3039 where cust_pkg.pkgpart = part_pkg.pkgpart )
3044 Returns an SQL expression identifying ordered packages (recurring packages not
3050 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3055 Returns an SQL expression identifying active packages.
3060 $_[0]->recurring_sql. "
3061 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3062 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3063 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3066 =item not_yet_billed_sql
3068 Returns an SQL expression identifying packages which have not yet been billed.
3072 sub not_yet_billed_sql { "
3073 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3074 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3075 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3080 Returns an SQL expression identifying inactive packages (one-time packages
3081 that are otherwise unsuspended/uncancelled).
3085 sub inactive_sql { "
3086 ". $_[0]->onetime_sql(). "
3087 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3088 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3089 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3095 Returns an SQL expression identifying suspended packages.
3099 sub suspended_sql { susp_sql(@_); }
3101 #$_[0]->recurring_sql(). ' AND '.
3103 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3104 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3111 Returns an SQL exprression identifying cancelled packages.
3115 sub cancelled_sql { cancel_sql(@_); }
3117 #$_[0]->recurring_sql(). ' AND '.
3118 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3123 Returns an SQL expression to give the package status as a string.
3129 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3130 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3131 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3132 WHEN ".onetime_sql()." THEN 'one-time charge'
3137 =item search HASHREF
3141 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3142 Valid parameters are
3150 active, inactive, suspended, cancel (or cancelled)
3154 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3158 boolean selects custom packages
3164 pkgpart or arrayref or hashref of pkgparts
3168 arrayref of beginning and ending epoch date
3172 arrayref of beginning and ending epoch date
3176 arrayref of beginning and ending epoch date
3180 arrayref of beginning and ending epoch date
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 pkgnum or APKG_pkgnum
3200 a value suited to passing to FS::UI::Web::cust_header
3204 specifies the user for agent virtualization
3208 boolean selects packages containing fcc form 477 telco lines
3215 my ($class, $params) = @_;
3222 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3224 "cust_main.agentnum = $1";
3231 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3233 "cust_pkg.custnum = $1";
3240 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3242 "cust_pkg.pkgbatch = '$1'";
3249 if ( $params->{'magic'} eq 'active'
3250 || $params->{'status'} eq 'active' ) {
3252 push @where, FS::cust_pkg->active_sql();
3254 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3255 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3257 push @where, FS::cust_pkg->not_yet_billed_sql();
3259 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3260 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3262 push @where, FS::cust_pkg->inactive_sql();
3264 } elsif ( $params->{'magic'} eq 'suspended'
3265 || $params->{'status'} eq 'suspended' ) {
3267 push @where, FS::cust_pkg->suspended_sql();
3269 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3270 || $params->{'status'} =~ /^cancell?ed$/ ) {
3272 push @where, FS::cust_pkg->cancelled_sql();
3277 # parse package class
3280 if ( exists($params->{'classnum'}) ) {
3283 if ( ref($params->{'classnum'}) ) {
3285 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3286 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3287 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3288 @classnum = @{ $params->{'classnum'} };
3290 die 'unhandled classnum ref '. $params->{'classnum'};
3294 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3301 my @nums = grep $_, @classnum;
3302 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3303 my $null = scalar( grep { $_ eq '' } @classnum );
3304 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3306 if ( scalar(@c_where) == 1 ) {
3307 push @where, @c_where;
3308 } elsif ( @c_where ) {
3309 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3318 # parse package report options
3321 my @report_option = ();
3322 if ( exists($params->{'report_option'}) ) {
3323 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3324 @report_option = @{ $params->{'report_option'} };
3325 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3326 @report_option = split(',', $1);
3331 if (@report_option) {
3332 # this will result in the empty set for the dangling comma case as it should
3334 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3335 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3336 AND optionname = 'report_option_$_'
3337 AND optionvalue = '1' )"
3341 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3343 my @report_option_any = ();
3344 if ( ref($params->{$any}) eq 'ARRAY' ) {
3345 @report_option_any = @{ $params->{$any} };
3346 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3347 @report_option_any = split(',', $1);
3350 if (@report_option_any) {
3351 # this will result in the empty set for the dangling comma case as it should
3352 push @where, ' ( '. join(' OR ',
3353 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3354 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3355 AND optionname = 'report_option_$_'
3356 AND optionvalue = '1' )"
3357 } @report_option_any
3367 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3373 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3374 if $params->{fcc_line};
3380 if ( exists($params->{'censustract'}) ) {
3381 $params->{'censustract'} =~ /^([.\d]*)$/;
3382 my $censustract = "cust_main.censustract = '$1'";
3383 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3384 push @where, "( $censustract )";
3388 # parse censustract2
3390 if ( exists($params->{'censustract2'})
3391 && $params->{'censustract2'} =~ /^(\d*)$/
3395 push @where, "cust_main.censustract LIKE '$1%'";
3398 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3406 if ( ref($params->{'pkgpart'}) ) {
3409 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3410 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3411 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3412 @pkgpart = @{ $params->{'pkgpart'} };
3414 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3417 @pkgpart = grep /^(\d+)$/, @pkgpart;
3419 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3421 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3422 push @where, "pkgpart = $1";
3431 #false laziness w/report_cust_pkg.html
3434 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3435 'active' => { 'susp'=>1, 'cancel'=>1 },
3436 'suspended' => { 'cancel' => 1 },
3441 if( exists($params->{'active'} ) ) {
3442 # This overrides all the other date-related fields
3443 my($beginning, $ending) = @{$params->{'active'}};
3445 "cust_pkg.setup IS NOT NULL",
3446 "cust_pkg.setup <= $ending",
3447 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3448 "NOT (".FS::cust_pkg->onetime_sql . ")";
3451 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
3453 next unless exists($params->{$field});
3455 my($beginning, $ending) = @{$params->{$field}};
3457 next if $beginning == 0 && $ending == 4294967295;
3460 "cust_pkg.$field IS NOT NULL",
3461 "cust_pkg.$field >= $beginning",
3462 "cust_pkg.$field <= $ending";
3464 $orderby ||= "ORDER BY cust_pkg.$field";
3469 $orderby ||= 'ORDER BY bill';
3472 # parse magic, legacy, etc.
3475 if ( $params->{'magic'} &&
3476 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3479 $orderby = 'ORDER BY pkgnum';
3481 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3482 push @where, "pkgpart = $1";
3485 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3487 $orderby = 'ORDER BY pkgnum';
3489 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3491 $orderby = 'ORDER BY pkgnum';
3494 SELECT count(*) FROM pkg_svc
3495 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3496 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3497 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3498 AND cust_svc.svcpart = pkg_svc.svcpart
3505 # setup queries, links, subs, etc. for the search
3508 # here is the agent virtualization
3509 if ($params->{CurrentUser}) {
3511 qsearchs('access_user', { username => $params->{CurrentUser} });
3514 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3519 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3522 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3524 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3525 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3526 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3530 if ( $params->{'select_zip5'} ) {
3531 my $zip = 'COALESCE(cust_location.zip, cust_main.ship_zip, cust_main.zip)';
3533 $select = "DISTINCT substr($zip,1,5) as zip";
3534 $orderby = "ORDER BY substr($zip,1,5)";
3535 $addl_from .= 'LEFT JOIN cust_location ON ( locationnum )';
3536 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
3538 $select = join(', ',
3540 ( map "part_pkg.$_", qw( pkg freq ) ),
3541 'pkg_class.classname',
3542 'cust_main.custnum AS cust_main_custnum',
3543 FS::UI::Web::cust_sql_fields(
3544 $params->{'cust_fields'}
3547 $count_query = 'SELECT COUNT(*)';
3550 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
3553 'table' => 'cust_pkg',
3555 'select' => $select,
3556 'extra_sql' => $extra_sql,
3557 'order_by' => $orderby,
3558 'addl_from' => $addl_from,
3559 'count_query' => $count_query,
3566 Returns a list of two package counts. The first is a count of packages
3567 based on the supplied criteria and the second is the count of residential
3568 packages with those same criteria. Criteria are specified as in the search
3574 my ($class, $params) = @_;
3576 my $sql_query = $class->search( $params );
3578 my $count_sql = delete($sql_query->{'count_query'});
3579 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3580 or die "couldn't parse count_sql";
3582 my $count_sth = dbh->prepare($count_sql)
3583 or die "Error preparing $count_sql: ". dbh->errstr;
3585 or die "Error executing $count_sql: ". $count_sth->errstr;
3586 my $count_arrayref = $count_sth->fetchrow_arrayref;
3588 return ( @$count_arrayref );
3595 Returns a list: the first item is an SQL fragment identifying matching
3596 packages/customers via location (taking into account shipping and package
3597 address taxation, if enabled), and subsequent items are the parameters to
3598 substitute for the placeholders in that fragment.
3603 my($class, %opt) = @_;
3604 my $ornull = $opt{'ornull'};
3606 my $conf = new FS::Conf;
3608 # '?' placeholders in _location_sql_where
3609 my $x = $ornull ? 3 : 2;
3620 if ( $conf->exists('tax-ship_address') ) {
3623 ( ( ship_last IS NULL OR ship_last = '' )
3624 AND ". _location_sql_where('cust_main', '', $ornull ). "
3626 OR ( ship_last IS NOT NULL AND ship_last != ''
3627 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3630 # AND payby != 'COMP'
3632 @main_param = ( @bill_param, @bill_param );
3636 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3637 @main_param = @bill_param;
3643 if ( $conf->exists('tax-pkg_address') ) {
3645 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3648 ( cust_pkg.locationnum IS NULL AND $main_where )
3649 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3652 @param = ( @main_param, @bill_param );
3656 $where = $main_where;
3657 @param = @main_param;
3665 #subroutine, helper for location_sql
3666 sub _location_sql_where {
3668 my $prefix = @_ ? shift : '';
3669 my $ornull = @_ ? shift : '';
3671 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3673 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3675 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
3676 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
3677 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
3679 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
3681 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3683 ( $table.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