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 @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
1052 if ( !$options{'quiet'} &&
1053 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
1055 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1058 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1059 $error = $msg_template->send( 'cust_main' => $self->cust_main,
1060 'object' => $self );
1063 $error = send_email(
1064 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
1065 'to' => \@invoicing_list,
1066 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
1067 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
1068 'custnum' => $self->custnum,
1069 'msgtype' => '', #admin?
1072 #should this do something on errors?
1079 =item cancel_if_expired [ NOW_TIMESTAMP ]
1081 Cancels this package if its expire date has been reached.
1085 # XXX should look for an expire reason
1086 # but seems to be unused; this is now handled more holistically in
1087 # cust_main::Billing
1089 sub cancel_if_expired {
1091 my $time = shift || time;
1092 return '' unless $self->expire && $self->expire <= $time;
1093 my $error = $self->cancel;
1095 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1096 $self->custnum. ": $error";
1101 =item uncancel_svc_x
1103 For cancelled cust_pkg, returns a list of new, uninserted FS::svc_X records
1104 for services that would be inserted by L</uncancel>. Returned objects also
1105 include the field _h_svc_x, which contains the service history object.
1107 Set pkgnum before inserting.
1109 Accepts the following options:
1111 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1112 (and only if they would otherwise be returned by this)
1116 sub uncancel_svc_x {
1117 my ($self, %opt) = @_;
1119 die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1121 #find historical services within this timeframe before the package cancel
1122 # (incompatible with "time" option to cust_pkg->cancel?)
1123 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1124 # too little? (unprovisioing export delay?)
1125 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1126 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1129 foreach my $h_cust_svc (@h_cust_svc) {
1130 next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1131 # filter out services that still exist on this package (ie preserved svcs)
1132 # but keep services that have since been provisioned on another package (for informational purposes)
1133 next if qsearchs('cust_svc',{ 'svcnum' => $h_cust_svc->svcnum, 'pkgnum' => $self->pkgnum });
1134 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1135 next unless $h_svc_x; # this probably doesn't happen, but just in case
1136 (my $table = $h_svc_x->table) =~ s/^h_//;
1137 require "FS/$table.pm";
1138 my $class = "FS::$table";
1139 my $svc_x = $class->new( {
1140 'svcpart' => $h_cust_svc->svcpart,
1141 '_h_svc_x' => $h_svc_x,
1142 map { $_ => $h_svc_x->get($_) } fields($table)
1146 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1147 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1150 #these are pretty rare, but should handle them
1151 # - dsl_device (mac addresses)
1152 # - phone_device (mac addresses)
1153 # - dsl_note (ikano notes)
1154 # - domain_record (i.e. restore DNS information w/domains)
1155 # - inventory_item(?) (inventory w/un-cancelling service?)
1156 # - nas (svc_broaband nas stuff)
1157 #this stuff is unused in the wild afaik
1158 # - mailinglistmember
1160 # - svc_domain.parent_svcnum?
1161 # - acct_snarf (ancient mail fetching config)
1162 # - cgp_rule (communigate)
1163 # - cust_svc_option (used by our Tron stuff)
1164 # - acct_rt_transaction (used by our time worked stuff)
1166 push @svc_x, $svc_x;
1171 =item uncancel_svc_summary
1173 Returns an array of hashrefs, one for each service that could
1174 potentially be reprovisioned by L</uncancel>, with the following keys:
1182 label - from history table if not currently calculable, undefined if it can't be loaded
1184 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1186 num_cust_svc - number of svcs for this svcpart, only if summarizing (see below)
1188 Cannot be run from within a transaction. Performs inserts
1189 to test the results, and then rolls back the transaction.
1190 Does not perform exports, so does not catch if export would fail.
1192 Also accepts the following options:
1194 no_test_reprovision - skip the test inserts (reprovisionable field will not exist)
1196 summarize_size - if true, returns a single summary record for svcparts with at
1197 least this many svcs, will have key num_cust_svc but not uncancel_svcnum, label or reprovisionable
1201 sub uncancel_svc_summary {
1202 my ($self, %opt) = @_;
1204 die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1205 die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1207 local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1208 local $FS::UID::AutoCommit = 0;
1210 # sort by svcpart, to check summarize_size
1211 my $uncancel_svc_x = {};
1212 foreach my $svc_x (sort { $a->{'svcpart'} <=> $b->{'svcpart'} } $self->uncancel_svc_x) {
1213 $uncancel_svc_x->{$svc_x->svcpart} = [] unless $uncancel_svc_x->{$svc_x->svcpart};
1214 push @{$uncancel_svc_x->{$svc_x->svcpart}}, $svc_x;
1218 foreach my $svcpart (keys %$uncancel_svc_x) {
1219 my @svcpart_svc_x = @{$uncancel_svc_x->{$svcpart}};
1220 if ($opt{'summarize_size'} && (@svcpart_svc_x >= $opt{'summarize_size'})) {
1221 my $svc_x = $svcpart_svc_x[0]; #grab first one for access to $part_svc
1222 my $part_svc = $svc_x->part_svc;
1224 'svcpart' => $part_svc->svcpart,
1225 'svc' => $part_svc->svc,
1226 'num_cust_svc' => scalar(@svcpart_svc_x),
1229 foreach my $svc_x (@svcpart_svc_x) {
1230 my $part_svc = $svc_x->part_svc;
1232 'svcpart' => $part_svc->svcpart,
1233 'svc' => $part_svc->svc,
1234 'uncancel_svcnum' => $svc_x->get('_h_svc_x')->svcnum,
1236 $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1238 unless ($opt{'no_test_reprovision'}) {
1239 # avoid possibly fatal errors from missing linked records
1240 eval { $insert_error = $svc_x->insert };
1241 $insert_error ||= $@;
1243 if ($opt{'no_test_reprovision'} or $insert_error) {
1244 # avoid possibly fatal errors from missing linked records
1245 eval { $out->{'label'} = $svc_x->label };
1246 eval { $out->{'label'} = $svc_x->get('_h_svc_x')->label } unless defined($out->{'label'});
1247 $out->{'reprovisionable'} = 0 unless $opt{'no_test_reprovision'};
1249 $out->{'label'} = $svc_x->label;
1250 $out->{'reprovisionable'} = 1;
1263 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1264 locationnum, (other fields?). Attempts to re-provision cancelled services
1265 using history information (errors at this stage are not fatal).
1267 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1269 svc_fatal: service provisioning errors are fatal
1271 svc_errors: pass an array reference, will be filled in with any provisioning errors
1273 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1275 main_pkgnum: link the package as a supplemental package of this one. For
1281 my( $self, %options ) = @_;
1283 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1284 return '' unless $self->get('cancel');
1286 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1287 return $self->main_pkg->uncancel(%options);
1294 local $SIG{HUP} = 'IGNORE';
1295 local $SIG{INT} = 'IGNORE';
1296 local $SIG{QUIT} = 'IGNORE';
1297 local $SIG{TERM} = 'IGNORE';
1298 local $SIG{TSTP} = 'IGNORE';
1299 local $SIG{PIPE} = 'IGNORE';
1301 my $oldAutoCommit = $FS::UID::AutoCommit;
1302 local $FS::UID::AutoCommit = 0;
1306 # insert the new package
1309 my $cust_pkg = new FS::cust_pkg {
1310 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1311 bill => ( $options{'bill'} || $self->get('bill') ),
1313 uncancel_pkgnum => $self->pkgnum,
1314 main_pkgnum => ($options{'main_pkgnum'} || ''),
1315 map { $_ => $self->get($_) } qw(
1316 custnum pkgpart locationnum
1318 susp adjourn resume expire start_date contract_end dundate
1319 change_date change_pkgpart change_locationnum
1320 manual_flag no_auto separate_bill quantity agent_pkgid
1321 recur_show_zero setup_show_zero
1325 my $error = $cust_pkg->insert(
1326 'change' => 1, #supresses any referral credit to a referring customer
1327 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1330 $dbh->rollback if $oldAutoCommit;
1339 foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1341 $svc_x->pkgnum($cust_pkg->pkgnum);
1342 my $svc_error = $svc_x->insert;
1345 if ( $options{svc_fatal} ) {
1346 $dbh->rollback if $oldAutoCommit;
1349 # if we've failed to insert the svc_x object, svc_Common->insert
1350 # will have removed the cust_svc already. if not, then both records
1351 # were inserted but we failed for some other reason (export, most
1352 # likely). in that case, report the error and delete the records.
1353 push @svc_errors, $svc_error;
1354 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1356 # except if export_insert failed, export_delete probably won't be
1358 local $FS::svc_Common::noexport_hack = 1;
1359 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1360 if ( $cleanup_error ) { # and if THAT fails, then run away
1361 $dbh->rollback if $oldAutoCommit;
1362 return $cleanup_error;
1367 } #foreach uncancel_svc_x
1370 # also move over any services that didn't unprovision at cancellation
1373 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1374 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1375 my $error = $cust_svc->replace;
1377 $dbh->rollback if $oldAutoCommit;
1383 # Uncancel any supplemental packages, and make them supplemental to the
1387 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1389 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1391 $dbh->rollback if $oldAutoCommit;
1392 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1400 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1402 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1403 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1410 Cancels any pending expiration (sets the expire field to null)
1411 for this package and any supplemental packages.
1413 If there is an error, returns the error, otherwise returns false.
1421 local $SIG{HUP} = 'IGNORE';
1422 local $SIG{INT} = 'IGNORE';
1423 local $SIG{QUIT} = 'IGNORE';
1424 local $SIG{TERM} = 'IGNORE';
1425 local $SIG{TSTP} = 'IGNORE';
1426 local $SIG{PIPE} = 'IGNORE';
1428 my $oldAutoCommit = $FS::UID::AutoCommit;
1429 local $FS::UID::AutoCommit = 0;
1432 my $old = $self->select_for_update;
1434 my $pkgnum = $old->pkgnum;
1435 if ( $old->get('cancel') || $self->get('cancel') ) {
1436 dbh->rollback if $oldAutoCommit;
1437 return "Can't unexpire cancelled package $pkgnum";
1438 # or at least it's pointless
1441 unless ( $old->get('expire') && $self->get('expire') ) {
1442 dbh->rollback if $oldAutoCommit;
1443 return ""; # no error
1446 my %hash = $self->hash;
1447 $hash{'expire'} = '';
1448 my $new = new FS::cust_pkg ( \%hash );
1449 $error = $new->replace( $self, options => { $self->options } );
1451 $dbh->rollback if $oldAutoCommit;
1455 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1456 $error = $supp_pkg->unexpire;
1458 $dbh->rollback if $oldAutoCommit;
1459 return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1463 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1469 =item suspend [ OPTION => VALUE ... ]
1471 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1472 package, then suspends the package itself (sets the susp field to now).
1474 Available options are:
1478 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1479 either a reasonnum of an existing reason, or passing a hashref will create
1480 a new reason. The hashref should have the following keys:
1481 - typenum - Reason type (see L<FS::reason_type>
1482 - reason - Text of the new reason.
1484 =item date - can be set to a unix style timestamp to specify when to
1487 =item time - can be set to override the current time, for calculation
1488 of final invoices or unused-time credits
1490 =item resume_date - can be set to a time when the package should be
1491 unsuspended. This may be more convenient than calling C<unsuspend()>
1494 =item from_main - allows a supplemental package to be suspended, rather
1495 than redirecting the method call to its main package. For internal use.
1497 =item from_cancel - used when suspending from the cancel method, forces
1498 this to skip everything besides basic suspension. For internal use.
1502 If there is an error, returns the error, otherwise returns false.
1507 my( $self, %options ) = @_;
1510 # pass all suspend/cancel actions to the main package
1511 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1512 return $self->main_pkg->suspend(%options);
1515 local $SIG{HUP} = 'IGNORE';
1516 local $SIG{INT} = 'IGNORE';
1517 local $SIG{QUIT} = 'IGNORE';
1518 local $SIG{TERM} = 'IGNORE';
1519 local $SIG{TSTP} = 'IGNORE';
1520 local $SIG{PIPE} = 'IGNORE';
1522 my $oldAutoCommit = $FS::UID::AutoCommit;
1523 local $FS::UID::AutoCommit = 0;
1526 my $old = $self->select_for_update;
1528 my $pkgnum = $old->pkgnum;
1529 if ( $old->get('cancel') || $self->get('cancel') ) {
1530 dbh->rollback if $oldAutoCommit;
1531 return "Can't suspend cancelled package $pkgnum";
1534 if ( $old->get('susp') || $self->get('susp') ) {
1535 dbh->rollback if $oldAutoCommit;
1536 return ""; # no error # complain on adjourn?
1539 my $suspend_time = $options{'time'} || time;
1540 my $date = $options{date} if $options{date}; # adjourn/suspend later
1541 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1543 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1544 dbh->rollback if $oldAutoCommit;
1545 return "Package $pkgnum expires before it would be suspended.";
1548 # some false laziness with sub cancel
1549 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1550 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1551 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1552 # make the entire cust_main->bill path recognize 'suspend' and
1553 # 'cancel' separately.
1554 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1555 my $copy = $self->new({$self->hash});
1557 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1559 'time' => $suspend_time );
1560 warn "Error billing during suspend, custnum ".
1561 #$self->cust_main->custnum. ": $error"
1566 my $cust_pkg_reason;
1567 if ( $options{'reason'} ) {
1568 $error = $self->insert_reason( 'reason' => $options{'reason'},
1569 'action' => $date ? 'adjourn' : 'suspend',
1570 'date' => $date ? $date : $suspend_time,
1571 'reason_otaker' => $options{'reason_otaker'},
1574 dbh->rollback if $oldAutoCommit;
1575 return "Error inserting cust_pkg_reason: $error";
1577 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1578 'date' => $date ? $date : $suspend_time,
1579 'action' => $date ? 'A' : 'S',
1580 'pkgnum' => $self->pkgnum,
1584 # if a reasonnum was passed, get the actual reason object so we can check
1586 # (passing a reason hashref is still allowed, but it can't be used with
1587 # the fancy behavioral options.)
1590 if ($options{'reason'} =~ /^\d+$/) {
1591 $reason = FS::reason->by_key($options{'reason'});
1594 my %hash = $self->hash;
1596 $hash{'adjourn'} = $date;
1598 $hash{'susp'} = $suspend_time;
1601 my $resume_date = $options{'resume_date'} || 0;
1602 if ( $resume_date > ($date || $suspend_time) ) {
1603 $hash{'resume'} = $resume_date;
1606 $options{options} ||= {};
1608 my $new = new FS::cust_pkg ( \%hash );
1609 $error = $new->replace( $self, options => { $self->options,
1610 %{ $options{options} },
1614 $dbh->rollback if $oldAutoCommit;
1618 unless ( $date ) { # then we are suspending now
1620 unless ($options{'from_cancel'}) {
1621 # credit remaining time if appropriate
1622 # (if required by the package def, or the suspend reason)
1623 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1624 || ( defined($reason) && $reason->unused_credit );
1626 if ( $unused_credit ) {
1627 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1628 my $error = $self->credit_remaining('suspend', $suspend_time);
1630 $dbh->rollback if $oldAutoCommit;
1638 foreach my $cust_svc (
1639 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1641 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1643 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1644 $dbh->rollback if $oldAutoCommit;
1645 return "Illegal svcdb value in part_svc!";
1648 require "FS/$svcdb.pm";
1650 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1652 $error = $svc->suspend;
1654 $dbh->rollback if $oldAutoCommit;
1657 my( $label, $value ) = $cust_svc->label;
1658 push @labels, "$label: $value";
1662 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1663 # and this is not a suspend-before-cancel
1664 if ( $cust_pkg_reason ) {
1665 my $reason_obj = $cust_pkg_reason->reason;
1666 if ( $reason_obj->feepart and
1667 ! $reason_obj->fee_on_unsuspend and
1668 ! $options{'from_cancel'} ) {
1670 # register the need to charge a fee, cust_main->bill will do the rest
1671 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1673 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1674 'pkgreasonnum' => $cust_pkg_reason->num,
1675 'pkgnum' => $self->pkgnum,
1676 'feepart' => $reason->feepart,
1677 'nextbill' => $reason->fee_hold,
1679 $error ||= $cust_pkg_reason_fee->insert;
1683 my $conf = new FS::Conf;
1684 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1686 my $error = send_email(
1687 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1688 #invoice_from ??? well as good as any
1689 'to' => $conf->config('suspend_email_admin'),
1690 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1692 "This is an automatic message from your Freeside installation\n",
1693 "informing you that the following customer package has been suspended:\n",
1695 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1696 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1697 ( map { "Service : $_\n" } @labels ),
1699 'custnum' => $self->custnum,
1700 'msgtype' => 'admin'
1704 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1712 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1713 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1715 $dbh->rollback if $oldAutoCommit;
1716 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1720 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1725 =item credit_remaining MODE TIME
1727 Generate a credit for this package for the time remaining in the current
1728 billing period. MODE is either "suspend" or "cancel" (determines the
1729 credit type). TIME is the time of suspension/cancellation. Both arguments
1734 # Implementation note:
1736 # If you pkgpart-change a package that has been billed, and it's set to give
1737 # credit on package change, then this method gets called and then the new
1738 # package will have no last_bill date. Therefore the customer will be credited
1739 # only once (per billing period) even if there are multiple package changes.
1741 # If you location-change a package that has been billed, this method will NOT
1742 # be called and the new package WILL have the last bill date of the old
1745 # If the new package is then canceled within the same billing cycle,
1746 # credit_remaining needs to run calc_remain on the OLD package to determine
1747 # the amount of unused time to credit.
1749 sub credit_remaining {
1750 # Add a credit for remaining service
1751 my ($self, $mode, $time) = @_;
1752 die 'credit_remaining requires suspend or cancel'
1753 unless $mode eq 'suspend' or $mode eq 'cancel';
1754 die 'no suspend/cancel time' unless $time > 0;
1756 my $conf = FS::Conf->new;
1757 my $reason_type = $conf->config($mode.'_credit_type');
1761 my $remain_pkg = $self;
1762 my (@billpkgnums, @amounts, @setuprecurs);
1764 # we may have to walk back past some package changes to get to the
1765 # one that actually has unused time. loop until that happens, or we
1766 # reach the first package in the chain.
1768 my $last_bill = $remain_pkg->get('last_bill') || 0;
1769 my $next_bill = $remain_pkg->get('bill') || 0;
1770 if ( $last_bill > 0 # the package has been billed
1771 and $next_bill > 0 # the package has a next bill date
1772 and $next_bill >= $time # which is in the future
1775 # Find actual charges for the period ending on or after the cancel
1777 my @charges = qsearch('cust_bill_pkg', {
1778 pkgnum => $remain_pkg->pkgnum,
1779 edate => {op => '>=', value => $time},
1780 recur => {op => '>' , value => 0},
1783 foreach my $cust_bill_pkg (@charges) {
1784 # hack to deal with the weird behavior of edate on package
1786 my $edate = $cust_bill_pkg->edate;
1787 if ( $self->recur_temporality eq 'preceding' ) {
1788 $edate = $self->add_freq($cust_bill_pkg->sdate);
1791 # this will also get any package charges that are _entirely_ after
1792 # the cancellation date (can happen with advance billing). in that
1793 # case, use the entire recurring charge:
1794 my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
1795 my $max_credit = $amount
1796 - $cust_bill_pkg->credited('', '', setuprecur => 'recur') || 0;
1798 # but if the cancellation happens during the interval, prorate it:
1799 # (XXX obey prorate_round_day here?)
1800 if ( $cust_bill_pkg->sdate < $time ) {
1802 ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
1805 # if there are existing credits, don't let the sum of credits exceed
1806 # the recurring charge
1807 $amount = $max_credit if $amount > $max_credit;
1809 $amount = sprintf('%.2f', $amount);
1811 # if no time has been used and/or there are existing line item
1812 # credits, we may end up not needing to credit anything.
1813 if ( $amount > 0 ) {
1815 push @billpkgnums, $cust_bill_pkg->billpkgnum;
1816 push @amounts, $amount;
1817 push @setuprecurs, 'recur';
1819 warn "Crediting for $amount on package ".$remain_pkg->pkgnum."\n"
1828 if ( my $changed_from_pkgnum = $remain_pkg->change_pkgnum ) {
1829 $remain_pkg = FS::cust_pkg->by_key($changed_from_pkgnum);
1831 # the package has really never been billed
1836 # keep traditional behavior here.
1838 my $reason = FS::reason->new_or_existing(
1839 reason => 'Credit for unused time on '. $self->part_pkg->pkg,
1840 type => $reason_type,
1844 return "failed to set credit reason: $@";
1847 my $error = FS::cust_credit->credit_lineitems(
1848 'billpkgnums' => \@billpkgnums,
1849 'setuprecurs' => \@setuprecurs,
1850 'amounts' => \@amounts,
1851 'custnum' => $self->custnum,
1853 'reasonnum' => $reason->reasonnum,
1860 =item unsuspend [ OPTION => VALUE ... ]
1862 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1863 package, then unsuspends the package itself (clears the susp field and the
1864 adjourn field if it is in the past). If the suspend reason includes an
1865 unsuspension package, that package will be ordered.
1867 Available options are:
1873 Can be set to a date to unsuspend the package in the future (the 'resume'
1876 =item adjust_next_bill
1878 Can be set true to adjust the next bill date forward by
1879 the amount of time the account was inactive. This was set true by default
1880 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1881 explicitly requested with this option or in the price plan.
1885 If there is an error, returns the error, otherwise returns false.
1890 my( $self, %opt ) = @_;
1893 # pass all suspend/cancel actions to the main package
1894 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1895 return $self->main_pkg->unsuspend(%opt);
1898 local $SIG{HUP} = 'IGNORE';
1899 local $SIG{INT} = 'IGNORE';
1900 local $SIG{QUIT} = 'IGNORE';
1901 local $SIG{TERM} = 'IGNORE';
1902 local $SIG{TSTP} = 'IGNORE';
1903 local $SIG{PIPE} = 'IGNORE';
1905 my $oldAutoCommit = $FS::UID::AutoCommit;
1906 local $FS::UID::AutoCommit = 0;
1909 my $old = $self->select_for_update;
1911 my $pkgnum = $old->pkgnum;
1912 if ( $old->get('cancel') || $self->get('cancel') ) {
1913 $dbh->rollback if $oldAutoCommit;
1914 return "Can't unsuspend cancelled package $pkgnum";
1917 unless ( $old->get('susp') && $self->get('susp') ) {
1918 $dbh->rollback if $oldAutoCommit;
1919 return ""; # no error # complain instead?
1922 # handle the case of setting a future unsuspend (resume) date
1923 # and do not continue to actually unsuspend the package
1924 my $date = $opt{'date'};
1925 if ( $date and $date > time ) { # return an error if $date <= time?
1927 if ( $old->get('expire') && $old->get('expire') < $date ) {
1928 $dbh->rollback if $oldAutoCommit;
1929 return "Package $pkgnum expires before it would be unsuspended.";
1932 my $new = new FS::cust_pkg { $self->hash };
1933 $new->set('resume', $date);
1934 $error = $new->replace($self, options => $self->options);
1937 $dbh->rollback if $oldAutoCommit;
1941 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1947 if (!$self->setup) {
1948 # then this package is being released from on-hold status
1949 $self->set_initial_timers;
1954 foreach my $cust_svc (
1955 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1957 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1959 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1960 $dbh->rollback if $oldAutoCommit;
1961 return "Illegal svcdb value in part_svc!";
1964 require "FS/$svcdb.pm";
1966 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1968 $error = $svc->unsuspend;
1970 $dbh->rollback if $oldAutoCommit;
1973 my( $label, $value ) = $cust_svc->label;
1974 push @labels, "$label: $value";
1979 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1980 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1982 my %hash = $self->hash;
1983 my $inactive = time - $hash{'susp'};
1985 my $conf = new FS::Conf;
1987 # increment next bill date if certain conditions are met:
1988 # - it was due to be billed at some point
1989 # - either the global or local config says to do this
1990 my $adjust_bill = 0;
1993 && ( $hash{'bill'} || $hash{'setup'} )
1994 && ( $opt{'adjust_next_bill'}
1995 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1996 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
2003 # - the package billed during suspension
2004 # - or it was ordered on hold
2005 # - or the customer was credited for the unused time
2007 if ( $self->option('suspend_bill',1)
2008 or ( $self->part_pkg->option('suspend_bill',1)
2009 and ! $self->option('no_suspend_bill',1)
2011 or $hash{'order_date'} == $hash{'susp'}
2016 if ( $adjust_bill ) {
2017 if ( $self->part_pkg->option('unused_credit_suspend')
2018 or ( $reason and $reason->unused_credit ) ) {
2019 # then the customer was credited for the unused time before suspending,
2020 # so their next bill should be immediate.
2021 $hash{'bill'} = time;
2023 # add the length of time suspended to the bill date
2024 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
2029 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
2030 $hash{'resume'} = '' if !$hash{'adjourn'};
2031 my $new = new FS::cust_pkg ( \%hash );
2032 $error = $new->replace( $self, options => { $self->options } );
2034 $dbh->rollback if $oldAutoCommit;
2041 if ( $reason->unsuspend_pkgpart ) {
2042 #warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n"; # in 4.x
2043 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
2044 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
2046 my $start_date = $self->cust_main->next_bill_date
2047 if $reason->unsuspend_hold;
2050 $unsusp_pkg = FS::cust_pkg->new({
2051 'custnum' => $self->custnum,
2052 'pkgpart' => $reason->unsuspend_pkgpart,
2053 'start_date' => $start_date,
2054 'locationnum' => $self->locationnum,
2055 # discount? probably not...
2058 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
2061 # new way, using fees
2062 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
2063 # register the need to charge a fee, cust_main->bill will do the rest
2064 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
2066 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
2067 'pkgreasonnum' => $cust_pkg_reason->num,
2068 'pkgnum' => $self->pkgnum,
2069 'feepart' => $reason->feepart,
2070 'nextbill' => $reason->fee_hold,
2072 $error ||= $cust_pkg_reason_fee->insert;
2076 $dbh->rollback if $oldAutoCommit;
2081 if ( $conf->config('unsuspend_email_admin') ) {
2083 my $error = send_email(
2084 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2085 #invoice_from ??? well as good as any
2086 'to' => $conf->config('unsuspend_email_admin'),
2087 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2088 "This is an automatic message from your Freeside installation\n",
2089 "informing you that the following customer package has been unsuspended:\n",
2091 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2092 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2093 ( map { "Service : $_\n" } @labels ),
2095 "An unsuspension fee was charged: ".
2096 $unsusp_pkg->part_pkg->pkg_comment."\n"
2100 'custnum' => $self->custnum,
2101 'msgtype' => 'admin',
2105 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2111 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2112 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2114 $dbh->rollback if $oldAutoCommit;
2115 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2119 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2126 Cancels any pending suspension (sets the adjourn field to null)
2127 for this package and any supplemental packages.
2129 If there is an error, returns the error, otherwise returns false.
2137 local $SIG{HUP} = 'IGNORE';
2138 local $SIG{INT} = 'IGNORE';
2139 local $SIG{QUIT} = 'IGNORE';
2140 local $SIG{TERM} = 'IGNORE';
2141 local $SIG{TSTP} = 'IGNORE';
2142 local $SIG{PIPE} = 'IGNORE';
2144 my $oldAutoCommit = $FS::UID::AutoCommit;
2145 local $FS::UID::AutoCommit = 0;
2148 my $old = $self->select_for_update;
2150 my $pkgnum = $old->pkgnum;
2151 if ( $old->get('cancel') || $self->get('cancel') ) {
2152 dbh->rollback if $oldAutoCommit;
2153 return "Can't unadjourn cancelled package $pkgnum";
2154 # or at least it's pointless
2157 if ( $old->get('susp') || $self->get('susp') ) {
2158 dbh->rollback if $oldAutoCommit;
2159 return "Can't unadjourn suspended package $pkgnum";
2160 # perhaps this is arbitrary
2163 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2164 dbh->rollback if $oldAutoCommit;
2165 return ""; # no error
2168 my %hash = $self->hash;
2169 $hash{'adjourn'} = '';
2170 $hash{'resume'} = '';
2171 my $new = new FS::cust_pkg ( \%hash );
2172 $error = $new->replace( $self, options => { $self->options } );
2174 $dbh->rollback if $oldAutoCommit;
2178 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2179 $error = $supp_pkg->unadjourn;
2181 $dbh->rollback if $oldAutoCommit;
2182 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2186 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2193 =item change HASHREF | OPTION => VALUE ...
2195 Changes this package: cancels it and creates a new one, with a different
2196 pkgpart or locationnum or both. All services are transferred to the new
2197 package (no change will be made if this is not possible).
2199 Options may be passed as a list of key/value pairs or as a hash reference.
2206 New locationnum, to change the location for this package.
2210 New FS::cust_location object, to create a new location and assign it
2215 New FS::cust_main object, to create a new customer and assign the new package
2220 New pkgpart (see L<FS::part_pkg>).
2224 New refnum (see L<FS::part_referral>).
2228 New quantity; if unspecified, the new package will have the same quantity
2233 "New" (existing) FS::cust_pkg object. The package's services and other
2234 attributes will be transferred to this package.
2238 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2239 susp, adjourn, cancel, expire, and contract_end) to the new package.
2241 =item unprotect_svcs
2243 Normally, change() will rollback and return an error if some services
2244 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2245 If unprotect_svcs is true, this method will transfer as many services as
2246 it can and then unconditionally cancel the old package.
2250 If specified, sets this value for the contract_end date on the new package
2251 (without regard for keep_dates or the usual date-preservation behavior.)
2252 Will throw an error if defined but false; the UI doesn't allow editing
2253 this unless it already exists, making removal impossible to undo.
2257 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2258 cust_pkg must be specified (otherwise, what's the point?)
2260 Returns either the new FS::cust_pkg object or a scalar error.
2264 my $err_or_new_cust_pkg = $old_cust_pkg->change
2268 #used by change and change_later
2269 #didn't put with documented check methods because it depends on change-specific opts
2270 #and it also possibly edits the value of opts
2274 if ( defined($opt->{'contract_end'}) ) {
2275 my $current_contract_end = $self->get('contract_end');
2276 unless ($opt->{'contract_end'}) {
2277 if ($current_contract_end) {
2278 return "Cannot remove contract end date when changing packages";
2280 #shouldn't even pass this option if there's not a current value
2281 #but can be handled gracefully if the option is empty
2282 warn "Contract end date passed unexpectedly";
2283 delete $opt->{'contract_end'};
2287 unless ($current_contract_end) {
2288 #option shouldn't be passed, throw error if it's non-empty
2289 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2295 #some false laziness w/order
2298 my $opt = ref($_[0]) ? shift : { @_ };
2300 my $conf = new FS::Conf;
2302 # handle contract_end on cust_pkg same as passed option
2303 if ( $opt->{'cust_pkg'} ) {
2304 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2305 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2308 # check contract_end, prevent adding/removing
2309 my $error = $self->_check_change($opt);
2310 return $error if $error;
2312 # Transactionize this whole mess
2313 local $SIG{HUP} = 'IGNORE';
2314 local $SIG{INT} = 'IGNORE';
2315 local $SIG{QUIT} = 'IGNORE';
2316 local $SIG{TERM} = 'IGNORE';
2317 local $SIG{TSTP} = 'IGNORE';
2318 local $SIG{PIPE} = 'IGNORE';
2320 my $oldAutoCommit = $FS::UID::AutoCommit;
2321 local $FS::UID::AutoCommit = 0;
2324 if ( $opt->{'cust_location'} ) {
2325 $error = $opt->{'cust_location'}->find_or_insert;
2327 $dbh->rollback if $oldAutoCommit;
2328 return "creating location record: $error";
2330 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2333 # figure out if we're changing pkgpart
2334 if ( $opt->{'cust_pkg'} ) {
2335 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2338 # whether to override pkgpart checking on the new package
2339 my $same_pkgpart = 1;
2340 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2344 # Before going any further here: if the package is still in the pre-setup
2345 # state, it's safe to modify it in place. No need to charge/credit for
2346 # partial period, transfer usage pools, copy invoice details, or change any
2347 # dates. We DO need to "transfer" services (from the package to itself) to
2348 # check their validity on the new pkgpart.
2349 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2350 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2351 if ( length($opt->{$_}) ) {
2352 $self->set($_, $opt->{$_});
2355 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2357 if ( !$same_pkgpart ) {
2358 $self->set_initial_timers;
2360 # but if contract_end was explicitly specified, that overrides all else
2361 $self->set('contract_end', $opt->{'contract_end'})
2362 if $opt->{'contract_end'};
2364 $error = $self->replace;
2366 $dbh->rollback if $oldAutoCommit;
2367 return "modifying package: $error";
2370 # check/convert services (only on pkgpart change, to avoid surprises
2371 # when editing locations)
2372 # (maybe do this if changing quantity?)
2373 if ( !$same_pkgpart ) {
2375 $error = $self->transfer($self);
2377 if ( $error and $error == 0 ) {
2378 $error = "transferring $error";
2379 } elsif ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2380 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2381 $error = $self->transfer($self, 'change_svcpart'=>1 );
2382 if ($error and $error == 0) {
2383 $error = "converting $error";
2388 $error = "unable to transfer all services";
2392 $dbh->rollback if $oldAutoCommit;
2396 } # done transferring services
2398 $dbh->commit if $oldAutoCommit;
2407 $hash{'setup'} = $time if $self->get('setup');
2409 $hash{'change_date'} = $time;
2410 $hash{"change_$_"} = $self->$_()
2411 foreach qw( pkgnum pkgpart locationnum );
2413 my $unused_credit = 0;
2414 my $keep_dates = $opt->{'keep_dates'};
2416 # Special case. If the pkgpart is changing, and the customer is going to be
2417 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2418 # and DO pass the flag to cancel() to credit the customer. If the old
2419 # package had a setup date, set the new package's setup to the package
2420 # change date so that it has the same status as before.
2421 if ( $opt->{'pkgpart'}
2422 and $opt->{'pkgpart'} != $self->pkgpart
2423 and $self->part_pkg->option('unused_credit_change', 1) ) {
2426 $hash{'last_bill'} = '';
2430 if ( $keep_dates ) {
2431 foreach my $date ( qw(setup bill last_bill) ) {
2432 $hash{$date} = $self->getfield($date);
2435 # always keep the following dates
2436 foreach my $date (qw(order_date susp adjourn cancel expire resume
2437 start_date contract_end)) {
2438 $hash{$date} = $self->getfield($date);
2440 # but if contract_end was explicitly specified, that overrides all else
2441 $hash{'contract_end'} = $opt->{'contract_end'}
2442 if $opt->{'contract_end'};
2444 # allow $opt->{'locationnum'} = '' to specifically set it to null
2445 # (i.e. customer default location)
2446 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2448 # usually this doesn't matter. the two cases where it does are:
2449 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2451 # 2. (more importantly) changing a package before it's billed
2452 $hash{'waive_setup'} = $self->waive_setup;
2454 # if this package is scheduled for a future package change, preserve that
2455 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2457 my $custnum = $self->custnum;
2458 if ( $opt->{cust_main} ) {
2459 my $cust_main = $opt->{cust_main};
2460 unless ( $cust_main->custnum ) {
2461 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2463 $dbh->rollback if $oldAutoCommit;
2464 return "inserting customer record: $error";
2467 $custnum = $cust_main->custnum;
2470 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2473 if ( $opt->{'cust_pkg'} ) {
2474 # The target package already exists; update it to show that it was
2475 # changed from this package.
2476 $cust_pkg = $opt->{'cust_pkg'};
2478 # follow all the above rules for date changes, etc.
2479 foreach (keys %hash) {
2480 $cust_pkg->set($_, $hash{$_});
2482 # except those that implement the future package change behavior
2483 foreach (qw(change_to_pkgnum start_date expire)) {
2484 $cust_pkg->set($_, '');
2487 $error = $cust_pkg->replace;
2490 # Create the new package.
2491 $cust_pkg = new FS::cust_pkg {
2492 custnum => $custnum,
2493 locationnum => $opt->{'locationnum'},
2494 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2495 qw( pkgpart quantity refnum salesnum )
2499 $error = $cust_pkg->insert( 'change' => 1,
2500 'allow_pkgpart' => $same_pkgpart );
2503 $dbh->rollback if $oldAutoCommit;
2504 return "inserting new package: $error";
2507 # Transfer services and cancel old package.
2508 # Enforce service limits only if this is a pkgpart change.
2509 local $FS::cust_svc::ignore_quantity;
2510 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2511 $error = $self->transfer($cust_pkg);
2512 if ($error and $error == 0) {
2513 # $old_pkg->transfer failed.
2514 $dbh->rollback if $oldAutoCommit;
2515 return "transferring $error";
2518 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2519 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2520 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2521 if ($error and $error == 0) {
2522 # $old_pkg->transfer failed.
2523 $dbh->rollback if $oldAutoCommit;
2524 return "converting $error";
2528 # We set unprotect_svcs when executing a "future package change". It's
2529 # not a user-interactive operation, so returning an error means the
2530 # package change will just fail. Rather than have that happen, we'll
2531 # let leftover services be deleted.
2532 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2533 # Transfers were successful, but we still had services left on the old
2534 # package. We can't change the package under this circumstances, so abort.
2535 $dbh->rollback if $oldAutoCommit;
2536 return "unable to transfer all services";
2539 #reset usage if changing pkgpart
2540 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2541 if ($self->pkgpart != $cust_pkg->pkgpart) {
2542 my $part_pkg = $cust_pkg->part_pkg;
2543 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2547 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2550 $dbh->rollback if $oldAutoCommit;
2551 return "setting usage values: $error";
2554 # if NOT changing pkgpart, transfer any usage pools over
2555 foreach my $usage ($self->cust_pkg_usage) {
2556 $usage->set('pkgnum', $cust_pkg->pkgnum);
2557 $error = $usage->replace;
2559 $dbh->rollback if $oldAutoCommit;
2560 return "transferring usage pools: $error";
2565 # transfer discounts, if we're not changing pkgpart
2566 if ( $same_pkgpart ) {
2567 foreach my $old_discount ($self->cust_pkg_discount_active) {
2568 # don't remove the old discount, we may still need to bill that package.
2569 my $new_discount = new FS::cust_pkg_discount {
2570 'pkgnum' => $cust_pkg->pkgnum,
2571 'discountnum' => $old_discount->discountnum,
2572 'months_used' => $old_discount->months_used,
2574 $error = $new_discount->insert;
2576 $dbh->rollback if $oldAutoCommit;
2577 return "transferring discounts: $error";
2582 # transfer (copy) invoice details
2583 foreach my $detail ($self->cust_pkg_detail) {
2584 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2585 $new_detail->set('pkgdetailnum', '');
2586 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2587 $error = $new_detail->insert;
2589 $dbh->rollback if $oldAutoCommit;
2590 return "transferring package notes: $error";
2594 # transfer scheduled expire/adjourn reasons
2595 foreach my $action ('expire', 'adjourn') {
2596 if ( $cust_pkg->get($action) ) {
2597 my $reason = $self->last_cust_pkg_reason($action);
2599 $reason->set('pkgnum', $cust_pkg->pkgnum);
2600 $error = $reason->replace;
2602 $dbh->rollback if $oldAutoCommit;
2603 return "transferring $action reason: $error";
2611 if ( !$opt->{'cust_pkg'} ) {
2612 # Order any supplemental packages.
2613 my $part_pkg = $cust_pkg->part_pkg;
2614 my @old_supp_pkgs = $self->supplemental_pkgs;
2615 foreach my $link ($part_pkg->supp_part_pkg_link) {
2617 foreach (@old_supp_pkgs) {
2618 if ($_->pkgpart == $link->dst_pkgpart) {
2620 $_->pkgpart(0); # so that it can't match more than once
2624 # false laziness with FS::cust_main::Packages::order_pkg
2625 my $new = FS::cust_pkg->new({
2626 pkgpart => $link->dst_pkgpart,
2627 pkglinknum => $link->pkglinknum,
2628 custnum => $custnum,
2629 main_pkgnum => $cust_pkg->pkgnum,
2630 locationnum => $cust_pkg->locationnum,
2631 start_date => $cust_pkg->start_date,
2632 order_date => $cust_pkg->order_date,
2633 expire => $cust_pkg->expire,
2634 adjourn => $cust_pkg->adjourn,
2635 contract_end => $cust_pkg->contract_end,
2636 refnum => $cust_pkg->refnum,
2637 discountnum => $cust_pkg->discountnum,
2638 waive_setup => $cust_pkg->waive_setup,
2640 if ( $old and $opt->{'keep_dates'} ) {
2641 foreach (qw(setup bill last_bill)) {
2642 $new->set($_, $old->get($_));
2645 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2648 $error ||= $old->transfer($new);
2650 if ( $error and $error > 0 ) {
2651 # no reason why this should ever fail, but still...
2652 $error = "Unable to transfer all services from supplemental package ".
2656 $dbh->rollback if $oldAutoCommit;
2659 push @new_supp_pkgs, $new;
2661 } # if !$opt->{'cust_pkg'}
2662 # because if there is one, then supplemental packages would already
2663 # have been created for it.
2665 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2667 #Don't allow billing the package (preceding period packages and/or
2668 #outstanding usage) if we are keeping dates (i.e. location changing),
2669 #because the new package will be billed for the same date range.
2670 #Supplemental packages are also canceled here.
2672 # during scheduled changes, avoid canceling the package we just
2674 $self->set('change_to_pkgnum' => '');
2676 $error = $self->cancel(
2678 unused_credit => $unused_credit,
2679 nobill => $keep_dates,
2680 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2681 no_delay_cancel => 1,
2684 $dbh->rollback if $oldAutoCommit;
2685 return "canceling old package: $error";
2688 # transfer rt_field_charge, if we're not changing pkgpart
2689 # after billing of old package, before billing of new package
2690 if ( $same_pkgpart ) {
2691 foreach my $rt_field_charge ($self->rt_field_charge) {
2692 $rt_field_charge->set('pkgnum', $cust_pkg->pkgnum);
2693 $error = $rt_field_charge->replace;
2695 $dbh->rollback if $oldAutoCommit;
2696 return "transferring rt_field_charge: $error";
2701 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2703 my $error = $cust_pkg->cust_main->bill(
2704 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2707 $dbh->rollback if $oldAutoCommit;
2708 return "billing new package: $error";
2712 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2718 =item change_later OPTION => VALUE...
2720 Schedule a package change for a later date. This actually orders the new
2721 package immediately, but sets its start date for a future date, and sets
2722 the current package to expire on the same date.
2724 If the package is already scheduled for a change, this can be called with
2725 'start_date' to change the scheduled date, or with pkgpart and/or
2726 locationnum to modify the package change. To cancel the scheduled change
2727 entirely, see C<abort_change>.
2735 The date for the package change. Required, and must be in the future.
2745 The pkgpart, locationnum, quantity and optional contract_end of the new
2746 package, with the same meaning as in C<change>.
2754 my $opt = ref($_[0]) ? shift : { @_ };
2756 # check contract_end, prevent adding/removing
2757 my $error = $self->_check_change($opt);
2758 return $error if $error;
2760 my $oldAutoCommit = $FS::UID::AutoCommit;
2761 local $FS::UID::AutoCommit = 0;
2764 my $cust_main = $self->cust_main;
2766 my $date = delete $opt->{'start_date'} or return 'start_date required';
2768 if ( $date <= time ) {
2769 $dbh->rollback if $oldAutoCommit;
2770 return "start_date $date is in the past";
2773 # If the user entered a new location, set it up now.
2774 if ( $opt->{'cust_location'} ) {
2775 $error = $opt->{'cust_location'}->find_or_insert;
2777 $dbh->rollback if $oldAutoCommit;
2778 return "creating location record: $error";
2780 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2783 if ( $self->change_to_pkgnum ) {
2784 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2785 my $new_pkgpart = $opt->{'pkgpart'}
2786 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2787 my $new_locationnum = $opt->{'locationnum'}
2788 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2789 my $new_quantity = $opt->{'quantity'}
2790 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2791 my $new_contract_end = $opt->{'contract_end'}
2792 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2793 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2794 # it hasn't been billed yet, so in principle we could just edit
2795 # it in place (w/o a package change), but that's bad form.
2796 # So change the package according to the new options...
2797 my $err_or_pkg = $change_to->change(%$opt);
2798 if ( ref $err_or_pkg ) {
2799 # Then set that package up for a future start.
2800 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2801 $self->set('expire', $date); # in case it's different
2802 $err_or_pkg->set('start_date', $date);
2803 $err_or_pkg->set('change_date', '');
2804 $err_or_pkg->set('change_pkgnum', '');
2806 $error = $self->replace ||
2807 $err_or_pkg->replace ||
2808 #because change() might've edited existing scheduled change in place
2809 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2810 $change_to->cancel('no_delay_cancel' => 1) ||
2811 $change_to->delete);
2813 $error = $err_or_pkg;
2815 } else { # change the start date only.
2816 $self->set('expire', $date);
2817 $change_to->set('start_date', $date);
2818 $error = $self->replace || $change_to->replace;
2821 $dbh->rollback if $oldAutoCommit;
2824 $dbh->commit if $oldAutoCommit;
2827 } # if $self->change_to_pkgnum
2829 my $new_pkgpart = $opt->{'pkgpart'}
2830 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2831 my $new_locationnum = $opt->{'locationnum'}
2832 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2833 my $new_quantity = $opt->{'quantity'}
2834 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2835 my $new_contract_end = $opt->{'contract_end'}
2836 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2838 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2840 # allow $opt->{'locationnum'} = '' to specifically set it to null
2841 # (i.e. customer default location)
2842 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2844 my $new = FS::cust_pkg->new( {
2845 custnum => $self->custnum,
2846 locationnum => $opt->{'locationnum'},
2847 start_date => $date,
2848 map { $_ => ( $opt->{$_} || $self->$_() ) }
2849 qw( pkgpart quantity refnum salesnum contract_end )
2851 $error = $new->insert('change' => 1,
2852 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2854 $self->set('change_to_pkgnum', $new->pkgnum);
2855 $self->set('expire', $date);
2856 $error = $self->replace;
2859 $dbh->rollback if $oldAutoCommit;
2861 $dbh->commit if $oldAutoCommit;
2869 Cancels a future package change scheduled by C<change_later>.
2875 my $pkgnum = $self->change_to_pkgnum;
2876 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2879 $error = $change_to->cancel || $change_to->delete;
2880 return $error if $error;
2882 $self->set('change_to_pkgnum', '');
2883 $self->set('expire', '');
2887 =item set_quantity QUANTITY
2889 Change the package's quantity field. This is one of the few package properties
2890 that can safely be changed without canceling and reordering the package
2891 (because it doesn't affect tax eligibility). Returns an error or an
2898 $self = $self->replace_old; # just to make sure
2899 $self->quantity(shift);
2903 =item set_salesnum SALESNUM
2905 Change the package's salesnum (sales person) field. This is one of the few
2906 package properties that can safely be changed without canceling and reordering
2907 the package (because it doesn't affect tax eligibility). Returns an error or
2914 $self = $self->replace_old; # just to make sure
2915 $self->salesnum(shift);
2917 # XXX this should probably reassign any credit that's already been given
2920 =item modify_charge OPTIONS
2922 Change the properties of a one-time charge. The following properties can
2923 be changed this way:
2924 - pkg: the package description
2925 - classnum: the package class
2926 - additional: arrayref of additional invoice details to add to this package
2928 and, I<if the charge has not yet been billed>:
2929 - start_date: the date when it will be billed
2930 - amount: the setup fee to be charged
2931 - quantity: the multiplier for the setup fee
2932 - separate_bill: whether to put the charge on a separate invoice
2934 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2935 commission credits linked to this charge, they will be recalculated.
2942 my $part_pkg = $self->part_pkg;
2943 my $pkgnum = $self->pkgnum;
2946 my $oldAutoCommit = $FS::UID::AutoCommit;
2947 local $FS::UID::AutoCommit = 0;
2949 return "Can't use modify_charge except on one-time charges"
2950 unless $part_pkg->freq eq '0';
2952 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2953 $part_pkg->set('pkg', $opt{'pkg'});
2956 my %pkg_opt = $part_pkg->options;
2957 my $pkg_opt_modified = 0;
2959 $opt{'additional'} ||= [];
2962 foreach (grep /^additional/, keys %pkg_opt) {
2963 ($i) = ($_ =~ /^additional_info(\d+)$/);
2964 $old_additional[$i] = $pkg_opt{$_} if $i;
2965 delete $pkg_opt{$_};
2968 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2969 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2970 if (!exists($old_additional[$i])
2971 or $old_additional[$i] ne $opt{'additional'}->[$i])
2973 $pkg_opt_modified = 1;
2976 $pkg_opt_modified = 1 if scalar(@old_additional) != $i;
2977 $pkg_opt{'additional_count'} = $i if $i > 0;
2980 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2983 $old_classnum = $part_pkg->classnum;
2984 $part_pkg->set('classnum', $opt{'classnum'});
2987 if ( !$self->get('setup') ) {
2988 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2991 if ( exists($opt{'amount'})
2992 and $part_pkg->option('setup_fee') != $opt{'amount'}
2993 and $opt{'amount'} > 0 ) {
2995 $pkg_opt{'setup_fee'} = $opt{'amount'};
2996 $pkg_opt_modified = 1;
2999 if ( exists($opt{'setup_cost'})
3000 and $part_pkg->setup_cost != $opt{'setup_cost'}
3001 and $opt{'setup_cost'} > 0 ) {
3003 $part_pkg->set('setup_cost', $opt{'setup_cost'});
3006 if ( exists($opt{'quantity'})
3007 and $opt{'quantity'} != $self->quantity
3008 and $opt{'quantity'} > 0 ) {
3010 $self->set('quantity', $opt{'quantity'});
3013 if ( exists($opt{'start_date'})
3014 and $opt{'start_date'} != $self->start_date ) {
3016 $self->set('start_date', $opt{'start_date'});
3019 if ( exists($opt{'separate_bill'})
3020 and $opt{'separate_bill'} ne $self->separate_bill ) {
3022 $self->set('separate_bill', $opt{'separate_bill'});
3026 } # else simply ignore them; the UI shouldn't allow editing the fields
3028 if ( exists($opt{'taxclass'})
3029 and $part_pkg->taxclass ne $opt{'taxclass'}) {
3031 $part_pkg->set('taxclass', $opt{'taxclass'});
3035 if ( $part_pkg->modified or $pkg_opt_modified ) {
3036 # can we safely modify the package def?
3037 # Yes, if it's not available for purchase, and this is the only instance
3039 if ( $part_pkg->disabled
3040 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
3041 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
3043 $error = $part_pkg->replace( options => \%pkg_opt );
3046 $part_pkg = $part_pkg->clone;
3047 $part_pkg->set('disabled' => 'Y');
3048 $error = $part_pkg->insert( options => \%pkg_opt );
3049 # and associate this as yet-unbilled package to the new package def
3050 $self->set('pkgpart' => $part_pkg->pkgpart);
3053 $dbh->rollback if $oldAutoCommit;
3058 if ($self->modified) { # for quantity or start_date change, or if we had
3059 # to clone the existing package def
3060 my $error = $self->replace;
3061 return $error if $error;
3063 if (defined $old_classnum) {
3064 # fix invoice grouping records
3065 my $old_catname = $old_classnum
3066 ? FS::pkg_class->by_key($old_classnum)->categoryname
3068 my $new_catname = $opt{'classnum'}
3069 ? $part_pkg->pkg_class->categoryname
3071 if ( $old_catname ne $new_catname ) {
3072 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
3073 # (there should only be one...)
3074 my @display = qsearch( 'cust_bill_pkg_display', {
3075 'billpkgnum' => $cust_bill_pkg->billpkgnum,
3076 'section' => $old_catname,
3078 foreach (@display) {
3079 $_->set('section', $new_catname);
3080 $error = $_->replace;
3082 $dbh->rollback if $oldAutoCommit;
3086 } # foreach $cust_bill_pkg
3089 if ( $opt{'adjust_commission'} ) {
3090 # fix commission credits...tricky.
3091 foreach my $cust_event ($self->cust_event) {
3092 my $part_event = $cust_event->part_event;
3093 foreach my $table (qw(sales agent)) {
3095 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3096 my $credit = qsearchs('cust_credit', {
3097 'eventnum' => $cust_event->eventnum,
3099 if ( $part_event->isa($class) ) {
3100 # Yes, this results in current commission rates being applied
3101 # retroactively to a one-time charge. For accounting purposes
3102 # there ought to be some kind of time limit on doing this.
3103 my $amount = $part_event->_calc_credit($self);
3104 if ( $credit and $credit->amount ne $amount ) {
3105 # Void the old credit.
3106 $error = $credit->void('Package class changed');
3108 $dbh->rollback if $oldAutoCommit;
3109 return "$error (adjusting commission credit)";
3112 # redo the event action to recreate the credit.
3114 eval { $part_event->do_action( $self, $cust_event ) };
3116 $dbh->rollback if $oldAutoCommit;
3119 } # if $part_event->isa($class)
3121 } # foreach $cust_event
3122 } # if $opt{'adjust_commission'}
3123 } # if defined $old_classnum
3125 $dbh->commit if $oldAutoCommit;
3129 use Storable 'thaw';
3132 sub process_bulk_cust_pkg {
3134 my $param = thaw(decode_base64(shift));
3135 warn Dumper($param) if $DEBUG;
3137 my $old_part_pkg = qsearchs('part_pkg',
3138 { pkgpart => $param->{'old_pkgpart'} });
3139 my $new_part_pkg = qsearchs('part_pkg',
3140 { pkgpart => $param->{'new_pkgpart'} });
3141 die "Must select a new package type\n" unless $new_part_pkg;
3142 #my $keep_dates = $param->{'keep_dates'} || 0;
3143 my $keep_dates = 1; # there is no good reason to turn this off
3145 local $SIG{HUP} = 'IGNORE';
3146 local $SIG{INT} = 'IGNORE';
3147 local $SIG{QUIT} = 'IGNORE';
3148 local $SIG{TERM} = 'IGNORE';
3149 local $SIG{TSTP} = 'IGNORE';
3150 local $SIG{PIPE} = 'IGNORE';
3152 my $oldAutoCommit = $FS::UID::AutoCommit;
3153 local $FS::UID::AutoCommit = 0;
3156 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3159 foreach my $old_cust_pkg ( @cust_pkgs ) {
3161 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3162 if ( $old_cust_pkg->getfield('cancel') ) {
3163 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3164 $old_cust_pkg->pkgnum."\n"
3168 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3170 my $error = $old_cust_pkg->change(
3171 'pkgpart' => $param->{'new_pkgpart'},
3172 'keep_dates' => $keep_dates
3174 if ( !ref($error) ) { # change returns the cust_pkg on success
3176 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3179 $dbh->commit if $oldAutoCommit;
3185 Returns the last bill date, or if there is no last bill date, the setup date.
3186 Useful for billing metered services.
3192 return $self->setfield('last_bill', $_[0]) if @_;
3193 return $self->getfield('last_bill') if $self->getfield('last_bill');
3194 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3195 'edate' => $self->bill, } );
3196 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3199 =item last_cust_pkg_reason ACTION
3201 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3202 Returns false if there is no reason or the package is not currenly ACTION'd
3203 ACTION is one of adjourn, susp, cancel, or expire.
3207 sub last_cust_pkg_reason {
3208 my ( $self, $action ) = ( shift, shift );
3209 my $date = $self->get($action);
3211 'table' => 'cust_pkg_reason',
3212 'hashref' => { 'pkgnum' => $self->pkgnum,
3213 'action' => substr(uc($action), 0, 1),
3216 'order_by' => 'ORDER BY num DESC LIMIT 1',
3220 =item last_reason ACTION
3222 Returns the most recent ACTION FS::reason associated with the package.
3223 Returns false if there is no reason or the package is not currenly ACTION'd
3224 ACTION is one of adjourn, susp, cancel, or expire.
3229 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3230 $cust_pkg_reason->reason
3231 if $cust_pkg_reason;
3236 Returns the definition for this billing item, as an FS::part_pkg object (see
3243 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3244 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3245 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3250 Returns the cancelled package this package was changed from, if any.
3256 return '' unless $self->change_pkgnum;
3257 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3260 =item change_cust_main
3262 Returns the customter this package was detached to, if any.
3266 sub change_cust_main {
3268 return '' unless $self->change_custnum;
3269 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3274 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3281 $self->part_pkg->calc_setup($self, @_);
3286 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3293 $self->part_pkg->calc_recur($self, @_);
3298 Returns the base setup fee (per unit) of this package, from the package
3303 # minimal version for 3.x; in 4.x this can invoke currency conversion
3307 $self->part_pkg->unit_setup($self);
3312 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3319 $self->part_pkg->base_recur($self, @_);
3324 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3331 $self->part_pkg->calc_remain($self, @_);
3336 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3343 $self->part_pkg->calc_cancel($self, @_);
3348 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3354 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3357 =item cust_pkg_detail [ DETAILTYPE ]
3359 Returns any customer package details for this package (see
3360 L<FS::cust_pkg_detail>).
3362 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3366 sub cust_pkg_detail {
3368 my %hash = ( 'pkgnum' => $self->pkgnum );
3369 $hash{detailtype} = shift if @_;
3371 'table' => 'cust_pkg_detail',
3372 'hashref' => \%hash,
3373 'order_by' => 'ORDER BY weight, pkgdetailnum',
3377 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3379 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3381 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3383 If there is an error, returns the error, otherwise returns false.
3387 sub set_cust_pkg_detail {
3388 my( $self, $detailtype, @details ) = @_;
3390 local $SIG{HUP} = 'IGNORE';
3391 local $SIG{INT} = 'IGNORE';
3392 local $SIG{QUIT} = 'IGNORE';
3393 local $SIG{TERM} = 'IGNORE';
3394 local $SIG{TSTP} = 'IGNORE';
3395 local $SIG{PIPE} = 'IGNORE';
3397 my $oldAutoCommit = $FS::UID::AutoCommit;
3398 local $FS::UID::AutoCommit = 0;
3401 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3402 my $error = $current->delete;
3404 $dbh->rollback if $oldAutoCommit;
3405 return "error removing old detail: $error";
3409 foreach my $detail ( @details ) {
3410 my $cust_pkg_detail = new FS::cust_pkg_detail {
3411 'pkgnum' => $self->pkgnum,
3412 'detailtype' => $detailtype,
3413 'detail' => $detail,
3415 my $error = $cust_pkg_detail->insert;
3417 $dbh->rollback if $oldAutoCommit;
3418 return "error adding new detail: $error";
3423 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3430 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3434 #false laziness w/cust_bill.pm
3438 'table' => 'cust_event',
3439 'addl_from' => 'JOIN part_event USING ( eventpart )',
3440 'hashref' => { 'tablenum' => $self->pkgnum },
3441 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3445 =item num_cust_event
3447 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3451 #false laziness w/cust_bill.pm
3452 sub num_cust_event {
3454 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3455 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3458 =item exists_cust_event
3460 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3464 sub exists_cust_event {
3466 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3467 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3468 $row ? $row->[0] : '';
3471 sub _from_cust_event_where {
3473 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3474 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3478 my( $self, $sql, @args ) = @_;
3479 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3480 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3484 =item cust_svc [ SVCPART ] (old, deprecated usage)
3486 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3488 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3490 Returns the services for this package, as FS::cust_svc objects (see
3491 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3492 spcififed, returns only the matching services.
3494 As an optimization, use the cust_svc_unsorted version if you are not displaying
3501 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3502 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3505 sub cust_svc_unsorted {
3507 @{ $self->cust_svc_unsorted_arrayref(@_) };
3510 sub cust_svc_unsorted_arrayref {
3513 return [] unless $self->num_cust_svc(@_);
3516 if ( @_ && $_[0] =~ /^\d+/ ) {
3517 $opt{svcpart} = shift;
3518 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3525 'select' => 'cust_svc.*, part_svc.*',
3526 'table' => 'cust_svc',
3527 'hashref' => { 'pkgnum' => $self->pkgnum },
3528 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3530 $search{hashref}->{svcpart} = $opt{svcpart}
3532 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3535 [ qsearch(\%search) ];
3539 =item overlimit [ SVCPART ]
3541 Returns the services for this package which have exceeded their
3542 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3543 is specified, return only the matching services.
3549 return () unless $self->num_cust_svc(@_);
3550 grep { $_->overlimit } $self->cust_svc(@_);
3553 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3555 Returns historical services for this package created before END TIMESTAMP and
3556 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3557 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3558 I<pkg_svc.hidden> flag will be omitted.
3564 warn "$me _h_cust_svc called on $self\n"
3567 my ($end, $start, $mode) = @_;
3568 my @cust_svc = $self->_sort_cust_svc(
3569 [ qsearch( 'h_cust_svc',
3570 { 'pkgnum' => $self->pkgnum, },
3571 FS::h_cust_svc->sql_h_search(@_),
3574 if ( defined($mode) && $mode eq 'I' ) {
3575 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3576 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3582 sub _sort_cust_svc {
3583 my( $self, $arrayref ) = @_;
3586 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3588 my %pkg_svc = map { $_->svcpart => $_ }
3589 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3594 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3596 $pkg_svc ? $pkg_svc->primary_svc : '',
3597 $pkg_svc ? $pkg_svc->quantity : 0,
3604 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3606 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3608 Returns the number of services for this package. Available options are svcpart
3609 and svcdb. If either is spcififed, returns only the matching services.
3616 return $self->{'_num_cust_svc'}
3618 && exists($self->{'_num_cust_svc'})
3619 && $self->{'_num_cust_svc'} =~ /\d/;
3621 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3625 if ( @_ && $_[0] =~ /^\d+/ ) {
3626 $opt{svcpart} = shift;
3627 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3633 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3634 my $where = ' WHERE pkgnum = ? ';
3635 my @param = ($self->pkgnum);
3637 if ( $opt{'svcpart'} ) {
3638 $where .= ' AND svcpart = ? ';
3639 push @param, $opt{'svcpart'};
3641 if ( $opt{'svcdb'} ) {
3642 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3643 $where .= ' AND svcdb = ? ';
3644 push @param, $opt{'svcdb'};
3647 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3648 $sth->execute(@param) or die $sth->errstr;
3649 $sth->fetchrow_arrayref->[0];
3652 =item available_part_svc
3654 Returns a list of FS::part_svc objects representing services included in this
3655 package but not yet provisioned. Each FS::part_svc object also has an extra
3656 field, I<num_avail>, which specifies the number of available services.
3658 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3659 associated pkg_svc has the provision_hold flag set.
3663 sub available_part_svc {
3667 my $pkg_quantity = $self->quantity || 1;
3669 grep { $_->num_avail > 0 }
3671 my $part_svc = $_->part_svc;
3672 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3673 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3675 # more evil encapsulation breakage
3676 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3677 my @exports = $part_svc->part_export_did;
3678 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3683 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3684 $self->part_pkg->pkg_svc;
3687 =item part_svc [ OPTION => VALUE ... ]
3689 Returns a list of FS::part_svc objects representing provisioned and available
3690 services included in this package. Each FS::part_svc object also has the
3691 following extra fields:
3705 (services) - array reference containing the provisioned services, as cust_svc objects
3709 Accepts two options:
3713 =item summarize_size
3715 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3716 is this size or greater.
3718 =item hide_discontinued
3720 If true, will omit looking for services that are no longer avaialble in the
3728 #label -> ($cust_svc->label)[1]
3734 my $pkg_quantity = $self->quantity || 1;
3736 #XXX some sort of sort order besides numeric by svcpart...
3737 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3739 my $part_svc = $pkg_svc->part_svc;
3740 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3741 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3742 $part_svc->{'Hash'}{'num_avail'} =
3743 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3744 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3745 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3746 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3747 && $num_cust_svc >= $opt{summarize_size};
3748 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3750 } $self->part_pkg->pkg_svc;
3752 unless ( $opt{hide_discontinued} ) {
3754 push @part_svc, map {
3756 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3757 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3758 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3759 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3760 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3762 } $self->extra_part_svc;
3769 =item extra_part_svc
3771 Returns a list of FS::part_svc objects corresponding to services in this
3772 package which are still provisioned but not (any longer) available in the
3777 sub extra_part_svc {
3780 my $pkgnum = $self->pkgnum;
3781 #my $pkgpart = $self->pkgpart;
3784 # 'table' => 'part_svc',
3787 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3788 # WHERE pkg_svc.svcpart = part_svc.svcpart
3789 # AND pkg_svc.pkgpart = ?
3792 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3793 # LEFT JOIN cust_pkg USING ( pkgnum )
3794 # WHERE cust_svc.svcpart = part_svc.svcpart
3797 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3800 #seems to benchmark slightly faster... (or did?)
3802 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3803 my $pkgparts = join(',', @pkgparts);
3806 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3807 #MySQL doesn't grok DISINCT ON
3808 'select' => 'DISTINCT part_svc.*',
3809 'table' => 'part_svc',
3811 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3812 AND pkg_svc.pkgpart IN ($pkgparts)
3815 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3816 LEFT JOIN cust_pkg USING ( pkgnum )
3819 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3820 'extra_param' => [ [$self->pkgnum=>'int'] ],
3826 Returns a short status string for this package, currently:
3832 =item not yet billed
3834 =item one-time charge
3849 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3851 return 'cancelled' if $self->get('cancel');
3852 return 'on hold' if $self->susp && ! $self->setup;
3853 return 'suspended' if $self->susp;
3854 return 'not yet billed' unless $self->setup;
3855 return 'one-time charge' if $freq =~ /^(0|$)/;
3859 =item ucfirst_status
3861 Returns the status with the first character capitalized.
3865 sub ucfirst_status {
3866 ucfirst(shift->status);
3871 Class method that returns the list of possible status strings for packages
3872 (see L<the status method|/status>). For example:
3874 @statuses = FS::cust_pkg->statuses();
3878 tie my %statuscolor, 'Tie::IxHash',
3879 'on hold' => 'FF00F5', #brighter purple!
3880 'not yet billed' => '009999', #teal? cyan?
3881 'one-time charge' => '0000CC', #blue #'000000',
3882 'active' => '00CC00',
3883 'suspended' => 'FF9900',
3884 'cancelled' => 'FF0000',
3888 my $self = shift; #could be class...
3889 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3890 # # mayble split btw one-time vs. recur
3901 Returns a hex triplet color string for this package's status.
3907 $statuscolor{$self->status};
3910 =item is_status_delay_cancel
3912 Returns true if part_pkg has option delay_cancel,
3913 cust_pkg status is 'suspended' and expire is set
3914 to cancel package within the next day (or however
3915 many days are set in global config part_pkg-delay_cancel-days.
3917 Accepts option I<part_pkg-delay_cancel-days> which should be
3918 the value of the config setting, to avoid looking it up again.
3920 This is not a real status, this only meant for hacking display
3921 values, because otherwise treating the package as suspended is
3922 really the whole point of the delay_cancel option.
3926 sub is_status_delay_cancel {
3927 my ($self,%opt) = @_;
3928 if ( $self->main_pkgnum and $self->pkglinknum ) {
3929 return $self->main_pkg->is_status_delay_cancel;
3931 return 0 unless $self->part_pkg->option('delay_cancel',1);
3932 return 0 unless $self->status eq 'suspended';
3933 return 0 unless $self->expire;
3934 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3936 my $conf = new FS::Conf;
3937 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3939 my $expsecs = 60*60*24*$expdays;
3940 return 0 unless $self->expire < time + $expsecs;
3946 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3947 "pkg - comment" depending on user preference).
3953 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3954 $label = $self->pkgnum. ": $label"
3955 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3959 =item pkg_label_long
3961 Returns a long label for this package, adding the primary service's label to
3966 sub pkg_label_long {
3968 my $label = $self->pkg_label;
3969 my $cust_svc = $self->primary_cust_svc;
3970 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3976 Returns a customer-localized label for this package.
3982 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3985 =item primary_cust_svc
3987 Returns a primary service (as FS::cust_svc object) if one can be identified.
3991 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3993 sub primary_cust_svc {
3996 my @cust_svc = $self->cust_svc;
3998 return '' unless @cust_svc; #no serivces - irrelevant then
4000 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
4002 # primary service as specified in the package definition
4003 # or exactly one service definition with quantity one
4004 my $svcpart = $self->part_pkg->svcpart;
4005 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
4006 return $cust_svc[0] if scalar(@cust_svc) == 1;
4008 #couldn't identify one thing..
4014 Returns a list of lists, calling the label method for all services
4015 (see L<FS::cust_svc>) of this billing item.
4021 map { [ $_->label ] } $self->cust_svc;
4024 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4026 Like the labels method, but returns historical information on services that
4027 were active as of END_TIMESTAMP and (optionally) not cancelled before
4028 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
4029 I<pkg_svc.hidden> flag will be omitted.
4031 If LOCALE is passed, service definition names will be localized.
4033 Returns a list of lists, calling the label method for all (historical)
4034 services (see L<FS::h_cust_svc>) of this billing item.
4040 my ($end, $start, $mode, $locale) = @_;
4041 warn "$me h_labels\n"
4043 map { [ $_->label($end, $start, $locale) ] }
4044 $self->h_cust_svc($end, $start, $mode);
4049 Like labels, except returns a simple flat list, and shortens long
4050 (currently >5 or the cust_bill-max_same_services configuration value) lists of
4051 identical services to one line that lists the service label and the number of
4052 individual services rather than individual items.
4057 shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
4060 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4062 Like h_labels, except returns a simple flat list, and shortens long
4063 (currently >5 or the cust_bill-max_same_services configuration value) lists
4064 of identical services to one line that lists the service label and the
4065 number of individual services rather than individual items.
4069 sub h_labels_short {
4070 shift->_labels_short( 'h_labels', @_ );
4073 # takes a method name ('labels' or 'h_labels') and all its arguments;
4074 # maybe should be "shorten($self->h_labels( ... ) )"
4077 my( $self, $method ) = ( shift, shift );
4079 warn "$me _labels_short called on $self with $method method\n"
4082 my $conf = new FS::Conf;
4083 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4085 warn "$me _labels_short populating \%labels\n"
4089 #tie %labels, 'Tie::IxHash';
4090 push @{ $labels{$_->[0]} }, $_->[1]
4091 foreach $self->$method(@_);
4093 warn "$me _labels_short populating \@labels\n"
4097 foreach my $label ( keys %labels ) {
4099 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4100 my $num = scalar(@values);
4101 warn "$me _labels_short $num items for $label\n"
4104 if ( $num > $max_same_services ) {
4105 warn "$me _labels_short more than $max_same_services, so summarizing\n"
4107 push @labels, "$label ($num)";
4109 if ( $conf->exists('cust_bill-consolidate_services') ) {
4110 warn "$me _labels_short consolidating services\n"
4112 # push @labels, "$label: ". join(', ', @values);
4114 my $detail = "$label: ";
4115 $detail .= shift(@values). ', '
4117 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4119 push @labels, $detail;
4121 warn "$me _labels_short done consolidating services\n"
4124 warn "$me _labels_short adding service data\n"
4126 push @labels, map { "$label: $_" } @values;
4137 Returns the parent customer object (see L<FS::cust_main>).
4143 cluck 'cust_pkg->cust_main called' if $DEBUG;
4144 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
4149 Returns the balance for this specific package, when using
4150 experimental package balance.
4156 $self->cust_main->balance_pkgnum( $self->pkgnum );
4159 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4163 Returns the location object, if any (see L<FS::cust_location>).
4165 =item cust_location_or_main
4167 If this package is associated with a location, returns the locaiton (see
4168 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4170 =item location_label [ OPTION => VALUE ... ]
4172 Returns the label of the location object (see L<FS::cust_location>).
4176 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4178 =item tax_locationnum
4180 Returns the foreign key to a L<FS::cust_location> object for calculating
4181 tax on this package, as determined by the C<tax-pkg_address> and
4182 C<tax-ship_address> configuration flags.
4186 sub tax_locationnum {
4188 my $conf = FS::Conf->new;
4189 if ( $conf->exists('tax-pkg_address') ) {
4190 return $self->locationnum;
4192 elsif ( $conf->exists('tax-ship_address') ) {
4193 return $self->cust_main->ship_locationnum;
4196 return $self->cust_main->bill_locationnum;
4202 Returns the L<FS::cust_location> object for tax_locationnum.
4208 my $conf = FS::Conf->new;
4209 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4210 return FS::cust_location->by_key($self->locationnum);
4212 elsif ( $conf->exists('tax-ship_address') ) {
4213 return $self->cust_main->ship_location;
4216 return $self->cust_main->bill_location;
4220 =item seconds_since TIMESTAMP
4222 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4223 package have been online since TIMESTAMP, according to the session monitor.
4225 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4226 L<Time::Local> and L<Date::Parse> for conversion functions.
4231 my($self, $since) = @_;
4234 foreach my $cust_svc (
4235 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4237 $seconds += $cust_svc->seconds_since($since);
4244 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4246 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4247 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4250 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4251 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4257 sub seconds_since_sqlradacct {
4258 my($self, $start, $end) = @_;
4262 foreach my $cust_svc (
4264 my $part_svc = $_->part_svc;
4265 $part_svc->svcdb eq 'svc_acct'
4266 && scalar($part_svc->part_export_usage);
4269 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4276 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4278 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4279 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4283 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4284 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4289 sub attribute_since_sqlradacct {
4290 my($self, $start, $end, $attrib) = @_;
4294 foreach my $cust_svc (
4296 my $part_svc = $_->part_svc;
4297 scalar($part_svc->part_export_usage);
4300 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4312 my( $self, $value ) = @_;
4313 if ( defined($value) ) {
4314 $self->setfield('quantity', $value);
4316 $self->getfield('quantity') || 1;
4319 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4321 Transfers as many services as possible from this package to another package.
4323 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4324 object. The destination package must already exist.
4326 Services are moved only if the destination allows services with the correct
4327 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4328 this option with caution! No provision is made for export differences
4329 between the old and new service definitions. Probably only should be used
4330 when your exports for all service definitions of a given svcdb are identical.
4331 (attempt a transfer without it first, to move all possible svcpart-matching
4334 Any services that can't be moved remain in the original package.
4336 Returns an error, if there is one; otherwise, returns the number of services
4337 that couldn't be moved.
4342 my ($self, $dest_pkgnum, %opt) = @_;
4348 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4349 $dest = $dest_pkgnum;
4350 $dest_pkgnum = $dest->pkgnum;
4352 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4355 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4357 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4358 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4361 unless ( $self->pkgnum == $dest->pkgnum ) {
4362 foreach my $cust_svc ($dest->cust_svc) {
4363 $target{$cust_svc->svcpart}--;
4367 my %svcpart2svcparts = ();
4368 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4369 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4370 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4371 next if exists $svcpart2svcparts{$svcpart};
4372 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4373 $svcpart2svcparts{$svcpart} = [
4375 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4377 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4378 'svcpart' => $_ } );
4380 $pkg_svc ? $pkg_svc->primary_svc : '',
4381 $pkg_svc ? $pkg_svc->quantity : 0,
4385 grep { $_ != $svcpart }
4387 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4389 warn "alternates for svcpart $svcpart: ".
4390 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4396 foreach my $cust_svc ($self->cust_svc) {
4397 my $svcnum = $cust_svc->svcnum;
4399 if ( $target{$cust_svc->svcpart} > 0
4400 or $FS::cust_svc::ignore_quantity # maybe should be a 'force' option
4403 $target{$cust_svc->svcpart}--;
4405 local $FS::cust_svc::ignore_quantity = 1
4406 if $self->pkgnum == $dest->pkgnum;
4408 #why run replace at all in the $self->pkgnum == $dest->pkgnum case?
4409 # we do want to trigger location and pkg_change exports, but
4410 # without pkgnum changing from an old to new package, cust_svc->replace
4411 # doesn't know how to trigger those. :/
4412 # does this mean we scrap the whole idea of "safe to modify it in place",
4413 # or do we special-case and pass the info needed to cust_svc->replace? :/
4415 my $new = new FS::cust_svc { $cust_svc->hash };
4416 $new->pkgnum($dest_pkgnum);
4417 $error = $new->replace($cust_svc);
4419 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4422 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4423 warn "alternates to consider: ".
4424 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4427 my @alternate = grep {
4428 warn "considering alternate svcpart $_: ".
4429 "$target{$_} available in new package\n"
4432 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4435 warn "alternate(s) found\n" if $DEBUG;
4436 my $change_svcpart = $alternate[0];
4437 $target{$change_svcpart}--;
4438 my $new = new FS::cust_svc { $cust_svc->hash };
4439 $new->svcpart($change_svcpart);
4440 $new->pkgnum($dest_pkgnum);
4441 $error = $new->replace($cust_svc);
4451 my @label = $cust_svc->label;
4452 return "service $label[1]: $error";
4459 =item grab_svcnums SVCNUM, SVCNUM ...
4461 Change the pkgnum for the provided services to this packages. If there is an
4462 error, returns the error, otherwise returns false.
4470 local $SIG{HUP} = 'IGNORE';
4471 local $SIG{INT} = 'IGNORE';
4472 local $SIG{QUIT} = 'IGNORE';
4473 local $SIG{TERM} = 'IGNORE';
4474 local $SIG{TSTP} = 'IGNORE';
4475 local $SIG{PIPE} = 'IGNORE';
4477 my $oldAutoCommit = $FS::UID::AutoCommit;
4478 local $FS::UID::AutoCommit = 0;
4481 foreach my $svcnum (@svcnum) {
4482 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4483 $dbh->rollback if $oldAutoCommit;
4484 return "unknown svcnum $svcnum";
4486 $cust_svc->pkgnum( $self->pkgnum );
4487 my $error = $cust_svc->replace;
4489 $dbh->rollback if $oldAutoCommit;
4494 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4501 This method is deprecated. See the I<depend_jobnum> option to the insert and
4502 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4509 local $SIG{HUP} = 'IGNORE';
4510 local $SIG{INT} = 'IGNORE';
4511 local $SIG{QUIT} = 'IGNORE';
4512 local $SIG{TERM} = 'IGNORE';
4513 local $SIG{TSTP} = 'IGNORE';
4514 local $SIG{PIPE} = 'IGNORE';
4516 my $oldAutoCommit = $FS::UID::AutoCommit;
4517 local $FS::UID::AutoCommit = 0;
4520 foreach my $cust_svc ( $self->cust_svc ) {
4521 #false laziness w/svc_Common::insert
4522 my $svc_x = $cust_svc->svc_x;
4523 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4524 my $error = $part_export->export_insert($svc_x);
4526 $dbh->rollback if $oldAutoCommit;
4532 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4537 =item export_pkg_change OLD_CUST_PKG
4539 Calls the "pkg_change" export action for all services attached to this package.
4543 sub export_pkg_change {
4544 my( $self, $old ) = ( shift, shift );
4546 local $SIG{HUP} = 'IGNORE';
4547 local $SIG{INT} = 'IGNORE';
4548 local $SIG{QUIT} = 'IGNORE';
4549 local $SIG{TERM} = 'IGNORE';
4550 local $SIG{TSTP} = 'IGNORE';
4551 local $SIG{PIPE} = 'IGNORE';
4553 my $oldAutoCommit = $FS::UID::AutoCommit;
4554 local $FS::UID::AutoCommit = 0;
4557 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4558 my $error = $svc_x->export('pkg_change', $self, $old);
4560 $dbh->rollback if $oldAutoCommit;
4565 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4572 Associates this package with a (suspension or cancellation) reason (see
4573 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4576 Available options are:
4582 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.
4586 the access_user (see L<FS::access_user>) providing the reason
4594 the action (cancel, susp, adjourn, expire) associated with the reason
4598 If there is an error, returns the error, otherwise returns false.
4603 my ($self, %options) = @_;
4605 my $otaker = $options{reason_otaker} ||
4606 $FS::CurrentUser::CurrentUser->username;
4609 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4613 } elsif ( ref($options{'reason'}) ) {
4615 return 'Enter a new reason (or select an existing one)'
4616 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4618 my $reason = new FS::reason({
4619 'reason_type' => $options{'reason'}->{'typenum'},
4620 'reason' => $options{'reason'}->{'reason'},
4622 my $error = $reason->insert;
4623 return $error if $error;
4625 $reasonnum = $reason->reasonnum;
4628 return "Unparseable reason: ". $options{'reason'};
4631 my $cust_pkg_reason =
4632 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4633 'reasonnum' => $reasonnum,
4634 'otaker' => $otaker,
4635 'action' => substr(uc($options{'action'}),0,1),
4636 'date' => $options{'date'}
4641 $cust_pkg_reason->insert;
4644 =item insert_discount
4646 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4647 inserting a new discount on the fly (see L<FS::discount>).
4649 Available options are:
4657 If there is an error, returns the error, otherwise returns false.
4661 sub insert_discount {
4662 #my ($self, %options) = @_;
4665 my $cust_pkg_discount = new FS::cust_pkg_discount {
4666 'pkgnum' => $self->pkgnum,
4667 'discountnum' => $self->discountnum,
4669 'end_date' => '', #XXX
4670 #for the create a new discount case
4671 '_type' => $self->discountnum__type,
4672 'amount' => $self->discountnum_amount,
4673 'percent' => $self->discountnum_percent,
4674 'months' => $self->discountnum_months,
4675 'setup' => $self->discountnum_setup,
4676 #'disabled' => $self->discountnum_disabled,
4679 $cust_pkg_discount->insert;
4682 =item set_usage USAGE_VALUE_HASHREF
4684 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4685 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4686 upbytes, downbytes, and totalbytes are appropriate keys.
4688 All svc_accts which are part of this package have their values reset.
4693 my ($self, $valueref, %opt) = @_;
4695 #only svc_acct can set_usage for now
4696 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4697 my $svc_x = $cust_svc->svc_x;
4698 $svc_x->set_usage($valueref, %opt)
4699 if $svc_x->can("set_usage");
4703 =item recharge USAGE_VALUE_HASHREF
4705 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4706 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4707 upbytes, downbytes, and totalbytes are appropriate keys.
4709 All svc_accts which are part of this package have their values incremented.
4714 my ($self, $valueref) = @_;
4716 #only svc_acct can set_usage for now
4717 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4718 my $svc_x = $cust_svc->svc_x;
4719 $svc_x->recharge($valueref)
4720 if $svc_x->can("recharge");
4724 =item cust_pkg_discount
4728 sub cust_pkg_discount {
4730 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4733 =item cust_pkg_discount_active
4737 sub cust_pkg_discount_active {
4739 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4742 =item cust_pkg_usage
4744 Returns a list of all voice usage counters attached to this package.
4748 sub cust_pkg_usage {
4750 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4753 =item apply_usage OPTIONS
4755 Takes the following options:
4756 - cdr: a call detail record (L<FS::cdr>)
4757 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4758 - minutes: the maximum number of minutes to be charged
4760 Finds available usage minutes for a call of this class, and subtracts
4761 up to that many minutes from the usage pool. If the usage pool is empty,
4762 and the C<cdr-minutes_priority> global config option is set, minutes may
4763 be taken from other calls as well. Either way, an allocation record will
4764 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4765 number of minutes of usage applied to the call.
4770 my ($self, %opt) = @_;
4771 my $cdr = $opt{cdr};
4772 my $rate_detail = $opt{rate_detail};
4773 my $minutes = $opt{minutes};
4774 my $classnum = $rate_detail->classnum;
4775 my $pkgnum = $self->pkgnum;
4776 my $custnum = $self->custnum;
4778 local $SIG{HUP} = 'IGNORE';
4779 local $SIG{INT} = 'IGNORE';
4780 local $SIG{QUIT} = 'IGNORE';
4781 local $SIG{TERM} = 'IGNORE';
4782 local $SIG{TSTP} = 'IGNORE';
4783 local $SIG{PIPE} = 'IGNORE';
4785 my $oldAutoCommit = $FS::UID::AutoCommit;
4786 local $FS::UID::AutoCommit = 0;
4788 my $order = FS::Conf->new->config('cdr-minutes_priority');
4792 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4794 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4796 my @usage_recs = qsearch({
4797 'table' => 'cust_pkg_usage',
4798 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4799 ' JOIN cust_pkg USING (pkgnum)'.
4800 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4801 'select' => 'cust_pkg_usage.*',
4802 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4803 " ( cust_pkg.custnum = $custnum AND ".
4804 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4805 $is_classnum . ' AND '.
4806 " cust_pkg_usage.minutes > 0",
4807 'order_by' => " ORDER BY priority ASC",
4810 my $orig_minutes = $minutes;
4812 while (!$error and $minutes > 0 and @usage_recs) {
4813 my $cust_pkg_usage = shift @usage_recs;
4814 $cust_pkg_usage->select_for_update;
4815 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4816 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4817 acctid => $cdr->acctid,
4818 minutes => min($cust_pkg_usage->minutes, $minutes),
4820 $cust_pkg_usage->set('minutes',
4821 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4823 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4824 $minutes -= $cdr_cust_pkg_usage->minutes;
4826 if ( $order and $minutes > 0 and !$error ) {
4827 # then try to steal minutes from another call
4829 'table' => 'cdr_cust_pkg_usage',
4830 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4831 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4832 ' JOIN cust_pkg USING (pkgnum)'.
4833 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4834 ' JOIN cdr USING (acctid)',
4835 'select' => 'cdr_cust_pkg_usage.*',
4836 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4837 " ( cust_pkg.pkgnum = $pkgnum OR ".
4838 " ( cust_pkg.custnum = $custnum AND ".
4839 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4840 " part_pkg_usage_class.classnum = $classnum",
4841 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4843 if ( $order eq 'time' ) {
4844 # find CDRs that are using minutes, but have a later startdate
4846 my $startdate = $cdr->startdate;
4847 if ($startdate !~ /^\d+$/) {
4848 die "bad cdr startdate '$startdate'";
4850 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4851 # minimize needless reshuffling
4852 $search{'order_by'} .= ', cdr.startdate DESC';
4854 # XXX may not work correctly with rate_time schedules. Could
4855 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4857 $search{'addl_from'} .=
4858 ' JOIN rate_detail'.
4859 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4860 if ( $order eq 'rate_high' ) {
4861 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4862 $rate_detail->min_charge;
4863 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4864 } elsif ( $order eq 'rate_low' ) {
4865 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4866 $rate_detail->min_charge;
4867 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4869 # this should really never happen
4870 die "invalid cdr-minutes_priority value '$order'\n";
4873 my @cdr_usage_recs = qsearch(\%search);
4875 while (!$error and @cdr_usage_recs and $minutes > 0) {
4876 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4877 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4878 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4879 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4880 $cdr_cust_pkg_usage->select_for_update;
4881 $old_cdr->select_for_update;
4882 $cust_pkg_usage->select_for_update;
4883 # in case someone else stole the usage from this CDR
4884 # while waiting for the lock...
4885 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4886 # steal the usage allocation and flag the old CDR for reprocessing
4887 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4888 # if the allocation is more minutes than we need, adjust it...
4889 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4891 $cdr_cust_pkg_usage->set('minutes', $minutes);
4892 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4893 $error = $cust_pkg_usage->replace;
4895 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4896 $error ||= $cdr_cust_pkg_usage->replace;
4897 # deduct the stolen minutes
4898 $minutes -= $cdr_cust_pkg_usage->minutes;
4900 # after all minute-stealing is done, reset the affected CDRs
4901 foreach (values %reproc_cdrs) {
4902 $error ||= $_->set_status('');
4903 # XXX or should we just call $cdr->rate right here?
4904 # it's not like we can create a loop this way, since the min_charge
4905 # or call time has to go monotonically in one direction.
4906 # we COULD get some very deep recursions going, though...
4908 } # if $order and $minutes
4911 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4913 $dbh->commit if $oldAutoCommit;
4914 return $orig_minutes - $minutes;
4918 =item supplemental_pkgs
4920 Returns a list of all packages supplemental to this one.
4924 sub supplemental_pkgs {
4926 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4931 Returns the package that this one is supplemental to, if any.
4937 if ( $self->main_pkgnum ) {
4938 return FS::cust_pkg->by_key($self->main_pkgnum);
4945 =head1 CLASS METHODS
4951 Returns an SQL expression identifying recurring packages.
4955 sub recurring_sql { "
4956 '0' != ( select freq from part_pkg
4957 where cust_pkg.pkgpart = part_pkg.pkgpart )
4962 Returns an SQL expression identifying one-time packages.
4967 '0' = ( select freq from part_pkg
4968 where cust_pkg.pkgpart = part_pkg.pkgpart )
4973 Returns an SQL expression identifying ordered packages (recurring packages not
4979 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4984 Returns an SQL expression identifying active packages.
4989 $_[0]->recurring_sql. "
4990 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4991 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4992 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4995 =item not_yet_billed_sql
4997 Returns an SQL expression identifying packages which have not yet been billed.
5001 sub not_yet_billed_sql { "
5002 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5003 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5004 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5009 Returns an SQL expression identifying inactive packages (one-time packages
5010 that are otherwise unsuspended/uncancelled).
5014 sub inactive_sql { "
5015 ". $_[0]->onetime_sql(). "
5016 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5017 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5018 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5023 Returns an SQL expression identifying on-hold packages.
5028 #$_[0]->recurring_sql(). ' AND '.
5030 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5031 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5032 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5039 Returns an SQL expression identifying suspended packages.
5043 sub suspended_sql { susp_sql(@_); }
5045 #$_[0]->recurring_sql(). ' AND '.
5047 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5048 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5049 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5056 Returns an SQL exprression identifying cancelled packages.
5060 sub cancelled_sql { cancel_sql(@_); }
5062 #$_[0]->recurring_sql(). ' AND '.
5063 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
5066 =item ncancelled_recurring_sql
5068 Returns an SQL expression identifying un-cancelled, recurring packages.
5072 sub ncancelled_recurring_sql {
5073 $_[0]->recurring_sql().
5074 " AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 ) ";
5079 Returns an SQL expression to give the package status as a string.
5085 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
5086 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
5087 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
5088 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
5089 WHEN ".onetime_sql()." THEN 'one-time charge'
5094 =item search HASHREF
5098 Returns a qsearch hash expression to search for parameters specified in HASHREF.
5099 Valid parameters are
5107 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
5111 Equivalent to "status", except that "canceled"/"cancelled" will exclude
5112 packages that were changed into a new package with the same pkgpart (i.e.
5113 location or quantity changes).
5117 boolean selects custom packages
5123 pkgpart or arrayref or hashref of pkgparts
5127 arrayref of beginning and ending epoch date
5131 arrayref of beginning and ending epoch date
5135 arrayref of beginning and ending epoch date
5139 arrayref of beginning and ending epoch date
5143 arrayref of beginning and ending epoch date
5147 arrayref of beginning and ending epoch date
5151 arrayref of beginning and ending epoch date
5155 pkgnum or APKG_pkgnum
5159 a value suited to passing to FS::UI::Web::cust_header
5163 specifies the user for agent virtualization
5167 boolean; if true, returns only packages with more than 0 FCC phone lines.
5169 =item state, country
5171 Limit to packages with a service location in the specified state and country.
5172 For FCC 477 reporting, mostly.
5176 Limit to packages whose service locations are the same as the customer's
5177 default service location.
5179 =item location_nocust
5181 Limit to packages whose service locations are not the customer's default
5184 =item location_census
5186 Limit to packages whose service locations have census tracts.
5188 =item location_nocensus
5190 Limit to packages whose service locations do not have a census tract.
5192 =item location_geocode
5194 Limit to packages whose locations have geocodes.
5196 =item location_geocode
5198 Limit to packages whose locations do not have geocodes.
5202 Limit to packages associated with a svc_broadband, associated with a sector,
5203 associated with this towernum (or any of these, if it's an arrayref) (or NO
5204 towernum, if it's zero). This is an extreme niche case.
5206 =item 477part, 477rownum, date
5208 Limit to packages included in a specific row of one of the FCC 477 reports.
5209 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
5210 is the report as-of date (completely unrelated to the package setup/bill/
5211 other date fields), and '477rownum' is the row number of the report starting
5212 with zero. Row numbers have no inherent meaning, so this is useful only
5213 for explaining a 477 report you've already run.
5220 my ($class, $params) = @_;
5227 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5229 "cust_main.agentnum = $1";
5236 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
5237 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
5241 # parse customer sales person
5244 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
5245 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
5246 : 'cust_main.salesnum IS NULL';
5251 # parse sales person
5254 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
5255 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
5256 : 'cust_pkg.salesnum IS NULL';
5263 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
5265 "cust_pkg.custnum = $1";
5272 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5274 "cust_pkg.pkgbatch = '$1'";
5281 if ( $params->{'magic'} eq 'active'
5282 || $params->{'status'} eq 'active' ) {
5284 push @where, FS::cust_pkg->active_sql();
5286 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
5287 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
5289 push @where, FS::cust_pkg->not_yet_billed_sql();
5291 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
5292 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
5294 push @where, FS::cust_pkg->inactive_sql();
5296 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
5297 || $params->{'status'} =~ /^on[ _]hold$/ ) {
5299 push @where, FS::cust_pkg->on_hold_sql();
5302 } elsif ( $params->{'magic'} eq 'suspended'
5303 || $params->{'status'} eq 'suspended' ) {
5305 push @where, FS::cust_pkg->suspended_sql();
5307 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
5308 || $params->{'status'} =~ /^cancell?ed$/ ) {
5310 push @where, FS::cust_pkg->cancelled_sql();
5314 ### special case: "magic" is used in detail links from browse/part_pkg,
5315 # where "cancelled" has the restriction "and not replaced with a package
5316 # of the same pkgpart". Be consistent with that.
5319 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
5320 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
5321 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
5322 # ...may not exist, if this was just canceled and not changed; in that
5323 # case give it a "new pkgpart" that never equals the old pkgpart
5324 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
5328 # parse package class
5331 if ( exists($params->{'classnum'}) ) {
5334 if ( ref($params->{'classnum'}) ) {
5336 if ( ref($params->{'classnum'}) eq 'HASH' ) {
5337 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
5338 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
5339 @classnum = @{ $params->{'classnum'} };
5341 die 'unhandled classnum ref '. $params->{'classnum'};
5345 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
5352 my @nums = grep $_, @classnum;
5353 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
5354 my $null = scalar( grep { $_ eq '' } @classnum );
5355 push @c_where, 'part_pkg.classnum IS NULL' if $null;
5357 if ( scalar(@c_where) == 1 ) {
5358 push @where, @c_where;
5359 } elsif ( @c_where ) {
5360 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
5369 # parse (customer) refnum (advertising source)
5372 if ( exists($params->{'refnum'}) ) {
5374 if (ref $params->{'refnum'}) {
5375 @refnum = @{ $params->{'refnum'} };
5377 @refnum = ( $params->{'refnum'} );
5379 my $in = join(',', grep /^\d+$/, @refnum);
5380 push @where, "cust_main.refnum IN($in)" if length $in;
5384 # parse package report options
5387 my @report_option = ();
5388 if ( exists($params->{'report_option'}) ) {
5389 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
5390 @report_option = @{ $params->{'report_option'} };
5391 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
5392 @report_option = split(',', $1);
5397 if (@report_option) {
5398 # this will result in the empty set for the dangling comma case as it should
5400 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5401 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5402 AND optionname = 'report_option_$_'
5403 AND optionvalue = '1' )"
5407 foreach my $any ( grep /^report_option_any/, keys %$params ) {
5409 my @report_option_any = ();
5410 if ( ref($params->{$any}) eq 'ARRAY' ) {
5411 @report_option_any = @{ $params->{$any} };
5412 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
5413 @report_option_any = split(',', $1);
5416 if (@report_option_any) {
5417 # this will result in the empty set for the dangling comma case as it should
5418 push @where, ' ( '. join(' OR ',
5419 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5420 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5421 AND optionname = 'report_option_$_'
5422 AND optionvalue = '1' )"
5423 } @report_option_any
5433 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
5439 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
5440 if $params->{fcc_line};
5446 if ( exists($params->{'censustract'}) ) {
5447 $params->{'censustract'} =~ /^([.\d]*)$/;
5448 my $censustract = "cust_location.censustract = '$1'";
5449 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
5450 push @where, "( $censustract )";
5454 # parse censustract2
5456 if ( exists($params->{'censustract2'})
5457 && $params->{'censustract2'} =~ /^(\d*)$/
5461 push @where, "cust_location.censustract LIKE '$1%'";
5464 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
5469 # parse country/state/zip
5471 for (qw(state country)) { # parsing rules are the same for these
5472 if ( exists($params->{$_})
5473 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
5475 # XXX post-2.3 only--before that, state/country may be in cust_main
5476 push @where, "cust_location.$_ = '$1'";
5479 if ( exists($params->{zip}) ) {
5480 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
5486 if ( $params->{location_cust} xor $params->{location_nocust} ) {
5487 my $op = $params->{location_cust} ? '=' : '!=';
5488 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
5490 if ( $params->{location_census} xor $params->{location_nocensus} ) {
5491 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
5492 push @where, "cust_location.censustract $op";
5494 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
5495 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
5496 push @where, "cust_location.geocode $op";
5503 if ( ref($params->{'pkgpart'}) ) {
5506 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
5507 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
5508 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
5509 @pkgpart = @{ $params->{'pkgpart'} };
5511 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
5514 @pkgpart = grep /^(\d+)$/, @pkgpart;
5516 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
5518 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5519 push @where, "pkgpart = $1";
5528 #false laziness w/report_cust_pkg.html
5531 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
5532 'active' => { 'susp'=>1, 'cancel'=>1 },
5533 'suspended' => { 'cancel' => 1 },
5538 if( exists($params->{'active'} ) ) {
5539 # This overrides all the other date-related fields, and includes packages
5540 # that were active at some time during the interval. It excludes:
5541 # - packages that were set up after the end of the interval
5542 # - packages that were canceled before the start of the interval
5543 # - packages that were suspended before the start of the interval
5544 # and are still suspended now
5545 my($beginning, $ending) = @{$params->{'active'}};
5547 "cust_pkg.setup IS NOT NULL",
5548 "cust_pkg.setup <= $ending",
5549 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5550 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
5551 "NOT (".FS::cust_pkg->onetime_sql . ")";
5554 my $exclude_change_from = 0;
5555 my $exclude_change_to = 0;
5557 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5559 if ( $params->{$field.'_null'} ) {
5561 push @where, "cust_pkg.$field IS NULL";
5562 # this should surely be obsoleted by now: OR cust_pkg.$field == 0
5566 next unless exists($params->{$field});
5568 my($beginning, $ending) = @{$params->{$field}};
5570 next if $beginning == 0 && $ending == 4294967295;
5573 "cust_pkg.$field IS NOT NULL",
5574 "cust_pkg.$field >= $beginning",
5575 "cust_pkg.$field <= $ending";
5577 $orderby ||= "ORDER BY cust_pkg.$field";
5579 if ( $field eq 'setup' ) {
5580 $exclude_change_from = 1;
5581 } elsif ( $field eq 'cancel' ) {
5582 $exclude_change_to = 1;
5583 } elsif ( $field eq 'change_date' ) {
5584 # if we are given setup and change_date ranges, and the setup date
5585 # falls in _both_ ranges, then include the package whether it was
5587 $exclude_change_from = 0;
5593 if ($exclude_change_from) {
5594 push @where, "change_pkgnum IS NULL";
5596 if ($exclude_change_to) {
5597 # a join might be more efficient here
5598 push @where, "NOT EXISTS(
5599 SELECT 1 FROM cust_pkg AS changed_to_pkg
5600 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5606 $orderby ||= 'ORDER BY bill';
5609 # parse magic, legacy, etc.
5612 if ( $params->{'magic'} &&
5613 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5616 $orderby = 'ORDER BY pkgnum';
5618 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5619 push @where, "pkgpart = $1";
5622 } elsif ( $params->{'query'} eq 'pkgnum' ) {
5624 $orderby = 'ORDER BY pkgnum';
5626 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5628 $orderby = 'ORDER BY pkgnum';
5631 SELECT count(*) FROM pkg_svc
5632 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
5633 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5634 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
5635 AND cust_svc.svcpart = pkg_svc.svcpart
5642 # parse the extremely weird 'towernum' param
5645 if ($params->{towernum}) {
5646 my $towernum = $params->{towernum};
5647 $towernum = [ $towernum ] if !ref($towernum);
5648 my $in = join(',', grep /^\d+$/, @$towernum);
5650 # inefficient, but this is an obscure feature
5651 eval "use FS::Report::Table";
5652 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5653 push @where, "EXISTS(
5654 SELECT 1 FROM tower_pkg_cache
5655 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5656 AND tower_pkg_cache.towernum IN ($in)
5662 # parse the 477 report drill-down options
5665 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5667 my ($date, $rownum, $agentnum);
5668 if ($params->{'date'} =~ /^(\d+)$/) {
5671 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5674 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5677 if ($date and defined($rownum)) {
5678 my $report = FS::Report::FCC_477->report($section,
5680 'agentnum' => $agentnum,
5683 my $pkgnums = $report->{detail}->[$rownum]
5684 or die "row $rownum is past the end of the report";
5685 # '0' so that if there are no pkgnums (empty string) it will create
5686 # a valid query that returns nothing
5687 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5689 # and this overrides everything
5690 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5691 } # else we're missing some params, ignore the whole business
5695 # setup queries, links, subs, etc. for the search
5698 # here is the agent virtualization
5699 if ($params->{CurrentUser}) {
5701 qsearchs('access_user', { username => $params->{CurrentUser} });
5704 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5709 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5712 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5714 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5715 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5716 'LEFT JOIN cust_location USING ( locationnum ) '.
5717 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5721 if ( $params->{'select_zip5'} ) {
5722 my $zip = 'cust_location.zip';
5724 $select = "DISTINCT substr($zip,1,5) as zip";
5725 $orderby = "ORDER BY substr($zip,1,5)";
5726 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5728 $select = join(', ',
5730 ( map "part_pkg.$_", qw( pkg freq ) ),
5731 'pkg_class.classname',
5732 'cust_main.custnum AS cust_main_custnum',
5733 FS::UI::Web::cust_sql_fields(
5734 $params->{'cust_fields'}
5737 $count_query = 'SELECT COUNT(*)';
5740 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5743 'table' => 'cust_pkg',
5745 'select' => $select,
5746 'extra_sql' => $extra_sql,
5747 'order_by' => $orderby,
5748 'addl_from' => $addl_from,
5749 'count_query' => $count_query,
5756 Returns a list of two package counts. The first is a count of packages
5757 based on the supplied criteria and the second is the count of residential
5758 packages with those same criteria. Criteria are specified as in the search
5764 my ($class, $params) = @_;
5766 my $sql_query = $class->search( $params );
5768 my $count_sql = delete($sql_query->{'count_query'});
5769 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5770 or die "couldn't parse count_sql";
5772 my $count_sth = dbh->prepare($count_sql)
5773 or die "Error preparing $count_sql: ". dbh->errstr;
5775 or die "Error executing $count_sql: ". $count_sth->errstr;
5776 my $count_arrayref = $count_sth->fetchrow_arrayref;
5778 return ( @$count_arrayref );
5782 =item tax_locationnum_sql
5784 Returns an SQL expression for the tax location for a package, based
5785 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5789 sub tax_locationnum_sql {
5790 my $conf = FS::Conf->new;
5791 if ( $conf->exists('tax-pkg_address') ) {
5792 'cust_pkg.locationnum';
5794 elsif ( $conf->exists('tax-ship_address') ) {
5795 'cust_main.ship_locationnum';
5798 'cust_main.bill_locationnum';
5804 Returns a list: the first item is an SQL fragment identifying matching
5805 packages/customers via location (taking into account shipping and package
5806 address taxation, if enabled), and subsequent items are the parameters to
5807 substitute for the placeholders in that fragment.
5812 my($class, %opt) = @_;
5813 my $ornull = $opt{'ornull'};
5815 my $conf = new FS::Conf;
5817 # '?' placeholders in _location_sql_where
5818 my $x = $ornull ? 3 : 2;
5829 if ( $conf->exists('tax-ship_address') ) {
5832 ( ( ship_last IS NULL OR ship_last = '' )
5833 AND ". _location_sql_where('cust_main', '', $ornull ). "
5835 OR ( ship_last IS NOT NULL AND ship_last != ''
5836 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5839 # AND payby != 'COMP'
5841 @main_param = ( @bill_param, @bill_param );
5845 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5846 @main_param = @bill_param;
5852 if ( $conf->exists('tax-pkg_address') ) {
5854 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5857 ( cust_pkg.locationnum IS NULL AND $main_where )
5858 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5861 @param = ( @main_param, @bill_param );
5865 $where = $main_where;
5866 @param = @main_param;
5874 #subroutine, helper for location_sql
5875 sub _location_sql_where {
5877 my $prefix = @_ ? shift : '';
5878 my $ornull = @_ ? shift : '';
5880 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5882 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5884 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5885 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5886 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5888 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5890 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5892 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5893 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5894 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5895 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5896 AND $table.${prefix}country = ?
5901 my( $self, $what ) = @_;
5903 my $what_show_zero = $what. '_show_zero';
5904 length($self->$what_show_zero())
5905 ? ($self->$what_show_zero() eq 'Y')
5906 : $self->part_pkg->$what_show_zero();
5913 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5915 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5916 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5918 CUSTNUM is a customer (see L<FS::cust_main>)
5920 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5921 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5924 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5925 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5926 new billing items. An error is returned if this is not possible (see
5927 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5930 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5931 newly-created cust_pkg objects.
5933 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5934 and inserted. Multiple FS::pkg_referral records can be created by
5935 setting I<refnum> to an array reference of refnums or a hash reference with
5936 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5937 record will be created corresponding to cust_main.refnum.
5942 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5944 my $conf = new FS::Conf;
5946 # Transactionize this whole mess
5947 local $SIG{HUP} = 'IGNORE';
5948 local $SIG{INT} = 'IGNORE';
5949 local $SIG{QUIT} = 'IGNORE';
5950 local $SIG{TERM} = 'IGNORE';
5951 local $SIG{TSTP} = 'IGNORE';
5952 local $SIG{PIPE} = 'IGNORE';
5954 my $oldAutoCommit = $FS::UID::AutoCommit;
5955 local $FS::UID::AutoCommit = 0;
5959 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5960 # return "Customer not found: $custnum" unless $cust_main;
5962 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5965 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5968 my $change = scalar(@old_cust_pkg) != 0;
5971 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5973 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5974 " to pkgpart ". $pkgparts->[0]. "\n"
5977 my $err_or_cust_pkg =
5978 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5979 'refnum' => $refnum,
5982 unless (ref($err_or_cust_pkg)) {
5983 $dbh->rollback if $oldAutoCommit;
5984 return $err_or_cust_pkg;
5987 push @$return_cust_pkg, $err_or_cust_pkg;
5988 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5993 # Create the new packages.
5994 foreach my $pkgpart (@$pkgparts) {
5996 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5998 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5999 pkgpart => $pkgpart,
6003 $error = $cust_pkg->insert( 'change' => $change );
6004 push @$return_cust_pkg, $cust_pkg;
6006 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
6007 my $supp_pkg = FS::cust_pkg->new({
6008 custnum => $custnum,
6009 pkgpart => $link->dst_pkgpart,
6011 main_pkgnum => $cust_pkg->pkgnum,
6014 $error ||= $supp_pkg->insert( 'change' => $change );
6015 push @$return_cust_pkg, $supp_pkg;
6019 $dbh->rollback if $oldAutoCommit;
6024 # $return_cust_pkg now contains refs to all of the newly
6027 # Transfer services and cancel old packages.
6028 foreach my $old_pkg (@old_cust_pkg) {
6030 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
6033 foreach my $new_pkg (@$return_cust_pkg) {
6034 $error = $old_pkg->transfer($new_pkg);
6035 if ($error and $error == 0) {
6036 # $old_pkg->transfer failed.
6037 $dbh->rollback if $oldAutoCommit;
6042 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
6043 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
6044 foreach my $new_pkg (@$return_cust_pkg) {
6045 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
6046 if ($error and $error == 0) {
6047 # $old_pkg->transfer failed.
6048 $dbh->rollback if $oldAutoCommit;
6055 # Transfers were successful, but we went through all of the
6056 # new packages and still had services left on the old package.
6057 # We can't cancel the package under the circumstances, so abort.
6058 $dbh->rollback if $oldAutoCommit;
6059 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
6061 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
6067 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6071 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
6073 A bulk change method to change packages for multiple customers.
6075 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
6076 L<FS::part_pkg>) to order for each customer. Duplicates are of course
6079 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
6080 replace. The services (see L<FS::cust_svc>) are moved to the
6081 new billing items. An error is returned if this is not possible (see
6084 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
6085 newly-created cust_pkg objects.
6090 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
6092 # Transactionize this whole mess
6093 local $SIG{HUP} = 'IGNORE';
6094 local $SIG{INT} = 'IGNORE';
6095 local $SIG{QUIT} = 'IGNORE';
6096 local $SIG{TERM} = 'IGNORE';
6097 local $SIG{TSTP} = 'IGNORE';
6098 local $SIG{PIPE} = 'IGNORE';
6100 my $oldAutoCommit = $FS::UID::AutoCommit;
6101 local $FS::UID::AutoCommit = 0;
6105 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
6108 while(scalar(@old_cust_pkg)) {
6110 my $custnum = $old_cust_pkg[0]->custnum;
6111 my (@remove) = map { $_->pkgnum }
6112 grep { $_->custnum == $custnum } @old_cust_pkg;
6113 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
6115 my $error = order $custnum, $pkgparts, \@remove, \@return;
6117 push @errors, $error
6119 push @$return_cust_pkg, @return;
6122 if (scalar(@errors)) {
6123 $dbh->rollback if $oldAutoCommit;
6124 return join(' / ', @errors);
6127 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6131 =item forward_emails
6133 Returns a hash of svcnums and corresponding email addresses
6134 for svc_acct services that can be used as source or dest
6135 for svc_forward services provisioned in this package.
6137 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
6138 service; if included, will ensure the current values of the
6139 specified service are included in the list, even if for some
6140 other reason they wouldn't be. If called as a class method
6141 with a specified service, returns only these current values.
6143 Caution: does not actually check if svc_forward services are
6144 available to be provisioned on this package.
6148 sub forward_emails {
6152 #load optional service, thoroughly validated
6153 die "Use svcnum or svc_forward, not both"
6154 if $opt{'svcnum'} && $opt{'svc_forward'};
6155 my $svc_forward = $opt{'svc_forward'};
6156 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
6158 die "Specified service is not a forward service"
6159 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
6160 die "Specified service not found"
6161 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
6165 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
6166 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
6168 #add current values from specified service, if there was one
6170 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
6171 my $svc_acct = $svc_forward->$method();
6172 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
6176 if (ref($self) eq 'FS::cust_pkg') {
6178 #and including the rest for this customer
6179 my($u_part_svc,@u_acct_svcparts);
6180 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
6181 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
6184 my $custnum = $self->getfield('custnum');
6185 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
6186 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
6187 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
6188 foreach my $acct_svcpart (@u_acct_svcparts) {
6189 foreach my $i_cust_svc (
6190 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
6191 'svcpart' => $acct_svcpart } )
6193 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
6194 $email{$svc_acct->svcnum} = $svc_acct->email;
6203 # Used by FS::Upgrade to migrate to a new database.
6204 sub _upgrade_data { # class method
6205 my ($class, %opts) = @_;
6206 $class->_upgrade_otaker(%opts);
6208 # RT#10139, bug resulting in contract_end being set when it shouldn't
6209 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
6210 # RT#10830, bad calculation of prorate date near end of year
6211 # the date range for bill is December 2009, and we move it forward
6212 # one year if it's before the previous bill date (which it should
6214 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
6215 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
6216 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
6217 # RT6628, add order_date to cust_pkg
6218 'update cust_pkg set order_date = (select history_date from h_cust_pkg
6219 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
6220 history_action = \'insert\') where order_date is null',
6222 foreach my $sql (@statements) {
6223 my $sth = dbh->prepare($sql);
6224 $sth->execute or die $sth->errstr;
6227 # RT31194: supplemental package links that are deleted don't clean up
6229 my @pkglinknums = qsearch({
6230 'select' => 'DISTINCT cust_pkg.pkglinknum',
6231 'table' => 'cust_pkg',
6232 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
6233 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
6234 AND part_pkg_link.pkglinknum IS NULL',
6236 foreach (@pkglinknums) {
6237 my $pkglinknum = $_->pkglinknum;
6238 warn "cleaning part_pkg_link #$pkglinknum\n";
6239 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
6240 my $error = $part_pkg_link->remove_linked;
6241 die $error if $error;
6244 # RT#73607: canceling a package with billing addons sometimes changes its
6246 # Find records where the last replace_new record for the package before it
6247 # was canceled has a different pkgpart from the package itself.
6248 my @cust_pkg = qsearch({
6249 'table' => 'cust_pkg',
6250 'select' => 'cust_pkg.*, h_cust_pkg.pkgpart AS h_pkgpart',
6251 'addl_from' => ' JOIN (
6252 SELECT pkgnum, MAX(historynum) AS historynum FROM h_cust_pkg
6253 WHERE cancel IS NULL
6254 AND history_action = \'replace_new\'
6256 ) AS last_history USING (pkgnum)
6257 JOIN h_cust_pkg USING (historynum)',
6258 'extra_sql' => ' WHERE cust_pkg.cancel is not null
6259 AND cust_pkg.pkgpart != h_cust_pkg.pkgpart'
6261 foreach my $cust_pkg ( @cust_pkg ) {
6262 my $pkgnum = $cust_pkg->pkgnum;
6263 warn "fixing pkgpart on canceled pkg#$pkgnum\n";
6264 $cust_pkg->set('pkgpart', $cust_pkg->h_pkgpart);
6265 my $error = $cust_pkg->replace;
6266 die $error if $error;
6271 # will autoload in v4+
6272 sub rt_field_charge {
6274 qsearch('rt_field_charge',{ 'pkgnum' => $self->pkgnum });
6281 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
6283 In sub order, the @pkgparts array (passed by reference) is clobbered.
6285 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
6286 method to pass dates to the recur_prog expression, it should do so.
6288 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
6289 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
6290 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
6291 configuration values. Probably need a subroutine which decides what to do
6292 based on whether or not we've fetched the user yet, rather than a hash. See
6293 FS::UID and the TODO.
6295 Now that things are transactional should the check in the insert method be
6300 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
6301 L<FS::pkg_svc>, schema.html from the base documentation