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).
1261 Available options are:
1267 Can be set to a date to unsuspend the package in the future (the 'resume'
1270 =item adjust_next_bill
1272 Can be set true to adjust the next bill date forward by
1273 the amount of time the account was inactive. This was set true by default
1274 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1275 explicitly requested. Price plans for which this makes sense (anniversary-date
1276 based than prorate or subscription) could have an option to enable this
1281 If there is an error, returns the error, otherwise returns false.
1286 my( $self, %opt ) = @_;
1289 local $SIG{HUP} = 'IGNORE';
1290 local $SIG{INT} = 'IGNORE';
1291 local $SIG{QUIT} = 'IGNORE';
1292 local $SIG{TERM} = 'IGNORE';
1293 local $SIG{TSTP} = 'IGNORE';
1294 local $SIG{PIPE} = 'IGNORE';
1296 my $oldAutoCommit = $FS::UID::AutoCommit;
1297 local $FS::UID::AutoCommit = 0;
1300 my $old = $self->select_for_update;
1302 my $pkgnum = $old->pkgnum;
1303 if ( $old->get('cancel') || $self->get('cancel') ) {
1304 $dbh->rollback if $oldAutoCommit;
1305 return "Can't unsuspend cancelled package $pkgnum";
1308 unless ( $old->get('susp') && $self->get('susp') ) {
1309 $dbh->rollback if $oldAutoCommit;
1310 return ""; # no error # complain instead?
1313 my $date = $opt{'date'};
1314 if ( $date and $date > time ) { # return an error if $date <= time?
1316 if ( $old->get('expire') && $old->get('expire') < $date ) {
1317 $dbh->rollback if $oldAutoCommit;
1318 return "Package $pkgnum expires before it would be unsuspended.";
1321 my $new = new FS::cust_pkg { $self->hash };
1322 $new->set('resume', $date);
1323 $error = $new->replace($self, options => $self->options);
1326 $dbh->rollback if $oldAutoCommit;
1330 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1338 foreach my $cust_svc (
1339 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1341 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1343 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1344 $dbh->rollback if $oldAutoCommit;
1345 return "Illegal svcdb value in part_svc!";
1348 require "FS/$svcdb.pm";
1350 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1352 $error = $svc->unsuspend;
1354 $dbh->rollback if $oldAutoCommit;
1357 my( $label, $value ) = $cust_svc->label;
1358 push @labels, "$label: $value";
1363 my %hash = $self->hash;
1364 my $inactive = time - $hash{'susp'};
1366 my $conf = new FS::Conf;
1368 if ( $inactive > 0 &&
1369 ( $hash{'bill'} || $hash{'setup'} ) &&
1370 ( $opt{'adjust_next_bill'} ||
1371 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1372 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1375 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1380 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1381 $hash{'resume'} = '' if !$hash{'adjourn'};
1382 my $new = new FS::cust_pkg ( \%hash );
1383 $error = $new->replace( $self, options => { $self->options } );
1385 $dbh->rollback if $oldAutoCommit;
1389 if ( $conf->config('unsuspend_email_admin') ) {
1391 my $error = send_email(
1392 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1393 #invoice_from ??? well as good as any
1394 'to' => $conf->config('unsuspend_email_admin'),
1395 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1396 "This is an automatic message from your Freeside installation\n",
1397 "informing you that the following customer package has been unsuspended:\n",
1399 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1400 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1401 ( map { "Service : $_\n" } @labels ),
1406 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1412 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1419 Cancels any pending suspension (sets the adjourn field to null).
1421 If there is an error, returns the error, otherwise returns false.
1426 my( $self, %options ) = @_;
1429 local $SIG{HUP} = 'IGNORE';
1430 local $SIG{INT} = 'IGNORE';
1431 local $SIG{QUIT} = 'IGNORE';
1432 local $SIG{TERM} = 'IGNORE';
1433 local $SIG{TSTP} = 'IGNORE';
1434 local $SIG{PIPE} = 'IGNORE';
1436 my $oldAutoCommit = $FS::UID::AutoCommit;
1437 local $FS::UID::AutoCommit = 0;
1440 my $old = $self->select_for_update;
1442 my $pkgnum = $old->pkgnum;
1443 if ( $old->get('cancel') || $self->get('cancel') ) {
1444 dbh->rollback if $oldAutoCommit;
1445 return "Can't unadjourn cancelled package $pkgnum";
1446 # or at least it's pointless
1449 if ( $old->get('susp') || $self->get('susp') ) {
1450 dbh->rollback if $oldAutoCommit;
1451 return "Can't unadjourn suspended package $pkgnum";
1452 # perhaps this is arbitrary
1455 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1456 dbh->rollback if $oldAutoCommit;
1457 return ""; # no error
1460 my %hash = $self->hash;
1461 $hash{'adjourn'} = '';
1462 $hash{'resume'} = '';
1463 my $new = new FS::cust_pkg ( \%hash );
1464 $error = $new->replace( $self, options => { $self->options } );
1466 $dbh->rollback if $oldAutoCommit;
1470 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1477 =item change HASHREF | OPTION => VALUE ...
1479 Changes this package: cancels it and creates a new one, with a different
1480 pkgpart or locationnum or both. All services are transferred to the new
1481 package (no change will be made if this is not possible).
1483 Options may be passed as a list of key/value pairs or as a hash reference.
1490 New locationnum, to change the location for this package.
1494 New FS::cust_location object, to create a new location and assign it
1499 New pkgpart (see L<FS::part_pkg>).
1503 New refnum (see L<FS::part_referral>).
1507 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1508 susp, adjourn, cancel, expire, and contract_end) to the new package.
1512 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1513 (otherwise, what's the point?)
1515 Returns either the new FS::cust_pkg object or a scalar error.
1519 my $err_or_new_cust_pkg = $old_cust_pkg->change
1523 #some false laziness w/order
1526 my $opt = ref($_[0]) ? shift : { @_ };
1528 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1531 my $conf = new FS::Conf;
1533 # Transactionize this whole mess
1534 local $SIG{HUP} = 'IGNORE';
1535 local $SIG{INT} = 'IGNORE';
1536 local $SIG{QUIT} = 'IGNORE';
1537 local $SIG{TERM} = 'IGNORE';
1538 local $SIG{TSTP} = 'IGNORE';
1539 local $SIG{PIPE} = 'IGNORE';
1541 my $oldAutoCommit = $FS::UID::AutoCommit;
1542 local $FS::UID::AutoCommit = 0;
1551 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1553 #$hash{$_} = $self->$_() foreach qw( setup );
1555 $hash{'setup'} = $time if $self->setup;
1557 $hash{'change_date'} = $time;
1558 $hash{"change_$_"} = $self->$_()
1559 foreach qw( pkgnum pkgpart locationnum );
1561 if ( $opt->{'cust_location'} &&
1562 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1563 $error = $opt->{'cust_location'}->insert;
1565 $dbh->rollback if $oldAutoCommit;
1566 return "inserting cust_location (transaction rolled back): $error";
1568 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1571 my $unused_credit = 0;
1572 if ( $opt->{'keep_dates'} ) {
1573 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1574 resume start_date contract_end ) ) {
1575 $hash{$date} = $self->getfield($date);
1578 # Special case. If the pkgpart is changing, and the customer is
1579 # going to be credited for remaining time, don't keep setup, bill,
1580 # or last_bill dates, and DO pass the flag to cancel() to credit
1582 if ( $opt->{'pkgpart'}
1583 and $opt->{'pkgpart'} != $self->pkgpart
1584 and $self->part_pkg->option('unused_credit_change', 1) ) {
1586 $hash{$_} = '' foreach qw(setup bill last_bill);
1589 # allow $opt->{'locationnum'} = '' to specifically set it to null
1590 # (i.e. customer default location)
1591 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1593 # Create the new package.
1594 my $cust_pkg = new FS::cust_pkg {
1595 custnum => $self->custnum,
1596 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1597 refnum => ( $opt->{'refnum'} || $self->refnum ),
1598 locationnum => ( $opt->{'locationnum'} ),
1602 $error = $cust_pkg->insert( 'change' => 1 );
1604 $dbh->rollback if $oldAutoCommit;
1608 # Transfer services and cancel old package.
1610 $error = $self->transfer($cust_pkg);
1611 if ($error and $error == 0) {
1612 # $old_pkg->transfer failed.
1613 $dbh->rollback if $oldAutoCommit;
1617 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1618 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1619 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1620 if ($error and $error == 0) {
1621 # $old_pkg->transfer failed.
1622 $dbh->rollback if $oldAutoCommit;
1628 # Transfers were successful, but we still had services left on the old
1629 # package. We can't change the package under this circumstances, so abort.
1630 $dbh->rollback if $oldAutoCommit;
1631 return "Unable to transfer all services from package ". $self->pkgnum;
1634 #reset usage if changing pkgpart
1635 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1636 if ($self->pkgpart != $cust_pkg->pkgpart) {
1637 my $part_pkg = $cust_pkg->part_pkg;
1638 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1642 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1645 $dbh->rollback if $oldAutoCommit;
1646 return "Error setting usage values: $error";
1650 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1652 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1654 $dbh->rollback if $oldAutoCommit;
1658 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1660 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1662 $dbh->rollback if $oldAutoCommit;
1667 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1673 use Storable 'thaw';
1675 sub process_bulk_cust_pkg {
1677 my $param = thaw(decode_base64(shift));
1678 warn Dumper($param) if $DEBUG;
1680 my $old_part_pkg = qsearchs('part_pkg',
1681 { pkgpart => $param->{'old_pkgpart'} });
1682 my $new_part_pkg = qsearchs('part_pkg',
1683 { pkgpart => $param->{'new_pkgpart'} });
1684 die "Must select a new package type\n" unless $new_part_pkg;
1685 #my $keep_dates = $param->{'keep_dates'} || 0;
1686 my $keep_dates = 1; # there is no good reason to turn this off
1688 local $SIG{HUP} = 'IGNORE';
1689 local $SIG{INT} = 'IGNORE';
1690 local $SIG{QUIT} = 'IGNORE';
1691 local $SIG{TERM} = 'IGNORE';
1692 local $SIG{TSTP} = 'IGNORE';
1693 local $SIG{PIPE} = 'IGNORE';
1695 my $oldAutoCommit = $FS::UID::AutoCommit;
1696 local $FS::UID::AutoCommit = 0;
1699 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1702 foreach my $old_cust_pkg ( @cust_pkgs ) {
1704 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1705 if ( $old_cust_pkg->getfield('cancel') ) {
1706 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1707 $old_cust_pkg->pkgnum."\n"
1711 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1713 my $error = $old_cust_pkg->change(
1714 'pkgpart' => $param->{'new_pkgpart'},
1715 'keep_dates' => $keep_dates
1717 if ( !ref($error) ) { # change returns the cust_pkg on success
1719 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1722 $dbh->commit if $oldAutoCommit;
1728 Returns the last bill date, or if there is no last bill date, the setup date.
1729 Useful for billing metered services.
1735 return $self->setfield('last_bill', $_[0]) if @_;
1736 return $self->getfield('last_bill') if $self->getfield('last_bill');
1737 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1738 'edate' => $self->bill, } );
1739 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1742 =item last_cust_pkg_reason ACTION
1744 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1745 Returns false if there is no reason or the package is not currenly ACTION'd
1746 ACTION is one of adjourn, susp, cancel, or expire.
1750 sub last_cust_pkg_reason {
1751 my ( $self, $action ) = ( shift, shift );
1752 my $date = $self->get($action);
1754 'table' => 'cust_pkg_reason',
1755 'hashref' => { 'pkgnum' => $self->pkgnum,
1756 'action' => substr(uc($action), 0, 1),
1759 'order_by' => 'ORDER BY num DESC LIMIT 1',
1763 =item last_reason ACTION
1765 Returns the most recent ACTION FS::reason associated with the package.
1766 Returns false if there is no reason or the package is not currenly ACTION'd
1767 ACTION is one of adjourn, susp, cancel, or expire.
1772 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1773 $cust_pkg_reason->reason
1774 if $cust_pkg_reason;
1779 Returns the definition for this billing item, as an FS::part_pkg object (see
1786 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1787 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1788 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1793 Returns the cancelled package this package was changed from, if any.
1799 return '' unless $self->change_pkgnum;
1800 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1805 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1812 $self->part_pkg->calc_setup($self, @_);
1817 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1824 $self->part_pkg->calc_recur($self, @_);
1829 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1836 $self->part_pkg->base_recur($self, @_);
1841 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1848 $self->part_pkg->calc_remain($self, @_);
1853 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1860 $self->part_pkg->calc_cancel($self, @_);
1865 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1871 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1874 =item cust_pkg_detail [ DETAILTYPE ]
1876 Returns any customer package details for this package (see
1877 L<FS::cust_pkg_detail>).
1879 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1883 sub cust_pkg_detail {
1885 my %hash = ( 'pkgnum' => $self->pkgnum );
1886 $hash{detailtype} = shift if @_;
1888 'table' => 'cust_pkg_detail',
1889 'hashref' => \%hash,
1890 'order_by' => 'ORDER BY weight, pkgdetailnum',
1894 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1896 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1898 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1900 If there is an error, returns the error, otherwise returns false.
1904 sub set_cust_pkg_detail {
1905 my( $self, $detailtype, @details ) = @_;
1907 local $SIG{HUP} = 'IGNORE';
1908 local $SIG{INT} = 'IGNORE';
1909 local $SIG{QUIT} = 'IGNORE';
1910 local $SIG{TERM} = 'IGNORE';
1911 local $SIG{TSTP} = 'IGNORE';
1912 local $SIG{PIPE} = 'IGNORE';
1914 my $oldAutoCommit = $FS::UID::AutoCommit;
1915 local $FS::UID::AutoCommit = 0;
1918 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1919 my $error = $current->delete;
1921 $dbh->rollback if $oldAutoCommit;
1922 return "error removing old detail: $error";
1926 foreach my $detail ( @details ) {
1927 my $cust_pkg_detail = new FS::cust_pkg_detail {
1928 'pkgnum' => $self->pkgnum,
1929 'detailtype' => $detailtype,
1930 'detail' => $detail,
1932 my $error = $cust_pkg_detail->insert;
1934 $dbh->rollback if $oldAutoCommit;
1935 return "error adding new detail: $error";
1940 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1947 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1951 #false laziness w/cust_bill.pm
1955 'table' => 'cust_event',
1956 'addl_from' => 'JOIN part_event USING ( eventpart )',
1957 'hashref' => { 'tablenum' => $self->pkgnum },
1958 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1962 =item num_cust_event
1964 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1968 #false laziness w/cust_bill.pm
1969 sub num_cust_event {
1972 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1973 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1974 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1975 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1976 $sth->fetchrow_arrayref->[0];
1979 =item cust_svc [ SVCPART ] (old, deprecated usage)
1981 =item cust_svc [ OPTION => VALUE ... ] (current usage)
1983 Returns the services for this package, as FS::cust_svc objects (see
1984 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
1985 spcififed, returns only the matching services.
1992 return () unless $self->num_cust_svc(@_);
1995 if ( @_ && $_[0] =~ /^\d+/ ) {
1996 $opt{svcpart} = shift;
1997 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2004 'table' => 'cust_svc',
2005 'hashref' => { 'pkgnum' => $self->pkgnum },
2007 if ( $opt{svcpart} ) {
2008 $search{hashref}->{svcpart} = $opt{'svcpart'};
2010 if ( $opt{'svcdb'} ) {
2011 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2012 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2015 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2017 #if ( $self->{'_svcnum'} ) {
2018 # values %{ $self->{'_svcnum'}->cache };
2020 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2025 =item overlimit [ SVCPART ]
2027 Returns the services for this package which have exceeded their
2028 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2029 is specified, return only the matching services.
2035 return () unless $self->num_cust_svc(@_);
2036 grep { $_->overlimit } $self->cust_svc(@_);
2039 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2041 Returns historical services for this package created before END TIMESTAMP and
2042 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2043 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2044 I<pkg_svc.hidden> flag will be omitted.
2050 warn "$me _h_cust_svc called on $self\n"
2053 my ($end, $start, $mode) = @_;
2054 my @cust_svc = $self->_sort_cust_svc(
2055 [ qsearch( 'h_cust_svc',
2056 { 'pkgnum' => $self->pkgnum, },
2057 FS::h_cust_svc->sql_h_search(@_),
2060 if ( defined($mode) && $mode eq 'I' ) {
2061 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2062 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2068 sub _sort_cust_svc {
2069 my( $self, $arrayref ) = @_;
2072 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2077 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2078 'svcpart' => $_->svcpart } );
2080 $pkg_svc ? $pkg_svc->primary_svc : '',
2081 $pkg_svc ? $pkg_svc->quantity : 0,
2088 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2090 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2092 Returns the number of services for this package. Available options are svcpart
2093 and svcdb. If either is spcififed, returns only the matching services.
2100 return $self->{'_num_cust_svc'}
2102 && exists($self->{'_num_cust_svc'})
2103 && $self->{'_num_cust_svc'} =~ /\d/;
2105 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2109 if ( @_ && $_[0] =~ /^\d+/ ) {
2110 $opt{svcpart} = shift;
2111 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2117 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2118 my $where = ' WHERE pkgnum = ? ';
2119 my @param = ($self->pkgnum);
2121 if ( $opt{'svcpart'} ) {
2122 $where .= ' AND svcpart = ? ';
2123 push @param, $opt{'svcpart'};
2125 if ( $opt{'svcdb'} ) {
2126 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2127 $where .= ' AND svcdb = ? ';
2128 push @param, $opt{'svcdb'};
2131 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2132 $sth->execute(@param) or die $sth->errstr;
2133 $sth->fetchrow_arrayref->[0];
2136 =item available_part_svc
2138 Returns a list of FS::part_svc objects representing services included in this
2139 package but not yet provisioned. Each FS::part_svc object also has an extra
2140 field, I<num_avail>, which specifies the number of available services.
2144 sub available_part_svc {
2146 grep { $_->num_avail > 0 }
2148 my $part_svc = $_->part_svc;
2149 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2150 $_->quantity - $self->num_cust_svc($_->svcpart);
2152 # more evil encapsulation breakage
2153 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2154 my @exports = $part_svc->part_export_did;
2155 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2160 $self->part_pkg->pkg_svc;
2163 =item part_svc [ OPTION => VALUE ... ]
2165 Returns a list of FS::part_svc objects representing provisioned and available
2166 services included in this package. Each FS::part_svc object also has the
2167 following extra fields:
2171 =item num_cust_svc (count)
2173 =item num_avail (quantity - count)
2175 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2179 Accepts one option: summarize_size. If specified and non-zero, will omit the
2180 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2186 #label -> ($cust_svc->label)[1]
2192 #XXX some sort of sort order besides numeric by svcpart...
2193 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2195 my $part_svc = $pkg_svc->part_svc;
2196 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2197 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2198 $part_svc->{'Hash'}{'num_avail'} =
2199 max( 0, $pkg_svc->quantity - $num_cust_svc );
2200 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2201 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2202 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2203 && $num_cust_svc >= $opt{summarize_size};
2204 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2206 } $self->part_pkg->pkg_svc;
2209 push @part_svc, map {
2211 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2212 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2213 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2214 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2215 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2217 } $self->extra_part_svc;
2223 =item extra_part_svc
2225 Returns a list of FS::part_svc objects corresponding to services in this
2226 package which are still provisioned but not (any longer) available in the
2231 sub extra_part_svc {
2234 my $pkgnum = $self->pkgnum;
2235 #my $pkgpart = $self->pkgpart;
2238 # 'table' => 'part_svc',
2241 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2242 # WHERE pkg_svc.svcpart = part_svc.svcpart
2243 # AND pkg_svc.pkgpart = ?
2246 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2247 # LEFT JOIN cust_pkg USING ( pkgnum )
2248 # WHERE cust_svc.svcpart = part_svc.svcpart
2251 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2254 #seems to benchmark slightly faster... (or did?)
2256 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2257 my $pkgparts = join(',', @pkgparts);
2260 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2261 #MySQL doesn't grok DISINCT ON
2262 'select' => 'DISTINCT part_svc.*',
2263 'table' => 'part_svc',
2265 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2266 AND pkg_svc.pkgpart IN ($pkgparts)
2269 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2270 LEFT JOIN cust_pkg USING ( pkgnum )
2273 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2274 'extra_param' => [ [$self->pkgnum=>'int'] ],
2280 Returns a short status string for this package, currently:
2284 =item not yet billed
2286 =item one-time charge
2301 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2303 return 'cancelled' if $self->get('cancel');
2304 return 'suspended' if $self->susp;
2305 return 'not yet billed' unless $self->setup;
2306 return 'one-time charge' if $freq =~ /^(0|$)/;
2310 =item ucfirst_status
2312 Returns the status with the first character capitalized.
2316 sub ucfirst_status {
2317 ucfirst(shift->status);
2322 Class method that returns the list of possible status strings for packages
2323 (see L<the status method|/status>). For example:
2325 @statuses = FS::cust_pkg->statuses();
2329 tie my %statuscolor, 'Tie::IxHash',
2330 'not yet billed' => '009999', #teal? cyan?
2331 'one-time charge' => '000000',
2332 'active' => '00CC00',
2333 'suspended' => 'FF9900',
2334 'cancelled' => 'FF0000',
2338 my $self = shift; #could be class...
2339 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2340 # # mayble split btw one-time vs. recur
2346 Returns a hex triplet color string for this package's status.
2352 $statuscolor{$self->status};
2357 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2358 "pkg-comment" depending on user preference).
2364 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2365 $label = $self->pkgnum. ": $label"
2366 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2370 =item pkg_label_long
2372 Returns a long label for this package, adding the primary service's label to
2377 sub pkg_label_long {
2379 my $label = $self->pkg_label;
2380 my $cust_svc = $self->primary_cust_svc;
2381 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2385 =item primary_cust_svc
2387 Returns a primary service (as FS::cust_svc object) if one can be identified.
2391 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2393 sub primary_cust_svc {
2396 my @cust_svc = $self->cust_svc;
2398 return '' unless @cust_svc; #no serivces - irrelevant then
2400 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2402 # primary service as specified in the package definition
2403 # or exactly one service definition with quantity one
2404 my $svcpart = $self->part_pkg->svcpart;
2405 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2406 return $cust_svc[0] if scalar(@cust_svc) == 1;
2408 #couldn't identify one thing..
2414 Returns a list of lists, calling the label method for all services
2415 (see L<FS::cust_svc>) of this billing item.
2421 map { [ $_->label ] } $self->cust_svc;
2424 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2426 Like the labels method, but returns historical information on services that
2427 were active as of END_TIMESTAMP and (optionally) not cancelled before
2428 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2429 I<pkg_svc.hidden> flag will be omitted.
2431 Returns a list of lists, calling the label method for all (historical) services
2432 (see L<FS::h_cust_svc>) of this billing item.
2438 warn "$me _h_labels called on $self\n"
2440 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2445 Like labels, except returns a simple flat list, and shortens long
2446 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2447 identical services to one line that lists the service label and the number of
2448 individual services rather than individual items.
2453 shift->_labels_short( 'labels', @_ );
2456 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2458 Like h_labels, except returns a simple flat list, and shortens long
2459 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2460 identical services to one line that lists the service label and the number of
2461 individual services rather than individual items.
2465 sub h_labels_short {
2466 shift->_labels_short( 'h_labels', @_ );
2470 my( $self, $method ) = ( shift, shift );
2472 warn "$me _labels_short called on $self with $method method\n"
2475 my $conf = new FS::Conf;
2476 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2478 warn "$me _labels_short populating \%labels\n"
2482 #tie %labels, 'Tie::IxHash';
2483 push @{ $labels{$_->[0]} }, $_->[1]
2484 foreach $self->$method(@_);
2486 warn "$me _labels_short populating \@labels\n"
2490 foreach my $label ( keys %labels ) {
2492 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2493 my $num = scalar(@values);
2494 warn "$me _labels_short $num items for $label\n"
2497 if ( $num > $max_same_services ) {
2498 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2500 push @labels, "$label ($num)";
2502 if ( $conf->exists('cust_bill-consolidate_services') ) {
2503 warn "$me _labels_short consolidating services\n"
2505 # push @labels, "$label: ". join(', ', @values);
2507 my $detail = "$label: ";
2508 $detail .= shift(@values). ', '
2510 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2512 push @labels, $detail;
2514 warn "$me _labels_short done consolidating services\n"
2517 warn "$me _labels_short adding service data\n"
2519 push @labels, map { "$label: $_" } @values;
2530 Returns the parent customer object (see L<FS::cust_main>).
2536 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2539 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2543 Returns the location object, if any (see L<FS::cust_location>).
2545 =item cust_location_or_main
2547 If this package is associated with a location, returns the locaiton (see
2548 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2550 =item location_label [ OPTION => VALUE ... ]
2552 Returns the label of the location object (see L<FS::cust_location>).
2556 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2558 =item seconds_since TIMESTAMP
2560 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2561 package have been online since TIMESTAMP, according to the session monitor.
2563 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2564 L<Time::Local> and L<Date::Parse> for conversion functions.
2569 my($self, $since) = @_;
2572 foreach my $cust_svc (
2573 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2575 $seconds += $cust_svc->seconds_since($since);
2582 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2584 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2585 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2588 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2589 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2595 sub seconds_since_sqlradacct {
2596 my($self, $start, $end) = @_;
2600 foreach my $cust_svc (
2602 my $part_svc = $_->part_svc;
2603 $part_svc->svcdb eq 'svc_acct'
2604 && scalar($part_svc->part_export_usage);
2607 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2614 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2616 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2617 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2621 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2622 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2627 sub attribute_since_sqlradacct {
2628 my($self, $start, $end, $attrib) = @_;
2632 foreach my $cust_svc (
2634 my $part_svc = $_->part_svc;
2635 $part_svc->svcdb eq 'svc_acct'
2636 && scalar($part_svc->part_export_usage);
2639 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2651 my( $self, $value ) = @_;
2652 if ( defined($value) ) {
2653 $self->setfield('quantity', $value);
2655 $self->getfield('quantity') || 1;
2658 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2660 Transfers as many services as possible from this package to another package.
2662 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2663 object. The destination package must already exist.
2665 Services are moved only if the destination allows services with the correct
2666 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2667 this option with caution! No provision is made for export differences
2668 between the old and new service definitions. Probably only should be used
2669 when your exports for all service definitions of a given svcdb are identical.
2670 (attempt a transfer without it first, to move all possible svcpart-matching
2673 Any services that can't be moved remain in the original package.
2675 Returns an error, if there is one; otherwise, returns the number of services
2676 that couldn't be moved.
2681 my ($self, $dest_pkgnum, %opt) = @_;
2687 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2688 $dest = $dest_pkgnum;
2689 $dest_pkgnum = $dest->pkgnum;
2691 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2694 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2696 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2697 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2700 foreach my $cust_svc ($dest->cust_svc) {
2701 $target{$cust_svc->svcpart}--;
2704 my %svcpart2svcparts = ();
2705 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2706 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2707 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2708 next if exists $svcpart2svcparts{$svcpart};
2709 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2710 $svcpart2svcparts{$svcpart} = [
2712 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2714 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2715 'svcpart' => $_ } );
2717 $pkg_svc ? $pkg_svc->primary_svc : '',
2718 $pkg_svc ? $pkg_svc->quantity : 0,
2722 grep { $_ != $svcpart }
2724 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2726 warn "alternates for svcpart $svcpart: ".
2727 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2732 foreach my $cust_svc ($self->cust_svc) {
2733 if($target{$cust_svc->svcpart} > 0) {
2734 $target{$cust_svc->svcpart}--;
2735 my $new = new FS::cust_svc { $cust_svc->hash };
2736 $new->pkgnum($dest_pkgnum);
2737 my $error = $new->replace($cust_svc);
2738 return $error if $error;
2739 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2741 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2742 warn "alternates to consider: ".
2743 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2745 my @alternate = grep {
2746 warn "considering alternate svcpart $_: ".
2747 "$target{$_} available in new package\n"
2750 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2752 warn "alternate(s) found\n" if $DEBUG;
2753 my $change_svcpart = $alternate[0];
2754 $target{$change_svcpart}--;
2755 my $new = new FS::cust_svc { $cust_svc->hash };
2756 $new->svcpart($change_svcpart);
2757 $new->pkgnum($dest_pkgnum);
2758 my $error = $new->replace($cust_svc);
2759 return $error if $error;
2772 This method is deprecated. See the I<depend_jobnum> option to the insert and
2773 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2780 local $SIG{HUP} = 'IGNORE';
2781 local $SIG{INT} = 'IGNORE';
2782 local $SIG{QUIT} = 'IGNORE';
2783 local $SIG{TERM} = 'IGNORE';
2784 local $SIG{TSTP} = 'IGNORE';
2785 local $SIG{PIPE} = 'IGNORE';
2787 my $oldAutoCommit = $FS::UID::AutoCommit;
2788 local $FS::UID::AutoCommit = 0;
2791 foreach my $cust_svc ( $self->cust_svc ) {
2792 #false laziness w/svc_Common::insert
2793 my $svc_x = $cust_svc->svc_x;
2794 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2795 my $error = $part_export->export_insert($svc_x);
2797 $dbh->rollback if $oldAutoCommit;
2803 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2810 Associates this package with a (suspension or cancellation) reason (see
2811 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2814 Available options are:
2820 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.
2824 the access_user (see L<FS::access_user>) providing the reason
2832 the action (cancel, susp, adjourn, expire) associated with the reason
2836 If there is an error, returns the error, otherwise returns false.
2841 my ($self, %options) = @_;
2843 my $otaker = $options{reason_otaker} ||
2844 $FS::CurrentUser::CurrentUser->username;
2847 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2851 } elsif ( ref($options{'reason'}) ) {
2853 return 'Enter a new reason (or select an existing one)'
2854 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2856 my $reason = new FS::reason({
2857 'reason_type' => $options{'reason'}->{'typenum'},
2858 'reason' => $options{'reason'}->{'reason'},
2860 my $error = $reason->insert;
2861 return $error if $error;
2863 $reasonnum = $reason->reasonnum;
2866 return "Unparsable reason: ". $options{'reason'};
2869 my $cust_pkg_reason =
2870 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2871 'reasonnum' => $reasonnum,
2872 'otaker' => $otaker,
2873 'action' => substr(uc($options{'action'}),0,1),
2874 'date' => $options{'date'}
2879 $cust_pkg_reason->insert;
2882 =item insert_discount
2884 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2885 inserting a new discount on the fly (see L<FS::discount>).
2887 Available options are:
2895 If there is an error, returns the error, otherwise returns false.
2899 sub insert_discount {
2900 #my ($self, %options) = @_;
2903 my $cust_pkg_discount = new FS::cust_pkg_discount {
2904 'pkgnum' => $self->pkgnum,
2905 'discountnum' => $self->discountnum,
2907 'end_date' => '', #XXX
2908 #for the create a new discount case
2909 '_type' => $self->discountnum__type,
2910 'amount' => $self->discountnum_amount,
2911 'percent' => $self->discountnum_percent,
2912 'months' => $self->discountnum_months,
2913 'setup' => $self->discountnum_setup,
2914 #'disabled' => $self->discountnum_disabled,
2917 $cust_pkg_discount->insert;
2920 =item set_usage USAGE_VALUE_HASHREF
2922 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2923 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2924 upbytes, downbytes, and totalbytes are appropriate keys.
2926 All svc_accts which are part of this package have their values reset.
2931 my ($self, $valueref, %opt) = @_;
2933 #only svc_acct can set_usage for now
2934 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
2935 my $svc_x = $cust_svc->svc_x;
2936 $svc_x->set_usage($valueref, %opt)
2937 if $svc_x->can("set_usage");
2941 =item recharge USAGE_VALUE_HASHREF
2943 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2944 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2945 upbytes, downbytes, and totalbytes are appropriate keys.
2947 All svc_accts which are part of this package have their values incremented.
2952 my ($self, $valueref) = @_;
2954 #only svc_acct can set_usage for now
2955 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
2956 my $svc_x = $cust_svc->svc_x;
2957 $svc_x->recharge($valueref)
2958 if $svc_x->can("recharge");
2962 =item cust_pkg_discount
2966 sub cust_pkg_discount {
2968 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2971 =item cust_pkg_discount_active
2975 sub cust_pkg_discount_active {
2977 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2982 =head1 CLASS METHODS
2988 Returns an SQL expression identifying recurring packages.
2992 sub recurring_sql { "
2993 '0' != ( select freq from part_pkg
2994 where cust_pkg.pkgpart = part_pkg.pkgpart )
2999 Returns an SQL expression identifying one-time packages.
3004 '0' = ( select freq from part_pkg
3005 where cust_pkg.pkgpart = part_pkg.pkgpart )
3010 Returns an SQL expression identifying ordered packages (recurring packages not
3016 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3021 Returns an SQL expression identifying active packages.
3026 $_[0]->recurring_sql. "
3027 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3028 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3029 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3032 =item not_yet_billed_sql
3034 Returns an SQL expression identifying packages which have not yet been billed.
3038 sub not_yet_billed_sql { "
3039 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3040 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3041 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3046 Returns an SQL expression identifying inactive packages (one-time packages
3047 that are otherwise unsuspended/uncancelled).
3051 sub inactive_sql { "
3052 ". $_[0]->onetime_sql(). "
3053 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3054 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3055 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3061 Returns an SQL expression identifying suspended packages.
3065 sub suspended_sql { susp_sql(@_); }
3067 #$_[0]->recurring_sql(). ' AND '.
3069 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3070 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3077 Returns an SQL exprression identifying cancelled packages.
3081 sub cancelled_sql { cancel_sql(@_); }
3083 #$_[0]->recurring_sql(). ' AND '.
3084 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3089 Returns an SQL expression to give the package status as a string.
3095 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3096 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3097 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3098 WHEN ".onetime_sql()." THEN 'one-time charge'
3103 =item search HASHREF
3107 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3108 Valid parameters are
3116 active, inactive, suspended, cancel (or cancelled)
3120 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3124 boolean selects custom packages
3130 pkgpart or arrayref or hashref of pkgparts
3134 arrayref of beginning and ending epoch date
3138 arrayref of beginning and ending epoch date
3142 arrayref of beginning and ending epoch date
3146 arrayref of beginning and ending epoch date
3150 arrayref of beginning and ending epoch date
3154 arrayref of beginning and ending epoch date
3158 arrayref of beginning and ending epoch date
3162 pkgnum or APKG_pkgnum
3166 a value suited to passing to FS::UI::Web::cust_header
3170 specifies the user for agent virtualization
3174 boolean selects packages containing fcc form 477 telco lines
3181 my ($class, $params) = @_;
3188 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3190 "cust_main.agentnum = $1";
3197 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3199 "cust_pkg.custnum = $1";
3206 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3208 "cust_pkg.pkgbatch = '$1'";
3215 if ( $params->{'magic'} eq 'active'
3216 || $params->{'status'} eq 'active' ) {
3218 push @where, FS::cust_pkg->active_sql();
3220 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3221 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3223 push @where, FS::cust_pkg->not_yet_billed_sql();
3225 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3226 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3228 push @where, FS::cust_pkg->inactive_sql();
3230 } elsif ( $params->{'magic'} eq 'suspended'
3231 || $params->{'status'} eq 'suspended' ) {
3233 push @where, FS::cust_pkg->suspended_sql();
3235 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3236 || $params->{'status'} =~ /^cancell?ed$/ ) {
3238 push @where, FS::cust_pkg->cancelled_sql();
3243 # parse package class
3246 if ( exists($params->{'classnum'}) ) {
3249 if ( ref($params->{'classnum'}) ) {
3251 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3252 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3253 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3254 @classnum = @{ $params->{'classnum'} };
3256 die 'unhandled classnum ref '. $params->{'classnum'};
3260 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3267 my @nums = grep $_, @classnum;
3268 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3269 my $null = scalar( grep { $_ eq '' } @classnum );
3270 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3272 if ( scalar(@c_where) == 1 ) {
3273 push @where, @c_where;
3274 } elsif ( @c_where ) {
3275 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3284 # parse package report options
3287 my @report_option = ();
3288 if ( exists($params->{'report_option'}) ) {
3289 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3290 @report_option = @{ $params->{'report_option'} };
3291 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3292 @report_option = split(',', $1);
3297 if (@report_option) {
3298 # this will result in the empty set for the dangling comma case as it should
3300 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3301 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3302 AND optionname = 'report_option_$_'
3303 AND optionvalue = '1' )"
3307 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3309 my @report_option_any = ();
3310 if ( ref($params->{$any}) eq 'ARRAY' ) {
3311 @report_option_any = @{ $params->{$any} };
3312 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3313 @report_option_any = split(',', $1);
3316 if (@report_option_any) {
3317 # this will result in the empty set for the dangling comma case as it should
3318 push @where, ' ( '. join(' OR ',
3319 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3320 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3321 AND optionname = 'report_option_$_'
3322 AND optionvalue = '1' )"
3323 } @report_option_any
3333 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3339 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3340 if $params->{fcc_line};
3346 if ( exists($params->{'censustract'}) ) {
3347 $params->{'censustract'} =~ /^([.\d]*)$/;
3348 my $censustract = "cust_main.censustract = '$1'";
3349 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3350 push @where, "( $censustract )";
3354 # parse censustract2
3356 if ( exists($params->{'censustract2'})
3357 && $params->{'censustract2'} =~ /^(\d*)$/
3361 push @where, "cust_main.censustract LIKE '$1%'";
3364 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3372 if ( ref($params->{'pkgpart'}) ) {
3375 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3376 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3377 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3378 @pkgpart = @{ $params->{'pkgpart'} };
3380 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3383 @pkgpart = grep /^(\d+)$/, @pkgpart;
3385 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3387 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3388 push @where, "pkgpart = $1";
3397 #false laziness w/report_cust_pkg.html
3400 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3401 'active' => { 'susp'=>1, 'cancel'=>1 },
3402 'suspended' => { 'cancel' => 1 },
3407 if( exists($params->{'active'} ) ) {
3408 # This overrides all the other date-related fields
3409 my($beginning, $ending) = @{$params->{'active'}};
3411 "cust_pkg.setup IS NOT NULL",
3412 "cust_pkg.setup <= $ending",
3413 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3414 "NOT (".FS::cust_pkg->onetime_sql . ")";
3417 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
3419 next unless exists($params->{$field});
3421 my($beginning, $ending) = @{$params->{$field}};
3423 next if $beginning == 0 && $ending == 4294967295;
3426 "cust_pkg.$field IS NOT NULL",
3427 "cust_pkg.$field >= $beginning",
3428 "cust_pkg.$field <= $ending";
3430 $orderby ||= "ORDER BY cust_pkg.$field";
3435 $orderby ||= 'ORDER BY bill';
3438 # parse magic, legacy, etc.
3441 if ( $params->{'magic'} &&
3442 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3445 $orderby = 'ORDER BY pkgnum';
3447 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3448 push @where, "pkgpart = $1";
3451 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3453 $orderby = 'ORDER BY pkgnum';
3455 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3457 $orderby = 'ORDER BY pkgnum';
3460 SELECT count(*) FROM pkg_svc
3461 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3462 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3463 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3464 AND cust_svc.svcpart = pkg_svc.svcpart
3471 # setup queries, links, subs, etc. for the search
3474 # here is the agent virtualization
3475 if ($params->{CurrentUser}) {
3477 qsearchs('access_user', { username => $params->{CurrentUser} });
3480 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3485 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3488 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3490 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3491 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3492 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3494 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3497 'table' => 'cust_pkg',
3499 'select' => join(', ',
3501 ( map "part_pkg.$_", qw( pkg freq ) ),
3502 'pkg_class.classname',
3503 'cust_main.custnum AS cust_main_custnum',
3504 FS::UI::Web::cust_sql_fields(
3505 $params->{'cust_fields'}
3508 'extra_sql' => $extra_sql,
3509 'order_by' => $orderby,
3510 'addl_from' => $addl_from,
3511 'count_query' => $count_query,
3518 Returns a list of two package counts. The first is a count of packages
3519 based on the supplied criteria and the second is the count of residential
3520 packages with those same criteria. Criteria are specified as in the search
3526 my ($class, $params) = @_;
3528 my $sql_query = $class->search( $params );
3530 my $count_sql = delete($sql_query->{'count_query'});
3531 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3532 or die "couldn't parse count_sql";
3534 my $count_sth = dbh->prepare($count_sql)
3535 or die "Error preparing $count_sql: ". dbh->errstr;
3537 or die "Error executing $count_sql: ". $count_sth->errstr;
3538 my $count_arrayref = $count_sth->fetchrow_arrayref;
3540 return ( @$count_arrayref );
3547 Returns a list: the first item is an SQL fragment identifying matching
3548 packages/customers via location (taking into account shipping and package
3549 address taxation, if enabled), and subsequent items are the parameters to
3550 substitute for the placeholders in that fragment.
3555 my($class, %opt) = @_;
3556 my $ornull = $opt{'ornull'};
3558 my $conf = new FS::Conf;
3560 # '?' placeholders in _location_sql_where
3561 my $x = $ornull ? 3 : 2;
3572 if ( $conf->exists('tax-ship_address') ) {
3575 ( ( ship_last IS NULL OR ship_last = '' )
3576 AND ". _location_sql_where('cust_main', '', $ornull ). "
3578 OR ( ship_last IS NOT NULL AND ship_last != ''
3579 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3582 # AND payby != 'COMP'
3584 @main_param = ( @bill_param, @bill_param );
3588 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3589 @main_param = @bill_param;
3595 if ( $conf->exists('tax-pkg_address') ) {
3597 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3600 ( cust_pkg.locationnum IS NULL AND $main_where )
3601 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3604 @param = ( @main_param, @bill_param );
3608 $where = $main_where;
3609 @param = @main_param;
3617 #subroutine, helper for location_sql
3618 sub _location_sql_where {
3620 my $prefix = @_ ? shift : '';
3621 my $ornull = @_ ? shift : '';
3623 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3625 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3627 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
3628 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
3629 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
3631 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
3633 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3635 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
3636 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
3637 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3638 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3639 AND $table.${prefix}country = ?
3644 my( $self, $what ) = @_;
3646 my $what_show_zero = $what. '_show_zero';
3647 length($self->$what_show_zero())
3648 ? ($self->$what_show_zero() eq 'Y')
3649 : $self->part_pkg->$what_show_zero();
3656 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3658 CUSTNUM is a customer (see L<FS::cust_main>)
3660 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3661 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3664 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3665 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3666 new billing items. An error is returned if this is not possible (see
3667 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3670 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3671 newly-created cust_pkg objects.
3673 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3674 and inserted. Multiple FS::pkg_referral records can be created by
3675 setting I<refnum> to an array reference of refnums or a hash reference with
3676 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3677 record will be created corresponding to cust_main.refnum.
3682 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3684 my $conf = new FS::Conf;
3686 # Transactionize this whole mess
3687 local $SIG{HUP} = 'IGNORE';
3688 local $SIG{INT} = 'IGNORE';
3689 local $SIG{QUIT} = 'IGNORE';
3690 local $SIG{TERM} = 'IGNORE';
3691 local $SIG{TSTP} = 'IGNORE';
3692 local $SIG{PIPE} = 'IGNORE';
3694 my $oldAutoCommit = $FS::UID::AutoCommit;
3695 local $FS::UID::AutoCommit = 0;
3699 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3700 # return "Customer not found: $custnum" unless $cust_main;
3702 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3705 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3708 my $change = scalar(@old_cust_pkg) != 0;
3711 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3713 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3714 " to pkgpart ". $pkgparts->[0]. "\n"
3717 my $err_or_cust_pkg =
3718 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3719 'refnum' => $refnum,
3722 unless (ref($err_or_cust_pkg)) {
3723 $dbh->rollback if $oldAutoCommit;
3724 return $err_or_cust_pkg;
3727 push @$return_cust_pkg, $err_or_cust_pkg;
3728 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3733 # Create the new packages.
3734 foreach my $pkgpart (@$pkgparts) {
3736 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3738 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3739 pkgpart => $pkgpart,
3743 $error = $cust_pkg->insert( 'change' => $change );
3745 $dbh->rollback if $oldAutoCommit;
3748 push @$return_cust_pkg, $cust_pkg;
3750 # $return_cust_pkg now contains refs to all of the newly
3753 # Transfer services and cancel old packages.
3754 foreach my $old_pkg (@old_cust_pkg) {
3756 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3759 foreach my $new_pkg (@$return_cust_pkg) {
3760 $error = $old_pkg->transfer($new_pkg);
3761 if ($error and $error == 0) {
3762 # $old_pkg->transfer failed.
3763 $dbh->rollback if $oldAutoCommit;
3768 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3769 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3770 foreach my $new_pkg (@$return_cust_pkg) {
3771 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3772 if ($error and $error == 0) {
3773 # $old_pkg->transfer failed.
3774 $dbh->rollback if $oldAutoCommit;
3781 # Transfers were successful, but we went through all of the
3782 # new packages and still had services left on the old package.
3783 # We can't cancel the package under the circumstances, so abort.
3784 $dbh->rollback if $oldAutoCommit;
3785 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3787 $error = $old_pkg->cancel( quiet=>1 );
3793 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3797 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3799 A bulk change method to change packages for multiple customers.
3801 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3802 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3805 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3806 replace. The services (see L<FS::cust_svc>) are moved to the
3807 new billing items. An error is returned if this is not possible (see
3810 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3811 newly-created cust_pkg objects.
3816 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3818 # Transactionize this whole mess
3819 local $SIG{HUP} = 'IGNORE';
3820 local $SIG{INT} = 'IGNORE';
3821 local $SIG{QUIT} = 'IGNORE';
3822 local $SIG{TERM} = 'IGNORE';
3823 local $SIG{TSTP} = 'IGNORE';
3824 local $SIG{PIPE} = 'IGNORE';
3826 my $oldAutoCommit = $FS::UID::AutoCommit;
3827 local $FS::UID::AutoCommit = 0;
3831 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3834 while(scalar(@old_cust_pkg)) {
3836 my $custnum = $old_cust_pkg[0]->custnum;
3837 my (@remove) = map { $_->pkgnum }
3838 grep { $_->custnum == $custnum } @old_cust_pkg;
3839 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3841 my $error = order $custnum, $pkgparts, \@remove, \@return;
3843 push @errors, $error
3845 push @$return_cust_pkg, @return;
3848 if (scalar(@errors)) {
3849 $dbh->rollback if $oldAutoCommit;
3850 return join(' / ', @errors);
3853 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3857 # Used by FS::Upgrade to migrate to a new database.
3858 sub _upgrade_data { # class method
3859 my ($class, %opts) = @_;
3860 $class->_upgrade_otaker(%opts);
3862 # RT#10139, bug resulting in contract_end being set when it shouldn't
3863 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3864 # RT#10830, bad calculation of prorate date near end of year
3865 # the date range for bill is December 2009, and we move it forward
3866 # one year if it's before the previous bill date (which it should
3868 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3869 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3870 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3871 # RT6628, add order_date to cust_pkg
3872 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3873 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3874 history_action = \'insert\') where order_date is null',
3876 foreach my $sql (@statements) {
3877 my $sth = dbh->prepare($sql);
3878 $sth->execute or die $sth->errstr;
3886 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3888 In sub order, the @pkgparts array (passed by reference) is clobbered.
3890 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3891 method to pass dates to the recur_prog expression, it should do so.
3893 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3894 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3895 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3896 configuration values. Probably need a subroutine which decides what to do
3897 based on whether or not we've fetched the user yet, rather than a hash. See
3898 FS::UID and the TODO.
3900 Now that things are transactional should the check in the insert method be
3905 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3906 L<FS::pkg_svc>, schema.html from the base documentation