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 actions that should only be taken for new package
246 orders. (Currently this includes: intro periods when delay_setup is on.)
250 cust_pkg_option records will be created
254 a ticket will be added to this customer with this subject
258 an optional queue name for ticket additions
265 my( $self, %options ) = @_;
267 my $error = $self->check_pkgpart;
268 return $error if $error;
270 my $part_pkg = $self->part_pkg;
272 # if the package def says to start only on the first of the month:
273 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
274 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
275 $mon += 1 unless $mday == 1;
276 until ( $mon < 12 ) { $mon -= 12; $year++; }
277 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
280 # set up any automatic expire/adjourn/contract_end timers
281 # based on the start date
282 foreach my $action ( qw(expire adjourn contract_end) ) {
283 my $months = $part_pkg->option("${action}_months",1);
284 if($months and !$self->$action) {
285 my $start = $self->start_date || $self->setup || time;
286 $self->$action( $part_pkg->add_freq($start, $months) );
290 # if this package has "free days" and delayed setup fee, tehn
291 # set start date that many days in the future.
292 # (this should have been set in the UI, but enforce it here)
293 if ( ! $options{'change'}
294 && ( my $free_days = $part_pkg->option('free_days',1) )
295 && $part_pkg->option('delay_setup',1)
296 #&& ! $self->start_date
299 $self->start_date( $part_pkg->default_start_date );
302 $self->order_date(time);
304 local $SIG{HUP} = 'IGNORE';
305 local $SIG{INT} = 'IGNORE';
306 local $SIG{QUIT} = 'IGNORE';
307 local $SIG{TERM} = 'IGNORE';
308 local $SIG{TSTP} = 'IGNORE';
309 local $SIG{PIPE} = 'IGNORE';
311 my $oldAutoCommit = $FS::UID::AutoCommit;
312 local $FS::UID::AutoCommit = 0;
315 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
317 $dbh->rollback if $oldAutoCommit;
321 $self->refnum($self->cust_main->refnum) unless $self->refnum;
322 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
323 $self->process_m2m( 'link_table' => 'pkg_referral',
324 'target_table' => 'part_referral',
325 'params' => $self->refnum,
328 if ( $self->discountnum ) {
329 my $error = $self->insert_discount();
331 $dbh->rollback if $oldAutoCommit;
336 #if ( $self->reg_code ) {
337 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
338 # $error = $reg_code->delete;
340 # $dbh->rollback if $oldAutoCommit;
345 my $conf = new FS::Conf;
347 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
350 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
357 use FS::TicketSystem;
358 FS::TicketSystem->init();
360 my $q = new RT::Queue($RT::SystemUser);
361 $q->Load($options{ticket_queue}) if $options{ticket_queue};
362 my $t = new RT::Ticket($RT::SystemUser);
363 my $mime = new MIME::Entity;
364 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
365 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
366 Subject => $options{ticket_subject},
369 $t->AddLink( Type => 'MemberOf',
370 Target => 'freeside://freeside/cust_main/'. $self->custnum,
374 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
375 my $queue = new FS::queue {
376 'job' => 'FS::cust_main::queueable_print',
378 $error = $queue->insert(
379 'custnum' => $self->custnum,
380 'template' => 'welcome_letter',
384 warn "can't send welcome letter: $error";
389 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
396 This method now works but you probably shouldn't use it.
398 You don't want to delete packages, because there would then be no record
399 the customer ever purchased the package. Instead, see the cancel method and
400 hide cancelled packages.
407 local $SIG{HUP} = 'IGNORE';
408 local $SIG{INT} = 'IGNORE';
409 local $SIG{QUIT} = 'IGNORE';
410 local $SIG{TERM} = 'IGNORE';
411 local $SIG{TSTP} = 'IGNORE';
412 local $SIG{PIPE} = 'IGNORE';
414 my $oldAutoCommit = $FS::UID::AutoCommit;
415 local $FS::UID::AutoCommit = 0;
418 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
419 my $error = $cust_pkg_discount->delete;
421 $dbh->rollback if $oldAutoCommit;
425 #cust_bill_pkg_discount?
427 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
428 my $error = $cust_pkg_detail->delete;
430 $dbh->rollback if $oldAutoCommit;
435 foreach my $cust_pkg_reason (
437 'table' => 'cust_pkg_reason',
438 'hashref' => { 'pkgnum' => $self->pkgnum },
442 my $error = $cust_pkg_reason->delete;
444 $dbh->rollback if $oldAutoCommit;
451 my $error = $self->SUPER::delete(@_);
453 $dbh->rollback if $oldAutoCommit;
457 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
463 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
465 Replaces the OLD_RECORD with this one in the database. If there is an error,
466 returns the error, otherwise returns false.
468 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
470 Changing pkgpart may have disasterous effects. See the order subroutine.
472 setup and bill are normally updated by calling the bill method of a customer
473 object (see L<FS::cust_main>).
475 suspend is normally updated by the suspend and unsuspend methods.
477 cancel is normally updated by the cancel method (and also the order subroutine
480 Available options are:
486 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.
490 the access_user (see L<FS::access_user>) providing the reason
494 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
503 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
508 ( ref($_[0]) eq 'HASH' )
512 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
513 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
516 #return "Can't change setup once it exists!"
517 # if $old->getfield('setup') &&
518 # $old->getfield('setup') != $new->getfield('setup');
520 #some logic for bill, susp, cancel?
522 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
524 local $SIG{HUP} = 'IGNORE';
525 local $SIG{INT} = 'IGNORE';
526 local $SIG{QUIT} = 'IGNORE';
527 local $SIG{TERM} = 'IGNORE';
528 local $SIG{TSTP} = 'IGNORE';
529 local $SIG{PIPE} = 'IGNORE';
531 my $oldAutoCommit = $FS::UID::AutoCommit;
532 local $FS::UID::AutoCommit = 0;
535 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
536 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
537 my $error = $new->insert_reason(
538 'reason' => $options->{'reason'},
539 'date' => $new->$method,
541 'reason_otaker' => $options->{'reason_otaker'},
544 dbh->rollback if $oldAutoCommit;
545 return "Error inserting cust_pkg_reason: $error";
550 #save off and freeze RADIUS attributes for any associated svc_acct records
552 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
554 #also check for specific exports?
555 # to avoid spurious modify export events
556 @svc_acct = map { $_->svc_x }
557 grep { $_->part_svc->svcdb eq 'svc_acct' }
560 $_->snapshot foreach @svc_acct;
564 my $error = $new->export_pkg_change($old)
565 || $new->SUPER::replace( $old,
567 ? $options->{options}
571 $dbh->rollback if $oldAutoCommit;
575 #for prepaid packages,
576 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
577 foreach my $old_svc_acct ( @svc_acct ) {
578 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
580 $new_svc_acct->replace( $old_svc_acct,
581 'depend_jobnum' => $options->{depend_jobnum},
584 $dbh->rollback if $oldAutoCommit;
589 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
596 Checks all fields to make sure this is a valid billing item. If there is an
597 error, returns the error, otherwise returns false. Called by the insert and
605 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
608 $self->ut_numbern('pkgnum')
609 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
610 || $self->ut_numbern('pkgpart')
611 || $self->check_pkgpart
612 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
613 || $self->ut_numbern('start_date')
614 || $self->ut_numbern('setup')
615 || $self->ut_numbern('bill')
616 || $self->ut_numbern('susp')
617 || $self->ut_numbern('cancel')
618 || $self->ut_numbern('adjourn')
619 || $self->ut_numbern('resume')
620 || $self->ut_numbern('expire')
621 || $self->ut_numbern('dundate')
622 || $self->ut_enum('no_auto', [ '', 'Y' ])
623 || $self->ut_enum('waive_setup', [ '', 'Y' ])
624 || $self->ut_numbern('agent_pkgid')
625 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
626 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
628 return $error if $error;
630 return "A package with both start date (future start) and setup date (already started) will never bill"
631 if $self->start_date && $self->setup;
633 return "A future unsuspend date can only be set for a package with a suspend date"
634 if $self->resume and !$self->susp and !$self->adjourn;
636 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
638 if ( $self->dbdef_table->column('manual_flag') ) {
639 $self->manual_flag('') if $self->manual_flag eq ' ';
640 $self->manual_flag =~ /^([01]?)$/
641 or return "Illegal manual_flag ". $self->manual_flag;
642 $self->manual_flag($1);
655 my $error = $self->ut_numbern('pkgpart');
656 return $error if $error;
658 if ( $self->reg_code ) {
660 unless ( grep { $self->pkgpart == $_->pkgpart }
661 map { $_->reg_code_pkg }
662 qsearchs( 'reg_code', { 'code' => $self->reg_code,
663 'agentnum' => $self->cust_main->agentnum })
665 return "Unknown registration code";
668 } elsif ( $self->promo_code ) {
671 qsearchs('part_pkg', {
672 'pkgpart' => $self->pkgpart,
673 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
675 return 'Unknown promotional code' unless $promo_part_pkg;
679 unless ( $disable_agentcheck ) {
681 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
682 return "agent ". $agent->agentnum. ':'. $agent->agent.
683 " can't purchase pkgpart ". $self->pkgpart
684 unless $agent->pkgpart_hashref->{ $self->pkgpart }
685 || $agent->agentnum == $self->part_pkg->agentnum;
688 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
689 return $error if $error;
697 =item cancel [ OPTION => VALUE ... ]
699 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
700 in this package, then cancels the package itself (sets the cancel field to
703 Available options are:
707 =item quiet - can be set true to supress email cancellation notices.
709 =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.
711 =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.
713 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
715 =item nobill - can be set true to skip billing if it might otherwise be done.
717 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
718 not credit it. This must be set (by change()) when changing the package
719 to a different pkgpart or location, and probably shouldn't be in any other
720 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
725 If there is an error, returns the error, otherwise returns false.
730 my( $self, %options ) = @_;
733 my $conf = new FS::Conf;
735 warn "cust_pkg::cancel called with options".
736 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
739 local $SIG{HUP} = 'IGNORE';
740 local $SIG{INT} = 'IGNORE';
741 local $SIG{QUIT} = 'IGNORE';
742 local $SIG{TERM} = 'IGNORE';
743 local $SIG{TSTP} = 'IGNORE';
744 local $SIG{PIPE} = 'IGNORE';
746 my $oldAutoCommit = $FS::UID::AutoCommit;
747 local $FS::UID::AutoCommit = 0;
750 my $old = $self->select_for_update;
752 if ( $old->get('cancel') || $self->get('cancel') ) {
753 dbh->rollback if $oldAutoCommit;
754 return ""; # no error
757 my $date = $options{date} if $options{date}; # expire/cancel later
758 $date = '' if ($date && $date <= time); # complain instead?
760 #race condition: usage could be ongoing until unprovisioned
761 #resolved by performing a change package instead (which unprovisions) and
763 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
764 my $copy = $self->new({$self->hash});
766 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
767 warn "Error billing during cancel, custnum ".
768 #$self->cust_main->custnum. ": $error"
773 my $cancel_time = $options{'time'} || time;
775 if ( $options{'reason'} ) {
776 $error = $self->insert_reason( 'reason' => $options{'reason'},
777 'action' => $date ? 'expire' : 'cancel',
778 'date' => $date ? $date : $cancel_time,
779 'reason_otaker' => $options{'reason_otaker'},
782 dbh->rollback if $oldAutoCommit;
783 return "Error inserting cust_pkg_reason: $error";
787 my %svc_cancel_opt = ();
788 $svc_cancel_opt{'date'} = $date if $date;
789 foreach my $cust_svc (
792 sort { $a->[1] <=> $b->[1] }
793 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
794 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
796 my $part_svc = $cust_svc->part_svc;
797 next if ( defined($part_svc) and $part_svc->preserve );
798 my $error = $cust_svc->cancel( %svc_cancel_opt );
801 $dbh->rollback if $oldAutoCommit;
802 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
809 # Add a credit for remaining service
810 my $last_bill = $self->getfield('last_bill') || 0;
811 my $next_bill = $self->getfield('bill') || 0;
813 if ( exists($options{'unused_credit'}) ) {
814 $do_credit = $options{'unused_credit'};
817 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
820 and $last_bill > 0 # the package has been billed
821 and $next_bill > 0 # the package has a next bill date
822 and $next_bill >= $cancel_time # which is in the future
824 my $remaining_value = $self->calc_remain('time' => $cancel_time);
825 if ( $remaining_value > 0 ) {
826 my $error = $self->cust_main->credit(
828 'Credit for unused time on '. $self->part_pkg->pkg,
829 'reason_type' => $conf->config('cancel_credit_type'),
832 $dbh->rollback if $oldAutoCommit;
833 return "Error crediting customer \$$remaining_value for unused time".
834 " on ". $self->part_pkg->pkg. ": $error";
836 } #if $remaining_value
841 my %hash = $self->hash;
842 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
843 my $new = new FS::cust_pkg ( \%hash );
844 $error = $new->replace( $self, options => { $self->options } );
846 $dbh->rollback if $oldAutoCommit;
850 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
851 return '' if $date; #no errors
853 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
854 if ( !$options{'quiet'} &&
855 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
857 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
860 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
861 $error = $msg_template->send( 'cust_main' => $self->cust_main,
866 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
867 'to' => \@invoicing_list,
868 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
869 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
872 #should this do something on errors?
879 =item cancel_if_expired [ NOW_TIMESTAMP ]
881 Cancels this package if its expire date has been reached.
885 sub cancel_if_expired {
887 my $time = shift || time;
888 return '' unless $self->expire && $self->expire <= $time;
889 my $error = $self->cancel;
891 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
892 $self->custnum. ": $error";
899 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
900 locationnum, (other fields?). Attempts to re-provision cancelled services
901 using history information (errors at this stage are not fatal).
903 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
905 svc_fatal: service provisioning errors are fatal
907 svc_errors: pass an array reference, will be filled in with any provisioning errors
912 my( $self, %options ) = @_;
914 #in case you try do do $uncancel-date = $cust_pkg->uncacel
915 return '' unless $self->get('cancel');
921 local $SIG{HUP} = 'IGNORE';
922 local $SIG{INT} = 'IGNORE';
923 local $SIG{QUIT} = 'IGNORE';
924 local $SIG{TERM} = 'IGNORE';
925 local $SIG{TSTP} = 'IGNORE';
926 local $SIG{PIPE} = 'IGNORE';
928 my $oldAutoCommit = $FS::UID::AutoCommit;
929 local $FS::UID::AutoCommit = 0;
933 # insert the new package
936 my $cust_pkg = new FS::cust_pkg {
937 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
938 bill => ( $options{'bill'} || $self->get('bill') ),
940 uncancel_pkgnum => $self->pkgnum,
941 map { $_ => $self->get($_) } qw(
942 custnum pkgpart locationnum
944 susp adjourn resume expire start_date contract_end dundate
945 change_date change_pkgpart change_locationnum
946 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
950 my $error = $cust_pkg->insert(
951 'change' => 1, #supresses any referral credit to a referring customer
954 $dbh->rollback if $oldAutoCommit;
962 #find historical services within this timeframe before the package cancel
963 # (incompatible with "time" option to cust_pkg->cancel?)
964 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
965 # too little? (unprovisioing export delay?)
966 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
967 my @h_cust_svc = $self->h_cust_svc( $end, $start );
970 foreach my $h_cust_svc (@h_cust_svc) {
971 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
972 #next unless $h_svc_x; #should this happen?
973 (my $table = $h_svc_x->table) =~ s/^h_//;
974 require "FS/$table.pm";
975 my $class = "FS::$table";
976 my $svc_x = $class->new( {
977 'pkgnum' => $cust_pkg->pkgnum,
978 'svcpart' => $h_cust_svc->svcpart,
979 map { $_ => $h_svc_x->get($_) } fields($table)
983 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
984 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
987 my $svc_error = $svc_x->insert;
989 if ( $options{svc_fatal} ) {
990 $dbh->rollback if $oldAutoCommit;
993 # if we've failed to insert the svc_x object, svc_Common->insert
994 # will have removed the cust_svc already. if not, then both records
995 # were inserted but we failed for some other reason (export, most
996 # likely). in that case, report the error and delete the records.
997 push @svc_errors, $svc_error;
998 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1000 # except if export_insert failed, export_delete probably won't be
1002 local $FS::svc_Common::noexport_hack = 1;
1003 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1004 if ( $cleanup_error ) { # and if THAT fails, then run away
1005 $dbh->rollback if $oldAutoCommit;
1006 return $cleanup_error;
1011 } #foreach $h_cust_svc
1013 #these are pretty rare, but should handle them
1014 # - dsl_device (mac addresses)
1015 # - phone_device (mac addresses)
1016 # - dsl_note (ikano notes)
1017 # - domain_record (i.e. restore DNS information w/domains)
1018 # - inventory_item(?) (inventory w/un-cancelling service?)
1019 # - nas (svc_broaband nas stuff)
1020 #this stuff is unused in the wild afaik
1021 # - mailinglistmember
1023 # - svc_domain.parent_svcnum?
1024 # - acct_snarf (ancient mail fetching config)
1025 # - cgp_rule (communigate)
1026 # - cust_svc_option (used by our Tron stuff)
1027 # - acct_rt_transaction (used by our time worked stuff)
1030 # also move over any services that didn't unprovision at cancellation
1033 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1034 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1035 my $error = $cust_svc->replace;
1037 $dbh->rollback if $oldAutoCommit;
1046 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1048 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1049 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1056 Cancels any pending expiration (sets the expire field to null).
1058 If there is an error, returns the error, otherwise returns false.
1063 my( $self, %options ) = @_;
1066 local $SIG{HUP} = 'IGNORE';
1067 local $SIG{INT} = 'IGNORE';
1068 local $SIG{QUIT} = 'IGNORE';
1069 local $SIG{TERM} = 'IGNORE';
1070 local $SIG{TSTP} = 'IGNORE';
1071 local $SIG{PIPE} = 'IGNORE';
1073 my $oldAutoCommit = $FS::UID::AutoCommit;
1074 local $FS::UID::AutoCommit = 0;
1077 my $old = $self->select_for_update;
1079 my $pkgnum = $old->pkgnum;
1080 if ( $old->get('cancel') || $self->get('cancel') ) {
1081 dbh->rollback if $oldAutoCommit;
1082 return "Can't unexpire cancelled package $pkgnum";
1083 # or at least it's pointless
1086 unless ( $old->get('expire') && $self->get('expire') ) {
1087 dbh->rollback if $oldAutoCommit;
1088 return ""; # no error
1091 my %hash = $self->hash;
1092 $hash{'expire'} = '';
1093 my $new = new FS::cust_pkg ( \%hash );
1094 $error = $new->replace( $self, options => { $self->options } );
1096 $dbh->rollback if $oldAutoCommit;
1100 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1106 =item suspend [ OPTION => VALUE ... ]
1108 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1109 package, then suspends the package itself (sets the susp field to now).
1111 Available options are:
1115 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1116 either a reasonnum of an existing reason, or passing a hashref will create
1117 a new reason. The hashref should have the following keys:
1118 - typenum - Reason type (see L<FS::reason_type>
1119 - reason - Text of the new reason.
1121 =item date - can be set to a unix style timestamp to specify when to
1124 =item time - can be set to override the current time, for calculation
1125 of final invoices or unused-time credits
1127 =item resume_date - can be set to a time when the package should be
1128 unsuspended. This may be more convenient than calling C<unsuspend()>
1133 If there is an error, returns the error, otherwise returns false.
1138 my( $self, %options ) = @_;
1141 local $SIG{HUP} = 'IGNORE';
1142 local $SIG{INT} = 'IGNORE';
1143 local $SIG{QUIT} = 'IGNORE';
1144 local $SIG{TERM} = 'IGNORE';
1145 local $SIG{TSTP} = 'IGNORE';
1146 local $SIG{PIPE} = 'IGNORE';
1148 my $oldAutoCommit = $FS::UID::AutoCommit;
1149 local $FS::UID::AutoCommit = 0;
1152 my $old = $self->select_for_update;
1154 my $pkgnum = $old->pkgnum;
1155 if ( $old->get('cancel') || $self->get('cancel') ) {
1156 dbh->rollback if $oldAutoCommit;
1157 return "Can't suspend cancelled package $pkgnum";
1160 if ( $old->get('susp') || $self->get('susp') ) {
1161 dbh->rollback if $oldAutoCommit;
1162 return ""; # no error # complain on adjourn?
1165 my $suspend_time = $options{'time'} || time;
1167 my $date = $options{date} if $options{date}; # adjourn/suspend later
1168 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1170 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1171 dbh->rollback if $oldAutoCommit;
1172 return "Package $pkgnum expires before it would be suspended.";
1175 if ( $options{'reason'} ) {
1176 $error = $self->insert_reason( 'reason' => $options{'reason'},
1177 'action' => $date ? 'adjourn' : 'suspend',
1178 'date' => $date ? $date : $suspend_time,
1179 'reason_otaker' => $options{'reason_otaker'},
1182 dbh->rollback if $oldAutoCommit;
1183 return "Error inserting cust_pkg_reason: $error";
1187 my %hash = $self->hash;
1189 $hash{'adjourn'} = $date;
1191 $hash{'susp'} = $suspend_time;
1194 my $resume_date = $options{'resume_date'} || 0;
1195 if ( $resume_date > ($date || $suspend_time) ) {
1196 $hash{'resume'} = $resume_date;
1199 $options{options} ||= {};
1201 my $new = new FS::cust_pkg ( \%hash );
1202 $error = $new->replace( $self, options => { $self->options,
1203 %{ $options{options} },
1207 $dbh->rollback if $oldAutoCommit;
1215 foreach my $cust_svc (
1216 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1218 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1220 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1221 $dbh->rollback if $oldAutoCommit;
1222 return "Illegal svcdb value in part_svc!";
1225 require "FS/$svcdb.pm";
1227 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1229 $error = $svc->suspend;
1231 $dbh->rollback if $oldAutoCommit;
1234 my( $label, $value ) = $cust_svc->label;
1235 push @labels, "$label: $value";
1239 my $conf = new FS::Conf;
1240 if ( $conf->config('suspend_email_admin') ) {
1242 my $error = send_email(
1243 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1244 #invoice_from ??? well as good as any
1245 'to' => $conf->config('suspend_email_admin'),
1246 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1248 "This is an automatic message from your Freeside installation\n",
1249 "informing you that the following customer package has been suspended:\n",
1251 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1252 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1253 ( map { "Service : $_\n" } @labels ),
1258 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1266 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1271 =item unsuspend [ OPTION => VALUE ... ]
1273 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1274 package, then unsuspends the package itself (clears the susp field and the
1275 adjourn field if it is in the past). If the suspend reason includes an
1276 unsuspension package, that package will be ordered.
1278 Available options are:
1284 Can be set to a date to unsuspend the package in the future (the 'resume'
1287 =item adjust_next_bill
1289 Can be set true to adjust the next bill date forward by
1290 the amount of time the account was inactive. This was set true by default
1291 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1292 explicitly requested. Price plans for which this makes sense (anniversary-date
1293 based than prorate or subscription) could have an option to enable this
1298 If there is an error, returns the error, otherwise returns false.
1303 my( $self, %opt ) = @_;
1306 local $SIG{HUP} = 'IGNORE';
1307 local $SIG{INT} = 'IGNORE';
1308 local $SIG{QUIT} = 'IGNORE';
1309 local $SIG{TERM} = 'IGNORE';
1310 local $SIG{TSTP} = 'IGNORE';
1311 local $SIG{PIPE} = 'IGNORE';
1313 my $oldAutoCommit = $FS::UID::AutoCommit;
1314 local $FS::UID::AutoCommit = 0;
1317 my $old = $self->select_for_update;
1319 my $pkgnum = $old->pkgnum;
1320 if ( $old->get('cancel') || $self->get('cancel') ) {
1321 $dbh->rollback if $oldAutoCommit;
1322 return "Can't unsuspend cancelled package $pkgnum";
1325 unless ( $old->get('susp') && $self->get('susp') ) {
1326 $dbh->rollback if $oldAutoCommit;
1327 return ""; # no error # complain instead?
1330 my $date = $opt{'date'};
1331 if ( $date and $date > time ) { # return an error if $date <= time?
1333 if ( $old->get('expire') && $old->get('expire') < $date ) {
1334 $dbh->rollback if $oldAutoCommit;
1335 return "Package $pkgnum expires before it would be unsuspended.";
1338 my $new = new FS::cust_pkg { $self->hash };
1339 $new->set('resume', $date);
1340 $error = $new->replace($self, options => $self->options);
1343 $dbh->rollback if $oldAutoCommit;
1347 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1355 foreach my $cust_svc (
1356 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1358 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1360 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1361 $dbh->rollback if $oldAutoCommit;
1362 return "Illegal svcdb value in part_svc!";
1365 require "FS/$svcdb.pm";
1367 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1369 $error = $svc->unsuspend;
1371 $dbh->rollback if $oldAutoCommit;
1374 my( $label, $value ) = $cust_svc->label;
1375 push @labels, "$label: $value";
1380 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1381 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1383 my %hash = $self->hash;
1384 my $inactive = time - $hash{'susp'};
1386 my $conf = new FS::Conf;
1388 if ( $inactive > 0 &&
1389 ( $hash{'bill'} || $hash{'setup'} ) &&
1390 ( $opt{'adjust_next_bill'} ||
1391 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1392 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1395 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1400 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1401 $hash{'resume'} = '' if !$hash{'adjourn'};
1402 my $new = new FS::cust_pkg ( \%hash );
1403 $error = $new->replace( $self, options => { $self->options } );
1405 $dbh->rollback if $oldAutoCommit;
1411 if ( $reason && $reason->unsuspend_pkgpart ) {
1412 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1413 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1415 my $start_date = $self->cust_main->next_bill_date
1416 if $reason->unsuspend_hold;
1419 $unsusp_pkg = FS::cust_pkg->new({
1420 'custnum' => $self->custnum,
1421 'pkgpart' => $reason->unsuspend_pkgpart,
1422 'start_date' => $start_date,
1423 'locationnum' => $self->locationnum,
1424 # discount? probably not...
1427 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1431 $dbh->rollback if $oldAutoCommit;
1436 if ( $conf->config('unsuspend_email_admin') ) {
1438 my $error = send_email(
1439 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1440 #invoice_from ??? well as good as any
1441 'to' => $conf->config('unsuspend_email_admin'),
1442 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1443 "This is an automatic message from your Freeside installation\n",
1444 "informing you that the following customer package has been unsuspended:\n",
1446 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1447 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1448 ( map { "Service : $_\n" } @labels ),
1450 "An unsuspension fee was charged: ".
1451 $unsusp_pkg->part_pkg->pkg_comment."\n"
1458 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1464 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1471 Cancels any pending suspension (sets the adjourn field to null).
1473 If there is an error, returns the error, otherwise returns false.
1478 my( $self, %options ) = @_;
1481 local $SIG{HUP} = 'IGNORE';
1482 local $SIG{INT} = 'IGNORE';
1483 local $SIG{QUIT} = 'IGNORE';
1484 local $SIG{TERM} = 'IGNORE';
1485 local $SIG{TSTP} = 'IGNORE';
1486 local $SIG{PIPE} = 'IGNORE';
1488 my $oldAutoCommit = $FS::UID::AutoCommit;
1489 local $FS::UID::AutoCommit = 0;
1492 my $old = $self->select_for_update;
1494 my $pkgnum = $old->pkgnum;
1495 if ( $old->get('cancel') || $self->get('cancel') ) {
1496 dbh->rollback if $oldAutoCommit;
1497 return "Can't unadjourn cancelled package $pkgnum";
1498 # or at least it's pointless
1501 if ( $old->get('susp') || $self->get('susp') ) {
1502 dbh->rollback if $oldAutoCommit;
1503 return "Can't unadjourn suspended package $pkgnum";
1504 # perhaps this is arbitrary
1507 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1508 dbh->rollback if $oldAutoCommit;
1509 return ""; # no error
1512 my %hash = $self->hash;
1513 $hash{'adjourn'} = '';
1514 $hash{'resume'} = '';
1515 my $new = new FS::cust_pkg ( \%hash );
1516 $error = $new->replace( $self, options => { $self->options } );
1518 $dbh->rollback if $oldAutoCommit;
1522 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1529 =item change HASHREF | OPTION => VALUE ...
1531 Changes this package: cancels it and creates a new one, with a different
1532 pkgpart or locationnum or both. All services are transferred to the new
1533 package (no change will be made if this is not possible).
1535 Options may be passed as a list of key/value pairs or as a hash reference.
1542 New locationnum, to change the location for this package.
1546 New FS::cust_location object, to create a new location and assign it
1551 New pkgpart (see L<FS::part_pkg>).
1555 New refnum (see L<FS::part_referral>).
1559 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1560 susp, adjourn, cancel, expire, and contract_end) to the new package.
1564 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1565 (otherwise, what's the point?)
1567 Returns either the new FS::cust_pkg object or a scalar error.
1571 my $err_or_new_cust_pkg = $old_cust_pkg->change
1575 #some false laziness w/order
1578 my $opt = ref($_[0]) ? shift : { @_ };
1580 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1583 my $conf = new FS::Conf;
1585 # Transactionize this whole mess
1586 local $SIG{HUP} = 'IGNORE';
1587 local $SIG{INT} = 'IGNORE';
1588 local $SIG{QUIT} = 'IGNORE';
1589 local $SIG{TERM} = 'IGNORE';
1590 local $SIG{TSTP} = 'IGNORE';
1591 local $SIG{PIPE} = 'IGNORE';
1593 my $oldAutoCommit = $FS::UID::AutoCommit;
1594 local $FS::UID::AutoCommit = 0;
1603 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1605 #$hash{$_} = $self->$_() foreach qw( setup );
1607 $hash{'setup'} = $time if $self->setup;
1609 $hash{'change_date'} = $time;
1610 $hash{"change_$_"} = $self->$_()
1611 foreach qw( pkgnum pkgpart locationnum );
1613 if ( $opt->{'cust_location'} &&
1614 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1615 $error = $opt->{'cust_location'}->insert;
1617 $dbh->rollback if $oldAutoCommit;
1618 return "inserting cust_location (transaction rolled back): $error";
1620 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1623 my $unused_credit = 0;
1624 if ( $opt->{'keep_dates'} ) {
1625 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1626 resume start_date contract_end ) ) {
1627 $hash{$date} = $self->getfield($date);
1630 # Special case. If the pkgpart is changing, and the customer is
1631 # going to be credited for remaining time, don't keep setup, bill,
1632 # or last_bill dates, and DO pass the flag to cancel() to credit
1634 if ( $opt->{'pkgpart'}
1635 and $opt->{'pkgpart'} != $self->pkgpart
1636 and $self->part_pkg->option('unused_credit_change', 1) ) {
1638 $hash{$_} = '' foreach qw(setup bill last_bill);
1641 # allow $opt->{'locationnum'} = '' to specifically set it to null
1642 # (i.e. customer default location)
1643 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1645 # Create the new package.
1646 my $cust_pkg = new FS::cust_pkg {
1647 custnum => $self->custnum,
1648 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1649 refnum => ( $opt->{'refnum'} || $self->refnum ),
1650 locationnum => ( $opt->{'locationnum'} ),
1654 $error = $cust_pkg->insert( 'change' => 1 );
1656 $dbh->rollback if $oldAutoCommit;
1660 # Transfer services and cancel old package.
1662 $error = $self->transfer($cust_pkg);
1663 if ($error and $error == 0) {
1664 # $old_pkg->transfer failed.
1665 $dbh->rollback if $oldAutoCommit;
1669 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1670 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1671 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1672 if ($error and $error == 0) {
1673 # $old_pkg->transfer failed.
1674 $dbh->rollback if $oldAutoCommit;
1680 # Transfers were successful, but we still had services left on the old
1681 # package. We can't change the package under this circumstances, so abort.
1682 $dbh->rollback if $oldAutoCommit;
1683 return "Unable to transfer all services from package ". $self->pkgnum;
1686 #reset usage if changing pkgpart
1687 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1688 if ($self->pkgpart != $cust_pkg->pkgpart) {
1689 my $part_pkg = $cust_pkg->part_pkg;
1690 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1694 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1697 $dbh->rollback if $oldAutoCommit;
1698 return "Error setting usage values: $error";
1702 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1704 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1706 $dbh->rollback if $oldAutoCommit;
1710 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1712 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1714 $dbh->rollback if $oldAutoCommit;
1719 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1725 use Storable 'thaw';
1727 sub process_bulk_cust_pkg {
1729 my $param = thaw(decode_base64(shift));
1730 warn Dumper($param) if $DEBUG;
1732 my $old_part_pkg = qsearchs('part_pkg',
1733 { pkgpart => $param->{'old_pkgpart'} });
1734 my $new_part_pkg = qsearchs('part_pkg',
1735 { pkgpart => $param->{'new_pkgpart'} });
1736 die "Must select a new package type\n" unless $new_part_pkg;
1737 #my $keep_dates = $param->{'keep_dates'} || 0;
1738 my $keep_dates = 1; # there is no good reason to turn this off
1740 local $SIG{HUP} = 'IGNORE';
1741 local $SIG{INT} = 'IGNORE';
1742 local $SIG{QUIT} = 'IGNORE';
1743 local $SIG{TERM} = 'IGNORE';
1744 local $SIG{TSTP} = 'IGNORE';
1745 local $SIG{PIPE} = 'IGNORE';
1747 my $oldAutoCommit = $FS::UID::AutoCommit;
1748 local $FS::UID::AutoCommit = 0;
1751 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1754 foreach my $old_cust_pkg ( @cust_pkgs ) {
1756 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1757 if ( $old_cust_pkg->getfield('cancel') ) {
1758 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1759 $old_cust_pkg->pkgnum."\n"
1763 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1765 my $error = $old_cust_pkg->change(
1766 'pkgpart' => $param->{'new_pkgpart'},
1767 'keep_dates' => $keep_dates
1769 if ( !ref($error) ) { # change returns the cust_pkg on success
1771 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1774 $dbh->commit if $oldAutoCommit;
1780 Returns the last bill date, or if there is no last bill date, the setup date.
1781 Useful for billing metered services.
1787 return $self->setfield('last_bill', $_[0]) if @_;
1788 return $self->getfield('last_bill') if $self->getfield('last_bill');
1789 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1790 'edate' => $self->bill, } );
1791 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1794 =item last_cust_pkg_reason ACTION
1796 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1797 Returns false if there is no reason or the package is not currenly ACTION'd
1798 ACTION is one of adjourn, susp, cancel, or expire.
1802 sub last_cust_pkg_reason {
1803 my ( $self, $action ) = ( shift, shift );
1804 my $date = $self->get($action);
1806 'table' => 'cust_pkg_reason',
1807 'hashref' => { 'pkgnum' => $self->pkgnum,
1808 'action' => substr(uc($action), 0, 1),
1811 'order_by' => 'ORDER BY num DESC LIMIT 1',
1815 =item last_reason ACTION
1817 Returns the most recent ACTION FS::reason associated with the package.
1818 Returns false if there is no reason or the package is not currenly ACTION'd
1819 ACTION is one of adjourn, susp, cancel, or expire.
1824 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1825 $cust_pkg_reason->reason
1826 if $cust_pkg_reason;
1831 Returns the definition for this billing item, as an FS::part_pkg object (see
1838 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1839 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1840 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1845 Returns the cancelled package this package was changed from, if any.
1851 return '' unless $self->change_pkgnum;
1852 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1857 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1864 $self->part_pkg->calc_setup($self, @_);
1869 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1876 $self->part_pkg->calc_recur($self, @_);
1881 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1888 $self->part_pkg->base_recur($self, @_);
1893 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1900 $self->part_pkg->calc_remain($self, @_);
1905 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1912 $self->part_pkg->calc_cancel($self, @_);
1917 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1923 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1926 =item cust_pkg_detail [ DETAILTYPE ]
1928 Returns any customer package details for this package (see
1929 L<FS::cust_pkg_detail>).
1931 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1935 sub cust_pkg_detail {
1937 my %hash = ( 'pkgnum' => $self->pkgnum );
1938 $hash{detailtype} = shift if @_;
1940 'table' => 'cust_pkg_detail',
1941 'hashref' => \%hash,
1942 'order_by' => 'ORDER BY weight, pkgdetailnum',
1946 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1948 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1950 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1952 If there is an error, returns the error, otherwise returns false.
1956 sub set_cust_pkg_detail {
1957 my( $self, $detailtype, @details ) = @_;
1959 local $SIG{HUP} = 'IGNORE';
1960 local $SIG{INT} = 'IGNORE';
1961 local $SIG{QUIT} = 'IGNORE';
1962 local $SIG{TERM} = 'IGNORE';
1963 local $SIG{TSTP} = 'IGNORE';
1964 local $SIG{PIPE} = 'IGNORE';
1966 my $oldAutoCommit = $FS::UID::AutoCommit;
1967 local $FS::UID::AutoCommit = 0;
1970 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1971 my $error = $current->delete;
1973 $dbh->rollback if $oldAutoCommit;
1974 return "error removing old detail: $error";
1978 foreach my $detail ( @details ) {
1979 my $cust_pkg_detail = new FS::cust_pkg_detail {
1980 'pkgnum' => $self->pkgnum,
1981 'detailtype' => $detailtype,
1982 'detail' => $detail,
1984 my $error = $cust_pkg_detail->insert;
1986 $dbh->rollback if $oldAutoCommit;
1987 return "error adding new detail: $error";
1992 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1999 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2003 #false laziness w/cust_bill.pm
2007 'table' => 'cust_event',
2008 'addl_from' => 'JOIN part_event USING ( eventpart )',
2009 'hashref' => { 'tablenum' => $self->pkgnum },
2010 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2014 =item num_cust_event
2016 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2020 #false laziness w/cust_bill.pm
2021 sub num_cust_event {
2024 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2025 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2026 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2027 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2028 $sth->fetchrow_arrayref->[0];
2031 =item cust_svc [ SVCPART ] (old, deprecated usage)
2033 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2035 Returns the services for this package, as FS::cust_svc objects (see
2036 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2037 spcififed, returns only the matching services.
2044 return () unless $self->num_cust_svc(@_);
2047 if ( @_ && $_[0] =~ /^\d+/ ) {
2048 $opt{svcpart} = shift;
2049 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2056 'table' => 'cust_svc',
2057 'hashref' => { 'pkgnum' => $self->pkgnum },
2059 if ( $opt{svcpart} ) {
2060 $search{hashref}->{svcpart} = $opt{'svcpart'};
2062 if ( $opt{'svcdb'} ) {
2063 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2064 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2067 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2069 #if ( $self->{'_svcnum'} ) {
2070 # values %{ $self->{'_svcnum'}->cache };
2072 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2077 =item overlimit [ SVCPART ]
2079 Returns the services for this package which have exceeded their
2080 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2081 is specified, return only the matching services.
2087 return () unless $self->num_cust_svc(@_);
2088 grep { $_->overlimit } $self->cust_svc(@_);
2091 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2093 Returns historical services for this package created before END TIMESTAMP and
2094 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2095 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2096 I<pkg_svc.hidden> flag will be omitted.
2102 warn "$me _h_cust_svc called on $self\n"
2105 my ($end, $start, $mode) = @_;
2106 my @cust_svc = $self->_sort_cust_svc(
2107 [ qsearch( 'h_cust_svc',
2108 { 'pkgnum' => $self->pkgnum, },
2109 FS::h_cust_svc->sql_h_search(@_),
2112 if ( defined($mode) && $mode eq 'I' ) {
2113 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2114 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2120 sub _sort_cust_svc {
2121 my( $self, $arrayref ) = @_;
2124 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2129 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2130 'svcpart' => $_->svcpart } );
2132 $pkg_svc ? $pkg_svc->primary_svc : '',
2133 $pkg_svc ? $pkg_svc->quantity : 0,
2140 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2142 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2144 Returns the number of services for this package. Available options are svcpart
2145 and svcdb. If either is spcififed, returns only the matching services.
2152 return $self->{'_num_cust_svc'}
2154 && exists($self->{'_num_cust_svc'})
2155 && $self->{'_num_cust_svc'} =~ /\d/;
2157 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2161 if ( @_ && $_[0] =~ /^\d+/ ) {
2162 $opt{svcpart} = shift;
2163 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2169 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2170 my $where = ' WHERE pkgnum = ? ';
2171 my @param = ($self->pkgnum);
2173 if ( $opt{'svcpart'} ) {
2174 $where .= ' AND svcpart = ? ';
2175 push @param, $opt{'svcpart'};
2177 if ( $opt{'svcdb'} ) {
2178 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2179 $where .= ' AND svcdb = ? ';
2180 push @param, $opt{'svcdb'};
2183 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2184 $sth->execute(@param) or die $sth->errstr;
2185 $sth->fetchrow_arrayref->[0];
2188 =item available_part_svc
2190 Returns a list of FS::part_svc objects representing services included in this
2191 package but not yet provisioned. Each FS::part_svc object also has an extra
2192 field, I<num_avail>, which specifies the number of available services.
2196 sub available_part_svc {
2198 grep { $_->num_avail > 0 }
2200 my $part_svc = $_->part_svc;
2201 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2202 $_->quantity - $self->num_cust_svc($_->svcpart);
2204 # more evil encapsulation breakage
2205 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2206 my @exports = $part_svc->part_export_did;
2207 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2212 $self->part_pkg->pkg_svc;
2215 =item part_svc [ OPTION => VALUE ... ]
2217 Returns a list of FS::part_svc objects representing provisioned and available
2218 services included in this package. Each FS::part_svc object also has the
2219 following extra fields:
2223 =item num_cust_svc (count)
2225 =item num_avail (quantity - count)
2227 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2231 Accepts one option: summarize_size. If specified and non-zero, will omit the
2232 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2238 #label -> ($cust_svc->label)[1]
2244 #XXX some sort of sort order besides numeric by svcpart...
2245 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2247 my $part_svc = $pkg_svc->part_svc;
2248 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2249 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2250 $part_svc->{'Hash'}{'num_avail'} =
2251 max( 0, $pkg_svc->quantity - $num_cust_svc );
2252 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2253 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2254 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2255 && $num_cust_svc >= $opt{summarize_size};
2256 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2258 } $self->part_pkg->pkg_svc;
2261 push @part_svc, map {
2263 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2264 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2265 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2266 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2267 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2269 } $self->extra_part_svc;
2275 =item extra_part_svc
2277 Returns a list of FS::part_svc objects corresponding to services in this
2278 package which are still provisioned but not (any longer) available in the
2283 sub extra_part_svc {
2286 my $pkgnum = $self->pkgnum;
2287 #my $pkgpart = $self->pkgpart;
2290 # 'table' => 'part_svc',
2293 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2294 # WHERE pkg_svc.svcpart = part_svc.svcpart
2295 # AND pkg_svc.pkgpart = ?
2298 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2299 # LEFT JOIN cust_pkg USING ( pkgnum )
2300 # WHERE cust_svc.svcpart = part_svc.svcpart
2303 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2306 #seems to benchmark slightly faster... (or did?)
2308 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2309 my $pkgparts = join(',', @pkgparts);
2312 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2313 #MySQL doesn't grok DISINCT ON
2314 'select' => 'DISTINCT part_svc.*',
2315 'table' => 'part_svc',
2317 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2318 AND pkg_svc.pkgpart IN ($pkgparts)
2321 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2322 LEFT JOIN cust_pkg USING ( pkgnum )
2325 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2326 'extra_param' => [ [$self->pkgnum=>'int'] ],
2332 Returns a short status string for this package, currently:
2336 =item not yet billed
2338 =item one-time charge
2353 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2355 return 'cancelled' if $self->get('cancel');
2356 return 'suspended' if $self->susp;
2357 return 'not yet billed' unless $self->setup;
2358 return 'one-time charge' if $freq =~ /^(0|$)/;
2362 =item ucfirst_status
2364 Returns the status with the first character capitalized.
2368 sub ucfirst_status {
2369 ucfirst(shift->status);
2374 Class method that returns the list of possible status strings for packages
2375 (see L<the status method|/status>). For example:
2377 @statuses = FS::cust_pkg->statuses();
2381 tie my %statuscolor, 'Tie::IxHash',
2382 'not yet billed' => '009999', #teal? cyan?
2383 'one-time charge' => '000000',
2384 'active' => '00CC00',
2385 'suspended' => 'FF9900',
2386 'cancelled' => 'FF0000',
2390 my $self = shift; #could be class...
2391 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2392 # # mayble split btw one-time vs. recur
2398 Returns a hex triplet color string for this package's status.
2404 $statuscolor{$self->status};
2409 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2410 "pkg-comment" depending on user preference).
2416 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2417 $label = $self->pkgnum. ": $label"
2418 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2422 =item pkg_label_long
2424 Returns a long label for this package, adding the primary service's label to
2429 sub pkg_label_long {
2431 my $label = $self->pkg_label;
2432 my $cust_svc = $self->primary_cust_svc;
2433 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2437 =item primary_cust_svc
2439 Returns a primary service (as FS::cust_svc object) if one can be identified.
2443 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2445 sub primary_cust_svc {
2448 my @cust_svc = $self->cust_svc;
2450 return '' unless @cust_svc; #no serivces - irrelevant then
2452 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2454 # primary service as specified in the package definition
2455 # or exactly one service definition with quantity one
2456 my $svcpart = $self->part_pkg->svcpart;
2457 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2458 return $cust_svc[0] if scalar(@cust_svc) == 1;
2460 #couldn't identify one thing..
2466 Returns a list of lists, calling the label method for all services
2467 (see L<FS::cust_svc>) of this billing item.
2473 map { [ $_->label ] } $self->cust_svc;
2476 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2478 Like the labels method, but returns historical information on services that
2479 were active as of END_TIMESTAMP and (optionally) not cancelled before
2480 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2481 I<pkg_svc.hidden> flag will be omitted.
2483 Returns a list of lists, calling the label method for all (historical) services
2484 (see L<FS::h_cust_svc>) of this billing item.
2490 warn "$me _h_labels called on $self\n"
2492 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2497 Like labels, except returns a simple flat list, and shortens long
2498 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2499 identical services to one line that lists the service label and the number of
2500 individual services rather than individual items.
2505 shift->_labels_short( 'labels', @_ );
2508 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2510 Like h_labels, except returns a simple flat list, and shortens long
2511 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2512 identical services to one line that lists the service label and the number of
2513 individual services rather than individual items.
2517 sub h_labels_short {
2518 shift->_labels_short( 'h_labels', @_ );
2522 my( $self, $method ) = ( shift, shift );
2524 warn "$me _labels_short called on $self with $method method\n"
2527 my $conf = new FS::Conf;
2528 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2530 warn "$me _labels_short populating \%labels\n"
2534 #tie %labels, 'Tie::IxHash';
2535 push @{ $labels{$_->[0]} }, $_->[1]
2536 foreach $self->$method(@_);
2538 warn "$me _labels_short populating \@labels\n"
2542 foreach my $label ( keys %labels ) {
2544 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2545 my $num = scalar(@values);
2546 warn "$me _labels_short $num items for $label\n"
2549 if ( $num > $max_same_services ) {
2550 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2552 push @labels, "$label ($num)";
2554 if ( $conf->exists('cust_bill-consolidate_services') ) {
2555 warn "$me _labels_short consolidating services\n"
2557 # push @labels, "$label: ". join(', ', @values);
2559 my $detail = "$label: ";
2560 $detail .= shift(@values). ', '
2562 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2564 push @labels, $detail;
2566 warn "$me _labels_short done consolidating services\n"
2569 warn "$me _labels_short adding service data\n"
2571 push @labels, map { "$label: $_" } @values;
2582 Returns the parent customer object (see L<FS::cust_main>).
2588 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2593 Returns the balance for this specific package, when using
2594 experimental package balance.
2600 $self->cust_main->balance_pkgnum( $self->pkgnum );
2603 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2607 Returns the location object, if any (see L<FS::cust_location>).
2609 =item cust_location_or_main
2611 If this package is associated with a location, returns the locaiton (see
2612 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2614 =item location_label [ OPTION => VALUE ... ]
2616 Returns the label of the location object (see L<FS::cust_location>).
2620 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2622 =item seconds_since TIMESTAMP
2624 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2625 package have been online since TIMESTAMP, according to the session monitor.
2627 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2628 L<Time::Local> and L<Date::Parse> for conversion functions.
2633 my($self, $since) = @_;
2636 foreach my $cust_svc (
2637 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2639 $seconds += $cust_svc->seconds_since($since);
2646 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2648 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2649 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2652 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2653 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2659 sub seconds_since_sqlradacct {
2660 my($self, $start, $end) = @_;
2664 foreach my $cust_svc (
2666 my $part_svc = $_->part_svc;
2667 $part_svc->svcdb eq 'svc_acct'
2668 && scalar($part_svc->part_export_usage);
2671 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2678 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2680 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2681 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2685 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2686 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2691 sub attribute_since_sqlradacct {
2692 my($self, $start, $end, $attrib) = @_;
2696 foreach my $cust_svc (
2698 my $part_svc = $_->part_svc;
2699 $part_svc->svcdb eq 'svc_acct'
2700 && scalar($part_svc->part_export_usage);
2703 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2715 my( $self, $value ) = @_;
2716 if ( defined($value) ) {
2717 $self->setfield('quantity', $value);
2719 $self->getfield('quantity') || 1;
2722 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2724 Transfers as many services as possible from this package to another package.
2726 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2727 object. The destination package must already exist.
2729 Services are moved only if the destination allows services with the correct
2730 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2731 this option with caution! No provision is made for export differences
2732 between the old and new service definitions. Probably only should be used
2733 when your exports for all service definitions of a given svcdb are identical.
2734 (attempt a transfer without it first, to move all possible svcpart-matching
2737 Any services that can't be moved remain in the original package.
2739 Returns an error, if there is one; otherwise, returns the number of services
2740 that couldn't be moved.
2745 my ($self, $dest_pkgnum, %opt) = @_;
2751 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2752 $dest = $dest_pkgnum;
2753 $dest_pkgnum = $dest->pkgnum;
2755 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2758 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2760 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2761 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2764 foreach my $cust_svc ($dest->cust_svc) {
2765 $target{$cust_svc->svcpart}--;
2768 my %svcpart2svcparts = ();
2769 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2770 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2771 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2772 next if exists $svcpart2svcparts{$svcpart};
2773 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2774 $svcpart2svcparts{$svcpart} = [
2776 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2778 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2779 'svcpart' => $_ } );
2781 $pkg_svc ? $pkg_svc->primary_svc : '',
2782 $pkg_svc ? $pkg_svc->quantity : 0,
2786 grep { $_ != $svcpart }
2788 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2790 warn "alternates for svcpart $svcpart: ".
2791 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2796 foreach my $cust_svc ($self->cust_svc) {
2797 if($target{$cust_svc->svcpart} > 0) {
2798 $target{$cust_svc->svcpart}--;
2799 my $new = new FS::cust_svc { $cust_svc->hash };
2800 $new->pkgnum($dest_pkgnum);
2801 my $error = $new->replace($cust_svc);
2802 return $error if $error;
2803 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2805 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2806 warn "alternates to consider: ".
2807 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2809 my @alternate = grep {
2810 warn "considering alternate svcpart $_: ".
2811 "$target{$_} available in new package\n"
2814 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2816 warn "alternate(s) found\n" if $DEBUG;
2817 my $change_svcpart = $alternate[0];
2818 $target{$change_svcpart}--;
2819 my $new = new FS::cust_svc { $cust_svc->hash };
2820 $new->svcpart($change_svcpart);
2821 $new->pkgnum($dest_pkgnum);
2822 my $error = $new->replace($cust_svc);
2823 return $error if $error;
2836 This method is deprecated. See the I<depend_jobnum> option to the insert and
2837 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2844 local $SIG{HUP} = 'IGNORE';
2845 local $SIG{INT} = 'IGNORE';
2846 local $SIG{QUIT} = 'IGNORE';
2847 local $SIG{TERM} = 'IGNORE';
2848 local $SIG{TSTP} = 'IGNORE';
2849 local $SIG{PIPE} = 'IGNORE';
2851 my $oldAutoCommit = $FS::UID::AutoCommit;
2852 local $FS::UID::AutoCommit = 0;
2855 foreach my $cust_svc ( $self->cust_svc ) {
2856 #false laziness w/svc_Common::insert
2857 my $svc_x = $cust_svc->svc_x;
2858 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2859 my $error = $part_export->export_insert($svc_x);
2861 $dbh->rollback if $oldAutoCommit;
2867 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2872 =item export_pkg_change OLD_CUST_PKG
2874 Calls the "pkg_change" export action for all services attached to this package.
2878 sub export_pkg_change {
2879 my( $self, $old ) = ( shift, shift );
2881 local $SIG{HUP} = 'IGNORE';
2882 local $SIG{INT} = 'IGNORE';
2883 local $SIG{QUIT} = 'IGNORE';
2884 local $SIG{TERM} = 'IGNORE';
2885 local $SIG{TSTP} = 'IGNORE';
2886 local $SIG{PIPE} = 'IGNORE';
2888 my $oldAutoCommit = $FS::UID::AutoCommit;
2889 local $FS::UID::AutoCommit = 0;
2892 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
2893 my $error = $svc_x->export('pkg_change', $self, $old);
2895 $dbh->rollback if $oldAutoCommit;
2900 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2907 Associates this package with a (suspension or cancellation) reason (see
2908 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2911 Available options are:
2917 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.
2921 the access_user (see L<FS::access_user>) providing the reason
2929 the action (cancel, susp, adjourn, expire) associated with the reason
2933 If there is an error, returns the error, otherwise returns false.
2938 my ($self, %options) = @_;
2940 my $otaker = $options{reason_otaker} ||
2941 $FS::CurrentUser::CurrentUser->username;
2944 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2948 } elsif ( ref($options{'reason'}) ) {
2950 return 'Enter a new reason (or select an existing one)'
2951 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2953 my $reason = new FS::reason({
2954 'reason_type' => $options{'reason'}->{'typenum'},
2955 'reason' => $options{'reason'}->{'reason'},
2957 my $error = $reason->insert;
2958 return $error if $error;
2960 $reasonnum = $reason->reasonnum;
2963 return "Unparsable reason: ". $options{'reason'};
2966 my $cust_pkg_reason =
2967 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2968 'reasonnum' => $reasonnum,
2969 'otaker' => $otaker,
2970 'action' => substr(uc($options{'action'}),0,1),
2971 'date' => $options{'date'}
2976 $cust_pkg_reason->insert;
2979 =item insert_discount
2981 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2982 inserting a new discount on the fly (see L<FS::discount>).
2984 Available options are:
2992 If there is an error, returns the error, otherwise returns false.
2996 sub insert_discount {
2997 #my ($self, %options) = @_;
3000 my $cust_pkg_discount = new FS::cust_pkg_discount {
3001 'pkgnum' => $self->pkgnum,
3002 'discountnum' => $self->discountnum,
3004 'end_date' => '', #XXX
3005 #for the create a new discount case
3006 '_type' => $self->discountnum__type,
3007 'amount' => $self->discountnum_amount,
3008 'percent' => $self->discountnum_percent,
3009 'months' => $self->discountnum_months,
3010 'setup' => $self->discountnum_setup,
3011 #'disabled' => $self->discountnum_disabled,
3014 $cust_pkg_discount->insert;
3017 =item set_usage USAGE_VALUE_HASHREF
3019 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3020 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3021 upbytes, downbytes, and totalbytes are appropriate keys.
3023 All svc_accts which are part of this package have their values reset.
3028 my ($self, $valueref, %opt) = @_;
3030 #only svc_acct can set_usage for now
3031 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3032 my $svc_x = $cust_svc->svc_x;
3033 $svc_x->set_usage($valueref, %opt)
3034 if $svc_x->can("set_usage");
3038 =item recharge USAGE_VALUE_HASHREF
3040 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3041 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3042 upbytes, downbytes, and totalbytes are appropriate keys.
3044 All svc_accts which are part of this package have their values incremented.
3049 my ($self, $valueref) = @_;
3051 #only svc_acct can set_usage for now
3052 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3053 my $svc_x = $cust_svc->svc_x;
3054 $svc_x->recharge($valueref)
3055 if $svc_x->can("recharge");
3059 =item cust_pkg_discount
3063 sub cust_pkg_discount {
3065 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3068 =item cust_pkg_discount_active
3072 sub cust_pkg_discount_active {
3074 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3079 =head1 CLASS METHODS
3085 Returns an SQL expression identifying recurring packages.
3089 sub recurring_sql { "
3090 '0' != ( select freq from part_pkg
3091 where cust_pkg.pkgpart = part_pkg.pkgpart )
3096 Returns an SQL expression identifying one-time packages.
3101 '0' = ( select freq from part_pkg
3102 where cust_pkg.pkgpart = part_pkg.pkgpart )
3107 Returns an SQL expression identifying ordered packages (recurring packages not
3113 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3118 Returns an SQL expression identifying active packages.
3123 $_[0]->recurring_sql. "
3124 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3125 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3126 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3129 =item not_yet_billed_sql
3131 Returns an SQL expression identifying packages which have not yet been billed.
3135 sub not_yet_billed_sql { "
3136 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3137 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3138 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3143 Returns an SQL expression identifying inactive packages (one-time packages
3144 that are otherwise unsuspended/uncancelled).
3148 sub inactive_sql { "
3149 ". $_[0]->onetime_sql(). "
3150 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3151 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3152 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3158 Returns an SQL expression identifying suspended packages.
3162 sub suspended_sql { susp_sql(@_); }
3164 #$_[0]->recurring_sql(). ' AND '.
3166 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3167 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3174 Returns an SQL exprression identifying cancelled packages.
3178 sub cancelled_sql { cancel_sql(@_); }
3180 #$_[0]->recurring_sql(). ' AND '.
3181 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3186 Returns an SQL expression to give the package status as a string.
3192 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3193 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3194 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3195 WHEN ".onetime_sql()." THEN 'one-time charge'
3200 =item search HASHREF
3204 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3205 Valid parameters are
3213 active, inactive, suspended, cancel (or cancelled)
3217 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3221 boolean selects custom packages
3227 pkgpart or arrayref or hashref of pkgparts
3231 arrayref of beginning and ending epoch date
3235 arrayref of beginning and ending epoch date
3239 arrayref of beginning and ending epoch date
3243 arrayref of beginning and ending epoch date
3247 arrayref of beginning and ending epoch date
3251 arrayref of beginning and ending epoch date
3255 arrayref of beginning and ending epoch date
3259 pkgnum or APKG_pkgnum
3263 a value suited to passing to FS::UI::Web::cust_header
3267 specifies the user for agent virtualization
3271 boolean; if true, returns only packages with more than 0 FCC phone lines
3273 =item state, country
3275 Limit to packages whose customer is located in the specified state and
3276 country. For FCC 477 reporting. This will use the customer's service
3277 address if there is one, but isn't yet smart enough to use the package
3285 my ($class, $params) = @_;
3292 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3294 "cust_main.agentnum = $1";
3301 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3303 "cust_pkg.custnum = $1";
3310 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3312 "cust_pkg.pkgbatch = '$1'";
3319 if ( $params->{'magic'} eq 'active'
3320 || $params->{'status'} eq 'active' ) {
3322 push @where, FS::cust_pkg->active_sql();
3324 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3325 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3327 push @where, FS::cust_pkg->not_yet_billed_sql();
3329 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3330 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3332 push @where, FS::cust_pkg->inactive_sql();
3334 } elsif ( $params->{'magic'} eq 'suspended'
3335 || $params->{'status'} eq 'suspended' ) {
3337 push @where, FS::cust_pkg->suspended_sql();
3339 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3340 || $params->{'status'} =~ /^cancell?ed$/ ) {
3342 push @where, FS::cust_pkg->cancelled_sql();
3347 # parse package class
3350 if ( exists($params->{'classnum'}) ) {
3353 if ( ref($params->{'classnum'}) ) {
3355 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3356 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3357 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3358 @classnum = @{ $params->{'classnum'} };
3360 die 'unhandled classnum ref '. $params->{'classnum'};
3364 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3371 my @nums = grep $_, @classnum;
3372 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3373 my $null = scalar( grep { $_ eq '' } @classnum );
3374 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3376 if ( scalar(@c_where) == 1 ) {
3377 push @where, @c_where;
3378 } elsif ( @c_where ) {
3379 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3388 # parse package report options
3391 my @report_option = ();
3392 if ( exists($params->{'report_option'}) ) {
3393 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3394 @report_option = @{ $params->{'report_option'} };
3395 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3396 @report_option = split(',', $1);
3401 if (@report_option) {
3402 # this will result in the empty set for the dangling comma case as it should
3404 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3405 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3406 AND optionname = 'report_option_$_'
3407 AND optionvalue = '1' )"
3411 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3413 my @report_option_any = ();
3414 if ( ref($params->{$any}) eq 'ARRAY' ) {
3415 @report_option_any = @{ $params->{$any} };
3416 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3417 @report_option_any = split(',', $1);
3420 if (@report_option_any) {
3421 # this will result in the empty set for the dangling comma case as it should
3422 push @where, ' ( '. join(' OR ',
3423 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3424 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3425 AND optionname = 'report_option_$_'
3426 AND optionvalue = '1' )"
3427 } @report_option_any
3437 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3443 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3444 if $params->{fcc_line};
3450 if ( exists($params->{'censustract'}) ) {
3451 $params->{'censustract'} =~ /^([.\d]*)$/;
3452 my $censustract = "cust_main.censustract = '$1'";
3453 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3454 push @where, "( $censustract )";
3458 # parse censustract2
3460 if ( exists($params->{'censustract2'})
3461 && $params->{'censustract2'} =~ /^(\d*)$/
3465 push @where, "cust_main.censustract LIKE '$1%'";
3468 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3473 # parse country/state
3476 for (qw(state country)) {
3477 if ( exists($params->{$_})
3478 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
3481 "COALESCE(cust_location.$_, cust_main.ship_$_, cust_main.$_) = '$1'";
3490 if ( ref($params->{'pkgpart'}) ) {
3493 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3494 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3495 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3496 @pkgpart = @{ $params->{'pkgpart'} };
3498 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3501 @pkgpart = grep /^(\d+)$/, @pkgpart;
3503 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3505 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3506 push @where, "pkgpart = $1";
3515 #false laziness w/report_cust_pkg.html
3518 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3519 'active' => { 'susp'=>1, 'cancel'=>1 },
3520 'suspended' => { 'cancel' => 1 },
3525 if( exists($params->{'active'} ) ) {
3526 # This overrides all the other date-related fields
3527 my($beginning, $ending) = @{$params->{'active'}};
3529 "cust_pkg.setup IS NOT NULL",
3530 "cust_pkg.setup <= $ending",
3531 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3532 "NOT (".FS::cust_pkg->onetime_sql . ")";
3535 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
3537 next unless exists($params->{$field});
3539 my($beginning, $ending) = @{$params->{$field}};
3541 next if $beginning == 0 && $ending == 4294967295;
3544 "cust_pkg.$field IS NOT NULL",
3545 "cust_pkg.$field >= $beginning",
3546 "cust_pkg.$field <= $ending";
3548 $orderby ||= "ORDER BY cust_pkg.$field";
3553 $orderby ||= 'ORDER BY bill';
3556 # parse magic, legacy, etc.
3559 if ( $params->{'magic'} &&
3560 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3563 $orderby = 'ORDER BY pkgnum';
3565 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3566 push @where, "pkgpart = $1";
3569 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3571 $orderby = 'ORDER BY pkgnum';
3573 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3575 $orderby = 'ORDER BY pkgnum';
3578 SELECT count(*) FROM pkg_svc
3579 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3580 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3581 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3582 AND cust_svc.svcpart = pkg_svc.svcpart
3589 # setup queries, links, subs, etc. for the search
3592 # here is the agent virtualization
3593 if ($params->{CurrentUser}) {
3595 qsearchs('access_user', { username => $params->{CurrentUser} });
3598 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3603 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3606 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3608 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3609 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3610 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
3611 'LEFT JOIN cust_location USING ( locationnum ) ';
3615 if ( $params->{'select_zip5'} ) {
3616 my $zip = 'COALESCE(cust_location.zip, cust_main.ship_zip, cust_main.zip)';
3618 $select = "DISTINCT substr($zip,1,5) as zip";
3619 $orderby = "ORDER BY substr($zip,1,5)";
3620 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
3622 $select = join(', ',
3624 ( map "part_pkg.$_", qw( pkg freq ) ),
3625 'pkg_class.classname',
3626 'cust_main.custnum AS cust_main_custnum',
3627 FS::UI::Web::cust_sql_fields(
3628 $params->{'cust_fields'}
3631 $count_query = 'SELECT COUNT(*)';
3634 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
3637 'table' => 'cust_pkg',
3639 'select' => $select,
3640 'extra_sql' => $extra_sql,
3641 'order_by' => $orderby,
3642 'addl_from' => $addl_from,
3643 'count_query' => $count_query,
3650 Returns a list of two package counts. The first is a count of packages
3651 based on the supplied criteria and the second is the count of residential
3652 packages with those same criteria. Criteria are specified as in the search
3658 my ($class, $params) = @_;
3660 my $sql_query = $class->search( $params );
3662 my $count_sql = delete($sql_query->{'count_query'});
3663 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3664 or die "couldn't parse count_sql";
3666 my $count_sth = dbh->prepare($count_sql)
3667 or die "Error preparing $count_sql: ". dbh->errstr;
3669 or die "Error executing $count_sql: ". $count_sth->errstr;
3670 my $count_arrayref = $count_sth->fetchrow_arrayref;
3672 return ( @$count_arrayref );
3679 Returns a list: the first item is an SQL fragment identifying matching
3680 packages/customers via location (taking into account shipping and package
3681 address taxation, if enabled), and subsequent items are the parameters to
3682 substitute for the placeholders in that fragment.
3687 my($class, %opt) = @_;
3688 my $ornull = $opt{'ornull'};
3690 my $conf = new FS::Conf;
3692 # '?' placeholders in _location_sql_where
3693 my $x = $ornull ? 3 : 2;
3704 if ( $conf->exists('tax-ship_address') ) {
3707 ( ( ship_last IS NULL OR ship_last = '' )
3708 AND ". _location_sql_where('cust_main', '', $ornull ). "
3710 OR ( ship_last IS NOT NULL AND ship_last != ''
3711 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3714 # AND payby != 'COMP'
3716 @main_param = ( @bill_param, @bill_param );
3720 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3721 @main_param = @bill_param;
3727 if ( $conf->exists('tax-pkg_address') ) {
3729 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3732 ( cust_pkg.locationnum IS NULL AND $main_where )
3733 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3736 @param = ( @main_param, @bill_param );
3740 $where = $main_where;
3741 @param = @main_param;
3749 #subroutine, helper for location_sql
3750 sub _location_sql_where {
3752 my $prefix = @_ ? shift : '';
3753 my $ornull = @_ ? shift : '';
3755 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3757 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3759 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
3760 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
3761 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
3763 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
3765 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3767 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
3768 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
3769 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3770 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3771 AND $table.${prefix}country = ?
3776 my( $self, $what ) = @_;
3778 my $what_show_zero = $what. '_show_zero';
3779 length($self->$what_show_zero())
3780 ? ($self->$what_show_zero() eq 'Y')
3781 : $self->part_pkg->$what_show_zero();
3788 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3790 CUSTNUM is a customer (see L<FS::cust_main>)
3792 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3793 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3796 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3797 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3798 new billing items. An error is returned if this is not possible (see
3799 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3802 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3803 newly-created cust_pkg objects.
3805 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3806 and inserted. Multiple FS::pkg_referral records can be created by
3807 setting I<refnum> to an array reference of refnums or a hash reference with
3808 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3809 record will be created corresponding to cust_main.refnum.
3814 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3816 my $conf = new FS::Conf;
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 $cust_main = qsearchs('cust_main', { custnum => $custnum });
3832 # return "Customer not found: $custnum" unless $cust_main;
3834 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3837 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3840 my $change = scalar(@old_cust_pkg) != 0;
3843 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3845 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3846 " to pkgpart ". $pkgparts->[0]. "\n"
3849 my $err_or_cust_pkg =
3850 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3851 'refnum' => $refnum,
3854 unless (ref($err_or_cust_pkg)) {
3855 $dbh->rollback if $oldAutoCommit;
3856 return $err_or_cust_pkg;
3859 push @$return_cust_pkg, $err_or_cust_pkg;
3860 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3865 # Create the new packages.
3866 foreach my $pkgpart (@$pkgparts) {
3868 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3870 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3871 pkgpart => $pkgpart,
3875 $error = $cust_pkg->insert( 'change' => $change );
3877 $dbh->rollback if $oldAutoCommit;
3880 push @$return_cust_pkg, $cust_pkg;
3882 # $return_cust_pkg now contains refs to all of the newly
3885 # Transfer services and cancel old packages.
3886 foreach my $old_pkg (@old_cust_pkg) {
3888 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3891 foreach my $new_pkg (@$return_cust_pkg) {
3892 $error = $old_pkg->transfer($new_pkg);
3893 if ($error and $error == 0) {
3894 # $old_pkg->transfer failed.
3895 $dbh->rollback if $oldAutoCommit;
3900 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3901 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3902 foreach my $new_pkg (@$return_cust_pkg) {
3903 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3904 if ($error and $error == 0) {
3905 # $old_pkg->transfer failed.
3906 $dbh->rollback if $oldAutoCommit;
3913 # Transfers were successful, but we went through all of the
3914 # new packages and still had services left on the old package.
3915 # We can't cancel the package under the circumstances, so abort.
3916 $dbh->rollback if $oldAutoCommit;
3917 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3919 $error = $old_pkg->cancel( quiet=>1 );
3925 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3929 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3931 A bulk change method to change packages for multiple customers.
3933 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3934 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3937 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3938 replace. The services (see L<FS::cust_svc>) are moved to the
3939 new billing items. An error is returned if this is not possible (see
3942 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3943 newly-created cust_pkg objects.
3948 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3950 # Transactionize this whole mess
3951 local $SIG{HUP} = 'IGNORE';
3952 local $SIG{INT} = 'IGNORE';
3953 local $SIG{QUIT} = 'IGNORE';
3954 local $SIG{TERM} = 'IGNORE';
3955 local $SIG{TSTP} = 'IGNORE';
3956 local $SIG{PIPE} = 'IGNORE';
3958 my $oldAutoCommit = $FS::UID::AutoCommit;
3959 local $FS::UID::AutoCommit = 0;
3963 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3966 while(scalar(@old_cust_pkg)) {
3968 my $custnum = $old_cust_pkg[0]->custnum;
3969 my (@remove) = map { $_->pkgnum }
3970 grep { $_->custnum == $custnum } @old_cust_pkg;
3971 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3973 my $error = order $custnum, $pkgparts, \@remove, \@return;
3975 push @errors, $error
3977 push @$return_cust_pkg, @return;
3980 if (scalar(@errors)) {
3981 $dbh->rollback if $oldAutoCommit;
3982 return join(' / ', @errors);
3985 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3989 # Used by FS::Upgrade to migrate to a new database.
3990 sub _upgrade_data { # class method
3991 my ($class, %opts) = @_;
3992 $class->_upgrade_otaker(%opts);
3994 # RT#10139, bug resulting in contract_end being set when it shouldn't
3995 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3996 # RT#10830, bad calculation of prorate date near end of year
3997 # the date range for bill is December 2009, and we move it forward
3998 # one year if it's before the previous bill date (which it should
4000 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4001 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4002 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4003 # RT6628, add order_date to cust_pkg
4004 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4005 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4006 history_action = \'insert\') where order_date is null',
4008 foreach my $sql (@statements) {
4009 my $sth = dbh->prepare($sql);
4010 $sth->execute or die $sth->errstr;
4018 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4020 In sub order, the @pkgparts array (passed by reference) is clobbered.
4022 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4023 method to pass dates to the recur_prog expression, it should do so.
4025 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4026 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4027 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4028 configuration values. Probably need a subroutine which decides what to do
4029 based on whether or not we've fetched the user yet, rather than a hash. See
4030 FS::UID and the TODO.
4032 Now that things are transactional should the check in the insert method be
4037 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4038 L<FS::pkg_svc>, schema.html from the base documentation