2 use base qw( FS::cust_pkg::API FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
3 FS::contact_Mixin FS::location_Mixin
4 FS::m2m_Common FS::option_Common );
7 use vars qw( $disable_agentcheck $DEBUG $me $upgrade );
9 use Scalar::Util qw( blessed );
10 use List::Util qw(min max sum);
12 use Time::Local qw( timelocal timelocal_nocheck );
14 use FS::UID qw( getotaker dbh driver_name );
15 use FS::Misc qw( send_email );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_discount;
41 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
43 # because they load configuration by setting FS::UID::callback (see TODO)
49 # for sending cancel emails in sub cancel
53 $me = '[FS::cust_pkg]';
55 $disable_agentcheck = 0;
57 $upgrade = 0; #go away after setup+start dates cleaned up for old customers
59 our $cache_enabled = 0;
62 my( $self, $hashref ) = @_;
63 if ( $cache_enabled && $hashref->{'pkg'} && $hashref->{'plan'} ) {
64 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
70 my ( $hashref, $cache ) = @_;
71 # #if ( $hashref->{'pkgpart'} ) {
72 # if ( $hashref->{'pkg'} ) {
73 # # #@{ $self->{'_pkgnum'} } = ();
74 # # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
75 # # $self->{'_pkgpart'} = $subcache;
76 # # #push @{ $self->{'_pkgnum'} },
77 # # FS::part_pkg->new_or_cached($hashref, $subcache);
78 # $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
80 if ( exists $hashref->{'svcnum'} ) {
81 #@{ $self->{'_pkgnum'} } = ();
82 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
83 $self->{'_svcnum'} = $subcache;
84 #push @{ $self->{'_pkgnum'} },
85 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
91 FS::cust_pkg - Object methods for cust_pkg objects
97 $record = new FS::cust_pkg \%hash;
98 $record = new FS::cust_pkg { 'column' => 'value' };
100 $error = $record->insert;
102 $error = $new_record->replace($old_record);
104 $error = $record->delete;
106 $error = $record->check;
108 $error = $record->cancel;
110 $error = $record->suspend;
112 $error = $record->unsuspend;
114 $part_pkg = $record->part_pkg;
116 @labels = $record->labels;
118 $seconds = $record->seconds_since($timestamp);
120 #bulk cancel+order... perhaps slightly deprecated, only used by the bulk
121 # cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
122 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
123 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
127 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
128 inherits from FS::Record. The following fields are currently supported:
134 Primary key (assigned automatically for new billing items)
138 Customer (see L<FS::cust_main>)
142 Billing item definition (see L<FS::part_pkg>)
146 Optional link to package location (see L<FS::location>)
150 date package was ordered (also remains same on changes)
162 date (next bill date)
190 order taker (see L<FS::access_user>)
194 If not set, defaults to 1
198 Date of change from previous package
208 =item change_locationnum
216 The pkgnum of the package that this package is supplemental to, if any.
220 The package link (L<FS::part_pkg_link>) that defines this supplemental
221 package, if it is one.
223 =item change_to_pkgnum
225 The pkgnum of the package this one will be "changed to" in the future
226 (on its expiration date).
230 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
231 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
232 L<Time::Local> and L<Date::Parse> for conversion functions.
240 Create a new billing item. To add the item to the database, see L<"insert">.
244 sub table { 'cust_pkg'; }
245 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
246 sub cust_unlinked_msg {
248 "WARNING: can't find cust_main.custnum ". $self->custnum.
249 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
252 =item set_initial_timers
254 If required by the package definition, sets any automatic expire, adjourn,
255 or contract_end timers to some number of months after the start date
256 (or setup date, if the package has already been setup). If the package has
257 a delayed setup fee after a period of "free days", will also set the
258 start date to the end of that period.
262 sub set_initial_timers {
264 my $part_pkg = $self->part_pkg;
265 foreach my $action ( qw(expire adjourn contract_end) ) {
266 my $months = $part_pkg->option("${action}_months",1);
267 if($months and !$self->get($action)) {
268 my $start = $self->start_date || $self->setup || time;
269 $self->set($action, $part_pkg->add_freq($start, $months) );
273 # if this package has "free days" and delayed setup fee, then
274 # set start date that many days in the future.
275 # (this should have been set in the UI, but enforce it here)
276 if ( $part_pkg->option('free_days',1)
277 && $part_pkg->option('delay_setup',1)
280 $self->start_date( $part_pkg->default_start_date );
285 =item insert [ OPTION => VALUE ... ]
287 Adds this billing item to the database ("Orders" the item). If there is an
288 error, returns the error, otherwise returns false.
290 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
291 will be used to look up the package definition and agent restrictions will be
294 If the additional field I<refnum> is defined, an FS::pkg_referral record will
295 be created and inserted. Multiple FS::pkg_referral records can be created by
296 setting I<refnum> to an array reference of refnums or a hash reference with
297 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
298 record will be created corresponding to cust_main.refnum.
300 The following options are available:
306 If set true, supresses actions that should only be taken for new package
307 orders. (Currently this includes: intro periods when delay_setup is on,
308 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
312 cust_pkg_option records will be created
316 a ticket will be added to this customer with this subject
320 an optional queue name for ticket additions
324 Don't check the legality of the package definition. This should be used
325 when performing a package change that doesn't change the pkgpart (i.e.
333 my( $self, %options ) = @_;
336 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
337 return $error if $error;
339 my $part_pkg = $self->part_pkg;
341 if ( ! $options{'change'} ) {
343 # set order date to now
344 $self->order_date(time);
346 # if the package def says to start only on the first of the month:
347 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
348 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
349 $mon += 1 unless $mday == 1;
350 until ( $mon < 12 ) { $mon -= 12; $year++; }
351 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
354 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
355 # if the package was ordered on hold:
357 # - don't set the start date (it will be started manually)
358 $self->set('susp', $self->order_date);
359 $self->set('start_date', '');
361 # set expire/adjourn/contract_end timers, and free days, if appropriate
362 $self->set_initial_timers;
364 } # else this is a package change, and shouldn't have "new package" behavior
366 local $SIG{HUP} = 'IGNORE';
367 local $SIG{INT} = 'IGNORE';
368 local $SIG{QUIT} = 'IGNORE';
369 local $SIG{TERM} = 'IGNORE';
370 local $SIG{TSTP} = 'IGNORE';
371 local $SIG{PIPE} = 'IGNORE';
373 my $oldAutoCommit = $FS::UID::AutoCommit;
374 local $FS::UID::AutoCommit = 0;
377 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
379 $dbh->rollback if $oldAutoCommit;
383 $self->refnum($self->cust_main->refnum) unless $self->refnum;
384 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
385 $self->process_m2m( 'link_table' => 'pkg_referral',
386 'target_table' => 'part_referral',
387 'params' => $self->refnum,
390 if ( $self->discountnum ) {
391 my $error = $self->insert_discount();
393 $dbh->rollback if $oldAutoCommit;
398 my $conf = new FS::Conf;
400 if ($self->locationnum) {
402 map qsearch( 'part_export', {exportnum=>$_} ),
403 $conf->config('cust_location-exports'); #, $agentnum
405 foreach my $part_export ( @part_export ) {
406 my $error = $part_export->export_pkg_location($self); #, @$export_args);
408 $dbh->rollback if $oldAutoCommit;
409 return "exporting to ". $part_export->exporttype.
410 " (transaction rolled back): $error";
415 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
417 #this init stuff is still inefficient, but at least its limited to
418 # the small number (any?) folks using ticket emailing on pkg order
421 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
428 use FS::TicketSystem;
429 FS::TicketSystem->init();
431 my $q = new RT::Queue($RT::SystemUser);
432 $q->Load($options{ticket_queue}) if $options{ticket_queue};
433 my $t = new RT::Ticket($RT::SystemUser);
434 my $mime = new MIME::Entity;
435 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
436 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
437 Subject => $options{ticket_subject},
440 $t->AddLink( Type => 'MemberOf',
441 Target => 'freeside://freeside/cust_main/'. $self->custnum,
445 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
446 my $queue = new FS::queue {
447 'job' => 'FS::cust_main::queueable_print',
449 $error = $queue->insert(
450 'custnum' => $self->custnum,
451 'template' => 'welcome_letter',
455 warn "can't send welcome letter: $error";
460 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
467 This method now works but you probably shouldn't use it.
469 You don't want to delete packages, because there would then be no record
470 the customer ever purchased the package. Instead, see the cancel method and
471 hide cancelled packages.
478 local $SIG{HUP} = 'IGNORE';
479 local $SIG{INT} = 'IGNORE';
480 local $SIG{QUIT} = 'IGNORE';
481 local $SIG{TERM} = 'IGNORE';
482 local $SIG{TSTP} = 'IGNORE';
483 local $SIG{PIPE} = 'IGNORE';
485 my $oldAutoCommit = $FS::UID::AutoCommit;
486 local $FS::UID::AutoCommit = 0;
489 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
490 my $error = $cust_pkg_discount->delete;
492 $dbh->rollback if $oldAutoCommit;
496 #cust_bill_pkg_discount?
498 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
499 my $error = $cust_pkg_detail->delete;
501 $dbh->rollback if $oldAutoCommit;
506 foreach my $cust_pkg_reason (
508 'table' => 'cust_pkg_reason',
509 'hashref' => { 'pkgnum' => $self->pkgnum },
513 my $error = $cust_pkg_reason->delete;
515 $dbh->rollback if $oldAutoCommit;
522 my $error = $self->SUPER::delete(@_);
524 $dbh->rollback if $oldAutoCommit;
528 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
534 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
536 Replaces the OLD_RECORD with this one in the database. If there is an error,
537 returns the error, otherwise returns false.
539 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
541 Changing pkgpart may have disasterous effects. See the order subroutine.
543 setup and bill are normally updated by calling the bill method of a customer
544 object (see L<FS::cust_main>).
546 suspend is normally updated by the suspend and unsuspend methods.
548 cancel is normally updated by the cancel method (and also the order subroutine
551 Available options are:
557 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.
561 the access_user (see L<FS::access_user>) providing the reason
565 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
574 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
579 ( ref($_[0]) eq 'HASH' )
583 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
584 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
587 #return "Can't change setup once it exists!"
588 # if $old->getfield('setup') &&
589 # $old->getfield('setup') != $new->getfield('setup');
591 #some logic for bill, susp, cancel?
593 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
595 local $SIG{HUP} = 'IGNORE';
596 local $SIG{INT} = 'IGNORE';
597 local $SIG{QUIT} = 'IGNORE';
598 local $SIG{TERM} = 'IGNORE';
599 local $SIG{TSTP} = 'IGNORE';
600 local $SIG{PIPE} = 'IGNORE';
602 my $oldAutoCommit = $FS::UID::AutoCommit;
603 local $FS::UID::AutoCommit = 0;
606 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
607 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
608 my $error = $new->insert_reason(
609 'reason' => $options->{'reason'},
610 'date' => $new->$method,
612 'reason_otaker' => $options->{'reason_otaker'},
615 dbh->rollback if $oldAutoCommit;
616 return "Error inserting cust_pkg_reason: $error";
621 #save off and freeze RADIUS attributes for any associated svc_acct records
623 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
625 #also check for specific exports?
626 # to avoid spurious modify export events
627 @svc_acct = map { $_->svc_x }
628 grep { $_->part_svc->svcdb eq 'svc_acct' }
631 $_->snapshot foreach @svc_acct;
635 my $error = $new->export_pkg_change($old)
636 || $new->SUPER::replace( $old,
638 ? $options->{options}
642 $dbh->rollback if $oldAutoCommit;
646 #for prepaid packages,
647 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
648 foreach my $old_svc_acct ( @svc_acct ) {
649 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
651 $new_svc_acct->replace( $old_svc_acct,
652 'depend_jobnum' => $options->{depend_jobnum},
655 $dbh->rollback if $oldAutoCommit;
660 # also run exports if removing locationnum?
661 # doesn't seem to happen, and we don't export blank locationnum on insert...
662 if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
663 my $conf = new FS::Conf;
665 map qsearch( 'part_export', {exportnum=>$_} ),
666 $conf->config('cust_location-exports'); #, $agentnum
668 foreach my $part_export ( @part_export ) {
669 my $error = $part_export->export_pkg_location($new); #, @$export_args);
671 $dbh->rollback if $oldAutoCommit;
672 return "exporting to ". $part_export->exporttype.
673 " (transaction rolled back): $error";
678 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
685 Checks all fields to make sure this is a valid billing item. If there is an
686 error, returns the error, otherwise returns false. Called by the insert and
694 if ( !$self->locationnum or $self->locationnum == -1 ) {
695 $self->set('locationnum', $self->cust_main->ship_locationnum);
699 $self->ut_numbern('pkgnum')
700 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
701 || $self->ut_numbern('pkgpart')
702 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
703 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
704 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
705 || $self->ut_numbern('quantity')
706 || $self->ut_numbern('start_date')
707 || $self->ut_numbern('setup')
708 || $self->ut_numbern('bill')
709 || $self->ut_numbern('susp')
710 || $self->ut_numbern('cancel')
711 || $self->ut_numbern('adjourn')
712 || $self->ut_numbern('resume')
713 || $self->ut_numbern('expire')
714 || $self->ut_numbern('dundate')
715 || $self->ut_flag('no_auto', [ '', 'Y' ])
716 || $self->ut_flag('waive_setup', [ '', 'Y' ])
717 || $self->ut_flag('separate_bill')
718 || $self->ut_textn('agent_pkgid')
719 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
720 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
721 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
722 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
723 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
725 return $error if $error;
727 return "A package with both start date (future start) and setup date (already started) will never bill"
728 if $self->start_date && $self->setup && ! $upgrade;
730 return "A future unsuspend date can only be set for a package with a suspend date"
731 if $self->resume and !$self->susp and !$self->adjourn;
733 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
735 if ( $self->dbdef_table->column('manual_flag') ) {
736 $self->manual_flag('') if $self->manual_flag eq ' ';
737 $self->manual_flag =~ /^([01]?)$/
738 or return "Illegal manual_flag ". $self->manual_flag;
739 $self->manual_flag($1);
747 Check the pkgpart to make sure it's allowed with the reg_code and/or
748 promo_code of the package (if present) and with the customer's agent.
749 Called from C<insert>, unless we are doing a package change that doesn't
757 # my $error = $self->ut_numbern('pkgpart'); # already done
760 if ( $self->reg_code ) {
762 unless ( grep { $self->pkgpart == $_->pkgpart }
763 map { $_->reg_code_pkg }
764 qsearchs( 'reg_code', { 'code' => $self->reg_code,
765 'agentnum' => $self->cust_main->agentnum })
767 return "Unknown registration code";
770 } elsif ( $self->promo_code ) {
773 qsearchs('part_pkg', {
774 'pkgpart' => $self->pkgpart,
775 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
777 return 'Unknown promotional code' unless $promo_part_pkg;
781 unless ( $disable_agentcheck ) {
783 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
784 return "agent ". $agent->agentnum. ':'. $agent->agent.
785 " can't purchase pkgpart ". $self->pkgpart
786 unless $agent->pkgpart_hashref->{ $self->pkgpart }
787 || $agent->agentnum == $self->part_pkg->agentnum;
790 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
791 return $error if $error;
799 =item cancel [ OPTION => VALUE ... ]
801 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
802 in this package, then cancels the package itself (sets the cancel field to
805 Available options are:
809 =item quiet - can be set true to supress email cancellation notices.
811 =item time - can be set to cancel the package based on a specific future or
812 historical date. Using time ensures that the remaining amount is calculated
813 correctly. Note however that this is an immediate cancel and just changes
814 the date. You are PROBABLY looking to expire the account instead of using
817 =item reason - can be set to a cancellation reason (see L<FS:reason>),
818 either a reasonnum of an existing reason, or a hashref to create
819 a new reason. The hashref should have the following keys:
820 typenum - Reason type (see L<FS::reason_type>
821 reason - Text of the new reason.
823 If this argument isn't given or is a false value, then the package will be
824 canceled with no reason.
826 =item date - can be set to a unix style timestamp to specify when to
829 =item nobill - can be set true to skip billing if it might otherwise be done.
831 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
832 not credit it. This must be set (by change()) when changing the package
833 to a different pkgpart or location, and probably shouldn't be in any other
834 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
837 =item no_delay_cancel - prevents delay_cancel behavior
838 no matter what other options say, for use when changing packages (or any
839 other time you're really sure you want an immediate cancel)
843 If there is an error, returns the error, otherwise returns false.
847 #NOT DOCUMENTING - this should only be used when calling recursively
848 #=item delay_cancel - for internal use, to allow proper handling of
849 #supplemental packages when the main package is flagged to suspend
850 #before cancelling, probably shouldn't be used otherwise (set the
851 #corresponding package option instead)
854 my( $self, %options ) = @_;
857 # pass all suspend/cancel actions to the main package
858 # (unless the pkglinknum has been removed, then the link is defunct and
859 # this package can be canceled on its own)
860 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
861 return $self->main_pkg->cancel(%options);
864 my $conf = new FS::Conf;
866 warn "cust_pkg::cancel called with options".
867 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
870 local $SIG{HUP} = 'IGNORE';
871 local $SIG{INT} = 'IGNORE';
872 local $SIG{QUIT} = 'IGNORE';
873 local $SIG{TERM} = 'IGNORE';
874 local $SIG{TSTP} = 'IGNORE';
875 local $SIG{PIPE} = 'IGNORE';
877 my $oldAutoCommit = $FS::UID::AutoCommit;
878 local $FS::UID::AutoCommit = 0;
881 my $old = $self->select_for_update;
883 if ( $old->get('cancel') || $self->get('cancel') ) {
884 dbh->rollback if $oldAutoCommit;
885 return ""; # no error
888 # XXX possibly set cancel_time to the expire date?
889 my $cancel_time = $options{'time'} || time;
890 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
891 $date = '' if ($date && $date <= $cancel_time); # complain instead?
893 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
894 if ( !$date && $self->part_pkg->option('delay_cancel',1)
895 && (($self->status eq 'active') || ($self->status eq 'suspended'))
896 && !$options{'no_delay_cancel'}
898 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
899 my $expsecs = 60*60*24*$expdays;
900 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
901 $expsecs = $expsecs - $suspfor if $suspfor;
902 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
904 $date = $cancel_time + $expsecs;
908 #race condition: usage could be ongoing until unprovisioned
909 #resolved by performing a change package instead (which unprovisions) and
911 if ( !$options{nobill} && !$date ) {
912 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
913 my $copy = $self->new({$self->hash});
915 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
917 'time' => $cancel_time );
918 warn "Error billing during cancel, custnum ".
919 #$self->cust_main->custnum. ": $error"
924 if ( $options{'reason'} ) {
925 $error = $self->insert_reason( 'reason' => $options{'reason'},
926 'action' => $date ? 'expire' : 'cancel',
927 'date' => $date ? $date : $cancel_time,
928 'reason_otaker' => $options{'reason_otaker'},
931 dbh->rollback if $oldAutoCommit;
932 return "Error inserting cust_pkg_reason: $error";
936 my %svc_cancel_opt = ();
937 $svc_cancel_opt{'date'} = $date if $date;
938 foreach my $cust_svc (
941 sort { $a->[1] <=> $b->[1] }
942 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
943 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
945 my $part_svc = $cust_svc->part_svc;
946 next if ( defined($part_svc) and $part_svc->preserve );
947 my $error = $cust_svc->cancel( %svc_cancel_opt );
950 $dbh->rollback if $oldAutoCommit;
951 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
956 # if a reasonnum was passed, get the actual reason object so we can check
960 if ($options{'reason'} =~ /^\d+$/) {
961 $reason = FS::reason->by_key($options{'reason'});
965 # credit remaining time if any of these are true:
966 # - unused_credit => 1 was passed (this happens when canceling a package
967 # for a package change when unused_credit_change is set)
968 # - no unused_credit option, and there is a cancel reason, and the cancel
969 # reason says to credit the package
970 # - no unused_credit option, and the package definition says to credit the
971 # package on cancellation
973 if ( exists($options{'unused_credit'}) ) {
974 $do_credit = $options{'unused_credit'};
975 } elsif ( defined($reason) && $reason->unused_credit ) {
978 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
981 my $error = $self->credit_remaining('cancel', $cancel_time);
983 $dbh->rollback if $oldAutoCommit;
989 my %hash = $self->hash;
991 $hash{'expire'} = $date;
993 # just to be sure these are clear
994 $hash{'adjourn'} = undef;
995 $hash{'resume'} = undef;
998 $hash{'cancel'} = $cancel_time;
1000 $hash{'change_custnum'} = $options{'change_custnum'};
1002 # if this is a supplemental package that's lost its part_pkg_link, and it's
1003 # being canceled for real, unlink it completely
1004 if ( !$date and ! $self->pkglinknum ) {
1005 $hash{main_pkgnum} = '';
1008 my $new = new FS::cust_pkg ( \%hash );
1009 $error = $new->replace( $self, options => { $self->options } );
1010 if ( $self->change_to_pkgnum ) {
1011 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1012 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1015 $dbh->rollback if $oldAutoCommit;
1019 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1020 $error = $supp_pkg->cancel(%options,
1022 'date' => $date, #in case it got changed by delay_cancel
1023 'delay_cancel' => $delay_cancel,
1026 $dbh->rollback if $oldAutoCommit;
1027 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1031 if ($delay_cancel && !$options{'from_main'}) {
1032 $error = $new->suspend(
1034 'time' => $cancel_time
1039 foreach my $usage ( $self->cust_pkg_usage ) {
1040 $error = $usage->delete;
1042 $dbh->rollback if $oldAutoCommit;
1043 return "deleting usage pools: $error";
1048 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1049 return '' if $date; #no errors
1051 my $cust_main = $self->cust_main;
1053 my @invoicing_list = $cust_main->invoicing_list_emailonly;
1054 if ( !$options{'quiet'}
1055 && $conf->config_bool('emailcancel', $cust_main->agentnum)
1059 my $msgnum = $conf->config('cancel_msgnum', $cust_main->agentnum);
1062 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1063 $error = $msg_template->send(
1064 'cust_main' => $cust_main,
1068 $error = send_email(
1069 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
1070 'to' => \@invoicing_list,
1071 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
1072 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
1073 'custnum' => $self->custnum,
1074 'msgtype' => '', #admin?
1077 #should this do something on errors?
1080 my %pkg_class = map { $_=>1 }
1081 $conf->config('cancel_msgnum-referring_cust-pkg_class');
1082 my $ref_msgnum = $conf->config('cancel_msgnum-referring_cust');
1083 if ( !$options{'quiet'}
1084 && $cust_main->referral_custnum
1085 && $pkg_class{ $self->classnum }
1089 my $msg_template = qsearchs('msg_template', { msgnum => $ref_msgnum });
1090 my $error = $msg_template->send(
1091 'cust_main' => $cust_main->referring_cust_main,
1094 #should this do something on errors?
1101 =item cancel_if_expired [ NOW_TIMESTAMP ]
1103 Cancels this package if its expire date has been reached.
1107 # XXX should look for an expire reason
1108 # but seems to be unused; this is now handled more holistically in
1109 # cust_main::Billing
1111 sub cancel_if_expired {
1113 my $time = shift || time;
1114 return '' unless $self->expire && $self->expire <= $time;
1115 my $error = $self->cancel;
1117 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1118 $self->custnum. ": $error";
1123 =item uncancel_svc_x
1125 For cancelled cust_pkg, returns a list of new, uninserted FS::svc_X records
1126 for services that would be inserted by L</uncancel>. Returned objects also
1127 include the field _h_svc_x, which contains the service history object.
1129 Set pkgnum before inserting.
1131 Accepts the following options:
1133 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1134 (and only if they would otherwise be returned by this)
1138 sub uncancel_svc_x {
1139 my ($self, %opt) = @_;
1141 die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1143 #find historical services within this timeframe before the package cancel
1144 # (incompatible with "time" option to cust_pkg->cancel?)
1145 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1146 # too little? (unprovisioing export delay?)
1147 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1148 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1151 foreach my $h_cust_svc (@h_cust_svc) {
1152 next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1153 # filter out services that still exist on this package (ie preserved svcs)
1154 # but keep services that have since been provisioned on another package (for informational purposes)
1155 next if qsearchs('cust_svc',{ 'svcnum' => $h_cust_svc->svcnum, 'pkgnum' => $self->pkgnum });
1156 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1157 next unless $h_svc_x; # this probably doesn't happen, but just in case
1158 (my $table = $h_svc_x->table) =~ s/^h_//;
1159 require "FS/$table.pm";
1160 my $class = "FS::$table";
1161 my $svc_x = $class->new( {
1162 'svcpart' => $h_cust_svc->svcpart,
1163 '_h_svc_x' => $h_svc_x,
1164 map { $_ => $h_svc_x->get($_) } fields($table)
1168 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1169 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1172 #these are pretty rare, but should handle them
1173 # - dsl_device (mac addresses)
1174 # - phone_device (mac addresses)
1175 # - dsl_note (ikano notes)
1176 # - domain_record (i.e. restore DNS information w/domains)
1177 # - inventory_item(?) (inventory w/un-cancelling service?)
1178 # - nas (svc_broaband nas stuff)
1179 #this stuff is unused in the wild afaik
1180 # - mailinglistmember
1182 # - svc_domain.parent_svcnum?
1183 # - acct_snarf (ancient mail fetching config)
1184 # - cgp_rule (communigate)
1185 # - cust_svc_option (used by our Tron stuff)
1186 # - acct_rt_transaction (used by our time worked stuff)
1188 push @svc_x, $svc_x;
1193 =item uncancel_svc_summary
1195 Returns an array of hashrefs, one for each service that could
1196 potentially be reprovisioned by L</uncancel>, with the following keys:
1204 label - from history table if not currently calculable, undefined if it can't be loaded
1206 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1208 num_cust_svc - number of svcs for this svcpart, only if summarizing (see below)
1210 Cannot be run from within a transaction. Performs inserts
1211 to test the results, and then rolls back the transaction.
1212 Does not perform exports, so does not catch if export would fail.
1214 Also accepts the following options:
1216 no_test_reprovision - skip the test inserts (reprovisionable field will not exist)
1218 summarize_size - if true, returns a single summary record for svcparts with at
1219 least this many svcs, will have key num_cust_svc but not uncancel_svcnum, label or reprovisionable
1223 sub uncancel_svc_summary {
1224 my ($self, %opt) = @_;
1226 die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1227 die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1229 local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1230 local $FS::UID::AutoCommit = 0;
1232 # sort by svcpart, to check summarize_size
1233 my $uncancel_svc_x = {};
1234 foreach my $svc_x (sort { $a->{'svcpart'} <=> $b->{'svcpart'} } $self->uncancel_svc_x) {
1235 $uncancel_svc_x->{$svc_x->svcpart} = [] unless $uncancel_svc_x->{$svc_x->svcpart};
1236 push @{$uncancel_svc_x->{$svc_x->svcpart}}, $svc_x;
1240 foreach my $svcpart (keys %$uncancel_svc_x) {
1241 my @svcpart_svc_x = @{$uncancel_svc_x->{$svcpart}};
1242 if ($opt{'summarize_size'} && (@svcpart_svc_x >= $opt{'summarize_size'})) {
1243 my $svc_x = $svcpart_svc_x[0]; #grab first one for access to $part_svc
1244 my $part_svc = $svc_x->part_svc;
1246 'svcpart' => $part_svc->svcpart,
1247 'svc' => $part_svc->svc,
1248 'num_cust_svc' => scalar(@svcpart_svc_x),
1251 foreach my $svc_x (@svcpart_svc_x) {
1252 my $part_svc = $svc_x->part_svc;
1254 'svcpart' => $part_svc->svcpart,
1255 'svc' => $part_svc->svc,
1256 'uncancel_svcnum' => $svc_x->get('_h_svc_x')->svcnum,
1258 $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1260 unless ($opt{'no_test_reprovision'}) {
1261 # avoid possibly fatal errors from missing linked records
1262 eval { $insert_error = $svc_x->insert };
1263 $insert_error ||= $@;
1265 if ($opt{'no_test_reprovision'} or $insert_error) {
1266 # avoid possibly fatal errors from missing linked records
1267 eval { $out->{'label'} = $svc_x->label };
1268 eval { $out->{'label'} = $svc_x->get('_h_svc_x')->label } unless defined($out->{'label'});
1269 $out->{'reprovisionable'} = 0 unless $opt{'no_test_reprovision'};
1271 $out->{'label'} = $svc_x->label;
1272 $out->{'reprovisionable'} = 1;
1285 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1286 locationnum, (other fields?). Attempts to re-provision cancelled services
1287 using history information (errors at this stage are not fatal).
1289 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1291 svc_fatal: service provisioning errors are fatal
1293 svc_errors: pass an array reference, will be filled in with any provisioning errors
1295 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1297 main_pkgnum: link the package as a supplemental package of this one. For
1303 my( $self, %options ) = @_;
1305 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1306 return '' unless $self->get('cancel');
1308 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1309 return $self->main_pkg->uncancel(%options);
1316 local $SIG{HUP} = 'IGNORE';
1317 local $SIG{INT} = 'IGNORE';
1318 local $SIG{QUIT} = 'IGNORE';
1319 local $SIG{TERM} = 'IGNORE';
1320 local $SIG{TSTP} = 'IGNORE';
1321 local $SIG{PIPE} = 'IGNORE';
1323 my $oldAutoCommit = $FS::UID::AutoCommit;
1324 local $FS::UID::AutoCommit = 0;
1328 # insert the new package
1331 my $cust_pkg = new FS::cust_pkg {
1332 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1333 bill => ( $options{'bill'} || $self->get('bill') ),
1335 uncancel_pkgnum => $self->pkgnum,
1336 main_pkgnum => ($options{'main_pkgnum'} || ''),
1337 map { $_ => $self->get($_) } qw(
1338 custnum pkgpart locationnum
1340 susp adjourn resume expire start_date contract_end dundate
1341 change_date change_pkgpart change_locationnum
1342 manual_flag no_auto separate_bill quantity agent_pkgid
1343 recur_show_zero setup_show_zero
1347 my $error = $cust_pkg->insert(
1348 'change' => 1, #supresses any referral credit to a referring customer
1349 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1352 $dbh->rollback if $oldAutoCommit;
1361 foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1363 $svc_x->pkgnum($cust_pkg->pkgnum);
1364 my $svc_error = $svc_x->insert;
1367 if ( $options{svc_fatal} ) {
1368 $dbh->rollback if $oldAutoCommit;
1371 # if we've failed to insert the svc_x object, svc_Common->insert
1372 # will have removed the cust_svc already. if not, then both records
1373 # were inserted but we failed for some other reason (export, most
1374 # likely). in that case, report the error and delete the records.
1375 push @svc_errors, $svc_error;
1376 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1378 # except if export_insert failed, export_delete probably won't be
1380 local $FS::svc_Common::noexport_hack = 1;
1381 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1382 if ( $cleanup_error ) { # and if THAT fails, then run away
1383 $dbh->rollback if $oldAutoCommit;
1384 return $cleanup_error;
1389 } #foreach uncancel_svc_x
1392 # also move over any services that didn't unprovision at cancellation
1395 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1396 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1397 my $error = $cust_svc->replace;
1399 $dbh->rollback if $oldAutoCommit;
1405 # Uncancel any supplemental packages, and make them supplemental to the
1409 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1411 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1413 $dbh->rollback if $oldAutoCommit;
1414 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1422 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1424 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1425 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1432 Cancels any pending expiration (sets the expire field to null)
1433 for this package and any supplemental packages.
1435 If there is an error, returns the error, otherwise returns false.
1443 local $SIG{HUP} = 'IGNORE';
1444 local $SIG{INT} = 'IGNORE';
1445 local $SIG{QUIT} = 'IGNORE';
1446 local $SIG{TERM} = 'IGNORE';
1447 local $SIG{TSTP} = 'IGNORE';
1448 local $SIG{PIPE} = 'IGNORE';
1450 my $oldAutoCommit = $FS::UID::AutoCommit;
1451 local $FS::UID::AutoCommit = 0;
1454 my $old = $self->select_for_update;
1456 my $pkgnum = $old->pkgnum;
1457 if ( $old->get('cancel') || $self->get('cancel') ) {
1458 dbh->rollback if $oldAutoCommit;
1459 return "Can't unexpire cancelled package $pkgnum";
1460 # or at least it's pointless
1463 unless ( $old->get('expire') && $self->get('expire') ) {
1464 dbh->rollback if $oldAutoCommit;
1465 return ""; # no error
1468 my %hash = $self->hash;
1469 $hash{'expire'} = '';
1470 my $new = new FS::cust_pkg ( \%hash );
1471 $error = $new->replace( $self, options => { $self->options } );
1473 $dbh->rollback if $oldAutoCommit;
1477 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1478 $error = $supp_pkg->unexpire;
1480 $dbh->rollback if $oldAutoCommit;
1481 return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1485 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1491 =item suspend [ OPTION => VALUE ... ]
1493 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1494 package, then suspends the package itself (sets the susp field to now).
1496 Available options are:
1500 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1501 either a reasonnum of an existing reason, or passing a hashref will create
1502 a new reason. The hashref should have the following keys:
1503 - typenum - Reason type (see L<FS::reason_type>
1504 - reason - Text of the new reason.
1506 =item date - can be set to a unix style timestamp to specify when to
1509 =item time - can be set to override the current time, for calculation
1510 of final invoices or unused-time credits
1512 =item resume_date - can be set to a time when the package should be
1513 unsuspended. This may be more convenient than calling C<unsuspend()>
1516 =item from_main - allows a supplemental package to be suspended, rather
1517 than redirecting the method call to its main package. For internal use.
1519 =item from_cancel - used when suspending from the cancel method, forces
1520 this to skip everything besides basic suspension. For internal use.
1524 If there is an error, returns the error, otherwise returns false.
1529 my( $self, %options ) = @_;
1532 # pass all suspend/cancel actions to the main package
1533 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1534 return $self->main_pkg->suspend(%options);
1537 local $SIG{HUP} = 'IGNORE';
1538 local $SIG{INT} = 'IGNORE';
1539 local $SIG{QUIT} = 'IGNORE';
1540 local $SIG{TERM} = 'IGNORE';
1541 local $SIG{TSTP} = 'IGNORE';
1542 local $SIG{PIPE} = 'IGNORE';
1544 my $oldAutoCommit = $FS::UID::AutoCommit;
1545 local $FS::UID::AutoCommit = 0;
1548 my $old = $self->select_for_update;
1550 my $pkgnum = $old->pkgnum;
1551 if ( $old->get('cancel') || $self->get('cancel') ) {
1552 dbh->rollback if $oldAutoCommit;
1553 return "Can't suspend cancelled package $pkgnum";
1556 if ( $old->get('susp') || $self->get('susp') ) {
1557 dbh->rollback if $oldAutoCommit;
1558 return ""; # no error # complain on adjourn?
1561 my $suspend_time = $options{'time'} || time;
1562 my $date = $options{date} if $options{date}; # adjourn/suspend later
1563 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1565 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1566 dbh->rollback if $oldAutoCommit;
1567 return "Package $pkgnum expires before it would be suspended.";
1570 # some false laziness with sub cancel
1571 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1572 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1573 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1574 # make the entire cust_main->bill path recognize 'suspend' and
1575 # 'cancel' separately.
1576 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1577 my $copy = $self->new({$self->hash});
1579 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1581 'time' => $suspend_time );
1582 warn "Error billing during suspend, custnum ".
1583 #$self->cust_main->custnum. ": $error"
1588 my $cust_pkg_reason;
1589 if ( $options{'reason'} ) {
1590 $error = $self->insert_reason( 'reason' => $options{'reason'},
1591 'action' => $date ? 'adjourn' : 'suspend',
1592 'date' => $date ? $date : $suspend_time,
1593 'reason_otaker' => $options{'reason_otaker'},
1596 dbh->rollback if $oldAutoCommit;
1597 return "Error inserting cust_pkg_reason: $error";
1599 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1600 'date' => $date ? $date : $suspend_time,
1601 'action' => $date ? 'A' : 'S',
1602 'pkgnum' => $self->pkgnum,
1606 # if a reasonnum was passed, get the actual reason object so we can check
1608 # (passing a reason hashref is still allowed, but it can't be used with
1609 # the fancy behavioral options.)
1612 if ($options{'reason'} =~ /^\d+$/) {
1613 $reason = FS::reason->by_key($options{'reason'});
1616 my %hash = $self->hash;
1618 $hash{'adjourn'} = $date;
1620 $hash{'susp'} = $suspend_time;
1623 my $resume_date = $options{'resume_date'} || 0;
1624 if ( $resume_date > ($date || $suspend_time) ) {
1625 $hash{'resume'} = $resume_date;
1628 $options{options} ||= {};
1630 my $new = new FS::cust_pkg ( \%hash );
1631 $error = $new->replace( $self, options => { $self->options,
1632 %{ $options{options} },
1636 $dbh->rollback if $oldAutoCommit;
1640 unless ( $date ) { # then we are suspending now
1642 unless ($options{'from_cancel'}) {
1643 # credit remaining time if appropriate
1644 # (if required by the package def, or the suspend reason)
1645 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1646 || ( defined($reason) && $reason->unused_credit );
1648 if ( $unused_credit ) {
1649 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1650 my $error = $self->credit_remaining('suspend', $suspend_time);
1652 $dbh->rollback if $oldAutoCommit;
1660 foreach my $cust_svc (
1661 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1663 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1665 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1666 $dbh->rollback if $oldAutoCommit;
1667 return "Illegal svcdb value in part_svc!";
1670 require "FS/$svcdb.pm";
1672 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1674 $error = $svc->suspend;
1676 $dbh->rollback if $oldAutoCommit;
1679 my( $label, $value ) = $cust_svc->label;
1680 push @labels, "$label: $value";
1684 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1685 # and this is not a suspend-before-cancel
1686 if ( $cust_pkg_reason ) {
1687 my $reason_obj = $cust_pkg_reason->reason;
1688 if ( $reason_obj->feepart and
1689 ! $reason_obj->fee_on_unsuspend and
1690 ! $options{'from_cancel'} ) {
1692 # register the need to charge a fee, cust_main->bill will do the rest
1693 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1695 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1696 'pkgreasonnum' => $cust_pkg_reason->num,
1697 'pkgnum' => $self->pkgnum,
1698 'feepart' => $reason->feepart,
1699 'nextbill' => $reason->fee_hold,
1701 $error ||= $cust_pkg_reason_fee->insert;
1705 my $conf = new FS::Conf;
1706 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1708 my $error = send_email(
1709 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1710 #invoice_from ??? well as good as any
1711 'to' => $conf->config('suspend_email_admin'),
1712 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1714 "This is an automatic message from your Freeside installation\n",
1715 "informing you that the following customer package has been suspended:\n",
1717 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1718 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1719 ( map { "Service : $_\n" } @labels ),
1721 'custnum' => $self->custnum,
1722 'msgtype' => 'admin'
1726 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1734 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1735 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1737 $dbh->rollback if $oldAutoCommit;
1738 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1742 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1747 =item credit_remaining MODE TIME
1749 Generate a credit for this package for the time remaining in the current
1750 billing period. MODE is either "suspend" or "cancel" (determines the
1751 credit type). TIME is the time of suspension/cancellation. Both arguments
1756 # Implementation note:
1758 # If you pkgpart-change a package that has been billed, and it's set to give
1759 # credit on package change, then this method gets called and then the new
1760 # package will have no last_bill date. Therefore the customer will be credited
1761 # only once (per billing period) even if there are multiple package changes.
1763 # If you location-change a package that has been billed, this method will NOT
1764 # be called and the new package WILL have the last bill date of the old
1767 # If the new package is then canceled within the same billing cycle,
1768 # credit_remaining needs to run calc_remain on the OLD package to determine
1769 # the amount of unused time to credit.
1771 sub credit_remaining {
1772 # Add a credit for remaining service
1773 my ($self, $mode, $time) = @_;
1774 die 'credit_remaining requires suspend or cancel'
1775 unless $mode eq 'suspend' or $mode eq 'cancel';
1776 die 'no suspend/cancel time' unless $time > 0;
1778 my $conf = FS::Conf->new;
1779 my $reason_type = $conf->config($mode.'_credit_type');
1783 my $remain_pkg = $self;
1784 my (@billpkgnums, @amounts, @setuprecurs);
1786 # we may have to walk back past some package changes to get to the
1787 # one that actually has unused time. loop until that happens, or we
1788 # reach the first package in the chain.
1790 my $last_bill = $remain_pkg->get('last_bill') || 0;
1791 my $next_bill = $remain_pkg->get('bill') || 0;
1792 if ( $last_bill > 0 # the package has been billed
1793 and $next_bill > 0 # the package has a next bill date
1794 and $next_bill >= $time # which is in the future
1797 # Find actual charges for the period ending on or after the cancel
1799 my @charges = qsearch('cust_bill_pkg', {
1800 pkgnum => $remain_pkg->pkgnum,
1801 edate => {op => '>=', value => $time},
1802 recur => {op => '>' , value => 0},
1805 foreach my $cust_bill_pkg (@charges) {
1806 # hack to deal with the weird behavior of edate on package
1808 my $edate = $cust_bill_pkg->edate;
1809 if ( $self->recur_temporality eq 'preceding' ) {
1810 $edate = $self->add_freq($cust_bill_pkg->sdate);
1813 # this will also get any package charges that are _entirely_ after
1814 # the cancellation date (can happen with advance billing). in that
1815 # case, use the entire recurring charge:
1816 my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
1817 my $max_credit = $amount
1818 - $cust_bill_pkg->credited('', '', setuprecur => 'recur') || 0;
1820 # but if the cancellation happens during the interval, prorate it:
1821 # (XXX obey prorate_round_day here?)
1822 if ( $cust_bill_pkg->sdate < $time ) {
1824 ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
1827 # if there are existing credits, don't let the sum of credits exceed
1828 # the recurring charge
1829 $amount = $max_credit if $amount > $max_credit;
1831 $amount = sprintf('%.2f', $amount);
1833 # if no time has been used and/or there are existing line item
1834 # credits, we may end up not needing to credit anything.
1835 if ( $amount > 0 ) {
1837 push @billpkgnums, $cust_bill_pkg->billpkgnum;
1838 push @amounts, $amount;
1839 push @setuprecurs, 'recur';
1841 warn "Crediting for $amount on package ".$remain_pkg->pkgnum."\n"
1850 if ( my $changed_from_pkgnum = $remain_pkg->change_pkgnum ) {
1851 $remain_pkg = FS::cust_pkg->by_key($changed_from_pkgnum);
1853 # the package has really never been billed
1858 # keep traditional behavior here.
1860 my $reason = FS::reason->new_or_existing(
1861 reason => 'Credit for unused time on '. $self->part_pkg->pkg,
1862 type => $reason_type,
1866 return "failed to set credit reason: $@";
1869 my $error = FS::cust_credit->credit_lineitems(
1870 'billpkgnums' => \@billpkgnums,
1871 'setuprecurs' => \@setuprecurs,
1872 'amounts' => \@amounts,
1873 'custnum' => $self->custnum,
1875 'reasonnum' => $reason->reasonnum,
1882 =item unsuspend [ OPTION => VALUE ... ]
1884 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1885 package, then unsuspends the package itself (clears the susp field and the
1886 adjourn field if it is in the past). If the suspend reason includes an
1887 unsuspension package, that package will be ordered.
1889 Available options are:
1895 Can be set to a date to unsuspend the package in the future (the 'resume'
1898 =item adjust_next_bill
1900 Can be set true to adjust the next bill date forward by
1901 the amount of time the account was inactive. This was set true by default
1902 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1903 explicitly requested with this option or in the price plan.
1907 If there is an error, returns the error, otherwise returns false.
1912 my( $self, %opt ) = @_;
1915 # pass all suspend/cancel actions to the main package
1916 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1917 return $self->main_pkg->unsuspend(%opt);
1920 local $SIG{HUP} = 'IGNORE';
1921 local $SIG{INT} = 'IGNORE';
1922 local $SIG{QUIT} = 'IGNORE';
1923 local $SIG{TERM} = 'IGNORE';
1924 local $SIG{TSTP} = 'IGNORE';
1925 local $SIG{PIPE} = 'IGNORE';
1927 my $oldAutoCommit = $FS::UID::AutoCommit;
1928 local $FS::UID::AutoCommit = 0;
1931 my $old = $self->select_for_update;
1933 my $pkgnum = $old->pkgnum;
1934 if ( $old->get('cancel') || $self->get('cancel') ) {
1935 $dbh->rollback if $oldAutoCommit;
1936 return "Can't unsuspend cancelled package $pkgnum";
1939 unless ( $old->get('susp') && $self->get('susp') ) {
1940 $dbh->rollback if $oldAutoCommit;
1941 return ""; # no error # complain instead?
1944 # handle the case of setting a future unsuspend (resume) date
1945 # and do not continue to actually unsuspend the package
1946 my $date = $opt{'date'};
1947 if ( $date and $date > time ) { # return an error if $date <= time?
1949 if ( $old->get('expire') && $old->get('expire') < $date ) {
1950 $dbh->rollback if $oldAutoCommit;
1951 return "Package $pkgnum expires before it would be unsuspended.";
1954 my $new = new FS::cust_pkg { $self->hash };
1955 $new->set('resume', $date);
1956 $error = $new->replace($self, options => $self->options);
1959 $dbh->rollback if $oldAutoCommit;
1963 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1969 if (!$self->setup) {
1970 # then this package is being released from on-hold status
1971 $self->set_initial_timers;
1976 foreach my $cust_svc (
1977 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1979 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1981 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1982 $dbh->rollback if $oldAutoCommit;
1983 return "Illegal svcdb value in part_svc!";
1986 require "FS/$svcdb.pm";
1988 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1990 $error = $svc->unsuspend;
1992 $dbh->rollback if $oldAutoCommit;
1995 my( $label, $value ) = $cust_svc->label;
1996 push @labels, "$label: $value";
2001 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
2002 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
2004 my %hash = $self->hash;
2005 my $inactive = time - $hash{'susp'};
2007 my $conf = new FS::Conf;
2009 # increment next bill date if certain conditions are met:
2010 # - it was due to be billed at some point
2011 # - either the global or local config says to do this
2012 my $adjust_bill = 0;
2015 && ( $hash{'bill'} || $hash{'setup'} )
2016 && ( $opt{'adjust_next_bill'}
2017 || $conf->exists('unsuspend-always_adjust_next_bill_date')
2018 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
2025 # - the package billed during suspension
2026 # - or it was ordered on hold
2027 # - or the customer was credited for the unused time
2029 if ( $self->option('suspend_bill',1)
2030 or ( $self->part_pkg->option('suspend_bill',1)
2031 and ! $self->option('no_suspend_bill',1)
2033 or $hash{'order_date'} == $hash{'susp'}
2038 if ( $adjust_bill ) {
2039 if ( $self->part_pkg->option('unused_credit_suspend')
2040 or ( $reason and $reason->unused_credit ) ) {
2041 # then the customer was credited for the unused time before suspending,
2042 # so their next bill should be immediate.
2043 $hash{'bill'} = time;
2045 # add the length of time suspended to the bill date
2046 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
2051 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
2052 $hash{'resume'} = '' if !$hash{'adjourn'};
2053 my $new = new FS::cust_pkg ( \%hash );
2054 $error = $new->replace( $self, options => { $self->options } );
2056 $dbh->rollback if $oldAutoCommit;
2063 if ( $reason->unsuspend_pkgpart ) {
2064 #warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n"; # in 4.x
2065 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
2066 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
2068 my $start_date = $self->cust_main->next_bill_date
2069 if $reason->unsuspend_hold;
2072 $unsusp_pkg = FS::cust_pkg->new({
2073 'custnum' => $self->custnum,
2074 'pkgpart' => $reason->unsuspend_pkgpart,
2075 'start_date' => $start_date,
2076 'locationnum' => $self->locationnum,
2077 # discount? probably not...
2080 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
2083 # new way, using fees
2084 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
2085 # register the need to charge a fee, cust_main->bill will do the rest
2086 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
2088 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
2089 'pkgreasonnum' => $cust_pkg_reason->num,
2090 'pkgnum' => $self->pkgnum,
2091 'feepart' => $reason->feepart,
2092 'nextbill' => $reason->fee_hold,
2094 $error ||= $cust_pkg_reason_fee->insert;
2098 $dbh->rollback if $oldAutoCommit;
2103 if ( $conf->config('unsuspend_email_admin') ) {
2105 my $error = send_email(
2106 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2107 #invoice_from ??? well as good as any
2108 'to' => $conf->config('unsuspend_email_admin'),
2109 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2110 "This is an automatic message from your Freeside installation\n",
2111 "informing you that the following customer package has been unsuspended:\n",
2113 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2114 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2115 ( map { "Service : $_\n" } @labels ),
2117 "An unsuspension fee was charged: ".
2118 $unsusp_pkg->part_pkg->pkg_comment."\n"
2122 'custnum' => $self->custnum,
2123 'msgtype' => 'admin',
2127 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2133 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2134 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2136 $dbh->rollback if $oldAutoCommit;
2137 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2148 Cancels any pending suspension (sets the adjourn field to null)
2149 for this package and any supplemental packages.
2151 If there is an error, returns the error, otherwise returns false.
2159 local $SIG{HUP} = 'IGNORE';
2160 local $SIG{INT} = 'IGNORE';
2161 local $SIG{QUIT} = 'IGNORE';
2162 local $SIG{TERM} = 'IGNORE';
2163 local $SIG{TSTP} = 'IGNORE';
2164 local $SIG{PIPE} = 'IGNORE';
2166 my $oldAutoCommit = $FS::UID::AutoCommit;
2167 local $FS::UID::AutoCommit = 0;
2170 my $old = $self->select_for_update;
2172 my $pkgnum = $old->pkgnum;
2173 if ( $old->get('cancel') || $self->get('cancel') ) {
2174 dbh->rollback if $oldAutoCommit;
2175 return "Can't unadjourn cancelled package $pkgnum";
2176 # or at least it's pointless
2179 if ( $old->get('susp') || $self->get('susp') ) {
2180 dbh->rollback if $oldAutoCommit;
2181 return "Can't unadjourn suspended package $pkgnum";
2182 # perhaps this is arbitrary
2185 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2186 dbh->rollback if $oldAutoCommit;
2187 return ""; # no error
2190 my %hash = $self->hash;
2191 $hash{'adjourn'} = '';
2192 $hash{'resume'} = '';
2193 my $new = new FS::cust_pkg ( \%hash );
2194 $error = $new->replace( $self, options => { $self->options } );
2196 $dbh->rollback if $oldAutoCommit;
2200 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2201 $error = $supp_pkg->unadjourn;
2203 $dbh->rollback if $oldAutoCommit;
2204 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2208 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2215 =item change HASHREF | OPTION => VALUE ...
2217 Changes this package: cancels it and creates a new one, with a different
2218 pkgpart or locationnum or both. All services are transferred to the new
2219 package (no change will be made if this is not possible).
2221 Options may be passed as a list of key/value pairs or as a hash reference.
2228 New locationnum, to change the location for this package.
2232 New FS::cust_location object, to create a new location and assign it
2237 New FS::cust_main object, to create a new customer and assign the new package
2242 New pkgpart (see L<FS::part_pkg>).
2246 New refnum (see L<FS::part_referral>).
2250 New quantity; if unspecified, the new package will have the same quantity
2255 "New" (existing) FS::cust_pkg object. The package's services and other
2256 attributes will be transferred to this package.
2260 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2261 susp, adjourn, cancel, expire, and contract_end) to the new package.
2263 =item unprotect_svcs
2265 Normally, change() will rollback and return an error if some services
2266 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2267 If unprotect_svcs is true, this method will transfer as many services as
2268 it can and then unconditionally cancel the old package.
2272 If specified, sets this value for the contract_end date on the new package
2273 (without regard for keep_dates or the usual date-preservation behavior.)
2274 Will throw an error if defined but false; the UI doesn't allow editing
2275 this unless it already exists, making removal impossible to undo.
2279 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2280 cust_pkg must be specified (otherwise, what's the point?)
2282 Returns either the new FS::cust_pkg object or a scalar error.
2286 my $err_or_new_cust_pkg = $old_cust_pkg->change
2290 #used by change and change_later
2291 #didn't put with documented check methods because it depends on change-specific opts
2292 #and it also possibly edits the value of opts
2296 if ( defined($opt->{'contract_end'}) ) {
2297 my $current_contract_end = $self->get('contract_end');
2298 unless ($opt->{'contract_end'}) {
2299 if ($current_contract_end) {
2300 return "Cannot remove contract end date when changing packages";
2302 #shouldn't even pass this option if there's not a current value
2303 #but can be handled gracefully if the option is empty
2304 warn "Contract end date passed unexpectedly";
2305 delete $opt->{'contract_end'};
2309 unless ($current_contract_end) {
2310 #option shouldn't be passed, throw error if it's non-empty
2311 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2317 #some false laziness w/order
2320 my $opt = ref($_[0]) ? shift : { @_ };
2322 my $conf = new FS::Conf;
2324 # handle contract_end on cust_pkg same as passed option
2325 if ( $opt->{'cust_pkg'} ) {
2326 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2327 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2330 # check contract_end, prevent adding/removing
2331 my $error = $self->_check_change($opt);
2332 return $error if $error;
2334 # Transactionize this whole mess
2335 local $SIG{HUP} = 'IGNORE';
2336 local $SIG{INT} = 'IGNORE';
2337 local $SIG{QUIT} = 'IGNORE';
2338 local $SIG{TERM} = 'IGNORE';
2339 local $SIG{TSTP} = 'IGNORE';
2340 local $SIG{PIPE} = 'IGNORE';
2342 my $oldAutoCommit = $FS::UID::AutoCommit;
2343 local $FS::UID::AutoCommit = 0;
2346 if ( $opt->{'cust_location'} ) {
2347 $error = $opt->{'cust_location'}->find_or_insert;
2349 $dbh->rollback if $oldAutoCommit;
2350 return "creating location record: $error";
2352 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2355 # figure out if we're changing pkgpart
2356 if ( $opt->{'cust_pkg'} ) {
2357 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2360 # whether to override pkgpart checking on the new package
2361 my $same_pkgpart = 1;
2362 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2366 # Before going any further here: if the package is still in the pre-setup
2367 # state, it's safe to modify it in place. No need to charge/credit for
2368 # partial period, transfer usage pools, copy invoice details, or change any
2369 # dates. We DO need to "transfer" services (from the package to itself) to
2370 # check their validity on the new pkgpart.
2371 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2372 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2373 if ( length($opt->{$_}) ) {
2374 $self->set($_, $opt->{$_});
2377 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2379 if ( !$same_pkgpart ) {
2380 $self->set_initial_timers;
2382 # but if contract_end was explicitly specified, that overrides all else
2383 $self->set('contract_end', $opt->{'contract_end'})
2384 if $opt->{'contract_end'};
2386 $error = $self->replace;
2388 $dbh->rollback if $oldAutoCommit;
2389 return "modifying package: $error";
2392 # check/convert services (only on pkgpart change, to avoid surprises
2393 # when editing locations)
2394 # (maybe do this if changing quantity?)
2395 if ( !$same_pkgpart ) {
2397 $error = $self->transfer($self);
2399 if ( $error and $error == 0 ) {
2400 $error = "transferring $error";
2401 } elsif ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2402 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2403 $error = $self->transfer($self, 'change_svcpart'=>1 );
2404 if ($error and $error == 0) {
2405 $error = "converting $error";
2410 $error = "unable to transfer all services";
2414 $dbh->rollback if $oldAutoCommit;
2418 } # done transferring services
2420 $dbh->commit if $oldAutoCommit;
2429 $hash{'setup'} = $time if $self->get('setup');
2431 $hash{'change_date'} = $time;
2432 $hash{"change_$_"} = $self->$_()
2433 foreach qw( pkgnum pkgpart locationnum );
2435 my $unused_credit = 0;
2436 my $keep_dates = $opt->{'keep_dates'};
2438 # Special case. If the pkgpart is changing, and the customer is going to be
2439 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2440 # and DO pass the flag to cancel() to credit the customer. If the old
2441 # package had a setup date, set the new package's setup to the package
2442 # change date so that it has the same status as before.
2443 if ( $opt->{'pkgpart'}
2444 and $opt->{'pkgpart'} != $self->pkgpart
2445 and $self->part_pkg->option('unused_credit_change', 1) ) {
2448 $hash{'last_bill'} = '';
2452 if ( $keep_dates ) {
2453 foreach my $date ( qw(setup bill last_bill) ) {
2454 $hash{$date} = $self->getfield($date);
2457 # always keep the following dates
2458 foreach my $date (qw(order_date susp adjourn cancel expire resume
2459 start_date contract_end)) {
2460 $hash{$date} = $self->getfield($date);
2462 # but if contract_end was explicitly specified, that overrides all else
2463 $hash{'contract_end'} = $opt->{'contract_end'}
2464 if $opt->{'contract_end'};
2466 # allow $opt->{'locationnum'} = '' to specifically set it to null
2467 # (i.e. customer default location)
2468 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2470 # usually this doesn't matter. the two cases where it does are:
2471 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2473 # 2. (more importantly) changing a package before it's billed
2474 $hash{'waive_setup'} = $self->waive_setup;
2476 # if this package is scheduled for a future package change, preserve that
2477 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2479 my $custnum = $self->custnum;
2480 if ( $opt->{cust_main} ) {
2481 my $cust_main = $opt->{cust_main};
2482 unless ( $cust_main->custnum ) {
2483 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2485 $dbh->rollback if $oldAutoCommit;
2486 return "inserting customer record: $error";
2489 $custnum = $cust_main->custnum;
2492 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2495 if ( $opt->{'cust_pkg'} ) {
2496 # The target package already exists; update it to show that it was
2497 # changed from this package.
2498 $cust_pkg = $opt->{'cust_pkg'};
2500 # follow all the above rules for date changes, etc.
2501 foreach (keys %hash) {
2502 $cust_pkg->set($_, $hash{$_});
2504 # except those that implement the future package change behavior
2505 foreach (qw(change_to_pkgnum start_date expire)) {
2506 $cust_pkg->set($_, '');
2509 $error = $cust_pkg->replace;
2512 # Create the new package.
2513 $cust_pkg = new FS::cust_pkg {
2514 custnum => $custnum,
2515 locationnum => $opt->{'locationnum'},
2516 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2517 qw( pkgpart quantity refnum salesnum )
2521 $error = $cust_pkg->insert( 'change' => 1,
2522 'allow_pkgpart' => $same_pkgpart );
2525 $dbh->rollback if $oldAutoCommit;
2526 return "inserting new package: $error";
2529 # Transfer services and cancel old package.
2530 # Enforce service limits only if this is a pkgpart change.
2531 local $FS::cust_svc::ignore_quantity;
2532 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2533 $error = $self->transfer($cust_pkg);
2534 if ($error and $error == 0) {
2535 # $old_pkg->transfer failed.
2536 $dbh->rollback if $oldAutoCommit;
2537 return "transferring $error";
2540 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2541 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2542 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2543 if ($error and $error == 0) {
2544 # $old_pkg->transfer failed.
2545 $dbh->rollback if $oldAutoCommit;
2546 return "converting $error";
2550 # We set unprotect_svcs when executing a "future package change". It's
2551 # not a user-interactive operation, so returning an error means the
2552 # package change will just fail. Rather than have that happen, we'll
2553 # let leftover services be deleted.
2554 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2555 # Transfers were successful, but we still had services left on the old
2556 # package. We can't change the package under this circumstances, so abort.
2557 $dbh->rollback if $oldAutoCommit;
2558 return "unable to transfer all services";
2561 #reset usage if changing pkgpart
2562 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2563 if ($self->pkgpart != $cust_pkg->pkgpart) {
2564 my $part_pkg = $cust_pkg->part_pkg;
2565 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2569 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2572 $dbh->rollback if $oldAutoCommit;
2573 return "setting usage values: $error";
2576 # if NOT changing pkgpart, transfer any usage pools over
2577 foreach my $usage ($self->cust_pkg_usage) {
2578 $usage->set('pkgnum', $cust_pkg->pkgnum);
2579 $error = $usage->replace;
2581 $dbh->rollback if $oldAutoCommit;
2582 return "transferring usage pools: $error";
2587 # transfer discounts, if we're not changing pkgpart
2588 if ( $same_pkgpart ) {
2589 foreach my $old_discount ($self->cust_pkg_discount_active) {
2590 # don't remove the old discount, we may still need to bill that package.
2591 my $new_discount = new FS::cust_pkg_discount {
2592 'pkgnum' => $cust_pkg->pkgnum,
2593 'discountnum' => $old_discount->discountnum,
2594 'months_used' => $old_discount->months_used,
2596 $error = $new_discount->insert;
2598 $dbh->rollback if $oldAutoCommit;
2599 return "transferring discounts: $error";
2604 # transfer (copy) invoice details
2605 foreach my $detail ($self->cust_pkg_detail) {
2606 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2607 $new_detail->set('pkgdetailnum', '');
2608 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2609 $error = $new_detail->insert;
2611 $dbh->rollback if $oldAutoCommit;
2612 return "transferring package notes: $error";
2616 # transfer scheduled expire/adjourn reasons
2617 foreach my $action ('expire', 'adjourn') {
2618 if ( $cust_pkg->get($action) ) {
2619 my $reason = $self->last_cust_pkg_reason($action);
2621 $reason->set('pkgnum', $cust_pkg->pkgnum);
2622 $error = $reason->replace;
2624 $dbh->rollback if $oldAutoCommit;
2625 return "transferring $action reason: $error";
2633 if ( !$opt->{'cust_pkg'} ) {
2634 # Order any supplemental packages.
2635 my $part_pkg = $cust_pkg->part_pkg;
2636 my @old_supp_pkgs = $self->supplemental_pkgs;
2637 foreach my $link ($part_pkg->supp_part_pkg_link) {
2639 foreach (@old_supp_pkgs) {
2640 if ($_->pkgpart == $link->dst_pkgpart) {
2642 $_->pkgpart(0); # so that it can't match more than once
2646 # false laziness with FS::cust_main::Packages::order_pkg
2647 my $new = FS::cust_pkg->new({
2648 pkgpart => $link->dst_pkgpart,
2649 pkglinknum => $link->pkglinknum,
2650 custnum => $custnum,
2651 main_pkgnum => $cust_pkg->pkgnum,
2652 locationnum => $cust_pkg->locationnum,
2653 start_date => $cust_pkg->start_date,
2654 order_date => $cust_pkg->order_date,
2655 expire => $cust_pkg->expire,
2656 adjourn => $cust_pkg->adjourn,
2657 contract_end => $cust_pkg->contract_end,
2658 refnum => $cust_pkg->refnum,
2659 discountnum => $cust_pkg->discountnum,
2660 waive_setup => $cust_pkg->waive_setup,
2662 if ( $old and $opt->{'keep_dates'} ) {
2663 foreach (qw(setup bill last_bill)) {
2664 $new->set($_, $old->get($_));
2667 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2670 $error ||= $old->transfer($new);
2672 if ( $error and $error > 0 ) {
2673 # no reason why this should ever fail, but still...
2674 $error = "Unable to transfer all services from supplemental package ".
2678 $dbh->rollback if $oldAutoCommit;
2681 push @new_supp_pkgs, $new;
2683 } # if !$opt->{'cust_pkg'}
2684 # because if there is one, then supplemental packages would already
2685 # have been created for it.
2687 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2689 #Don't allow billing the package (preceding period packages and/or
2690 #outstanding usage) if we are keeping dates (i.e. location changing),
2691 #because the new package will be billed for the same date range.
2692 #Supplemental packages are also canceled here.
2694 # during scheduled changes, avoid canceling the package we just
2696 $self->set('change_to_pkgnum' => '');
2698 $error = $self->cancel(
2700 unused_credit => $unused_credit,
2701 nobill => $keep_dates,
2702 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2703 no_delay_cancel => 1,
2706 $dbh->rollback if $oldAutoCommit;
2707 return "canceling old package: $error";
2710 # transfer rt_field_charge, if we're not changing pkgpart
2711 # after billing of old package, before billing of new package
2712 if ( $same_pkgpart ) {
2713 foreach my $rt_field_charge ($self->rt_field_charge) {
2714 $rt_field_charge->set('pkgnum', $cust_pkg->pkgnum);
2715 $error = $rt_field_charge->replace;
2717 $dbh->rollback if $oldAutoCommit;
2718 return "transferring rt_field_charge: $error";
2723 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2725 my $error = $cust_pkg->cust_main->bill(
2726 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2729 $dbh->rollback if $oldAutoCommit;
2730 return "billing new package: $error";
2734 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2740 =item change_later OPTION => VALUE...
2742 Schedule a package change for a later date. This actually orders the new
2743 package immediately, but sets its start date for a future date, and sets
2744 the current package to expire on the same date.
2746 If the package is already scheduled for a change, this can be called with
2747 'start_date' to change the scheduled date, or with pkgpart and/or
2748 locationnum to modify the package change. To cancel the scheduled change
2749 entirely, see C<abort_change>.
2757 The date for the package change. Required, and must be in the future.
2767 The pkgpart, locationnum, quantity and optional contract_end of the new
2768 package, with the same meaning as in C<change>.
2776 my $opt = ref($_[0]) ? shift : { @_ };
2778 # check contract_end, prevent adding/removing
2779 my $error = $self->_check_change($opt);
2780 return $error if $error;
2782 my $oldAutoCommit = $FS::UID::AutoCommit;
2783 local $FS::UID::AutoCommit = 0;
2786 my $cust_main = $self->cust_main;
2788 my $date = delete $opt->{'start_date'} or return 'start_date required';
2790 if ( $date <= time ) {
2791 $dbh->rollback if $oldAutoCommit;
2792 return "start_date $date is in the past";
2795 # If the user entered a new location, set it up now.
2796 if ( $opt->{'cust_location'} ) {
2797 $error = $opt->{'cust_location'}->find_or_insert;
2799 $dbh->rollback if $oldAutoCommit;
2800 return "creating location record: $error";
2802 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2805 if ( $self->change_to_pkgnum ) {
2806 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2807 my $new_pkgpart = $opt->{'pkgpart'}
2808 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2809 my $new_locationnum = $opt->{'locationnum'}
2810 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2811 my $new_quantity = $opt->{'quantity'}
2812 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2813 my $new_contract_end = $opt->{'contract_end'}
2814 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2815 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2816 # it hasn't been billed yet, so in principle we could just edit
2817 # it in place (w/o a package change), but that's bad form.
2818 # So change the package according to the new options...
2819 my $err_or_pkg = $change_to->change(%$opt);
2820 if ( ref $err_or_pkg ) {
2821 # Then set that package up for a future start.
2822 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2823 $self->set('expire', $date); # in case it's different
2824 $err_or_pkg->set('start_date', $date);
2825 $err_or_pkg->set('change_date', '');
2826 $err_or_pkg->set('change_pkgnum', '');
2828 $error = $self->replace ||
2829 $err_or_pkg->replace ||
2830 #because change() might've edited existing scheduled change in place
2831 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2832 $change_to->cancel('no_delay_cancel' => 1) ||
2833 $change_to->delete);
2835 $error = $err_or_pkg;
2837 } else { # change the start date only.
2838 $self->set('expire', $date);
2839 $change_to->set('start_date', $date);
2840 $error = $self->replace || $change_to->replace;
2843 $dbh->rollback if $oldAutoCommit;
2846 $dbh->commit if $oldAutoCommit;
2849 } # if $self->change_to_pkgnum
2851 my $new_pkgpart = $opt->{'pkgpart'}
2852 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2853 my $new_locationnum = $opt->{'locationnum'}
2854 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2855 my $new_quantity = $opt->{'quantity'}
2856 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2857 my $new_contract_end = $opt->{'contract_end'}
2858 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2860 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2862 # allow $opt->{'locationnum'} = '' to specifically set it to null
2863 # (i.e. customer default location)
2864 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2866 my $new = FS::cust_pkg->new( {
2867 custnum => $self->custnum,
2868 locationnum => $opt->{'locationnum'},
2869 start_date => $date,
2870 map { $_ => ( $opt->{$_} || $self->$_() ) }
2871 qw( pkgpart quantity refnum salesnum contract_end )
2873 $error = $new->insert('change' => 1,
2874 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2876 $self->set('change_to_pkgnum', $new->pkgnum);
2877 $self->set('expire', $date);
2878 $error = $self->replace;
2881 $dbh->rollback if $oldAutoCommit;
2883 $dbh->commit if $oldAutoCommit;
2891 Cancels a future package change scheduled by C<change_later>.
2897 my $pkgnum = $self->change_to_pkgnum;
2898 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2901 $error = $change_to->cancel || $change_to->delete;
2902 return $error if $error;
2904 $self->set('change_to_pkgnum', '');
2905 $self->set('expire', '');
2909 =item set_quantity QUANTITY
2911 Change the package's quantity field. This is one of the few package properties
2912 that can safely be changed without canceling and reordering the package
2913 (because it doesn't affect tax eligibility). Returns an error or an
2920 $self = $self->replace_old; # just to make sure
2921 $self->quantity(shift);
2925 =item set_salesnum SALESNUM
2927 Change the package's salesnum (sales person) field. This is one of the few
2928 package properties that can safely be changed without canceling and reordering
2929 the package (because it doesn't affect tax eligibility). Returns an error or
2936 $self = $self->replace_old; # just to make sure
2937 $self->salesnum(shift);
2939 # XXX this should probably reassign any credit that's already been given
2942 =item modify_charge OPTIONS
2944 Change the properties of a one-time charge. The following properties can
2945 be changed this way:
2946 - pkg: the package description
2947 - classnum: the package class
2948 - additional: arrayref of additional invoice details to add to this package
2950 and, I<if the charge has not yet been billed>:
2951 - start_date: the date when it will be billed
2952 - amount: the setup fee to be charged
2953 - quantity: the multiplier for the setup fee
2954 - separate_bill: whether to put the charge on a separate invoice
2956 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2957 commission credits linked to this charge, they will be recalculated.
2964 my $part_pkg = $self->part_pkg;
2965 my $pkgnum = $self->pkgnum;
2968 my $oldAutoCommit = $FS::UID::AutoCommit;
2969 local $FS::UID::AutoCommit = 0;
2971 return "Can't use modify_charge except on one-time charges"
2972 unless $part_pkg->freq eq '0';
2974 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2975 $part_pkg->set('pkg', $opt{'pkg'});
2978 my %pkg_opt = $part_pkg->options;
2979 my $pkg_opt_modified = 0;
2981 $opt{'additional'} ||= [];
2984 foreach (grep /^additional/, keys %pkg_opt) {
2985 ($i) = ($_ =~ /^additional_info(\d+)$/);
2986 $old_additional[$i] = $pkg_opt{$_} if $i;
2987 delete $pkg_opt{$_};
2990 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2991 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2992 if (!exists($old_additional[$i])
2993 or $old_additional[$i] ne $opt{'additional'}->[$i])
2995 $pkg_opt_modified = 1;
2998 $pkg_opt_modified = 1 if scalar(@old_additional) != $i;
2999 $pkg_opt{'additional_count'} = $i if $i > 0;
3002 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
3005 $old_classnum = $part_pkg->classnum;
3006 $part_pkg->set('classnum', $opt{'classnum'});
3009 if ( !$self->get('setup') ) {
3010 # not yet billed, so allow amount, setup_cost, quantity, start_date,
3013 if ( exists($opt{'amount'})
3014 and $part_pkg->option('setup_fee') != $opt{'amount'}
3015 and $opt{'amount'} > 0 ) {
3017 $pkg_opt{'setup_fee'} = $opt{'amount'};
3018 $pkg_opt_modified = 1;
3021 if ( exists($opt{'setup_cost'})
3022 and $part_pkg->setup_cost != $opt{'setup_cost'}
3023 and $opt{'setup_cost'} > 0 ) {
3025 $part_pkg->set('setup_cost', $opt{'setup_cost'});
3028 if ( exists($opt{'quantity'})
3029 and $opt{'quantity'} != $self->quantity
3030 and $opt{'quantity'} > 0 ) {
3032 $self->set('quantity', $opt{'quantity'});
3035 if ( exists($opt{'start_date'})
3036 and $opt{'start_date'} != $self->start_date ) {
3038 $self->set('start_date', $opt{'start_date'});
3041 if ( exists($opt{'separate_bill'})
3042 and $opt{'separate_bill'} ne $self->separate_bill ) {
3044 $self->set('separate_bill', $opt{'separate_bill'});
3048 } # else simply ignore them; the UI shouldn't allow editing the fields
3050 if ( exists($opt{'taxclass'})
3051 and $part_pkg->taxclass ne $opt{'taxclass'}) {
3053 $part_pkg->set('taxclass', $opt{'taxclass'});
3057 if ( $part_pkg->modified or $pkg_opt_modified ) {
3058 # can we safely modify the package def?
3059 # Yes, if it's not available for purchase, and this is the only instance
3061 if ( $part_pkg->disabled
3062 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
3063 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
3065 $error = $part_pkg->replace( options => \%pkg_opt );
3068 $part_pkg = $part_pkg->clone;
3069 $part_pkg->set('disabled' => 'Y');
3070 $error = $part_pkg->insert( options => \%pkg_opt );
3071 # and associate this as yet-unbilled package to the new package def
3072 $self->set('pkgpart' => $part_pkg->pkgpart);
3075 $dbh->rollback if $oldAutoCommit;
3080 if ($self->modified) { # for quantity or start_date change, or if we had
3081 # to clone the existing package def
3082 my $error = $self->replace;
3083 return $error if $error;
3085 if (defined $old_classnum) {
3086 # fix invoice grouping records
3087 my $old_catname = $old_classnum
3088 ? FS::pkg_class->by_key($old_classnum)->categoryname
3090 my $new_catname = $opt{'classnum'}
3091 ? $part_pkg->pkg_class->categoryname
3093 if ( $old_catname ne $new_catname ) {
3094 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
3095 # (there should only be one...)
3096 my @display = qsearch( 'cust_bill_pkg_display', {
3097 'billpkgnum' => $cust_bill_pkg->billpkgnum,
3098 'section' => $old_catname,
3100 foreach (@display) {
3101 $_->set('section', $new_catname);
3102 $error = $_->replace;
3104 $dbh->rollback if $oldAutoCommit;
3108 } # foreach $cust_bill_pkg
3111 if ( $opt{'adjust_commission'} ) {
3112 # fix commission credits...tricky.
3113 foreach my $cust_event ($self->cust_event) {
3114 my $part_event = $cust_event->part_event;
3115 foreach my $table (qw(sales agent)) {
3117 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3118 my $credit = qsearchs('cust_credit', {
3119 'eventnum' => $cust_event->eventnum,
3121 if ( $part_event->isa($class) ) {
3122 # Yes, this results in current commission rates being applied
3123 # retroactively to a one-time charge. For accounting purposes
3124 # there ought to be some kind of time limit on doing this.
3125 my $amount = $part_event->_calc_credit($self);
3126 if ( $credit and $credit->amount ne $amount ) {
3127 # Void the old credit.
3128 $error = $credit->void('Package class changed');
3130 $dbh->rollback if $oldAutoCommit;
3131 return "$error (adjusting commission credit)";
3134 # redo the event action to recreate the credit.
3136 eval { $part_event->do_action( $self, $cust_event ) };
3138 $dbh->rollback if $oldAutoCommit;
3141 } # if $part_event->isa($class)
3143 } # foreach $cust_event
3144 } # if $opt{'adjust_commission'}
3145 } # if defined $old_classnum
3147 $dbh->commit if $oldAutoCommit;
3151 use Storable 'thaw';
3154 sub process_bulk_cust_pkg {
3156 my $param = thaw(decode_base64(shift));
3157 warn Dumper($param) if $DEBUG;
3159 my $old_part_pkg = qsearchs('part_pkg',
3160 { pkgpart => $param->{'old_pkgpart'} });
3161 my $new_part_pkg = qsearchs('part_pkg',
3162 { pkgpart => $param->{'new_pkgpart'} });
3163 die "Must select a new package type\n" unless $new_part_pkg;
3164 #my $keep_dates = $param->{'keep_dates'} || 0;
3165 my $keep_dates = 1; # there is no good reason to turn this off
3167 local $SIG{HUP} = 'IGNORE';
3168 local $SIG{INT} = 'IGNORE';
3169 local $SIG{QUIT} = 'IGNORE';
3170 local $SIG{TERM} = 'IGNORE';
3171 local $SIG{TSTP} = 'IGNORE';
3172 local $SIG{PIPE} = 'IGNORE';
3174 my $oldAutoCommit = $FS::UID::AutoCommit;
3175 local $FS::UID::AutoCommit = 0;
3178 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3181 foreach my $old_cust_pkg ( @cust_pkgs ) {
3183 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3184 if ( $old_cust_pkg->getfield('cancel') ) {
3185 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3186 $old_cust_pkg->pkgnum."\n"
3190 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3192 my $error = $old_cust_pkg->change(
3193 'pkgpart' => $param->{'new_pkgpart'},
3194 'keep_dates' => $keep_dates
3196 if ( !ref($error) ) { # change returns the cust_pkg on success
3198 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3201 $dbh->commit if $oldAutoCommit;
3207 Returns the last bill date, or if there is no last bill date, the setup date.
3208 Useful for billing metered services.
3214 return $self->setfield('last_bill', $_[0]) if @_;
3215 return $self->getfield('last_bill') if $self->getfield('last_bill');
3216 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3217 'edate' => $self->bill, } );
3218 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3221 =item last_cust_pkg_reason ACTION
3223 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3224 Returns false if there is no reason or the package is not currenly ACTION'd
3225 ACTION is one of adjourn, susp, cancel, or expire.
3229 sub last_cust_pkg_reason {
3230 my ( $self, $action ) = ( shift, shift );
3231 my $date = $self->get($action);
3233 'table' => 'cust_pkg_reason',
3234 'hashref' => { 'pkgnum' => $self->pkgnum,
3235 'action' => substr(uc($action), 0, 1),
3238 'order_by' => 'ORDER BY num DESC LIMIT 1',
3242 =item last_reason ACTION
3244 Returns the most recent ACTION FS::reason associated with the package.
3245 Returns false if there is no reason or the package is not currenly ACTION'd
3246 ACTION is one of adjourn, susp, cancel, or expire.
3251 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3252 $cust_pkg_reason->reason
3253 if $cust_pkg_reason;
3258 Returns the definition for this billing item, as an FS::part_pkg object (see
3265 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3266 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3267 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3272 Returns the cancelled package this package was changed from, if any.
3278 return '' unless $self->change_pkgnum;
3279 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3282 =item change_cust_main
3284 Returns the customter this package was detached to, if any.
3288 sub change_cust_main {
3290 return '' unless $self->change_custnum;
3291 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3296 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3303 $self->part_pkg->calc_setup($self, @_);
3308 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3315 $self->part_pkg->calc_recur($self, @_);
3320 Returns the base setup fee (per unit) of this package, from the package
3325 # minimal version for 3.x; in 4.x this can invoke currency conversion
3329 $self->part_pkg->unit_setup($self);
3334 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3341 $self->part_pkg->base_recur($self, @_);
3346 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3353 $self->part_pkg->calc_remain($self, @_);
3358 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3365 $self->part_pkg->calc_cancel($self, @_);
3370 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3376 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3379 =item cust_pkg_detail [ DETAILTYPE ]
3381 Returns any customer package details for this package (see
3382 L<FS::cust_pkg_detail>).
3384 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3388 sub cust_pkg_detail {
3390 my %hash = ( 'pkgnum' => $self->pkgnum );
3391 $hash{detailtype} = shift if @_;
3393 'table' => 'cust_pkg_detail',
3394 'hashref' => \%hash,
3395 'order_by' => 'ORDER BY weight, pkgdetailnum',
3399 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3401 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3403 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3405 If there is an error, returns the error, otherwise returns false.
3409 sub set_cust_pkg_detail {
3410 my( $self, $detailtype, @details ) = @_;
3412 local $SIG{HUP} = 'IGNORE';
3413 local $SIG{INT} = 'IGNORE';
3414 local $SIG{QUIT} = 'IGNORE';
3415 local $SIG{TERM} = 'IGNORE';
3416 local $SIG{TSTP} = 'IGNORE';
3417 local $SIG{PIPE} = 'IGNORE';
3419 my $oldAutoCommit = $FS::UID::AutoCommit;
3420 local $FS::UID::AutoCommit = 0;
3423 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3424 my $error = $current->delete;
3426 $dbh->rollback if $oldAutoCommit;
3427 return "error removing old detail: $error";
3431 foreach my $detail ( @details ) {
3432 my $cust_pkg_detail = new FS::cust_pkg_detail {
3433 'pkgnum' => $self->pkgnum,
3434 'detailtype' => $detailtype,
3435 'detail' => $detail,
3437 my $error = $cust_pkg_detail->insert;
3439 $dbh->rollback if $oldAutoCommit;
3440 return "error adding new detail: $error";
3445 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3452 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3456 #false laziness w/cust_bill.pm
3460 'table' => 'cust_event',
3461 'addl_from' => 'JOIN part_event USING ( eventpart )',
3462 'hashref' => { 'tablenum' => $self->pkgnum },
3463 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3467 =item num_cust_event
3469 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3473 #false laziness w/cust_bill.pm
3474 sub num_cust_event {
3476 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3477 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3480 =item exists_cust_event
3482 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3486 sub exists_cust_event {
3488 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3489 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3490 $row ? $row->[0] : '';
3493 sub _from_cust_event_where {
3495 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3496 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3500 my( $self, $sql, @args ) = @_;
3501 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3502 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3506 =item cust_svc [ SVCPART ] (old, deprecated usage)
3508 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3510 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3512 Returns the services for this package, as FS::cust_svc objects (see
3513 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3514 spcififed, returns only the matching services.
3516 As an optimization, use the cust_svc_unsorted version if you are not displaying
3523 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3524 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3527 sub cust_svc_unsorted {
3529 @{ $self->cust_svc_unsorted_arrayref(@_) };
3532 sub cust_svc_unsorted_arrayref {
3535 return [] unless $self->num_cust_svc(@_);
3538 if ( @_ && $_[0] =~ /^\d+/ ) {
3539 $opt{svcpart} = shift;
3540 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3547 'select' => 'cust_svc.*, part_svc.*',
3548 'table' => 'cust_svc',
3549 'hashref' => { 'pkgnum' => $self->pkgnum },
3550 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3552 $search{hashref}->{svcpart} = $opt{svcpart}
3554 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3557 [ qsearch(\%search) ];
3561 =item overlimit [ SVCPART ]
3563 Returns the services for this package which have exceeded their
3564 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3565 is specified, return only the matching services.
3571 return () unless $self->num_cust_svc(@_);
3572 grep { $_->overlimit } $self->cust_svc(@_);
3575 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3577 Returns historical services for this package created before END TIMESTAMP and
3578 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3579 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3580 I<pkg_svc.hidden> flag will be omitted.
3586 warn "$me _h_cust_svc called on $self\n"
3589 my ($end, $start, $mode) = @_;
3590 my @cust_svc = $self->_sort_cust_svc(
3591 [ qsearch( 'h_cust_svc',
3592 { 'pkgnum' => $self->pkgnum, },
3593 FS::h_cust_svc->sql_h_search(@_),
3596 if ( defined($mode) && $mode eq 'I' ) {
3597 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3598 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3604 sub _sort_cust_svc {
3605 my( $self, $arrayref ) = @_;
3608 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3610 my %pkg_svc = map { $_->svcpart => $_ }
3611 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3616 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3618 $pkg_svc ? $pkg_svc->primary_svc : '',
3619 $pkg_svc ? $pkg_svc->quantity : 0,
3626 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3628 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3630 Returns the number of services for this package. Available options are svcpart
3631 and svcdb. If either is spcififed, returns only the matching services.
3638 return $self->{'_num_cust_svc'}
3640 && exists($self->{'_num_cust_svc'})
3641 && $self->{'_num_cust_svc'} =~ /\d/;
3643 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3647 if ( @_ && $_[0] =~ /^\d+/ ) {
3648 $opt{svcpart} = shift;
3649 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3655 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3656 my $where = ' WHERE pkgnum = ? ';
3657 my @param = ($self->pkgnum);
3659 if ( $opt{'svcpart'} ) {
3660 $where .= ' AND svcpart = ? ';
3661 push @param, $opt{'svcpart'};
3663 if ( $opt{'svcdb'} ) {
3664 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3665 $where .= ' AND svcdb = ? ';
3666 push @param, $opt{'svcdb'};
3669 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3670 $sth->execute(@param) or die $sth->errstr;
3671 $sth->fetchrow_arrayref->[0];
3674 =item available_part_svc
3676 Returns a list of FS::part_svc objects representing services included in this
3677 package but not yet provisioned. Each FS::part_svc object also has an extra
3678 field, I<num_avail>, which specifies the number of available services.
3680 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3681 associated pkg_svc has the provision_hold flag set.
3685 sub available_part_svc {
3689 my $pkg_quantity = $self->quantity || 1;
3691 grep { $_->num_avail > 0 }
3693 my $part_svc = $_->part_svc;
3694 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3695 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3697 # more evil encapsulation breakage
3698 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3699 my @exports = $part_svc->part_export_did;
3700 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3705 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3706 $self->part_pkg->pkg_svc;
3709 =item part_svc [ OPTION => VALUE ... ]
3711 Returns a list of FS::part_svc objects representing provisioned and available
3712 services included in this package. Each FS::part_svc object also has the
3713 following extra fields:
3727 (services) - array reference containing the provisioned services, as cust_svc objects
3731 Accepts two options:
3735 =item summarize_size
3737 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3738 is this size or greater.
3740 =item hide_discontinued
3742 If true, will omit looking for services that are no longer avaialble in the
3750 #label -> ($cust_svc->label)[1]
3756 my $pkg_quantity = $self->quantity || 1;
3758 #XXX some sort of sort order besides numeric by svcpart...
3759 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3761 my $part_svc = $pkg_svc->part_svc;
3762 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3763 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3764 $part_svc->{'Hash'}{'num_avail'} =
3765 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3766 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3767 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3768 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3769 && $num_cust_svc >= $opt{summarize_size};
3770 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3772 } $self->part_pkg->pkg_svc;
3774 unless ( $opt{hide_discontinued} ) {
3776 push @part_svc, map {
3778 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3779 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3780 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3781 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3782 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3784 } $self->extra_part_svc;
3791 =item extra_part_svc
3793 Returns a list of FS::part_svc objects corresponding to services in this
3794 package which are still provisioned but not (any longer) available in the
3799 sub extra_part_svc {
3802 my $pkgnum = $self->pkgnum;
3803 #my $pkgpart = $self->pkgpart;
3806 # 'table' => 'part_svc',
3809 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3810 # WHERE pkg_svc.svcpart = part_svc.svcpart
3811 # AND pkg_svc.pkgpart = ?
3814 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3815 # LEFT JOIN cust_pkg USING ( pkgnum )
3816 # WHERE cust_svc.svcpart = part_svc.svcpart
3819 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3822 #seems to benchmark slightly faster... (or did?)
3824 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3825 my $pkgparts = join(',', @pkgparts);
3828 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3829 #MySQL doesn't grok DISINCT ON
3830 'select' => 'DISTINCT part_svc.*',
3831 'table' => 'part_svc',
3833 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3834 AND pkg_svc.pkgpart IN ($pkgparts)
3837 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3838 LEFT JOIN cust_pkg USING ( pkgnum )
3841 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3842 'extra_param' => [ [$self->pkgnum=>'int'] ],
3848 Returns a short status string for this package, currently:
3854 =item not yet billed
3856 =item one-time charge
3871 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3873 return 'cancelled' if $self->get('cancel');
3874 return 'on hold' if $self->susp && ! $self->setup;
3875 return 'suspended' if $self->susp;
3876 return 'not yet billed' unless $self->setup;
3877 return 'one-time charge' if $freq =~ /^(0|$)/;
3881 =item ucfirst_status
3883 Returns the status with the first character capitalized.
3887 sub ucfirst_status {
3888 ucfirst(shift->status);
3893 Class method that returns the list of possible status strings for packages
3894 (see L<the status method|/status>). For example:
3896 @statuses = FS::cust_pkg->statuses();
3900 tie my %statuscolor, 'Tie::IxHash',
3901 'on hold' => 'FF00F5', #brighter purple!
3902 'not yet billed' => '009999', #teal? cyan?
3903 'one-time charge' => '0000CC', #blue #'000000',
3904 'active' => '00CC00',
3905 'suspended' => 'FF9900',
3906 'cancelled' => 'FF0000',
3910 my $self = shift; #could be class...
3911 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3912 # # mayble split btw one-time vs. recur
3923 Returns a hex triplet color string for this package's status.
3929 $statuscolor{$self->status};
3932 =item is_status_delay_cancel
3934 Returns true if part_pkg has option delay_cancel,
3935 cust_pkg status is 'suspended' and expire is set
3936 to cancel package within the next day (or however
3937 many days are set in global config part_pkg-delay_cancel-days.
3939 Accepts option I<part_pkg-delay_cancel-days> which should be
3940 the value of the config setting, to avoid looking it up again.
3942 This is not a real status, this only meant for hacking display
3943 values, because otherwise treating the package as suspended is
3944 really the whole point of the delay_cancel option.
3948 sub is_status_delay_cancel {
3949 my ($self,%opt) = @_;
3950 if ( $self->main_pkgnum and $self->pkglinknum ) {
3951 return $self->main_pkg->is_status_delay_cancel;
3953 return 0 unless $self->part_pkg->option('delay_cancel',1);
3954 return 0 unless $self->status eq 'suspended';
3955 return 0 unless $self->expire;
3956 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3958 my $conf = new FS::Conf;
3959 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3961 my $expsecs = 60*60*24*$expdays;
3962 return 0 unless $self->expire < time + $expsecs;
3968 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3969 "pkg - comment" depending on user preference).
3975 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3976 $label = $self->pkgnum. ": $label"
3977 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3981 =item pkg_label_long
3983 Returns a long label for this package, adding the primary service's label to
3988 sub pkg_label_long {
3990 my $label = $self->pkg_label;
3991 my $cust_svc = $self->primary_cust_svc;
3992 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3998 Returns a customer-localized label for this package.
4004 $self->part_pkg->pkg_locale( $self->cust_main->locale );
4007 =item primary_cust_svc
4009 Returns a primary service (as FS::cust_svc object) if one can be identified.
4013 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
4015 sub primary_cust_svc {
4018 my @cust_svc = $self->cust_svc;
4020 return '' unless @cust_svc; #no serivces - irrelevant then
4022 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
4024 # primary service as specified in the package definition
4025 # or exactly one service definition with quantity one
4026 my $svcpart = $self->part_pkg->svcpart;
4027 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
4028 return $cust_svc[0] if scalar(@cust_svc) == 1;
4030 #couldn't identify one thing..
4036 Returns a list of lists, calling the label method for all services
4037 (see L<FS::cust_svc>) of this billing item.
4043 map { [ $_->label ] } $self->cust_svc;
4046 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4048 Like the labels method, but returns historical information on services that
4049 were active as of END_TIMESTAMP and (optionally) not cancelled before
4050 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
4051 I<pkg_svc.hidden> flag will be omitted.
4053 If LOCALE is passed, service definition names will be localized.
4055 Returns a list of lists, calling the label method for all (historical)
4056 services (see L<FS::h_cust_svc>) of this billing item.
4062 my ($end, $start, $mode, $locale) = @_;
4063 warn "$me h_labels\n"
4065 map { [ $_->label($end, $start, $locale) ] }
4066 $self->h_cust_svc($end, $start, $mode);
4071 Like labels, except returns a simple flat list, and shortens long
4072 (currently >5 or the cust_bill-max_same_services configuration value) lists of
4073 identical services to one line that lists the service label and the number of
4074 individual services rather than individual items.
4079 shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
4082 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4084 Like h_labels, except returns a simple flat list, and shortens long
4085 (currently >5 or the cust_bill-max_same_services configuration value) lists
4086 of identical services to one line that lists the service label and the
4087 number of individual services rather than individual items.
4091 sub h_labels_short {
4092 shift->_labels_short( 'h_labels', @_ );
4095 # takes a method name ('labels' or 'h_labels') and all its arguments;
4096 # maybe should be "shorten($self->h_labels( ... ) )"
4099 my( $self, $method ) = ( shift, shift );
4101 warn "$me _labels_short called on $self with $method method\n"
4104 my $conf = new FS::Conf;
4105 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4107 warn "$me _labels_short populating \%labels\n"
4111 #tie %labels, 'Tie::IxHash';
4112 push @{ $labels{$_->[0]} }, $_->[1]
4113 foreach $self->$method(@_);
4115 warn "$me _labels_short populating \@labels\n"
4119 foreach my $label ( keys %labels ) {
4121 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4122 my $num = scalar(@values);
4123 warn "$me _labels_short $num items for $label\n"
4126 if ( $num > $max_same_services ) {
4127 warn "$me _labels_short more than $max_same_services, so summarizing\n"
4129 push @labels, "$label ($num)";
4131 if ( $conf->exists('cust_bill-consolidate_services') ) {
4132 warn "$me _labels_short consolidating services\n"
4134 # push @labels, "$label: ". join(', ', @values);
4136 my $detail = "$label: ";
4137 $detail .= shift(@values). ', '
4139 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4141 push @labels, $detail;
4143 warn "$me _labels_short done consolidating services\n"
4146 warn "$me _labels_short adding service data\n"
4148 push @labels, map { "$label: $_" } @values;
4159 Returns the parent customer object (see L<FS::cust_main>).
4165 cluck 'cust_pkg->cust_main called' if $DEBUG;
4166 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
4171 Returns the balance for this specific package, when using
4172 experimental package balance.
4178 $self->cust_main->balance_pkgnum( $self->pkgnum );
4181 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4185 Returns the location object, if any (see L<FS::cust_location>).
4187 =item cust_location_or_main
4189 If this package is associated with a location, returns the locaiton (see
4190 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4192 =item location_label [ OPTION => VALUE ... ]
4194 Returns the label of the location object (see L<FS::cust_location>).
4198 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4200 =item tax_locationnum
4202 Returns the foreign key to a L<FS::cust_location> object for calculating
4203 tax on this package, as determined by the C<tax-pkg_address> and
4204 C<tax-ship_address> configuration flags.
4208 sub tax_locationnum {
4210 my $conf = FS::Conf->new;
4211 if ( $conf->exists('tax-pkg_address') ) {
4212 return $self->locationnum;
4214 elsif ( $conf->exists('tax-ship_address') ) {
4215 return $self->cust_main->ship_locationnum;
4218 return $self->cust_main->bill_locationnum;
4224 Returns the L<FS::cust_location> object for tax_locationnum.
4230 my $conf = FS::Conf->new;
4231 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4232 return FS::cust_location->by_key($self->locationnum);
4234 elsif ( $conf->exists('tax-ship_address') ) {
4235 return $self->cust_main->ship_location;
4238 return $self->cust_main->bill_location;
4242 =item seconds_since TIMESTAMP
4244 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4245 package have been online since TIMESTAMP, according to the session monitor.
4247 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4248 L<Time::Local> and L<Date::Parse> for conversion functions.
4253 my($self, $since) = @_;
4256 foreach my $cust_svc (
4257 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4259 $seconds += $cust_svc->seconds_since($since);
4266 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4268 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4269 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4272 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4273 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4279 sub seconds_since_sqlradacct {
4280 my($self, $start, $end) = @_;
4284 foreach my $cust_svc (
4286 my $part_svc = $_->part_svc;
4287 $part_svc->svcdb eq 'svc_acct'
4288 && scalar($part_svc->part_export_usage);
4291 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4298 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4300 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4301 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4305 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4306 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4311 sub attribute_since_sqlradacct {
4312 my($self, $start, $end, $attrib) = @_;
4316 foreach my $cust_svc (
4318 my $part_svc = $_->part_svc;
4319 scalar($part_svc->part_export_usage);
4322 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4334 my( $self, $value ) = @_;
4335 if ( defined($value) ) {
4336 $self->setfield('quantity', $value);
4338 $self->getfield('quantity') || 1;
4341 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4343 Transfers as many services as possible from this package to another package.
4345 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4346 object. The destination package must already exist.
4348 Services are moved only if the destination allows services with the correct
4349 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4350 this option with caution! No provision is made for export differences
4351 between the old and new service definitions. Probably only should be used
4352 when your exports for all service definitions of a given svcdb are identical.
4353 (attempt a transfer without it first, to move all possible svcpart-matching
4356 Any services that can't be moved remain in the original package.
4358 Returns an error, if there is one; otherwise, returns the number of services
4359 that couldn't be moved.
4364 my ($self, $dest_pkgnum, %opt) = @_;
4370 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4371 $dest = $dest_pkgnum;
4372 $dest_pkgnum = $dest->pkgnum;
4374 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4377 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4379 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4380 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4383 unless ( $self->pkgnum == $dest->pkgnum ) {
4384 foreach my $cust_svc ($dest->cust_svc) {
4385 $target{$cust_svc->svcpart}--;
4389 my %svcpart2svcparts = ();
4390 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4391 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4392 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4393 next if exists $svcpart2svcparts{$svcpart};
4394 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4395 $svcpart2svcparts{$svcpart} = [
4397 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4399 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4400 'svcpart' => $_ } );
4402 $pkg_svc ? $pkg_svc->primary_svc : '',
4403 $pkg_svc ? $pkg_svc->quantity : 0,
4407 grep { $_ != $svcpart }
4409 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4411 warn "alternates for svcpart $svcpart: ".
4412 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4418 foreach my $cust_svc ($self->cust_svc) {
4419 my $svcnum = $cust_svc->svcnum;
4421 if ( $target{$cust_svc->svcpart} > 0
4422 or $FS::cust_svc::ignore_quantity # maybe should be a 'force' option
4425 $target{$cust_svc->svcpart}--;
4427 local $FS::cust_svc::ignore_quantity = 1
4428 if $self->pkgnum == $dest->pkgnum;
4430 #why run replace at all in the $self->pkgnum == $dest->pkgnum case?
4431 # we do want to trigger location and pkg_change exports, but
4432 # without pkgnum changing from an old to new package, cust_svc->replace
4433 # doesn't know how to trigger those. :/
4434 # does this mean we scrap the whole idea of "safe to modify it in place",
4435 # or do we special-case and pass the info needed to cust_svc->replace? :/
4437 my $new = new FS::cust_svc { $cust_svc->hash };
4438 $new->pkgnum($dest_pkgnum);
4439 $error = $new->replace($cust_svc);
4441 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4444 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4445 warn "alternates to consider: ".
4446 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4449 my @alternate = grep {
4450 warn "considering alternate svcpart $_: ".
4451 "$target{$_} available in new package\n"
4454 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4457 warn "alternate(s) found\n" if $DEBUG;
4458 my $change_svcpart = $alternate[0];
4459 $target{$change_svcpart}--;
4460 my $new = new FS::cust_svc { $cust_svc->hash };
4461 $new->svcpart($change_svcpart);
4462 $new->pkgnum($dest_pkgnum);
4463 $error = $new->replace($cust_svc);
4473 my @label = $cust_svc->label;
4474 return "service $label[1]: $error";
4481 =item grab_svcnums SVCNUM, SVCNUM ...
4483 Change the pkgnum for the provided services to this packages. If there is an
4484 error, returns the error, otherwise returns false.
4492 local $SIG{HUP} = 'IGNORE';
4493 local $SIG{INT} = 'IGNORE';
4494 local $SIG{QUIT} = 'IGNORE';
4495 local $SIG{TERM} = 'IGNORE';
4496 local $SIG{TSTP} = 'IGNORE';
4497 local $SIG{PIPE} = 'IGNORE';
4499 my $oldAutoCommit = $FS::UID::AutoCommit;
4500 local $FS::UID::AutoCommit = 0;
4503 foreach my $svcnum (@svcnum) {
4504 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4505 $dbh->rollback if $oldAutoCommit;
4506 return "unknown svcnum $svcnum";
4508 $cust_svc->pkgnum( $self->pkgnum );
4509 my $error = $cust_svc->replace;
4511 $dbh->rollback if $oldAutoCommit;
4516 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4523 This method is deprecated. See the I<depend_jobnum> option to the insert and
4524 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4531 local $SIG{HUP} = 'IGNORE';
4532 local $SIG{INT} = 'IGNORE';
4533 local $SIG{QUIT} = 'IGNORE';
4534 local $SIG{TERM} = 'IGNORE';
4535 local $SIG{TSTP} = 'IGNORE';
4536 local $SIG{PIPE} = 'IGNORE';
4538 my $oldAutoCommit = $FS::UID::AutoCommit;
4539 local $FS::UID::AutoCommit = 0;
4542 foreach my $cust_svc ( $self->cust_svc ) {
4543 #false laziness w/svc_Common::insert
4544 my $svc_x = $cust_svc->svc_x;
4545 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4546 my $error = $part_export->export_insert($svc_x);
4548 $dbh->rollback if $oldAutoCommit;
4554 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4559 =item export_pkg_change OLD_CUST_PKG
4561 Calls the "pkg_change" export action for all services attached to this package.
4565 sub export_pkg_change {
4566 my( $self, $old ) = ( shift, shift );
4568 local $SIG{HUP} = 'IGNORE';
4569 local $SIG{INT} = 'IGNORE';
4570 local $SIG{QUIT} = 'IGNORE';
4571 local $SIG{TERM} = 'IGNORE';
4572 local $SIG{TSTP} = 'IGNORE';
4573 local $SIG{PIPE} = 'IGNORE';
4575 my $oldAutoCommit = $FS::UID::AutoCommit;
4576 local $FS::UID::AutoCommit = 0;
4579 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4580 my $error = $svc_x->export('pkg_change', $self, $old);
4582 $dbh->rollback if $oldAutoCommit;
4587 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4594 Associates this package with a (suspension or cancellation) reason (see
4595 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4598 Available options are:
4604 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.
4608 the access_user (see L<FS::access_user>) providing the reason
4616 the action (cancel, susp, adjourn, expire) associated with the reason
4620 If there is an error, returns the error, otherwise returns false.
4625 my ($self, %options) = @_;
4627 my $otaker = $options{reason_otaker} ||
4628 $FS::CurrentUser::CurrentUser->username;
4631 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4635 } elsif ( ref($options{'reason'}) ) {
4637 return 'Enter a new reason (or select an existing one)'
4638 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4640 my $reason = new FS::reason({
4641 'reason_type' => $options{'reason'}->{'typenum'},
4642 'reason' => $options{'reason'}->{'reason'},
4644 my $error = $reason->insert;
4645 return $error if $error;
4647 $reasonnum = $reason->reasonnum;
4650 return "Unparseable reason: ". $options{'reason'};
4653 my $cust_pkg_reason =
4654 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4655 'reasonnum' => $reasonnum,
4656 'otaker' => $otaker,
4657 'action' => substr(uc($options{'action'}),0,1),
4658 'date' => $options{'date'}
4663 $cust_pkg_reason->insert;
4666 =item insert_discount
4668 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4669 inserting a new discount on the fly (see L<FS::discount>).
4671 Available options are:
4679 If there is an error, returns the error, otherwise returns false.
4683 sub insert_discount {
4684 #my ($self, %options) = @_;
4687 my $cust_pkg_discount = new FS::cust_pkg_discount {
4688 'pkgnum' => $self->pkgnum,
4689 'discountnum' => $self->discountnum,
4691 'end_date' => '', #XXX
4692 #for the create a new discount case
4693 '_type' => $self->discountnum__type,
4694 'amount' => $self->discountnum_amount,
4695 'percent' => $self->discountnum_percent,
4696 'months' => $self->discountnum_months,
4697 'setup' => $self->discountnum_setup,
4698 #'disabled' => $self->discountnum_disabled,
4701 $cust_pkg_discount->insert;
4704 =item set_usage USAGE_VALUE_HASHREF
4706 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4707 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4708 upbytes, downbytes, and totalbytes are appropriate keys.
4710 All svc_accts which are part of this package have their values reset.
4715 my ($self, $valueref, %opt) = @_;
4717 #only svc_acct can set_usage for now
4718 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4719 my $svc_x = $cust_svc->svc_x;
4720 $svc_x->set_usage($valueref, %opt)
4721 if $svc_x->can("set_usage");
4725 =item recharge USAGE_VALUE_HASHREF
4727 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4728 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4729 upbytes, downbytes, and totalbytes are appropriate keys.
4731 All svc_accts which are part of this package have their values incremented.
4736 my ($self, $valueref) = @_;
4738 #only svc_acct can set_usage for now
4739 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4740 my $svc_x = $cust_svc->svc_x;
4741 $svc_x->recharge($valueref)
4742 if $svc_x->can("recharge");
4746 =item cust_pkg_discount
4750 sub cust_pkg_discount {
4752 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4755 =item cust_pkg_discount_active
4759 sub cust_pkg_discount_active {
4761 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4764 =item cust_pkg_usage
4766 Returns a list of all voice usage counters attached to this package.
4770 sub cust_pkg_usage {
4772 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4775 =item apply_usage OPTIONS
4777 Takes the following options:
4778 - cdr: a call detail record (L<FS::cdr>)
4779 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4780 - minutes: the maximum number of minutes to be charged
4782 Finds available usage minutes for a call of this class, and subtracts
4783 up to that many minutes from the usage pool. If the usage pool is empty,
4784 and the C<cdr-minutes_priority> global config option is set, minutes may
4785 be taken from other calls as well. Either way, an allocation record will
4786 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4787 number of minutes of usage applied to the call.
4792 my ($self, %opt) = @_;
4793 my $cdr = $opt{cdr};
4794 my $rate_detail = $opt{rate_detail};
4795 my $minutes = $opt{minutes};
4796 my $classnum = $rate_detail->classnum;
4797 my $pkgnum = $self->pkgnum;
4798 my $custnum = $self->custnum;
4800 local $SIG{HUP} = 'IGNORE';
4801 local $SIG{INT} = 'IGNORE';
4802 local $SIG{QUIT} = 'IGNORE';
4803 local $SIG{TERM} = 'IGNORE';
4804 local $SIG{TSTP} = 'IGNORE';
4805 local $SIG{PIPE} = 'IGNORE';
4807 my $oldAutoCommit = $FS::UID::AutoCommit;
4808 local $FS::UID::AutoCommit = 0;
4810 my $order = FS::Conf->new->config('cdr-minutes_priority');
4814 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4816 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4818 my @usage_recs = qsearch({
4819 'table' => 'cust_pkg_usage',
4820 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4821 ' JOIN cust_pkg USING (pkgnum)'.
4822 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4823 'select' => 'cust_pkg_usage.*',
4824 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4825 " ( cust_pkg.custnum = $custnum AND ".
4826 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4827 $is_classnum . ' AND '.
4828 " cust_pkg_usage.minutes > 0",
4829 'order_by' => " ORDER BY priority ASC",
4832 my $orig_minutes = $minutes;
4834 while (!$error and $minutes > 0 and @usage_recs) {
4835 my $cust_pkg_usage = shift @usage_recs;
4836 $cust_pkg_usage->select_for_update;
4837 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4838 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4839 acctid => $cdr->acctid,
4840 minutes => min($cust_pkg_usage->minutes, $minutes),
4842 $cust_pkg_usage->set('minutes',
4843 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4845 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4846 $minutes -= $cdr_cust_pkg_usage->minutes;
4848 if ( $order and $minutes > 0 and !$error ) {
4849 # then try to steal minutes from another call
4851 'table' => 'cdr_cust_pkg_usage',
4852 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4853 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4854 ' JOIN cust_pkg USING (pkgnum)'.
4855 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4856 ' JOIN cdr USING (acctid)',
4857 'select' => 'cdr_cust_pkg_usage.*',
4858 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4859 " ( cust_pkg.pkgnum = $pkgnum OR ".
4860 " ( cust_pkg.custnum = $custnum AND ".
4861 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4862 " part_pkg_usage_class.classnum = $classnum",
4863 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4865 if ( $order eq 'time' ) {
4866 # find CDRs that are using minutes, but have a later startdate
4868 my $startdate = $cdr->startdate;
4869 if ($startdate !~ /^\d+$/) {
4870 die "bad cdr startdate '$startdate'";
4872 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4873 # minimize needless reshuffling
4874 $search{'order_by'} .= ', cdr.startdate DESC';
4876 # XXX may not work correctly with rate_time schedules. Could
4877 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4879 $search{'addl_from'} .=
4880 ' JOIN rate_detail'.
4881 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4882 if ( $order eq 'rate_high' ) {
4883 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4884 $rate_detail->min_charge;
4885 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4886 } elsif ( $order eq 'rate_low' ) {
4887 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4888 $rate_detail->min_charge;
4889 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4891 # this should really never happen
4892 die "invalid cdr-minutes_priority value '$order'\n";
4895 my @cdr_usage_recs = qsearch(\%search);
4897 while (!$error and @cdr_usage_recs and $minutes > 0) {
4898 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4899 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4900 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4901 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4902 $cdr_cust_pkg_usage->select_for_update;
4903 $old_cdr->select_for_update;
4904 $cust_pkg_usage->select_for_update;
4905 # in case someone else stole the usage from this CDR
4906 # while waiting for the lock...
4907 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4908 # steal the usage allocation and flag the old CDR for reprocessing
4909 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4910 # if the allocation is more minutes than we need, adjust it...
4911 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4913 $cdr_cust_pkg_usage->set('minutes', $minutes);
4914 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4915 $error = $cust_pkg_usage->replace;
4917 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4918 $error ||= $cdr_cust_pkg_usage->replace;
4919 # deduct the stolen minutes
4920 $minutes -= $cdr_cust_pkg_usage->minutes;
4922 # after all minute-stealing is done, reset the affected CDRs
4923 foreach (values %reproc_cdrs) {
4924 $error ||= $_->set_status('');
4925 # XXX or should we just call $cdr->rate right here?
4926 # it's not like we can create a loop this way, since the min_charge
4927 # or call time has to go monotonically in one direction.
4928 # we COULD get some very deep recursions going, though...
4930 } # if $order and $minutes
4933 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4935 $dbh->commit if $oldAutoCommit;
4936 return $orig_minutes - $minutes;
4940 =item supplemental_pkgs
4942 Returns a list of all packages supplemental to this one.
4946 sub supplemental_pkgs {
4948 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4953 Returns the package that this one is supplemental to, if any.
4959 if ( $self->main_pkgnum ) {
4960 return FS::cust_pkg->by_key($self->main_pkgnum);
4967 =head1 CLASS METHODS
4973 Returns an SQL expression identifying recurring packages.
4977 sub recurring_sql { "
4978 '0' != ( select freq from part_pkg
4979 where cust_pkg.pkgpart = part_pkg.pkgpart )
4984 Returns an SQL expression identifying one-time packages.
4989 '0' = ( select freq from part_pkg
4990 where cust_pkg.pkgpart = part_pkg.pkgpart )
4995 Returns an SQL expression identifying ordered packages (recurring packages not
5001 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
5006 Returns an SQL expression identifying active packages.
5011 $_[0]->recurring_sql. "
5012 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5013 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5014 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5017 =item not_yet_billed_sql
5019 Returns an SQL expression identifying packages which have not yet been billed.
5023 sub not_yet_billed_sql { "
5024 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5025 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5026 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5031 Returns an SQL expression identifying inactive packages (one-time packages
5032 that are otherwise unsuspended/uncancelled).
5036 sub inactive_sql { "
5037 ". $_[0]->onetime_sql(). "
5038 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5039 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5040 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5045 Returns an SQL expression identifying on-hold packages.
5050 #$_[0]->recurring_sql(). ' AND '.
5052 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5053 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5054 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5061 Returns an SQL expression identifying suspended packages.
5065 sub suspended_sql { susp_sql(@_); }
5067 #$_[0]->recurring_sql(). ' AND '.
5069 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5070 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5071 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5078 Returns an SQL exprression identifying cancelled packages.
5082 sub cancelled_sql { cancel_sql(@_); }
5084 #$_[0]->recurring_sql(). ' AND '.
5085 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
5088 =item ncancelled_recurring_sql
5090 Returns an SQL expression identifying un-cancelled, recurring packages.
5094 sub ncancelled_recurring_sql {
5095 $_[0]->recurring_sql().
5096 " AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 ) ";
5101 Returns an SQL expression to give the package status as a string.
5107 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
5108 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
5109 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
5110 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
5111 WHEN ".onetime_sql()." THEN 'one-time charge'
5116 =item search HASHREF
5120 Returns a qsearch hash expression to search for parameters specified in HASHREF.
5121 Valid parameters are
5129 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
5133 Equivalent to "status", except that "canceled"/"cancelled" will exclude
5134 packages that were changed into a new package with the same pkgpart (i.e.
5135 location or quantity changes).
5139 boolean selects custom packages
5145 pkgpart or arrayref or hashref of pkgparts
5149 arrayref of beginning and ending epoch date
5153 arrayref of beginning and ending epoch date
5157 arrayref of beginning and ending epoch date
5161 arrayref of beginning and ending epoch date
5165 arrayref of beginning and ending epoch date
5169 arrayref of beginning and ending epoch date
5173 arrayref of beginning and ending epoch date
5177 pkgnum or APKG_pkgnum
5181 a value suited to passing to FS::UI::Web::cust_header
5185 specifies the user for agent virtualization
5189 boolean; if true, returns only packages with more than 0 FCC phone lines.
5191 =item state, country
5193 Limit to packages with a service location in the specified state and country.
5194 For FCC 477 reporting, mostly.
5198 Limit to packages whose service locations are the same as the customer's
5199 default service location.
5201 =item location_nocust
5203 Limit to packages whose service locations are not the customer's default
5206 =item location_census
5208 Limit to packages whose service locations have census tracts.
5210 =item location_nocensus
5212 Limit to packages whose service locations do not have a census tract.
5214 =item location_geocode
5216 Limit to packages whose locations have geocodes.
5218 =item location_geocode
5220 Limit to packages whose locations do not have geocodes.
5224 Limit to packages associated with a svc_broadband, associated with a sector,
5225 associated with this towernum (or any of these, if it's an arrayref) (or NO
5226 towernum, if it's zero). This is an extreme niche case.
5228 =item 477part, 477rownum, date
5230 Limit to packages included in a specific row of one of the FCC 477 reports.
5231 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
5232 is the report as-of date (completely unrelated to the package setup/bill/
5233 other date fields), and '477rownum' is the row number of the report starting
5234 with zero. Row numbers have no inherent meaning, so this is useful only
5235 for explaining a 477 report you've already run.
5242 my ($class, $params) = @_;
5249 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5251 "cust_main.agentnum = $1";
5258 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
5259 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
5263 # parse customer sales person
5266 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
5267 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
5268 : 'cust_main.salesnum IS NULL';
5273 # parse sales person
5276 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
5277 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
5278 : 'cust_pkg.salesnum IS NULL';
5285 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
5287 "cust_pkg.custnum = $1";
5294 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5296 "cust_pkg.pkgbatch = '$1'";
5303 if ( $params->{'magic'} eq 'active'
5304 || $params->{'status'} eq 'active' ) {
5306 push @where, FS::cust_pkg->active_sql();
5308 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
5309 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
5311 push @where, FS::cust_pkg->not_yet_billed_sql();
5313 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
5314 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
5316 push @where, FS::cust_pkg->inactive_sql();
5318 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
5319 || $params->{'status'} =~ /^on[ _]hold$/ ) {
5321 push @where, FS::cust_pkg->on_hold_sql();
5324 } elsif ( $params->{'magic'} eq 'suspended'
5325 || $params->{'status'} eq 'suspended' ) {
5327 push @where, FS::cust_pkg->suspended_sql();
5329 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
5330 || $params->{'status'} =~ /^cancell?ed$/ ) {
5332 push @where, FS::cust_pkg->cancelled_sql();
5336 ### special case: "magic" is used in detail links from browse/part_pkg,
5337 # where "cancelled" has the restriction "and not replaced with a package
5338 # of the same pkgpart". Be consistent with that.
5341 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
5342 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
5343 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
5344 # ...may not exist, if this was just canceled and not changed; in that
5345 # case give it a "new pkgpart" that never equals the old pkgpart
5346 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
5350 # parse package class
5353 if ( exists($params->{'classnum'}) ) {
5356 if ( ref($params->{'classnum'}) ) {
5358 if ( ref($params->{'classnum'}) eq 'HASH' ) {
5359 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
5360 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
5361 @classnum = @{ $params->{'classnum'} };
5363 die 'unhandled classnum ref '. $params->{'classnum'};
5367 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
5374 my @nums = grep $_, @classnum;
5375 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
5376 my $null = scalar( grep { $_ eq '' } @classnum );
5377 push @c_where, 'part_pkg.classnum IS NULL' if $null;
5379 if ( scalar(@c_where) == 1 ) {
5380 push @where, @c_where;
5381 } elsif ( @c_where ) {
5382 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
5391 # parse (customer) refnum (advertising source)
5394 if ( exists($params->{'refnum'}) ) {
5396 if (ref $params->{'refnum'}) {
5397 @refnum = @{ $params->{'refnum'} };
5399 @refnum = ( $params->{'refnum'} );
5401 my $in = join(',', grep /^\d+$/, @refnum);
5402 push @where, "cust_main.refnum IN($in)" if length $in;
5406 # parse package report options
5409 my @report_option = ();
5410 if ( exists($params->{'report_option'}) ) {
5411 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
5412 @report_option = @{ $params->{'report_option'} };
5413 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
5414 @report_option = split(',', $1);
5419 if (@report_option) {
5420 # this will result in the empty set for the dangling comma case as it should
5422 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5423 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5424 AND optionname = 'report_option_$_'
5425 AND optionvalue = '1' )"
5429 foreach my $any ( grep /^report_option_any/, keys %$params ) {
5431 my @report_option_any = ();
5432 if ( ref($params->{$any}) eq 'ARRAY' ) {
5433 @report_option_any = @{ $params->{$any} };
5434 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
5435 @report_option_any = split(',', $1);
5438 if (@report_option_any) {
5439 # this will result in the empty set for the dangling comma case as it should
5440 push @where, ' ( '. join(' OR ',
5441 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5442 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5443 AND optionname = 'report_option_$_'
5444 AND optionvalue = '1' )"
5445 } @report_option_any
5455 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
5461 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
5462 if $params->{fcc_line};
5468 if ( exists($params->{'censustract'}) ) {
5469 $params->{'censustract'} =~ /^([.\d]*)$/;
5470 my $censustract = "cust_location.censustract = '$1'";
5471 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
5472 push @where, "( $censustract )";
5476 # parse censustract2
5478 if ( exists($params->{'censustract2'})
5479 && $params->{'censustract2'} =~ /^(\d*)$/
5483 push @where, "cust_location.censustract LIKE '$1%'";
5486 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
5491 # parse country/state/zip
5493 for (qw(state country)) { # parsing rules are the same for these
5494 if ( exists($params->{$_})
5495 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
5497 # XXX post-2.3 only--before that, state/country may be in cust_main
5498 push @where, "cust_location.$_ = '$1'";
5501 if ( exists($params->{zip}) ) {
5502 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
5508 if ( $params->{location_cust} xor $params->{location_nocust} ) {
5509 my $op = $params->{location_cust} ? '=' : '!=';
5510 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
5512 if ( $params->{location_census} xor $params->{location_nocensus} ) {
5513 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
5514 push @where, "cust_location.censustract $op";
5516 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
5517 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
5518 push @where, "cust_location.geocode $op";
5525 if ( ref($params->{'pkgpart'}) ) {
5528 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
5529 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
5530 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
5531 @pkgpart = @{ $params->{'pkgpart'} };
5533 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
5536 @pkgpart = grep /^(\d+)$/, @pkgpart;
5538 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
5540 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5541 push @where, "pkgpart = $1";
5550 #false laziness w/report_cust_pkg.html
5553 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
5554 'active' => { 'susp'=>1, 'cancel'=>1 },
5555 'suspended' => { 'cancel' => 1 },
5560 if( exists($params->{'active'} ) ) {
5561 # This overrides all the other date-related fields, and includes packages
5562 # that were active at some time during the interval. It excludes:
5563 # - packages that were set up after the end of the interval
5564 # - packages that were canceled before the start of the interval
5565 # - packages that were suspended before the start of the interval
5566 # and are still suspended now
5567 my($beginning, $ending) = @{$params->{'active'}};
5569 "cust_pkg.setup IS NOT NULL",
5570 "cust_pkg.setup <= $ending",
5571 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5572 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
5573 "NOT (".FS::cust_pkg->onetime_sql . ")";
5576 my $exclude_change_from = 0;
5577 my $exclude_change_to = 0;
5579 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5581 if ( $params->{$field.'_null'} ) {
5583 push @where, "cust_pkg.$field IS NULL";
5584 # this should surely be obsoleted by now: OR cust_pkg.$field == 0
5588 next unless exists($params->{$field});
5590 my($beginning, $ending) = @{$params->{$field}};
5592 next if $beginning == 0 && $ending == 4294967295;
5595 "cust_pkg.$field IS NOT NULL",
5596 "cust_pkg.$field >= $beginning",
5597 "cust_pkg.$field <= $ending";
5599 $orderby ||= "ORDER BY cust_pkg.$field";
5601 if ( $field eq 'setup' ) {
5602 $exclude_change_from = 1;
5603 } elsif ( $field eq 'cancel' ) {
5604 $exclude_change_to = 1;
5605 } elsif ( $field eq 'change_date' ) {
5606 # if we are given setup and change_date ranges, and the setup date
5607 # falls in _both_ ranges, then include the package whether it was
5609 $exclude_change_from = 0;
5615 if ($exclude_change_from) {
5616 push @where, "change_pkgnum IS NULL";
5618 if ($exclude_change_to) {
5619 # a join might be more efficient here
5620 push @where, "NOT EXISTS(
5621 SELECT 1 FROM cust_pkg AS changed_to_pkg
5622 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5628 $orderby ||= 'ORDER BY bill';
5631 # parse magic, legacy, etc.
5634 if ( $params->{'magic'} &&
5635 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5638 $orderby = 'ORDER BY pkgnum';
5640 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5641 push @where, "pkgpart = $1";
5644 } elsif ( $params->{'query'} eq 'pkgnum' ) {
5646 $orderby = 'ORDER BY pkgnum';
5648 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5650 $orderby = 'ORDER BY pkgnum';
5653 SELECT count(*) FROM pkg_svc
5654 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
5655 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5656 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
5657 AND cust_svc.svcpart = pkg_svc.svcpart
5664 # parse the extremely weird 'towernum' param
5667 if ($params->{towernum}) {
5668 my $towernum = $params->{towernum};
5669 $towernum = [ $towernum ] if !ref($towernum);
5670 my $in = join(',', grep /^\d+$/, @$towernum);
5672 # inefficient, but this is an obscure feature
5673 eval "use FS::Report::Table";
5674 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5675 push @where, "EXISTS(
5676 SELECT 1 FROM tower_pkg_cache
5677 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5678 AND tower_pkg_cache.towernum IN ($in)
5684 # parse the 477 report drill-down options
5687 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5689 my ($date, $rownum, $agentnum);
5690 if ($params->{'date'} =~ /^(\d+)$/) {
5693 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5696 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5699 if ($date and defined($rownum)) {
5700 my $report = FS::Report::FCC_477->report($section,
5702 'agentnum' => $agentnum,
5705 my $pkgnums = $report->{detail}->[$rownum]
5706 or die "row $rownum is past the end of the report";
5707 # '0' so that if there are no pkgnums (empty string) it will create
5708 # a valid query that returns nothing
5709 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5711 # and this overrides everything
5712 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5713 } # else we're missing some params, ignore the whole business
5717 # setup queries, links, subs, etc. for the search
5720 # here is the agent virtualization
5721 if ($params->{CurrentUser}) {
5723 qsearchs('access_user', { username => $params->{CurrentUser} });
5726 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5731 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5734 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5736 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5737 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5738 'LEFT JOIN cust_location USING ( locationnum ) '.
5739 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5743 if ( $params->{'select_zip5'} ) {
5744 my $zip = 'cust_location.zip';
5746 $select = "DISTINCT substr($zip,1,5) as zip";
5747 $orderby = "ORDER BY substr($zip,1,5)";
5748 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5750 $select = join(', ',
5752 ( map "part_pkg.$_", qw( pkg freq ) ),
5753 'pkg_class.classname',
5754 'cust_main.custnum AS cust_main_custnum',
5755 FS::UI::Web::cust_sql_fields(
5756 $params->{'cust_fields'}
5759 $count_query = 'SELECT COUNT(*)';
5762 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5765 'table' => 'cust_pkg',
5767 'select' => $select,
5768 'extra_sql' => $extra_sql,
5769 'order_by' => $orderby,
5770 'addl_from' => $addl_from,
5771 'count_query' => $count_query,
5778 Returns a list of two package counts. The first is a count of packages
5779 based on the supplied criteria and the second is the count of residential
5780 packages with those same criteria. Criteria are specified as in the search
5786 my ($class, $params) = @_;
5788 my $sql_query = $class->search( $params );
5790 my $count_sql = delete($sql_query->{'count_query'});
5791 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5792 or die "couldn't parse count_sql";
5794 my $count_sth = dbh->prepare($count_sql)
5795 or die "Error preparing $count_sql: ". dbh->errstr;
5797 or die "Error executing $count_sql: ". $count_sth->errstr;
5798 my $count_arrayref = $count_sth->fetchrow_arrayref;
5800 return ( @$count_arrayref );
5804 =item tax_locationnum_sql
5806 Returns an SQL expression for the tax location for a package, based
5807 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5811 sub tax_locationnum_sql {
5812 my $conf = FS::Conf->new;
5813 if ( $conf->exists('tax-pkg_address') ) {
5814 'cust_pkg.locationnum';
5816 elsif ( $conf->exists('tax-ship_address') ) {
5817 'cust_main.ship_locationnum';
5820 'cust_main.bill_locationnum';
5826 Returns a list: the first item is an SQL fragment identifying matching
5827 packages/customers via location (taking into account shipping and package
5828 address taxation, if enabled), and subsequent items are the parameters to
5829 substitute for the placeholders in that fragment.
5834 my($class, %opt) = @_;
5835 my $ornull = $opt{'ornull'};
5837 my $conf = new FS::Conf;
5839 # '?' placeholders in _location_sql_where
5840 my $x = $ornull ? 3 : 2;
5851 if ( $conf->exists('tax-ship_address') ) {
5854 ( ( ship_last IS NULL OR ship_last = '' )
5855 AND ". _location_sql_where('cust_main', '', $ornull ). "
5857 OR ( ship_last IS NOT NULL AND ship_last != ''
5858 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5861 # AND payby != 'COMP'
5863 @main_param = ( @bill_param, @bill_param );
5867 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5868 @main_param = @bill_param;
5874 if ( $conf->exists('tax-pkg_address') ) {
5876 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5879 ( cust_pkg.locationnum IS NULL AND $main_where )
5880 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5883 @param = ( @main_param, @bill_param );
5887 $where = $main_where;
5888 @param = @main_param;
5896 #subroutine, helper for location_sql
5897 sub _location_sql_where {
5899 my $prefix = @_ ? shift : '';
5900 my $ornull = @_ ? shift : '';
5902 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5904 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5906 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5907 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5908 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5910 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5912 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5914 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5915 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5916 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5917 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5918 AND $table.${prefix}country = ?
5923 my( $self, $what ) = @_;
5925 my $what_show_zero = $what. '_show_zero';
5926 length($self->$what_show_zero())
5927 ? ($self->$what_show_zero() eq 'Y')
5928 : $self->part_pkg->$what_show_zero();
5935 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5937 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5938 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5940 CUSTNUM is a customer (see L<FS::cust_main>)
5942 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5943 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5946 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5947 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5948 new billing items. An error is returned if this is not possible (see
5949 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5952 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5953 newly-created cust_pkg objects.
5955 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5956 and inserted. Multiple FS::pkg_referral records can be created by
5957 setting I<refnum> to an array reference of refnums or a hash reference with
5958 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5959 record will be created corresponding to cust_main.refnum.
5964 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5966 my $conf = new FS::Conf;
5968 # Transactionize this whole mess
5969 local $SIG{HUP} = 'IGNORE';
5970 local $SIG{INT} = 'IGNORE';
5971 local $SIG{QUIT} = 'IGNORE';
5972 local $SIG{TERM} = 'IGNORE';
5973 local $SIG{TSTP} = 'IGNORE';
5974 local $SIG{PIPE} = 'IGNORE';
5976 my $oldAutoCommit = $FS::UID::AutoCommit;
5977 local $FS::UID::AutoCommit = 0;
5981 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5982 # return "Customer not found: $custnum" unless $cust_main;
5984 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5987 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5990 my $change = scalar(@old_cust_pkg) != 0;
5993 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5995 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5996 " to pkgpart ". $pkgparts->[0]. "\n"
5999 my $err_or_cust_pkg =
6000 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
6001 'refnum' => $refnum,
6004 unless (ref($err_or_cust_pkg)) {
6005 $dbh->rollback if $oldAutoCommit;
6006 return $err_or_cust_pkg;
6009 push @$return_cust_pkg, $err_or_cust_pkg;
6010 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6015 # Create the new packages.
6016 foreach my $pkgpart (@$pkgparts) {
6018 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
6020 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
6021 pkgpart => $pkgpart,
6025 $error = $cust_pkg->insert( 'change' => $change );
6026 push @$return_cust_pkg, $cust_pkg;
6028 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
6029 my $supp_pkg = FS::cust_pkg->new({
6030 custnum => $custnum,
6031 pkgpart => $link->dst_pkgpart,
6033 main_pkgnum => $cust_pkg->pkgnum,
6036 $error ||= $supp_pkg->insert( 'change' => $change );
6037 push @$return_cust_pkg, $supp_pkg;
6041 $dbh->rollback if $oldAutoCommit;
6046 # $return_cust_pkg now contains refs to all of the newly
6049 # Transfer services and cancel old packages.
6050 foreach my $old_pkg (@old_cust_pkg) {
6052 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
6055 foreach my $new_pkg (@$return_cust_pkg) {
6056 $error = $old_pkg->transfer($new_pkg);
6057 if ($error and $error == 0) {
6058 # $old_pkg->transfer failed.
6059 $dbh->rollback if $oldAutoCommit;
6064 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
6065 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
6066 foreach my $new_pkg (@$return_cust_pkg) {
6067 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
6068 if ($error and $error == 0) {
6069 # $old_pkg->transfer failed.
6070 $dbh->rollback if $oldAutoCommit;
6077 # Transfers were successful, but we went through all of the
6078 # new packages and still had services left on the old package.
6079 # We can't cancel the package under the circumstances, so abort.
6080 $dbh->rollback if $oldAutoCommit;
6081 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
6083 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
6089 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6093 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
6095 A bulk change method to change packages for multiple customers.
6097 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
6098 L<FS::part_pkg>) to order for each customer. Duplicates are of course
6101 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
6102 replace. The services (see L<FS::cust_svc>) are moved to the
6103 new billing items. An error is returned if this is not possible (see
6106 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
6107 newly-created cust_pkg objects.
6112 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
6114 # Transactionize this whole mess
6115 local $SIG{HUP} = 'IGNORE';
6116 local $SIG{INT} = 'IGNORE';
6117 local $SIG{QUIT} = 'IGNORE';
6118 local $SIG{TERM} = 'IGNORE';
6119 local $SIG{TSTP} = 'IGNORE';
6120 local $SIG{PIPE} = 'IGNORE';
6122 my $oldAutoCommit = $FS::UID::AutoCommit;
6123 local $FS::UID::AutoCommit = 0;
6127 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
6130 while(scalar(@old_cust_pkg)) {
6132 my $custnum = $old_cust_pkg[0]->custnum;
6133 my (@remove) = map { $_->pkgnum }
6134 grep { $_->custnum == $custnum } @old_cust_pkg;
6135 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
6137 my $error = order $custnum, $pkgparts, \@remove, \@return;
6139 push @errors, $error
6141 push @$return_cust_pkg, @return;
6144 if (scalar(@errors)) {
6145 $dbh->rollback if $oldAutoCommit;
6146 return join(' / ', @errors);
6149 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6153 =item forward_emails
6155 Returns a hash of svcnums and corresponding email addresses
6156 for svc_acct services that can be used as source or dest
6157 for svc_forward services provisioned in this package.
6159 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
6160 service; if included, will ensure the current values of the
6161 specified service are included in the list, even if for some
6162 other reason they wouldn't be. If called as a class method
6163 with a specified service, returns only these current values.
6165 Caution: does not actually check if svc_forward services are
6166 available to be provisioned on this package.
6170 sub forward_emails {
6174 #load optional service, thoroughly validated
6175 die "Use svcnum or svc_forward, not both"
6176 if $opt{'svcnum'} && $opt{'svc_forward'};
6177 my $svc_forward = $opt{'svc_forward'};
6178 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
6180 die "Specified service is not a forward service"
6181 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
6182 die "Specified service not found"
6183 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
6187 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
6188 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
6190 #add current values from specified service, if there was one
6192 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
6193 my $svc_acct = $svc_forward->$method();
6194 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
6198 if (ref($self) eq 'FS::cust_pkg') {
6200 #and including the rest for this customer
6201 my($u_part_svc,@u_acct_svcparts);
6202 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
6203 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
6206 my $custnum = $self->getfield('custnum');
6207 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
6208 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
6209 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
6210 foreach my $acct_svcpart (@u_acct_svcparts) {
6211 foreach my $i_cust_svc (
6212 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
6213 'svcpart' => $acct_svcpart } )
6215 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
6216 $email{$svc_acct->svcnum} = $svc_acct->email;
6225 # Used by FS::Upgrade to migrate to a new database.
6226 sub _upgrade_data { # class method
6227 my ($class, %opts) = @_;
6228 $class->_upgrade_otaker(%opts);
6230 # RT#10139, bug resulting in contract_end being set when it shouldn't
6231 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
6232 # RT#10830, bad calculation of prorate date near end of year
6233 # the date range for bill is December 2009, and we move it forward
6234 # one year if it's before the previous bill date (which it should
6236 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
6237 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
6238 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
6239 # RT6628, add order_date to cust_pkg
6240 'update cust_pkg set order_date = (select history_date from h_cust_pkg
6241 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
6242 history_action = \'insert\') where order_date is null',
6244 foreach my $sql (@statements) {
6245 my $sth = dbh->prepare($sql);
6246 $sth->execute or die $sth->errstr;
6249 # RT31194: supplemental package links that are deleted don't clean up
6251 my @pkglinknums = qsearch({
6252 'select' => 'DISTINCT cust_pkg.pkglinknum',
6253 'table' => 'cust_pkg',
6254 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
6255 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
6256 AND part_pkg_link.pkglinknum IS NULL',
6258 foreach (@pkglinknums) {
6259 my $pkglinknum = $_->pkglinknum;
6260 warn "cleaning part_pkg_link #$pkglinknum\n";
6261 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
6262 my $error = $part_pkg_link->remove_linked;
6263 die $error if $error;
6266 # RT#73607: canceling a package with billing addons sometimes changes its
6268 # Find records where the last replace_new record for the package before it
6269 # was canceled has a different pkgpart from the package itself.
6270 my @cust_pkg = qsearch({
6271 'table' => 'cust_pkg',
6272 'select' => 'cust_pkg.*, h_cust_pkg.pkgpart AS h_pkgpart',
6273 'addl_from' => ' JOIN (
6274 SELECT pkgnum, MAX(historynum) AS historynum FROM h_cust_pkg
6275 WHERE cancel IS NULL
6276 AND history_action = \'replace_new\'
6278 ) AS last_history USING (pkgnum)
6279 JOIN h_cust_pkg USING (historynum)',
6280 'extra_sql' => ' WHERE cust_pkg.cancel is not null
6281 AND cust_pkg.pkgpart != h_cust_pkg.pkgpart'
6283 foreach my $cust_pkg ( @cust_pkg ) {
6284 my $pkgnum = $cust_pkg->pkgnum;
6285 warn "fixing pkgpart on canceled pkg#$pkgnum\n";
6286 $cust_pkg->set('pkgpart', $cust_pkg->h_pkgpart);
6287 my $error = $cust_pkg->replace;
6288 die $error if $error;
6293 # will autoload in v4+
6294 sub rt_field_charge {
6296 qsearch('rt_field_charge',{ 'pkgnum' => $self->pkgnum });
6303 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
6305 In sub order, the @pkgparts array (passed by reference) is clobbered.
6307 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
6308 method to pass dates to the recur_prog expression, it should do so.
6310 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
6311 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
6312 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
6313 configuration values. Probably need a subroutine which decides what to do
6314 based on whether or not we've fetched the user yet, rather than a hash. See
6315 FS::UID and the TODO.
6317 Now that things are transactional should the check in the insert method be
6322 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
6323 L<FS::pkg_svc>, schema.html from the base documentation