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);
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 passing a hashref will create
819 a new reason. The hashref should have the following keys: typenum - Reason
820 type (see L<FS::reason_type>, reason - Text of the new reason.
822 =item date - can be set to a unix style timestamp to specify when to
825 =item nobill - can be set true to skip billing if it might otherwise be done.
827 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
828 not credit it. This must be set (by change()) when changing the package
829 to a different pkgpart or location, and probably shouldn't be in any other
830 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
833 =item no_delay_cancel - prevents delay_cancel behavior
834 no matter what other options say, for use when changing packages (or any
835 other time you're really sure you want an immediate cancel)
839 If there is an error, returns the error, otherwise returns false.
843 #NOT DOCUMENTING - this should only be used when calling recursively
844 #=item delay_cancel - for internal use, to allow proper handling of
845 #supplemental packages when the main package is flagged to suspend
846 #before cancelling, probably shouldn't be used otherwise (set the
847 #corresponding package option instead)
850 my( $self, %options ) = @_;
853 # pass all suspend/cancel actions to the main package
854 # (unless the pkglinknum has been removed, then the link is defunct and
855 # this package can be canceled on its own)
856 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
857 return $self->main_pkg->cancel(%options);
860 my $conf = new FS::Conf;
862 warn "cust_pkg::cancel called with options".
863 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
866 local $SIG{HUP} = 'IGNORE';
867 local $SIG{INT} = 'IGNORE';
868 local $SIG{QUIT} = 'IGNORE';
869 local $SIG{TERM} = 'IGNORE';
870 local $SIG{TSTP} = 'IGNORE';
871 local $SIG{PIPE} = 'IGNORE';
873 my $oldAutoCommit = $FS::UID::AutoCommit;
874 local $FS::UID::AutoCommit = 0;
877 my $old = $self->select_for_update;
879 if ( $old->get('cancel') || $self->get('cancel') ) {
880 dbh->rollback if $oldAutoCommit;
881 return ""; # no error
884 # XXX possibly set cancel_time to the expire date?
885 my $cancel_time = $options{'time'} || time;
886 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
887 $date = '' if ($date && $date <= $cancel_time); # complain instead?
889 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
890 if ( !$date && $self->part_pkg->option('delay_cancel',1)
891 && (($self->status eq 'active') || ($self->status eq 'suspended'))
892 && !$options{'no_delay_cancel'}
894 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
895 my $expsecs = 60*60*24*$expdays;
896 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
897 $expsecs = $expsecs - $suspfor if $suspfor;
898 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
900 $date = $cancel_time + $expsecs;
904 #race condition: usage could be ongoing until unprovisioned
905 #resolved by performing a change package instead (which unprovisions) and
907 if ( !$options{nobill} && !$date ) {
908 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
909 my $copy = $self->new({$self->hash});
911 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
913 'time' => $cancel_time );
914 warn "Error billing during cancel, custnum ".
915 #$self->cust_main->custnum. ": $error"
920 if ( $options{'reason'} ) {
921 $error = $self->insert_reason( 'reason' => $options{'reason'},
922 'action' => $date ? 'expire' : 'cancel',
923 'date' => $date ? $date : $cancel_time,
924 'reason_otaker' => $options{'reason_otaker'},
927 dbh->rollback if $oldAutoCommit;
928 return "Error inserting cust_pkg_reason: $error";
932 my %svc_cancel_opt = ();
933 $svc_cancel_opt{'date'} = $date if $date;
934 foreach my $cust_svc (
937 sort { $a->[1] <=> $b->[1] }
938 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
939 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
941 my $part_svc = $cust_svc->part_svc;
942 next if ( defined($part_svc) and $part_svc->preserve );
943 my $error = $cust_svc->cancel( %svc_cancel_opt );
946 $dbh->rollback if $oldAutoCommit;
947 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
952 # if a reasonnum was passed, get the actual reason object so we can check
956 if ($options{'reason'} =~ /^\d+$/) {
957 $reason = FS::reason->by_key($options{'reason'});
961 # credit remaining time if any of these are true:
962 # - unused_credit => 1 was passed (this happens when canceling a package
963 # for a package change when unused_credit_change is set)
964 # - no unused_credit option, and there is a cancel reason, and the cancel
965 # reason says to credit the package
966 # - no unused_credit option, and the package definition says to credit the
967 # package on cancellation
969 if ( exists($options{'unused_credit'}) ) {
970 $do_credit = $options{'unused_credit'};
971 } elsif ( defined($reason) && $reason->unused_credit ) {
974 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
977 my $error = $self->credit_remaining('cancel', $cancel_time);
979 $dbh->rollback if $oldAutoCommit;
985 my %hash = $self->hash;
987 $hash{'expire'} = $date;
989 # just to be sure these are clear
990 $hash{'adjourn'} = undef;
991 $hash{'resume'} = undef;
994 $hash{'cancel'} = $cancel_time;
996 $hash{'change_custnum'} = $options{'change_custnum'};
998 # if this is a supplemental package that's lost its part_pkg_link, and it's
999 # being canceled for real, unlink it completely
1000 if ( !$date and ! $self->pkglinknum ) {
1001 $hash{main_pkgnum} = '';
1004 my $new = new FS::cust_pkg ( \%hash );
1005 $error = $new->replace( $self, options => { $self->options } );
1006 if ( $self->change_to_pkgnum ) {
1007 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1008 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1011 $dbh->rollback if $oldAutoCommit;
1015 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1016 $error = $supp_pkg->cancel(%options,
1018 'date' => $date, #in case it got changed by delay_cancel
1019 'delay_cancel' => $delay_cancel,
1022 $dbh->rollback if $oldAutoCommit;
1023 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1027 if ($delay_cancel && !$options{'from_main'}) {
1028 $error = $new->suspend(
1030 'time' => $cancel_time
1035 foreach my $usage ( $self->cust_pkg_usage ) {
1036 $error = $usage->delete;
1038 $dbh->rollback if $oldAutoCommit;
1039 return "deleting usage pools: $error";
1044 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1045 return '' if $date; #no errors
1047 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
1048 if ( !$options{'quiet'} &&
1049 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
1051 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1054 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1055 $error = $msg_template->send( 'cust_main' => $self->cust_main,
1056 'object' => $self );
1059 $error = send_email(
1060 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
1061 'to' => \@invoicing_list,
1062 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
1063 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
1064 'custnum' => $self->custnum,
1065 'msgtype' => '', #admin?
1068 #should this do something on errors?
1075 =item cancel_if_expired [ NOW_TIMESTAMP ]
1077 Cancels this package if its expire date has been reached.
1081 sub cancel_if_expired {
1083 my $time = shift || time;
1084 return '' unless $self->expire && $self->expire <= $time;
1085 my $error = $self->cancel;
1087 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1088 $self->custnum. ": $error";
1093 =item uncancel_svc_x
1095 For cancelled cust_pkg, returns a list of new, uninserted FS::svc_X records
1096 for services that would be inserted by L</uncancel>. Returned objects also
1097 include the field _h_svc_x, which contains the service history object.
1099 Set pkgnum before inserting.
1101 Accepts the following options:
1103 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1104 (and only if they would otherwise be returned by this)
1108 sub uncancel_svc_x {
1109 my ($self, %opt) = @_;
1111 die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1113 #find historical services within this timeframe before the package cancel
1114 # (incompatible with "time" option to cust_pkg->cancel?)
1115 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1116 # too little? (unprovisioing export delay?)
1117 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1118 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1121 foreach my $h_cust_svc (@h_cust_svc) {
1122 next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1123 # filter out services that still exist on this package (ie preserved svcs)
1124 # but keep services that have since been provisioned on another package (for informational purposes)
1125 next if qsearchs('cust_svc',{ 'svcnum' => $h_cust_svc->svcnum, 'pkgnum' => $self->pkgnum });
1126 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1127 next unless $h_svc_x; # this probably doesn't happen, but just in case
1128 (my $table = $h_svc_x->table) =~ s/^h_//;
1129 require "FS/$table.pm";
1130 my $class = "FS::$table";
1131 my $svc_x = $class->new( {
1132 'svcpart' => $h_cust_svc->svcpart,
1133 '_h_svc_x' => $h_svc_x,
1134 map { $_ => $h_svc_x->get($_) } fields($table)
1138 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1139 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1142 #these are pretty rare, but should handle them
1143 # - dsl_device (mac addresses)
1144 # - phone_device (mac addresses)
1145 # - dsl_note (ikano notes)
1146 # - domain_record (i.e. restore DNS information w/domains)
1147 # - inventory_item(?) (inventory w/un-cancelling service?)
1148 # - nas (svc_broaband nas stuff)
1149 #this stuff is unused in the wild afaik
1150 # - mailinglistmember
1152 # - svc_domain.parent_svcnum?
1153 # - acct_snarf (ancient mail fetching config)
1154 # - cgp_rule (communigate)
1155 # - cust_svc_option (used by our Tron stuff)
1156 # - acct_rt_transaction (used by our time worked stuff)
1158 push @svc_x, $svc_x;
1163 =item uncancel_svc_summary
1165 Returns an array of hashrefs, one for each service that could
1166 potentially be reprovisioned by L</uncancel>, with the following keys:
1174 label - from history table if not currently calculable, undefined if it can't be loaded
1176 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1178 num_cust_svc - number of svcs for this svcpart, only if summarizing (see below)
1180 Cannot be run from within a transaction. Performs inserts
1181 to test the results, and then rolls back the transaction.
1182 Does not perform exports, so does not catch if export would fail.
1184 Also accepts the following options:
1186 no_test_reprovision - skip the test inserts (reprovisionable field will not exist)
1188 summarize_size - if true, returns a single summary record for svcparts with at
1189 least this many svcs, will have key num_cust_svc but not uncancel_svcnum, label or reprovisionable
1193 sub uncancel_svc_summary {
1194 my ($self, %opt) = @_;
1196 die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1197 die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1199 local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1200 local $FS::UID::AutoCommit = 0;
1202 # sort by svcpart, to check summarize_size
1203 my $uncancel_svc_x = {};
1204 foreach my $svc_x (sort { $a->{'svcpart'} <=> $b->{'svcpart'} } $self->uncancel_svc_x) {
1205 $uncancel_svc_x->{$svc_x->svcpart} = [] unless $uncancel_svc_x->{$svc_x->svcpart};
1206 push @{$uncancel_svc_x->{$svc_x->svcpart}}, $svc_x;
1210 foreach my $svcpart (keys %$uncancel_svc_x) {
1211 my @svcpart_svc_x = @{$uncancel_svc_x->{$svcpart}};
1212 if ($opt{'summarize_size'} && (@svcpart_svc_x >= $opt{'summarize_size'})) {
1213 my $svc_x = $svcpart_svc_x[0]; #grab first one for access to $part_svc
1214 my $part_svc = $svc_x->part_svc;
1216 'svcpart' => $part_svc->svcpart,
1217 'svc' => $part_svc->svc,
1218 'num_cust_svc' => scalar(@svcpart_svc_x),
1221 foreach my $svc_x (@svcpart_svc_x) {
1222 my $part_svc = $svc_x->part_svc;
1224 'svcpart' => $part_svc->svcpart,
1225 'svc' => $part_svc->svc,
1226 'uncancel_svcnum' => $svc_x->get('_h_svc_x')->svcnum,
1228 $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1230 unless ($opt{'no_test_reprovision'}) {
1231 # avoid possibly fatal errors from missing linked records
1232 eval { $insert_error = $svc_x->insert };
1233 $insert_error ||= $@;
1235 if ($opt{'no_test_reprovision'} or $insert_error) {
1236 # avoid possibly fatal errors from missing linked records
1237 eval { $out->{'label'} = $svc_x->label };
1238 eval { $out->{'label'} = $svc_x->get('_h_svc_x')->label } unless defined($out->{'label'});
1239 $out->{'reprovisionable'} = 0 unless $opt{'no_test_reprovision'};
1241 $out->{'label'} = $svc_x->label;
1242 $out->{'reprovisionable'} = 1;
1255 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1256 locationnum, (other fields?). Attempts to re-provision cancelled services
1257 using history information (errors at this stage are not fatal).
1259 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1261 svc_fatal: service provisioning errors are fatal
1263 svc_errors: pass an array reference, will be filled in with any provisioning errors
1265 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1267 main_pkgnum: link the package as a supplemental package of this one. For
1273 my( $self, %options ) = @_;
1275 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1276 return '' unless $self->get('cancel');
1278 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1279 return $self->main_pkg->uncancel(%options);
1286 local $SIG{HUP} = 'IGNORE';
1287 local $SIG{INT} = 'IGNORE';
1288 local $SIG{QUIT} = 'IGNORE';
1289 local $SIG{TERM} = 'IGNORE';
1290 local $SIG{TSTP} = 'IGNORE';
1291 local $SIG{PIPE} = 'IGNORE';
1293 my $oldAutoCommit = $FS::UID::AutoCommit;
1294 local $FS::UID::AutoCommit = 0;
1298 # insert the new package
1301 my $cust_pkg = new FS::cust_pkg {
1302 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1303 bill => ( $options{'bill'} || $self->get('bill') ),
1305 uncancel_pkgnum => $self->pkgnum,
1306 main_pkgnum => ($options{'main_pkgnum'} || ''),
1307 map { $_ => $self->get($_) } qw(
1308 custnum pkgpart locationnum
1310 susp adjourn resume expire start_date contract_end dundate
1311 change_date change_pkgpart change_locationnum
1312 manual_flag no_auto separate_bill quantity agent_pkgid
1313 recur_show_zero setup_show_zero
1317 my $error = $cust_pkg->insert(
1318 'change' => 1, #supresses any referral credit to a referring customer
1319 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1322 $dbh->rollback if $oldAutoCommit;
1331 foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1333 $svc_x->pkgnum($cust_pkg->pkgnum);
1334 my $svc_error = $svc_x->insert;
1337 if ( $options{svc_fatal} ) {
1338 $dbh->rollback if $oldAutoCommit;
1341 # if we've failed to insert the svc_x object, svc_Common->insert
1342 # will have removed the cust_svc already. if not, then both records
1343 # were inserted but we failed for some other reason (export, most
1344 # likely). in that case, report the error and delete the records.
1345 push @svc_errors, $svc_error;
1346 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1348 # except if export_insert failed, export_delete probably won't be
1350 local $FS::svc_Common::noexport_hack = 1;
1351 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1352 if ( $cleanup_error ) { # and if THAT fails, then run away
1353 $dbh->rollback if $oldAutoCommit;
1354 return $cleanup_error;
1359 } #foreach uncancel_svc_x
1362 # also move over any services that didn't unprovision at cancellation
1365 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1366 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1367 my $error = $cust_svc->replace;
1369 $dbh->rollback if $oldAutoCommit;
1375 # Uncancel any supplemental packages, and make them supplemental to the
1379 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1381 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1383 $dbh->rollback if $oldAutoCommit;
1384 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1392 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1394 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1395 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1402 Cancels any pending expiration (sets the expire field to null)
1403 for this package and any supplemental packages.
1405 If there is an error, returns the error, otherwise returns false.
1413 local $SIG{HUP} = 'IGNORE';
1414 local $SIG{INT} = 'IGNORE';
1415 local $SIG{QUIT} = 'IGNORE';
1416 local $SIG{TERM} = 'IGNORE';
1417 local $SIG{TSTP} = 'IGNORE';
1418 local $SIG{PIPE} = 'IGNORE';
1420 my $oldAutoCommit = $FS::UID::AutoCommit;
1421 local $FS::UID::AutoCommit = 0;
1424 my $old = $self->select_for_update;
1426 my $pkgnum = $old->pkgnum;
1427 if ( $old->get('cancel') || $self->get('cancel') ) {
1428 dbh->rollback if $oldAutoCommit;
1429 return "Can't unexpire cancelled package $pkgnum";
1430 # or at least it's pointless
1433 unless ( $old->get('expire') && $self->get('expire') ) {
1434 dbh->rollback if $oldAutoCommit;
1435 return ""; # no error
1438 my %hash = $self->hash;
1439 $hash{'expire'} = '';
1440 my $new = new FS::cust_pkg ( \%hash );
1441 $error = $new->replace( $self, options => { $self->options } );
1443 $dbh->rollback if $oldAutoCommit;
1447 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1448 $error = $supp_pkg->unexpire;
1450 $dbh->rollback if $oldAutoCommit;
1451 return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1455 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1461 =item suspend [ OPTION => VALUE ... ]
1463 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1464 package, then suspends the package itself (sets the susp field to now).
1466 Available options are:
1470 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1471 either a reasonnum of an existing reason, or passing a hashref will create
1472 a new reason. The hashref should have the following keys:
1473 - typenum - Reason type (see L<FS::reason_type>
1474 - reason - Text of the new reason.
1476 =item date - can be set to a unix style timestamp to specify when to
1479 =item time - can be set to override the current time, for calculation
1480 of final invoices or unused-time credits
1482 =item resume_date - can be set to a time when the package should be
1483 unsuspended. This may be more convenient than calling C<unsuspend()>
1486 =item from_main - allows a supplemental package to be suspended, rather
1487 than redirecting the method call to its main package. For internal use.
1489 =item from_cancel - used when suspending from the cancel method, forces
1490 this to skip everything besides basic suspension. For internal use.
1494 If there is an error, returns the error, otherwise returns false.
1499 my( $self, %options ) = @_;
1502 # pass all suspend/cancel actions to the main package
1503 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1504 return $self->main_pkg->suspend(%options);
1507 local $SIG{HUP} = 'IGNORE';
1508 local $SIG{INT} = 'IGNORE';
1509 local $SIG{QUIT} = 'IGNORE';
1510 local $SIG{TERM} = 'IGNORE';
1511 local $SIG{TSTP} = 'IGNORE';
1512 local $SIG{PIPE} = 'IGNORE';
1514 my $oldAutoCommit = $FS::UID::AutoCommit;
1515 local $FS::UID::AutoCommit = 0;
1518 my $old = $self->select_for_update;
1520 my $pkgnum = $old->pkgnum;
1521 if ( $old->get('cancel') || $self->get('cancel') ) {
1522 dbh->rollback if $oldAutoCommit;
1523 return "Can't suspend cancelled package $pkgnum";
1526 if ( $old->get('susp') || $self->get('susp') ) {
1527 dbh->rollback if $oldAutoCommit;
1528 return ""; # no error # complain on adjourn?
1531 my $suspend_time = $options{'time'} || time;
1532 my $date = $options{date} if $options{date}; # adjourn/suspend later
1533 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1535 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1536 dbh->rollback if $oldAutoCommit;
1537 return "Package $pkgnum expires before it would be suspended.";
1540 # some false laziness with sub cancel
1541 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1542 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1543 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1544 # make the entire cust_main->bill path recognize 'suspend' and
1545 # 'cancel' separately.
1546 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1547 my $copy = $self->new({$self->hash});
1549 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1551 'time' => $suspend_time );
1552 warn "Error billing during suspend, custnum ".
1553 #$self->cust_main->custnum. ": $error"
1558 my $cust_pkg_reason;
1559 if ( $options{'reason'} ) {
1560 $error = $self->insert_reason( 'reason' => $options{'reason'},
1561 'action' => $date ? 'adjourn' : 'suspend',
1562 'date' => $date ? $date : $suspend_time,
1563 'reason_otaker' => $options{'reason_otaker'},
1566 dbh->rollback if $oldAutoCommit;
1567 return "Error inserting cust_pkg_reason: $error";
1569 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1570 'date' => $date ? $date : $suspend_time,
1571 'action' => $date ? 'A' : 'S',
1572 'pkgnum' => $self->pkgnum,
1576 # if a reasonnum was passed, get the actual reason object so we can check
1578 # (passing a reason hashref is still allowed, but it can't be used with
1579 # the fancy behavioral options.)
1582 if ($options{'reason'} =~ /^\d+$/) {
1583 $reason = FS::reason->by_key($options{'reason'});
1586 my %hash = $self->hash;
1588 $hash{'adjourn'} = $date;
1590 $hash{'susp'} = $suspend_time;
1593 my $resume_date = $options{'resume_date'} || 0;
1594 if ( $resume_date > ($date || $suspend_time) ) {
1595 $hash{'resume'} = $resume_date;
1598 $options{options} ||= {};
1600 my $new = new FS::cust_pkg ( \%hash );
1601 $error = $new->replace( $self, options => { $self->options,
1602 %{ $options{options} },
1606 $dbh->rollback if $oldAutoCommit;
1610 unless ( $date ) { # then we are suspending now
1612 unless ($options{'from_cancel'}) {
1613 # credit remaining time if appropriate
1614 # (if required by the package def, or the suspend reason)
1615 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1616 || ( defined($reason) && $reason->unused_credit );
1618 if ( $unused_credit ) {
1619 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1620 my $error = $self->credit_remaining('suspend', $suspend_time);
1622 $dbh->rollback if $oldAutoCommit;
1630 foreach my $cust_svc (
1631 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1633 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1635 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1636 $dbh->rollback if $oldAutoCommit;
1637 return "Illegal svcdb value in part_svc!";
1640 require "FS/$svcdb.pm";
1642 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1644 $error = $svc->suspend;
1646 $dbh->rollback if $oldAutoCommit;
1649 my( $label, $value ) = $cust_svc->label;
1650 push @labels, "$label: $value";
1654 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1655 # and this is not a suspend-before-cancel
1656 if ( $cust_pkg_reason ) {
1657 my $reason_obj = $cust_pkg_reason->reason;
1658 if ( $reason_obj->feepart and
1659 ! $reason_obj->fee_on_unsuspend and
1660 ! $options{'from_cancel'} ) {
1662 # register the need to charge a fee, cust_main->bill will do the rest
1663 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1665 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1666 'pkgreasonnum' => $cust_pkg_reason->num,
1667 'pkgnum' => $self->pkgnum,
1668 'feepart' => $reason->feepart,
1669 'nextbill' => $reason->fee_hold,
1671 $error ||= $cust_pkg_reason_fee->insert;
1675 my $conf = new FS::Conf;
1676 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1678 my $error = send_email(
1679 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1680 #invoice_from ??? well as good as any
1681 'to' => $conf->config('suspend_email_admin'),
1682 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1684 "This is an automatic message from your Freeside installation\n",
1685 "informing you that the following customer package has been suspended:\n",
1687 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1688 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1689 ( map { "Service : $_\n" } @labels ),
1691 'custnum' => $self->custnum,
1692 'msgtype' => 'admin'
1696 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1704 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1705 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1707 $dbh->rollback if $oldAutoCommit;
1708 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1712 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1717 =item credit_remaining MODE TIME
1719 Generate a credit for this package for the time remaining in the current
1720 billing period. MODE is either "suspend" or "cancel" (determines the
1721 credit type). TIME is the time of suspension/cancellation. Both arguments
1726 # Implementation note:
1728 # If you pkgpart-change a package that has been billed, and it's set to give
1729 # credit on package change, then this method gets called and then the new
1730 # package will have no last_bill date. Therefore the customer will be credited
1731 # only once (per billing period) even if there are multiple package changes.
1733 # If you location-change a package that has been billed, this method will NOT
1734 # be called and the new package WILL have the last bill date of the old
1737 # If the new package is then canceled within the same billing cycle,
1738 # credit_remaining needs to run calc_remain on the OLD package to determine
1739 # the amount of unused time to credit.
1741 sub credit_remaining {
1742 # Add a credit for remaining service
1743 my ($self, $mode, $time) = @_;
1744 die 'credit_remaining requires suspend or cancel'
1745 unless $mode eq 'suspend' or $mode eq 'cancel';
1746 die 'no suspend/cancel time' unless $time > 0;
1748 my $conf = FS::Conf->new;
1749 my $reason_type = $conf->config($mode.'_credit_type');
1751 my $last_bill = $self->getfield('last_bill') || 0;
1752 my $next_bill = $self->getfield('bill') || 0;
1753 if ( $last_bill > 0 # the package has been billed
1754 and $next_bill > 0 # the package has a next bill date
1755 and $next_bill >= $time # which is in the future
1757 my $remaining_value = 0;
1759 my $remain_pkg = $self;
1760 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1762 # we may have to walk back past some package changes to get to the
1763 # one that actually has unused time
1764 while ( $remaining_value == 0 ) {
1765 if ( $remain_pkg->change_pkgnum ) {
1766 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1768 # the package has really never been billed
1771 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1774 if ( $remaining_value > 0 ) {
1775 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1777 my $error = $self->cust_main->credit(
1779 'Credit for unused time on '. $self->part_pkg->pkg,
1780 'reason_type' => $reason_type,
1782 return "Error crediting customer \$$remaining_value for unused time".
1783 " on ". $self->part_pkg->pkg. ": $error"
1785 } #if $remaining_value
1786 } #if $last_bill, etc.
1790 =item unsuspend [ OPTION => VALUE ... ]
1792 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1793 package, then unsuspends the package itself (clears the susp field and the
1794 adjourn field if it is in the past). If the suspend reason includes an
1795 unsuspension package, that package will be ordered.
1797 Available options are:
1803 Can be set to a date to unsuspend the package in the future (the 'resume'
1806 =item adjust_next_bill
1808 Can be set true to adjust the next bill date forward by
1809 the amount of time the account was inactive. This was set true by default
1810 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1811 explicitly requested with this option or in the price plan.
1815 If there is an error, returns the error, otherwise returns false.
1820 my( $self, %opt ) = @_;
1823 # pass all suspend/cancel actions to the main package
1824 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1825 return $self->main_pkg->unsuspend(%opt);
1828 local $SIG{HUP} = 'IGNORE';
1829 local $SIG{INT} = 'IGNORE';
1830 local $SIG{QUIT} = 'IGNORE';
1831 local $SIG{TERM} = 'IGNORE';
1832 local $SIG{TSTP} = 'IGNORE';
1833 local $SIG{PIPE} = 'IGNORE';
1835 my $oldAutoCommit = $FS::UID::AutoCommit;
1836 local $FS::UID::AutoCommit = 0;
1839 my $old = $self->select_for_update;
1841 my $pkgnum = $old->pkgnum;
1842 if ( $old->get('cancel') || $self->get('cancel') ) {
1843 $dbh->rollback if $oldAutoCommit;
1844 return "Can't unsuspend cancelled package $pkgnum";
1847 unless ( $old->get('susp') && $self->get('susp') ) {
1848 $dbh->rollback if $oldAutoCommit;
1849 return ""; # no error # complain instead?
1852 # handle the case of setting a future unsuspend (resume) date
1853 # and do not continue to actually unsuspend the package
1854 my $date = $opt{'date'};
1855 if ( $date and $date > time ) { # return an error if $date <= time?
1857 if ( $old->get('expire') && $old->get('expire') < $date ) {
1858 $dbh->rollback if $oldAutoCommit;
1859 return "Package $pkgnum expires before it would be unsuspended.";
1862 my $new = new FS::cust_pkg { $self->hash };
1863 $new->set('resume', $date);
1864 $error = $new->replace($self, options => $self->options);
1867 $dbh->rollback if $oldAutoCommit;
1871 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1877 if (!$self->setup) {
1878 # then this package is being released from on-hold status
1879 $self->set_initial_timers;
1884 foreach my $cust_svc (
1885 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1887 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1889 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1890 $dbh->rollback if $oldAutoCommit;
1891 return "Illegal svcdb value in part_svc!";
1894 require "FS/$svcdb.pm";
1896 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1898 $error = $svc->unsuspend;
1900 $dbh->rollback if $oldAutoCommit;
1903 my( $label, $value ) = $cust_svc->label;
1904 push @labels, "$label: $value";
1909 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1910 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1912 my %hash = $self->hash;
1913 my $inactive = time - $hash{'susp'};
1915 my $conf = new FS::Conf;
1917 # increment next bill date if certain conditions are met:
1918 # - it was due to be billed at some point
1919 # - either the global or local config says to do this
1920 my $adjust_bill = 0;
1923 && ( $hash{'bill'} || $hash{'setup'} )
1924 && ( $opt{'adjust_next_bill'}
1925 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1926 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1933 # - the package billed during suspension
1934 # - or it was ordered on hold
1935 # - or the customer was credited for the unused time
1937 if ( $self->option('suspend_bill',1)
1938 or ( $self->part_pkg->option('suspend_bill',1)
1939 and ! $self->option('no_suspend_bill',1)
1941 or $hash{'order_date'} == $hash{'susp'}
1946 if ( $adjust_bill ) {
1947 if ( $self->part_pkg->option('unused_credit_suspend')
1948 or ( $reason and $reason->unused_credit ) ) {
1949 # then the customer was credited for the unused time before suspending,
1950 # so their next bill should be immediate.
1951 $hash{'bill'} = time;
1953 # add the length of time suspended to the bill date
1954 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1959 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1960 $hash{'resume'} = '' if !$hash{'adjourn'};
1961 my $new = new FS::cust_pkg ( \%hash );
1962 $error = $new->replace( $self, options => { $self->options } );
1964 $dbh->rollback if $oldAutoCommit;
1971 if ( $reason->unsuspend_pkgpart ) {
1972 #warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n"; # in 4.x
1973 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1974 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1976 my $start_date = $self->cust_main->next_bill_date
1977 if $reason->unsuspend_hold;
1980 $unsusp_pkg = FS::cust_pkg->new({
1981 'custnum' => $self->custnum,
1982 'pkgpart' => $reason->unsuspend_pkgpart,
1983 'start_date' => $start_date,
1984 'locationnum' => $self->locationnum,
1985 # discount? probably not...
1988 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1991 # new way, using fees
1992 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1993 # register the need to charge a fee, cust_main->bill will do the rest
1994 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1996 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1997 'pkgreasonnum' => $cust_pkg_reason->num,
1998 'pkgnum' => $self->pkgnum,
1999 'feepart' => $reason->feepart,
2000 'nextbill' => $reason->fee_hold,
2002 $error ||= $cust_pkg_reason_fee->insert;
2006 $dbh->rollback if $oldAutoCommit;
2011 if ( $conf->config('unsuspend_email_admin') ) {
2013 my $error = send_email(
2014 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2015 #invoice_from ??? well as good as any
2016 'to' => $conf->config('unsuspend_email_admin'),
2017 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2018 "This is an automatic message from your Freeside installation\n",
2019 "informing you that the following customer package has been unsuspended:\n",
2021 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2022 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2023 ( map { "Service : $_\n" } @labels ),
2025 "An unsuspension fee was charged: ".
2026 $unsusp_pkg->part_pkg->pkg_comment."\n"
2030 'custnum' => $self->custnum,
2031 'msgtype' => 'admin',
2035 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2041 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2042 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2044 $dbh->rollback if $oldAutoCommit;
2045 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2049 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2056 Cancels any pending suspension (sets the adjourn field to null)
2057 for this package and any supplemental packages.
2059 If there is an error, returns the error, otherwise returns false.
2067 local $SIG{HUP} = 'IGNORE';
2068 local $SIG{INT} = 'IGNORE';
2069 local $SIG{QUIT} = 'IGNORE';
2070 local $SIG{TERM} = 'IGNORE';
2071 local $SIG{TSTP} = 'IGNORE';
2072 local $SIG{PIPE} = 'IGNORE';
2074 my $oldAutoCommit = $FS::UID::AutoCommit;
2075 local $FS::UID::AutoCommit = 0;
2078 my $old = $self->select_for_update;
2080 my $pkgnum = $old->pkgnum;
2081 if ( $old->get('cancel') || $self->get('cancel') ) {
2082 dbh->rollback if $oldAutoCommit;
2083 return "Can't unadjourn cancelled package $pkgnum";
2084 # or at least it's pointless
2087 if ( $old->get('susp') || $self->get('susp') ) {
2088 dbh->rollback if $oldAutoCommit;
2089 return "Can't unadjourn suspended package $pkgnum";
2090 # perhaps this is arbitrary
2093 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2094 dbh->rollback if $oldAutoCommit;
2095 return ""; # no error
2098 my %hash = $self->hash;
2099 $hash{'adjourn'} = '';
2100 $hash{'resume'} = '';
2101 my $new = new FS::cust_pkg ( \%hash );
2102 $error = $new->replace( $self, options => { $self->options } );
2104 $dbh->rollback if $oldAutoCommit;
2108 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2109 $error = $supp_pkg->unadjourn;
2111 $dbh->rollback if $oldAutoCommit;
2112 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2116 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2123 =item change HASHREF | OPTION => VALUE ...
2125 Changes this package: cancels it and creates a new one, with a different
2126 pkgpart or locationnum or both. All services are transferred to the new
2127 package (no change will be made if this is not possible).
2129 Options may be passed as a list of key/value pairs or as a hash reference.
2136 New locationnum, to change the location for this package.
2140 New FS::cust_location object, to create a new location and assign it
2145 New FS::cust_main object, to create a new customer and assign the new package
2150 New pkgpart (see L<FS::part_pkg>).
2154 New refnum (see L<FS::part_referral>).
2158 New quantity; if unspecified, the new package will have the same quantity
2163 "New" (existing) FS::cust_pkg object. The package's services and other
2164 attributes will be transferred to this package.
2168 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2169 susp, adjourn, cancel, expire, and contract_end) to the new package.
2171 =item unprotect_svcs
2173 Normally, change() will rollback and return an error if some services
2174 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2175 If unprotect_svcs is true, this method will transfer as many services as
2176 it can and then unconditionally cancel the old package.
2180 If specified, sets this value for the contract_end date on the new package
2181 (without regard for keep_dates or the usual date-preservation behavior.)
2182 Will throw an error if defined but false; the UI doesn't allow editing
2183 this unless it already exists, making removal impossible to undo.
2187 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2188 cust_pkg must be specified (otherwise, what's the point?)
2190 Returns either the new FS::cust_pkg object or a scalar error.
2194 my $err_or_new_cust_pkg = $old_cust_pkg->change
2198 #used by change and change_later
2199 #didn't put with documented check methods because it depends on change-specific opts
2200 #and it also possibly edits the value of opts
2204 if ( defined($opt->{'contract_end'}) ) {
2205 my $current_contract_end = $self->get('contract_end');
2206 unless ($opt->{'contract_end'}) {
2207 if ($current_contract_end) {
2208 return "Cannot remove contract end date when changing packages";
2210 #shouldn't even pass this option if there's not a current value
2211 #but can be handled gracefully if the option is empty
2212 warn "Contract end date passed unexpectedly";
2213 delete $opt->{'contract_end'};
2217 unless ($current_contract_end) {
2218 #option shouldn't be passed, throw error if it's non-empty
2219 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2225 #some false laziness w/order
2228 my $opt = ref($_[0]) ? shift : { @_ };
2230 my $conf = new FS::Conf;
2232 # handle contract_end on cust_pkg same as passed option
2233 if ( $opt->{'cust_pkg'} ) {
2234 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2235 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2238 # check contract_end, prevent adding/removing
2239 my $error = $self->_check_change($opt);
2240 return $error if $error;
2242 # Transactionize this whole mess
2243 local $SIG{HUP} = 'IGNORE';
2244 local $SIG{INT} = 'IGNORE';
2245 local $SIG{QUIT} = 'IGNORE';
2246 local $SIG{TERM} = 'IGNORE';
2247 local $SIG{TSTP} = 'IGNORE';
2248 local $SIG{PIPE} = 'IGNORE';
2250 my $oldAutoCommit = $FS::UID::AutoCommit;
2251 local $FS::UID::AutoCommit = 0;
2254 if ( $opt->{'cust_location'} ) {
2255 $error = $opt->{'cust_location'}->find_or_insert;
2257 $dbh->rollback if $oldAutoCommit;
2258 return "creating location record: $error";
2260 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2263 # Before going any further here: if the package is still in the pre-setup
2264 # state, it's safe to modify it in place. No need to charge/credit for
2265 # partial period, transfer services, transfer usage pools, copy invoice
2266 # details, or change any dates.
2267 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2268 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2269 if ( length($opt->{$_}) ) {
2270 $self->set($_, $opt->{$_});
2273 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2275 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2276 $self->set_initial_timers;
2278 # but if contract_end was explicitly specified, that overrides all else
2279 $self->set('contract_end', $opt->{'contract_end'})
2280 if $opt->{'contract_end'};
2281 $error = $self->replace;
2283 $dbh->rollback if $oldAutoCommit;
2284 return "modifying package: $error";
2286 $dbh->commit if $oldAutoCommit;
2295 $hash{'setup'} = $time if $self->get('setup');
2297 $hash{'change_date'} = $time;
2298 $hash{"change_$_"} = $self->$_()
2299 foreach qw( pkgnum pkgpart locationnum );
2301 if ( $opt->{'cust_pkg'} ) {
2302 # treat changing to a package with a different pkgpart as a
2303 # pkgpart change (because it is)
2304 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2307 # whether to override pkgpart checking on the new package
2308 my $same_pkgpart = 1;
2309 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2313 my $unused_credit = 0;
2314 my $keep_dates = $opt->{'keep_dates'};
2316 # Special case. If the pkgpart is changing, and the customer is going to be
2317 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2318 # and DO pass the flag to cancel() to credit the customer. If the old
2319 # package had a setup date, set the new package's setup to the package
2320 # change date so that it has the same status as before.
2321 if ( $opt->{'pkgpart'}
2322 and $opt->{'pkgpart'} != $self->pkgpart
2323 and $self->part_pkg->option('unused_credit_change', 1) ) {
2326 $hash{'last_bill'} = '';
2330 if ( $keep_dates ) {
2331 foreach my $date ( qw(setup bill last_bill) ) {
2332 $hash{$date} = $self->getfield($date);
2335 # always keep the following dates
2336 foreach my $date (qw(order_date susp adjourn cancel expire resume
2337 start_date contract_end)) {
2338 $hash{$date} = $self->getfield($date);
2340 # but if contract_end was explicitly specified, that overrides all else
2341 $hash{'contract_end'} = $opt->{'contract_end'}
2342 if $opt->{'contract_end'};
2344 # allow $opt->{'locationnum'} = '' to specifically set it to null
2345 # (i.e. customer default location)
2346 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2348 # usually this doesn't matter. the two cases where it does are:
2349 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2351 # 2. (more importantly) changing a package before it's billed
2352 $hash{'waive_setup'} = $self->waive_setup;
2354 # if this package is scheduled for a future package change, preserve that
2355 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2357 my $custnum = $self->custnum;
2358 if ( $opt->{cust_main} ) {
2359 my $cust_main = $opt->{cust_main};
2360 unless ( $cust_main->custnum ) {
2361 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2363 $dbh->rollback if $oldAutoCommit;
2364 return "inserting customer record: $error";
2367 $custnum = $cust_main->custnum;
2370 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2373 if ( $opt->{'cust_pkg'} ) {
2374 # The target package already exists; update it to show that it was
2375 # changed from this package.
2376 $cust_pkg = $opt->{'cust_pkg'};
2378 # follow all the above rules for date changes, etc.
2379 foreach (keys %hash) {
2380 $cust_pkg->set($_, $hash{$_});
2382 # except those that implement the future package change behavior
2383 foreach (qw(change_to_pkgnum start_date expire)) {
2384 $cust_pkg->set($_, '');
2387 $error = $cust_pkg->replace;
2390 # Create the new package.
2391 $cust_pkg = new FS::cust_pkg {
2392 custnum => $custnum,
2393 locationnum => $opt->{'locationnum'},
2394 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2395 qw( pkgpart quantity refnum salesnum )
2399 $error = $cust_pkg->insert( 'change' => 1,
2400 'allow_pkgpart' => $same_pkgpart );
2403 $dbh->rollback if $oldAutoCommit;
2404 return "inserting new package: $error";
2407 # Transfer services and cancel old package.
2408 # Enforce service limits only if this is a pkgpart change.
2409 local $FS::cust_svc::ignore_quantity;
2410 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2411 $error = $self->transfer($cust_pkg);
2412 if ($error and $error == 0) {
2413 # $old_pkg->transfer failed.
2414 $dbh->rollback if $oldAutoCommit;
2415 return "transferring $error";
2418 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2419 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2420 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2421 if ($error and $error == 0) {
2422 # $old_pkg->transfer failed.
2423 $dbh->rollback if $oldAutoCommit;
2424 return "converting $error";
2428 # We set unprotect_svcs when executing a "future package change". It's
2429 # not a user-interactive operation, so returning an error means the
2430 # package change will just fail. Rather than have that happen, we'll
2431 # let leftover services be deleted.
2432 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2433 # Transfers were successful, but we still had services left on the old
2434 # package. We can't change the package under this circumstances, so abort.
2435 $dbh->rollback if $oldAutoCommit;
2436 return "unable to transfer all services";
2439 #reset usage if changing pkgpart
2440 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2441 if ($self->pkgpart != $cust_pkg->pkgpart) {
2442 my $part_pkg = $cust_pkg->part_pkg;
2443 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2447 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2450 $dbh->rollback if $oldAutoCommit;
2451 return "setting usage values: $error";
2454 # if NOT changing pkgpart, transfer any usage pools over
2455 foreach my $usage ($self->cust_pkg_usage) {
2456 $usage->set('pkgnum', $cust_pkg->pkgnum);
2457 $error = $usage->replace;
2459 $dbh->rollback if $oldAutoCommit;
2460 return "transferring usage pools: $error";
2465 # transfer discounts, if we're not changing pkgpart
2466 if ( $same_pkgpart ) {
2467 foreach my $old_discount ($self->cust_pkg_discount_active) {
2468 # don't remove the old discount, we may still need to bill that package.
2469 my $new_discount = new FS::cust_pkg_discount {
2470 'pkgnum' => $cust_pkg->pkgnum,
2471 'discountnum' => $old_discount->discountnum,
2472 'months_used' => $old_discount->months_used,
2474 $error = $new_discount->insert;
2476 $dbh->rollback if $oldAutoCommit;
2477 return "transferring discounts: $error";
2482 # transfer (copy) invoice details
2483 foreach my $detail ($self->cust_pkg_detail) {
2484 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2485 $new_detail->set('pkgdetailnum', '');
2486 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2487 $error = $new_detail->insert;
2489 $dbh->rollback if $oldAutoCommit;
2490 return "transferring package notes: $error";
2496 if ( !$opt->{'cust_pkg'} ) {
2497 # Order any supplemental packages.
2498 my $part_pkg = $cust_pkg->part_pkg;
2499 my @old_supp_pkgs = $self->supplemental_pkgs;
2500 foreach my $link ($part_pkg->supp_part_pkg_link) {
2502 foreach (@old_supp_pkgs) {
2503 if ($_->pkgpart == $link->dst_pkgpart) {
2505 $_->pkgpart(0); # so that it can't match more than once
2509 # false laziness with FS::cust_main::Packages::order_pkg
2510 my $new = FS::cust_pkg->new({
2511 pkgpart => $link->dst_pkgpart,
2512 pkglinknum => $link->pkglinknum,
2513 custnum => $custnum,
2514 main_pkgnum => $cust_pkg->pkgnum,
2515 locationnum => $cust_pkg->locationnum,
2516 start_date => $cust_pkg->start_date,
2517 order_date => $cust_pkg->order_date,
2518 expire => $cust_pkg->expire,
2519 adjourn => $cust_pkg->adjourn,
2520 contract_end => $cust_pkg->contract_end,
2521 refnum => $cust_pkg->refnum,
2522 discountnum => $cust_pkg->discountnum,
2523 waive_setup => $cust_pkg->waive_setup,
2525 if ( $old and $opt->{'keep_dates'} ) {
2526 foreach (qw(setup bill last_bill)) {
2527 $new->set($_, $old->get($_));
2530 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2533 $error ||= $old->transfer($new);
2535 if ( $error and $error > 0 ) {
2536 # no reason why this should ever fail, but still...
2537 $error = "Unable to transfer all services from supplemental package ".
2541 $dbh->rollback if $oldAutoCommit;
2544 push @new_supp_pkgs, $new;
2546 } # if !$opt->{'cust_pkg'}
2547 # because if there is one, then supplemental packages would already
2548 # have been created for it.
2550 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2552 #Don't allow billing the package (preceding period packages and/or
2553 #outstanding usage) if we are keeping dates (i.e. location changing),
2554 #because the new package will be billed for the same date range.
2555 #Supplemental packages are also canceled here.
2557 # during scheduled changes, avoid canceling the package we just
2559 $self->set('change_to_pkgnum' => '');
2561 $error = $self->cancel(
2563 unused_credit => $unused_credit,
2564 nobill => $keep_dates,
2565 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2566 no_delay_cancel => 1,
2569 $dbh->rollback if $oldAutoCommit;
2570 return "canceling old package: $error";
2573 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2575 my $error = $cust_pkg->cust_main->bill(
2576 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2579 $dbh->rollback if $oldAutoCommit;
2580 return "billing new package: $error";
2584 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2590 =item change_later OPTION => VALUE...
2592 Schedule a package change for a later date. This actually orders the new
2593 package immediately, but sets its start date for a future date, and sets
2594 the current package to expire on the same date.
2596 If the package is already scheduled for a change, this can be called with
2597 'start_date' to change the scheduled date, or with pkgpart and/or
2598 locationnum to modify the package change. To cancel the scheduled change
2599 entirely, see C<abort_change>.
2607 The date for the package change. Required, and must be in the future.
2617 The pkgpart, locationnum, quantity and optional contract_end of the new
2618 package, with the same meaning as in C<change>.
2626 my $opt = ref($_[0]) ? shift : { @_ };
2628 # check contract_end, prevent adding/removing
2629 my $error = $self->_check_change($opt);
2630 return $error if $error;
2632 my $oldAutoCommit = $FS::UID::AutoCommit;
2633 local $FS::UID::AutoCommit = 0;
2636 my $cust_main = $self->cust_main;
2638 my $date = delete $opt->{'start_date'} or return 'start_date required';
2640 if ( $date <= time ) {
2641 $dbh->rollback if $oldAutoCommit;
2642 return "start_date $date is in the past";
2645 # If the user entered a new location, set it up now.
2646 if ( $opt->{'cust_location'} ) {
2647 $error = $opt->{'cust_location'}->find_or_insert;
2649 $dbh->rollback if $oldAutoCommit;
2650 return "creating location record: $error";
2652 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2655 if ( $self->change_to_pkgnum ) {
2656 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2657 my $new_pkgpart = $opt->{'pkgpart'}
2658 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2659 my $new_locationnum = $opt->{'locationnum'}
2660 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2661 my $new_quantity = $opt->{'quantity'}
2662 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2663 my $new_contract_end = $opt->{'contract_end'}
2664 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2665 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2666 # it hasn't been billed yet, so in principle we could just edit
2667 # it in place (w/o a package change), but that's bad form.
2668 # So change the package according to the new options...
2669 my $err_or_pkg = $change_to->change(%$opt);
2670 if ( ref $err_or_pkg ) {
2671 # Then set that package up for a future start.
2672 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2673 $self->set('expire', $date); # in case it's different
2674 $err_or_pkg->set('start_date', $date);
2675 $err_or_pkg->set('change_date', '');
2676 $err_or_pkg->set('change_pkgnum', '');
2678 $error = $self->replace ||
2679 $err_or_pkg->replace ||
2680 #because change() might've edited existing scheduled change in place
2681 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2682 $change_to->cancel('no_delay_cancel' => 1) ||
2683 $change_to->delete);
2685 $error = $err_or_pkg;
2687 } else { # change the start date only.
2688 $self->set('expire', $date);
2689 $change_to->set('start_date', $date);
2690 $error = $self->replace || $change_to->replace;
2693 $dbh->rollback if $oldAutoCommit;
2696 $dbh->commit if $oldAutoCommit;
2699 } # if $self->change_to_pkgnum
2701 my $new_pkgpart = $opt->{'pkgpart'}
2702 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2703 my $new_locationnum = $opt->{'locationnum'}
2704 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2705 my $new_quantity = $opt->{'quantity'}
2706 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2707 my $new_contract_end = $opt->{'contract_end'}
2708 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2710 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2712 # allow $opt->{'locationnum'} = '' to specifically set it to null
2713 # (i.e. customer default location)
2714 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2716 my $new = FS::cust_pkg->new( {
2717 custnum => $self->custnum,
2718 locationnum => $opt->{'locationnum'},
2719 start_date => $date,
2720 map { $_ => ( $opt->{$_} || $self->$_() ) }
2721 qw( pkgpart quantity refnum salesnum contract_end )
2723 $error = $new->insert('change' => 1,
2724 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2726 $self->set('change_to_pkgnum', $new->pkgnum);
2727 $self->set('expire', $date);
2728 $error = $self->replace;
2731 $dbh->rollback if $oldAutoCommit;
2733 $dbh->commit if $oldAutoCommit;
2741 Cancels a future package change scheduled by C<change_later>.
2747 my $pkgnum = $self->change_to_pkgnum;
2748 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2751 $error = $change_to->cancel || $change_to->delete;
2752 return $error if $error;
2754 $self->set('change_to_pkgnum', '');
2755 $self->set('expire', '');
2759 =item set_quantity QUANTITY
2761 Change the package's quantity field. This is one of the few package properties
2762 that can safely be changed without canceling and reordering the package
2763 (because it doesn't affect tax eligibility). Returns an error or an
2770 $self = $self->replace_old; # just to make sure
2771 $self->quantity(shift);
2775 =item set_salesnum SALESNUM
2777 Change the package's salesnum (sales person) field. This is one of the few
2778 package properties that can safely be changed without canceling and reordering
2779 the package (because it doesn't affect tax eligibility). Returns an error or
2786 $self = $self->replace_old; # just to make sure
2787 $self->salesnum(shift);
2789 # XXX this should probably reassign any credit that's already been given
2792 =item modify_charge OPTIONS
2794 Change the properties of a one-time charge. The following properties can
2795 be changed this way:
2796 - pkg: the package description
2797 - classnum: the package class
2798 - additional: arrayref of additional invoice details to add to this package
2800 and, I<if the charge has not yet been billed>:
2801 - start_date: the date when it will be billed
2802 - amount: the setup fee to be charged
2803 - quantity: the multiplier for the setup fee
2804 - separate_bill: whether to put the charge on a separate invoice
2806 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2807 commission credits linked to this charge, they will be recalculated.
2814 my $part_pkg = $self->part_pkg;
2815 my $pkgnum = $self->pkgnum;
2818 my $oldAutoCommit = $FS::UID::AutoCommit;
2819 local $FS::UID::AutoCommit = 0;
2821 return "Can't use modify_charge except on one-time charges"
2822 unless $part_pkg->freq eq '0';
2824 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2825 $part_pkg->set('pkg', $opt{'pkg'});
2828 my %pkg_opt = $part_pkg->options;
2829 my $pkg_opt_modified = 0;
2831 $opt{'additional'} ||= [];
2834 foreach (grep /^additional/, keys %pkg_opt) {
2835 ($i) = ($_ =~ /^additional_info(\d+)$/);
2836 $old_additional[$i] = $pkg_opt{$_} if $i;
2837 delete $pkg_opt{$_};
2840 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2841 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2842 if (!exists($old_additional[$i])
2843 or $old_additional[$i] ne $opt{'additional'}->[$i])
2845 $pkg_opt_modified = 1;
2848 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2849 $pkg_opt{'additional_count'} = $i if $i > 0;
2852 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2855 $old_classnum = $part_pkg->classnum;
2856 $part_pkg->set('classnum', $opt{'classnum'});
2859 if ( !$self->get('setup') ) {
2860 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2863 if ( exists($opt{'amount'})
2864 and $part_pkg->option('setup_fee') != $opt{'amount'}
2865 and $opt{'amount'} > 0 ) {
2867 $pkg_opt{'setup_fee'} = $opt{'amount'};
2868 $pkg_opt_modified = 1;
2871 if ( exists($opt{'setup_cost'})
2872 and $part_pkg->setup_cost != $opt{'setup_cost'}
2873 and $opt{'setup_cost'} > 0 ) {
2875 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2878 if ( exists($opt{'quantity'})
2879 and $opt{'quantity'} != $self->quantity
2880 and $opt{'quantity'} > 0 ) {
2882 $self->set('quantity', $opt{'quantity'});
2885 if ( exists($opt{'start_date'})
2886 and $opt{'start_date'} != $self->start_date ) {
2888 $self->set('start_date', $opt{'start_date'});
2891 if ( exists($opt{'separate_bill'})
2892 and $opt{'separate_bill'} ne $self->separate_bill ) {
2894 $self->set('separate_bill', $opt{'separate_bill'});
2898 } # else simply ignore them; the UI shouldn't allow editing the fields
2900 if ( exists($opt{'taxclass'})
2901 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2903 $part_pkg->set('taxclass', $opt{'taxclass'});
2907 if ( $part_pkg->modified or $pkg_opt_modified ) {
2908 # can we safely modify the package def?
2909 # Yes, if it's not available for purchase, and this is the only instance
2911 if ( $part_pkg->disabled
2912 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2913 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2915 $error = $part_pkg->replace( options => \%pkg_opt );
2918 $part_pkg = $part_pkg->clone;
2919 $part_pkg->set('disabled' => 'Y');
2920 $error = $part_pkg->insert( options => \%pkg_opt );
2921 # and associate this as yet-unbilled package to the new package def
2922 $self->set('pkgpart' => $part_pkg->pkgpart);
2925 $dbh->rollback if $oldAutoCommit;
2930 if ($self->modified) { # for quantity or start_date change, or if we had
2931 # to clone the existing package def
2932 my $error = $self->replace;
2933 return $error if $error;
2935 if (defined $old_classnum) {
2936 # fix invoice grouping records
2937 my $old_catname = $old_classnum
2938 ? FS::pkg_class->by_key($old_classnum)->categoryname
2940 my $new_catname = $opt{'classnum'}
2941 ? $part_pkg->pkg_class->categoryname
2943 if ( $old_catname ne $new_catname ) {
2944 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2945 # (there should only be one...)
2946 my @display = qsearch( 'cust_bill_pkg_display', {
2947 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2948 'section' => $old_catname,
2950 foreach (@display) {
2951 $_->set('section', $new_catname);
2952 $error = $_->replace;
2954 $dbh->rollback if $oldAutoCommit;
2958 } # foreach $cust_bill_pkg
2961 if ( $opt{'adjust_commission'} ) {
2962 # fix commission credits...tricky.
2963 foreach my $cust_event ($self->cust_event) {
2964 my $part_event = $cust_event->part_event;
2965 foreach my $table (qw(sales agent)) {
2967 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2968 my $credit = qsearchs('cust_credit', {
2969 'eventnum' => $cust_event->eventnum,
2971 if ( $part_event->isa($class) ) {
2972 # Yes, this results in current commission rates being applied
2973 # retroactively to a one-time charge. For accounting purposes
2974 # there ought to be some kind of time limit on doing this.
2975 my $amount = $part_event->_calc_credit($self);
2976 if ( $credit and $credit->amount ne $amount ) {
2977 # Void the old credit.
2978 $error = $credit->void('Package class changed');
2980 $dbh->rollback if $oldAutoCommit;
2981 return "$error (adjusting commission credit)";
2984 # redo the event action to recreate the credit.
2986 eval { $part_event->do_action( $self, $cust_event ) };
2988 $dbh->rollback if $oldAutoCommit;
2991 } # if $part_event->isa($class)
2993 } # foreach $cust_event
2994 } # if $opt{'adjust_commission'}
2995 } # if defined $old_classnum
2997 $dbh->commit if $oldAutoCommit;
3003 use Storable 'thaw';
3006 sub process_bulk_cust_pkg {
3008 my $param = thaw(decode_base64(shift));
3009 warn Dumper($param) if $DEBUG;
3011 my $old_part_pkg = qsearchs('part_pkg',
3012 { pkgpart => $param->{'old_pkgpart'} });
3013 my $new_part_pkg = qsearchs('part_pkg',
3014 { pkgpart => $param->{'new_pkgpart'} });
3015 die "Must select a new package type\n" unless $new_part_pkg;
3016 #my $keep_dates = $param->{'keep_dates'} || 0;
3017 my $keep_dates = 1; # there is no good reason to turn this off
3019 local $SIG{HUP} = 'IGNORE';
3020 local $SIG{INT} = 'IGNORE';
3021 local $SIG{QUIT} = 'IGNORE';
3022 local $SIG{TERM} = 'IGNORE';
3023 local $SIG{TSTP} = 'IGNORE';
3024 local $SIG{PIPE} = 'IGNORE';
3026 my $oldAutoCommit = $FS::UID::AutoCommit;
3027 local $FS::UID::AutoCommit = 0;
3030 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3033 foreach my $old_cust_pkg ( @cust_pkgs ) {
3035 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3036 if ( $old_cust_pkg->getfield('cancel') ) {
3037 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3038 $old_cust_pkg->pkgnum."\n"
3042 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3044 my $error = $old_cust_pkg->change(
3045 'pkgpart' => $param->{'new_pkgpart'},
3046 'keep_dates' => $keep_dates
3048 if ( !ref($error) ) { # change returns the cust_pkg on success
3050 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3053 $dbh->commit if $oldAutoCommit;
3059 Returns the last bill date, or if there is no last bill date, the setup date.
3060 Useful for billing metered services.
3066 return $self->setfield('last_bill', $_[0]) if @_;
3067 return $self->getfield('last_bill') if $self->getfield('last_bill');
3068 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3069 'edate' => $self->bill, } );
3070 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3073 =item last_cust_pkg_reason ACTION
3075 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3076 Returns false if there is no reason or the package is not currenly ACTION'd
3077 ACTION is one of adjourn, susp, cancel, or expire.
3081 sub last_cust_pkg_reason {
3082 my ( $self, $action ) = ( shift, shift );
3083 my $date = $self->get($action);
3085 'table' => 'cust_pkg_reason',
3086 'hashref' => { 'pkgnum' => $self->pkgnum,
3087 'action' => substr(uc($action), 0, 1),
3090 'order_by' => 'ORDER BY num DESC LIMIT 1',
3094 =item last_reason ACTION
3096 Returns the most recent ACTION FS::reason associated with the package.
3097 Returns false if there is no reason or the package is not currenly ACTION'd
3098 ACTION is one of adjourn, susp, cancel, or expire.
3103 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3104 $cust_pkg_reason->reason
3105 if $cust_pkg_reason;
3110 Returns the definition for this billing item, as an FS::part_pkg object (see
3117 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3118 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3119 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3124 Returns the cancelled package this package was changed from, if any.
3130 return '' unless $self->change_pkgnum;
3131 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3134 =item change_cust_main
3136 Returns the customter this package was detached to, if any.
3140 sub change_cust_main {
3142 return '' unless $self->change_custnum;
3143 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3148 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3155 $self->part_pkg->calc_setup($self, @_);
3160 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3167 $self->part_pkg->calc_recur($self, @_);
3172 Returns the base setup fee (per unit) of this package, from the package
3177 # minimal version for 3.x; in 4.x this can invoke currency conversion
3181 $self->part_pkg->unit_setup($self);
3186 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3193 $self->part_pkg->base_recur($self, @_);
3198 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3205 $self->part_pkg->calc_remain($self, @_);
3210 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3217 $self->part_pkg->calc_cancel($self, @_);
3222 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3228 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3231 =item cust_pkg_detail [ DETAILTYPE ]
3233 Returns any customer package details for this package (see
3234 L<FS::cust_pkg_detail>).
3236 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3240 sub cust_pkg_detail {
3242 my %hash = ( 'pkgnum' => $self->pkgnum );
3243 $hash{detailtype} = shift if @_;
3245 'table' => 'cust_pkg_detail',
3246 'hashref' => \%hash,
3247 'order_by' => 'ORDER BY weight, pkgdetailnum',
3251 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3253 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3255 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3257 If there is an error, returns the error, otherwise returns false.
3261 sub set_cust_pkg_detail {
3262 my( $self, $detailtype, @details ) = @_;
3264 local $SIG{HUP} = 'IGNORE';
3265 local $SIG{INT} = 'IGNORE';
3266 local $SIG{QUIT} = 'IGNORE';
3267 local $SIG{TERM} = 'IGNORE';
3268 local $SIG{TSTP} = 'IGNORE';
3269 local $SIG{PIPE} = 'IGNORE';
3271 my $oldAutoCommit = $FS::UID::AutoCommit;
3272 local $FS::UID::AutoCommit = 0;
3275 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3276 my $error = $current->delete;
3278 $dbh->rollback if $oldAutoCommit;
3279 return "error removing old detail: $error";
3283 foreach my $detail ( @details ) {
3284 my $cust_pkg_detail = new FS::cust_pkg_detail {
3285 'pkgnum' => $self->pkgnum,
3286 'detailtype' => $detailtype,
3287 'detail' => $detail,
3289 my $error = $cust_pkg_detail->insert;
3291 $dbh->rollback if $oldAutoCommit;
3292 return "error adding new detail: $error";
3297 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3304 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3308 #false laziness w/cust_bill.pm
3312 'table' => 'cust_event',
3313 'addl_from' => 'JOIN part_event USING ( eventpart )',
3314 'hashref' => { 'tablenum' => $self->pkgnum },
3315 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3319 =item num_cust_event
3321 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3325 #false laziness w/cust_bill.pm
3326 sub num_cust_event {
3328 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3329 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3332 =item exists_cust_event
3334 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3338 sub exists_cust_event {
3340 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3341 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3342 $row ? $row->[0] : '';
3345 sub _from_cust_event_where {
3347 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3348 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3352 my( $self, $sql, @args ) = @_;
3353 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3354 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3358 =item cust_svc [ SVCPART ] (old, deprecated usage)
3360 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3362 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3364 Returns the services for this package, as FS::cust_svc objects (see
3365 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3366 spcififed, returns only the matching services.
3368 As an optimization, use the cust_svc_unsorted version if you are not displaying
3375 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3376 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3379 sub cust_svc_unsorted {
3381 @{ $self->cust_svc_unsorted_arrayref(@_) };
3384 sub cust_svc_unsorted_arrayref {
3387 return [] unless $self->num_cust_svc(@_);
3390 if ( @_ && $_[0] =~ /^\d+/ ) {
3391 $opt{svcpart} = shift;
3392 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3399 'select' => 'cust_svc.*, part_svc.*',
3400 'table' => 'cust_svc',
3401 'hashref' => { 'pkgnum' => $self->pkgnum },
3402 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3404 $search{hashref}->{svcpart} = $opt{svcpart}
3406 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3409 [ qsearch(\%search) ];
3413 =item overlimit [ SVCPART ]
3415 Returns the services for this package which have exceeded their
3416 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3417 is specified, return only the matching services.
3423 return () unless $self->num_cust_svc(@_);
3424 grep { $_->overlimit } $self->cust_svc(@_);
3427 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3429 Returns historical services for this package created before END TIMESTAMP and
3430 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3431 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3432 I<pkg_svc.hidden> flag will be omitted.
3438 warn "$me _h_cust_svc called on $self\n"
3441 my ($end, $start, $mode) = @_;
3442 my @cust_svc = $self->_sort_cust_svc(
3443 [ qsearch( 'h_cust_svc',
3444 { 'pkgnum' => $self->pkgnum, },
3445 FS::h_cust_svc->sql_h_search(@_),
3448 if ( defined($mode) && $mode eq 'I' ) {
3449 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3450 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3456 sub _sort_cust_svc {
3457 my( $self, $arrayref ) = @_;
3460 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3462 my %pkg_svc = map { $_->svcpart => $_ }
3463 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3468 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3470 $pkg_svc ? $pkg_svc->primary_svc : '',
3471 $pkg_svc ? $pkg_svc->quantity : 0,
3478 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3480 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3482 Returns the number of services for this package. Available options are svcpart
3483 and svcdb. If either is spcififed, returns only the matching services.
3490 return $self->{'_num_cust_svc'}
3492 && exists($self->{'_num_cust_svc'})
3493 && $self->{'_num_cust_svc'} =~ /\d/;
3495 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3499 if ( @_ && $_[0] =~ /^\d+/ ) {
3500 $opt{svcpart} = shift;
3501 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3507 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3508 my $where = ' WHERE pkgnum = ? ';
3509 my @param = ($self->pkgnum);
3511 if ( $opt{'svcpart'} ) {
3512 $where .= ' AND svcpart = ? ';
3513 push @param, $opt{'svcpart'};
3515 if ( $opt{'svcdb'} ) {
3516 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3517 $where .= ' AND svcdb = ? ';
3518 push @param, $opt{'svcdb'};
3521 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3522 $sth->execute(@param) or die $sth->errstr;
3523 $sth->fetchrow_arrayref->[0];
3526 =item available_part_svc
3528 Returns a list of FS::part_svc objects representing services included in this
3529 package but not yet provisioned. Each FS::part_svc object also has an extra
3530 field, I<num_avail>, which specifies the number of available services.
3532 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3533 associated pkg_svc has the provision_hold flag set.
3537 sub available_part_svc {
3541 my $pkg_quantity = $self->quantity || 1;
3543 grep { $_->num_avail > 0 }
3545 my $part_svc = $_->part_svc;
3546 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3547 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3549 # more evil encapsulation breakage
3550 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3551 my @exports = $part_svc->part_export_did;
3552 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3557 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3558 $self->part_pkg->pkg_svc;
3561 =item part_svc [ OPTION => VALUE ... ]
3563 Returns a list of FS::part_svc objects representing provisioned and available
3564 services included in this package. Each FS::part_svc object also has the
3565 following extra fields:
3579 (services) - array reference containing the provisioned services, as cust_svc objects
3583 Accepts two options:
3587 =item summarize_size
3589 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3590 is this size or greater.
3592 =item hide_discontinued
3594 If true, will omit looking for services that are no longer avaialble in the
3602 #label -> ($cust_svc->label)[1]
3608 my $pkg_quantity = $self->quantity || 1;
3610 #XXX some sort of sort order besides numeric by svcpart...
3611 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3613 my $part_svc = $pkg_svc->part_svc;
3614 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3615 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3616 $part_svc->{'Hash'}{'num_avail'} =
3617 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3618 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3619 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3620 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3621 && $num_cust_svc >= $opt{summarize_size};
3622 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3624 } $self->part_pkg->pkg_svc;
3626 unless ( $opt{hide_discontinued} ) {
3628 push @part_svc, map {
3630 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3631 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3632 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3633 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3634 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3636 } $self->extra_part_svc;
3643 =item extra_part_svc
3645 Returns a list of FS::part_svc objects corresponding to services in this
3646 package which are still provisioned but not (any longer) available in the
3651 sub extra_part_svc {
3654 my $pkgnum = $self->pkgnum;
3655 #my $pkgpart = $self->pkgpart;
3658 # 'table' => 'part_svc',
3661 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3662 # WHERE pkg_svc.svcpart = part_svc.svcpart
3663 # AND pkg_svc.pkgpart = ?
3666 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3667 # LEFT JOIN cust_pkg USING ( pkgnum )
3668 # WHERE cust_svc.svcpart = part_svc.svcpart
3671 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3674 #seems to benchmark slightly faster... (or did?)
3676 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3677 my $pkgparts = join(',', @pkgparts);
3680 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3681 #MySQL doesn't grok DISINCT ON
3682 'select' => 'DISTINCT part_svc.*',
3683 'table' => 'part_svc',
3685 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3686 AND pkg_svc.pkgpart IN ($pkgparts)
3689 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3690 LEFT JOIN cust_pkg USING ( pkgnum )
3693 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3694 'extra_param' => [ [$self->pkgnum=>'int'] ],
3700 Returns a short status string for this package, currently:
3706 =item not yet billed
3708 =item one-time charge
3723 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3725 return 'cancelled' if $self->get('cancel');
3726 return 'on hold' if $self->susp && ! $self->setup;
3727 return 'suspended' if $self->susp;
3728 return 'not yet billed' unless $self->setup;
3729 return 'one-time charge' if $freq =~ /^(0|$)/;
3733 =item ucfirst_status
3735 Returns the status with the first character capitalized.
3739 sub ucfirst_status {
3740 ucfirst(shift->status);
3745 Class method that returns the list of possible status strings for packages
3746 (see L<the status method|/status>). For example:
3748 @statuses = FS::cust_pkg->statuses();
3752 tie my %statuscolor, 'Tie::IxHash',
3753 'on hold' => 'FF00F5', #brighter purple!
3754 'not yet billed' => '009999', #teal? cyan?
3755 'one-time charge' => '0000CC', #blue #'000000',
3756 'active' => '00CC00',
3757 'suspended' => 'FF9900',
3758 'cancelled' => 'FF0000',
3762 my $self = shift; #could be class...
3763 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3764 # # mayble split btw one-time vs. recur
3775 Returns a hex triplet color string for this package's status.
3781 $statuscolor{$self->status};
3784 =item is_status_delay_cancel
3786 Returns true if part_pkg has option delay_cancel,
3787 cust_pkg status is 'suspended' and expire is set
3788 to cancel package within the next day (or however
3789 many days are set in global config part_pkg-delay_cancel-days.
3791 Accepts option I<part_pkg-delay_cancel-days> which should be
3792 the value of the config setting, to avoid looking it up again.
3794 This is not a real status, this only meant for hacking display
3795 values, because otherwise treating the package as suspended is
3796 really the whole point of the delay_cancel option.
3800 sub is_status_delay_cancel {
3801 my ($self,%opt) = @_;
3802 if ( $self->main_pkgnum and $self->pkglinknum ) {
3803 return $self->main_pkg->is_status_delay_cancel;
3805 return 0 unless $self->part_pkg->option('delay_cancel',1);
3806 return 0 unless $self->status eq 'suspended';
3807 return 0 unless $self->expire;
3808 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3810 my $conf = new FS::Conf;
3811 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3813 my $expsecs = 60*60*24*$expdays;
3814 return 0 unless $self->expire < time + $expsecs;
3820 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3821 "pkg - comment" depending on user preference).
3827 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3828 $label = $self->pkgnum. ": $label"
3829 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3833 =item pkg_label_long
3835 Returns a long label for this package, adding the primary service's label to
3840 sub pkg_label_long {
3842 my $label = $self->pkg_label;
3843 my $cust_svc = $self->primary_cust_svc;
3844 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3850 Returns a customer-localized label for this package.
3856 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3859 =item primary_cust_svc
3861 Returns a primary service (as FS::cust_svc object) if one can be identified.
3865 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3867 sub primary_cust_svc {
3870 my @cust_svc = $self->cust_svc;
3872 return '' unless @cust_svc; #no serivces - irrelevant then
3874 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3876 # primary service as specified in the package definition
3877 # or exactly one service definition with quantity one
3878 my $svcpart = $self->part_pkg->svcpart;
3879 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3880 return $cust_svc[0] if scalar(@cust_svc) == 1;
3882 #couldn't identify one thing..
3888 Returns a list of lists, calling the label method for all services
3889 (see L<FS::cust_svc>) of this billing item.
3895 map { [ $_->label ] } $self->cust_svc;
3898 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
3900 Like the labels method, but returns historical information on services that
3901 were active as of END_TIMESTAMP and (optionally) not cancelled before
3902 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3903 I<pkg_svc.hidden> flag will be omitted.
3905 If LOCALE is passed, service definition names will be localized.
3907 Returns a list of lists, calling the label method for all (historical)
3908 services (see L<FS::h_cust_svc>) of this billing item.
3914 my ($end, $start, $mode, $locale) = @_;
3915 warn "$me h_labels\n"
3917 map { [ $_->label($end, $start, $locale) ] }
3918 $self->h_cust_svc($end, $start, $mode);
3923 Like labels, except returns a simple flat list, and shortens long
3924 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3925 identical services to one line that lists the service label and the number of
3926 individual services rather than individual items.
3931 shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
3934 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
3936 Like h_labels, except returns a simple flat list, and shortens long
3937 (currently >5 or the cust_bill-max_same_services configuration value) lists
3938 of identical services to one line that lists the service label and the
3939 number of individual services rather than individual items.
3943 sub h_labels_short {
3944 shift->_labels_short( 'h_labels', @_ );
3947 # takes a method name ('labels' or 'h_labels') and all its arguments;
3948 # maybe should be "shorten($self->h_labels( ... ) )"
3951 my( $self, $method ) = ( shift, shift );
3953 warn "$me _labels_short called on $self with $method method\n"
3956 my $conf = new FS::Conf;
3957 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3959 warn "$me _labels_short populating \%labels\n"
3963 #tie %labels, 'Tie::IxHash';
3964 push @{ $labels{$_->[0]} }, $_->[1]
3965 foreach $self->$method(@_);
3967 warn "$me _labels_short populating \@labels\n"
3971 foreach my $label ( keys %labels ) {
3973 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3974 my $num = scalar(@values);
3975 warn "$me _labels_short $num items for $label\n"
3978 if ( $num > $max_same_services ) {
3979 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3981 push @labels, "$label ($num)";
3983 if ( $conf->exists('cust_bill-consolidate_services') ) {
3984 warn "$me _labels_short consolidating services\n"
3986 # push @labels, "$label: ". join(', ', @values);
3988 my $detail = "$label: ";
3989 $detail .= shift(@values). ', '
3991 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3993 push @labels, $detail;
3995 warn "$me _labels_short done consolidating services\n"
3998 warn "$me _labels_short adding service data\n"
4000 push @labels, map { "$label: $_" } @values;
4011 Returns the parent customer object (see L<FS::cust_main>).
4017 cluck 'cust_pkg->cust_main called' if $DEBUG;
4018 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
4023 Returns the balance for this specific package, when using
4024 experimental package balance.
4030 $self->cust_main->balance_pkgnum( $self->pkgnum );
4033 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4037 Returns the location object, if any (see L<FS::cust_location>).
4039 =item cust_location_or_main
4041 If this package is associated with a location, returns the locaiton (see
4042 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4044 =item location_label [ OPTION => VALUE ... ]
4046 Returns the label of the location object (see L<FS::cust_location>).
4050 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4052 =item tax_locationnum
4054 Returns the foreign key to a L<FS::cust_location> object for calculating
4055 tax on this package, as determined by the C<tax-pkg_address> and
4056 C<tax-ship_address> configuration flags.
4060 sub tax_locationnum {
4062 my $conf = FS::Conf->new;
4063 if ( $conf->exists('tax-pkg_address') ) {
4064 return $self->locationnum;
4066 elsif ( $conf->exists('tax-ship_address') ) {
4067 return $self->cust_main->ship_locationnum;
4070 return $self->cust_main->bill_locationnum;
4076 Returns the L<FS::cust_location> object for tax_locationnum.
4082 my $conf = FS::Conf->new;
4083 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4084 return FS::cust_location->by_key($self->locationnum);
4086 elsif ( $conf->exists('tax-ship_address') ) {
4087 return $self->cust_main->ship_location;
4090 return $self->cust_main->bill_location;
4094 =item seconds_since TIMESTAMP
4096 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4097 package have been online since TIMESTAMP, according to the session monitor.
4099 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4100 L<Time::Local> and L<Date::Parse> for conversion functions.
4105 my($self, $since) = @_;
4108 foreach my $cust_svc (
4109 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4111 $seconds += $cust_svc->seconds_since($since);
4118 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4120 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4121 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4124 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4125 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4131 sub seconds_since_sqlradacct {
4132 my($self, $start, $end) = @_;
4136 foreach my $cust_svc (
4138 my $part_svc = $_->part_svc;
4139 $part_svc->svcdb eq 'svc_acct'
4140 && scalar($part_svc->part_export_usage);
4143 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4150 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4152 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4153 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4157 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4158 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4163 sub attribute_since_sqlradacct {
4164 my($self, $start, $end, $attrib) = @_;
4168 foreach my $cust_svc (
4170 my $part_svc = $_->part_svc;
4171 scalar($part_svc->part_export_usage);
4174 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4186 my( $self, $value ) = @_;
4187 if ( defined($value) ) {
4188 $self->setfield('quantity', $value);
4190 $self->getfield('quantity') || 1;
4193 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4195 Transfers as many services as possible from this package to another package.
4197 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4198 object. The destination package must already exist.
4200 Services are moved only if the destination allows services with the correct
4201 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4202 this option with caution! No provision is made for export differences
4203 between the old and new service definitions. Probably only should be used
4204 when your exports for all service definitions of a given svcdb are identical.
4205 (attempt a transfer without it first, to move all possible svcpart-matching
4208 Any services that can't be moved remain in the original package.
4210 Returns an error, if there is one; otherwise, returns the number of services
4211 that couldn't be moved.
4216 my ($self, $dest_pkgnum, %opt) = @_;
4222 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4223 $dest = $dest_pkgnum;
4224 $dest_pkgnum = $dest->pkgnum;
4226 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4229 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4231 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4232 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4235 foreach my $cust_svc ($dest->cust_svc) {
4236 $target{$cust_svc->svcpart}--;
4239 my %svcpart2svcparts = ();
4240 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4241 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4242 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4243 next if exists $svcpart2svcparts{$svcpart};
4244 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4245 $svcpart2svcparts{$svcpart} = [
4247 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4249 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4250 'svcpart' => $_ } );
4252 $pkg_svc ? $pkg_svc->primary_svc : '',
4253 $pkg_svc ? $pkg_svc->quantity : 0,
4257 grep { $_ != $svcpart }
4259 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4261 warn "alternates for svcpart $svcpart: ".
4262 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4268 foreach my $cust_svc ($self->cust_svc) {
4269 my $svcnum = $cust_svc->svcnum;
4270 if($target{$cust_svc->svcpart} > 0
4271 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4272 $target{$cust_svc->svcpart}--;
4273 my $new = new FS::cust_svc { $cust_svc->hash };
4274 $new->pkgnum($dest_pkgnum);
4275 $error = $new->replace($cust_svc);
4276 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4278 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4279 warn "alternates to consider: ".
4280 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4282 my @alternate = grep {
4283 warn "considering alternate svcpart $_: ".
4284 "$target{$_} available in new package\n"
4287 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4289 warn "alternate(s) found\n" if $DEBUG;
4290 my $change_svcpart = $alternate[0];
4291 $target{$change_svcpart}--;
4292 my $new = new FS::cust_svc { $cust_svc->hash };
4293 $new->svcpart($change_svcpart);
4294 $new->pkgnum($dest_pkgnum);
4295 $error = $new->replace($cust_svc);
4303 my @label = $cust_svc->label;
4304 return "service $label[1]: $error";
4310 =item grab_svcnums SVCNUM, SVCNUM ...
4312 Change the pkgnum for the provided services to this packages. If there is an
4313 error, returns the error, otherwise returns false.
4321 local $SIG{HUP} = 'IGNORE';
4322 local $SIG{INT} = 'IGNORE';
4323 local $SIG{QUIT} = 'IGNORE';
4324 local $SIG{TERM} = 'IGNORE';
4325 local $SIG{TSTP} = 'IGNORE';
4326 local $SIG{PIPE} = 'IGNORE';
4328 my $oldAutoCommit = $FS::UID::AutoCommit;
4329 local $FS::UID::AutoCommit = 0;
4332 foreach my $svcnum (@svcnum) {
4333 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4334 $dbh->rollback if $oldAutoCommit;
4335 return "unknown svcnum $svcnum";
4337 $cust_svc->pkgnum( $self->pkgnum );
4338 my $error = $cust_svc->replace;
4340 $dbh->rollback if $oldAutoCommit;
4345 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4352 This method is deprecated. See the I<depend_jobnum> option to the insert and
4353 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4360 local $SIG{HUP} = 'IGNORE';
4361 local $SIG{INT} = 'IGNORE';
4362 local $SIG{QUIT} = 'IGNORE';
4363 local $SIG{TERM} = 'IGNORE';
4364 local $SIG{TSTP} = 'IGNORE';
4365 local $SIG{PIPE} = 'IGNORE';
4367 my $oldAutoCommit = $FS::UID::AutoCommit;
4368 local $FS::UID::AutoCommit = 0;
4371 foreach my $cust_svc ( $self->cust_svc ) {
4372 #false laziness w/svc_Common::insert
4373 my $svc_x = $cust_svc->svc_x;
4374 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4375 my $error = $part_export->export_insert($svc_x);
4377 $dbh->rollback if $oldAutoCommit;
4383 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4388 =item export_pkg_change OLD_CUST_PKG
4390 Calls the "pkg_change" export action for all services attached to this package.
4394 sub export_pkg_change {
4395 my( $self, $old ) = ( shift, shift );
4397 local $SIG{HUP} = 'IGNORE';
4398 local $SIG{INT} = 'IGNORE';
4399 local $SIG{QUIT} = 'IGNORE';
4400 local $SIG{TERM} = 'IGNORE';
4401 local $SIG{TSTP} = 'IGNORE';
4402 local $SIG{PIPE} = 'IGNORE';
4404 my $oldAutoCommit = $FS::UID::AutoCommit;
4405 local $FS::UID::AutoCommit = 0;
4408 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4409 my $error = $svc_x->export('pkg_change', $self, $old);
4411 $dbh->rollback if $oldAutoCommit;
4416 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4423 Associates this package with a (suspension or cancellation) reason (see
4424 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4427 Available options are:
4433 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.
4437 the access_user (see L<FS::access_user>) providing the reason
4445 the action (cancel, susp, adjourn, expire) associated with the reason
4449 If there is an error, returns the error, otherwise returns false.
4454 my ($self, %options) = @_;
4456 my $otaker = $options{reason_otaker} ||
4457 $FS::CurrentUser::CurrentUser->username;
4460 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4464 } elsif ( ref($options{'reason'}) ) {
4466 return 'Enter a new reason (or select an existing one)'
4467 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4469 my $reason = new FS::reason({
4470 'reason_type' => $options{'reason'}->{'typenum'},
4471 'reason' => $options{'reason'}->{'reason'},
4473 my $error = $reason->insert;
4474 return $error if $error;
4476 $reasonnum = $reason->reasonnum;
4479 return "Unparseable reason: ". $options{'reason'};
4482 my $cust_pkg_reason =
4483 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4484 'reasonnum' => $reasonnum,
4485 'otaker' => $otaker,
4486 'action' => substr(uc($options{'action'}),0,1),
4487 'date' => $options{'date'}
4492 $cust_pkg_reason->insert;
4495 =item insert_discount
4497 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4498 inserting a new discount on the fly (see L<FS::discount>).
4500 Available options are:
4508 If there is an error, returns the error, otherwise returns false.
4512 sub insert_discount {
4513 #my ($self, %options) = @_;
4516 my $cust_pkg_discount = new FS::cust_pkg_discount {
4517 'pkgnum' => $self->pkgnum,
4518 'discountnum' => $self->discountnum,
4520 'end_date' => '', #XXX
4521 #for the create a new discount case
4522 '_type' => $self->discountnum__type,
4523 'amount' => $self->discountnum_amount,
4524 'percent' => $self->discountnum_percent,
4525 'months' => $self->discountnum_months,
4526 'setup' => $self->discountnum_setup,
4527 #'disabled' => $self->discountnum_disabled,
4530 $cust_pkg_discount->insert;
4533 =item set_usage USAGE_VALUE_HASHREF
4535 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4536 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4537 upbytes, downbytes, and totalbytes are appropriate keys.
4539 All svc_accts which are part of this package have their values reset.
4544 my ($self, $valueref, %opt) = @_;
4546 #only svc_acct can set_usage for now
4547 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4548 my $svc_x = $cust_svc->svc_x;
4549 $svc_x->set_usage($valueref, %opt)
4550 if $svc_x->can("set_usage");
4554 =item recharge USAGE_VALUE_HASHREF
4556 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4557 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4558 upbytes, downbytes, and totalbytes are appropriate keys.
4560 All svc_accts which are part of this package have their values incremented.
4565 my ($self, $valueref) = @_;
4567 #only svc_acct can set_usage for now
4568 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4569 my $svc_x = $cust_svc->svc_x;
4570 $svc_x->recharge($valueref)
4571 if $svc_x->can("recharge");
4575 =item cust_pkg_discount
4579 sub cust_pkg_discount {
4581 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4584 =item cust_pkg_discount_active
4588 sub cust_pkg_discount_active {
4590 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4593 =item cust_pkg_usage
4595 Returns a list of all voice usage counters attached to this package.
4599 sub cust_pkg_usage {
4601 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4604 =item apply_usage OPTIONS
4606 Takes the following options:
4607 - cdr: a call detail record (L<FS::cdr>)
4608 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4609 - minutes: the maximum number of minutes to be charged
4611 Finds available usage minutes for a call of this class, and subtracts
4612 up to that many minutes from the usage pool. If the usage pool is empty,
4613 and the C<cdr-minutes_priority> global config option is set, minutes may
4614 be taken from other calls as well. Either way, an allocation record will
4615 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4616 number of minutes of usage applied to the call.
4621 my ($self, %opt) = @_;
4622 my $cdr = $opt{cdr};
4623 my $rate_detail = $opt{rate_detail};
4624 my $minutes = $opt{minutes};
4625 my $classnum = $rate_detail->classnum;
4626 my $pkgnum = $self->pkgnum;
4627 my $custnum = $self->custnum;
4629 local $SIG{HUP} = 'IGNORE';
4630 local $SIG{INT} = 'IGNORE';
4631 local $SIG{QUIT} = 'IGNORE';
4632 local $SIG{TERM} = 'IGNORE';
4633 local $SIG{TSTP} = 'IGNORE';
4634 local $SIG{PIPE} = 'IGNORE';
4636 my $oldAutoCommit = $FS::UID::AutoCommit;
4637 local $FS::UID::AutoCommit = 0;
4639 my $order = FS::Conf->new->config('cdr-minutes_priority');
4643 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4645 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4647 my @usage_recs = qsearch({
4648 'table' => 'cust_pkg_usage',
4649 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4650 ' JOIN cust_pkg USING (pkgnum)'.
4651 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4652 'select' => 'cust_pkg_usage.*',
4653 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4654 " ( cust_pkg.custnum = $custnum AND ".
4655 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4656 $is_classnum . ' AND '.
4657 " cust_pkg_usage.minutes > 0",
4658 'order_by' => " ORDER BY priority ASC",
4661 my $orig_minutes = $minutes;
4663 while (!$error and $minutes > 0 and @usage_recs) {
4664 my $cust_pkg_usage = shift @usage_recs;
4665 $cust_pkg_usage->select_for_update;
4666 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4667 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4668 acctid => $cdr->acctid,
4669 minutes => min($cust_pkg_usage->minutes, $minutes),
4671 $cust_pkg_usage->set('minutes',
4672 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4674 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4675 $minutes -= $cdr_cust_pkg_usage->minutes;
4677 if ( $order and $minutes > 0 and !$error ) {
4678 # then try to steal minutes from another call
4680 'table' => 'cdr_cust_pkg_usage',
4681 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4682 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4683 ' JOIN cust_pkg USING (pkgnum)'.
4684 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4685 ' JOIN cdr USING (acctid)',
4686 'select' => 'cdr_cust_pkg_usage.*',
4687 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4688 " ( cust_pkg.pkgnum = $pkgnum OR ".
4689 " ( cust_pkg.custnum = $custnum AND ".
4690 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4691 " part_pkg_usage_class.classnum = $classnum",
4692 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4694 if ( $order eq 'time' ) {
4695 # find CDRs that are using minutes, but have a later startdate
4697 my $startdate = $cdr->startdate;
4698 if ($startdate !~ /^\d+$/) {
4699 die "bad cdr startdate '$startdate'";
4701 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4702 # minimize needless reshuffling
4703 $search{'order_by'} .= ', cdr.startdate DESC';
4705 # XXX may not work correctly with rate_time schedules. Could
4706 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4708 $search{'addl_from'} .=
4709 ' JOIN rate_detail'.
4710 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4711 if ( $order eq 'rate_high' ) {
4712 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4713 $rate_detail->min_charge;
4714 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4715 } elsif ( $order eq 'rate_low' ) {
4716 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4717 $rate_detail->min_charge;
4718 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4720 # this should really never happen
4721 die "invalid cdr-minutes_priority value '$order'\n";
4724 my @cdr_usage_recs = qsearch(\%search);
4726 while (!$error and @cdr_usage_recs and $minutes > 0) {
4727 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4728 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4729 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4730 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4731 $cdr_cust_pkg_usage->select_for_update;
4732 $old_cdr->select_for_update;
4733 $cust_pkg_usage->select_for_update;
4734 # in case someone else stole the usage from this CDR
4735 # while waiting for the lock...
4736 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4737 # steal the usage allocation and flag the old CDR for reprocessing
4738 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4739 # if the allocation is more minutes than we need, adjust it...
4740 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4742 $cdr_cust_pkg_usage->set('minutes', $minutes);
4743 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4744 $error = $cust_pkg_usage->replace;
4746 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4747 $error ||= $cdr_cust_pkg_usage->replace;
4748 # deduct the stolen minutes
4749 $minutes -= $cdr_cust_pkg_usage->minutes;
4751 # after all minute-stealing is done, reset the affected CDRs
4752 foreach (values %reproc_cdrs) {
4753 $error ||= $_->set_status('');
4754 # XXX or should we just call $cdr->rate right here?
4755 # it's not like we can create a loop this way, since the min_charge
4756 # or call time has to go monotonically in one direction.
4757 # we COULD get some very deep recursions going, though...
4759 } # if $order and $minutes
4762 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4764 $dbh->commit if $oldAutoCommit;
4765 return $orig_minutes - $minutes;
4769 =item supplemental_pkgs
4771 Returns a list of all packages supplemental to this one.
4775 sub supplemental_pkgs {
4777 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4782 Returns the package that this one is supplemental to, if any.
4788 if ( $self->main_pkgnum ) {
4789 return FS::cust_pkg->by_key($self->main_pkgnum);
4796 =head1 CLASS METHODS
4802 Returns an SQL expression identifying recurring packages.
4806 sub recurring_sql { "
4807 '0' != ( select freq from part_pkg
4808 where cust_pkg.pkgpart = part_pkg.pkgpart )
4813 Returns an SQL expression identifying one-time packages.
4818 '0' = ( select freq from part_pkg
4819 where cust_pkg.pkgpart = part_pkg.pkgpart )
4824 Returns an SQL expression identifying ordered packages (recurring packages not
4830 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4835 Returns an SQL expression identifying active packages.
4840 $_[0]->recurring_sql. "
4841 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4842 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4843 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4846 =item not_yet_billed_sql
4848 Returns an SQL expression identifying packages which have not yet been billed.
4852 sub not_yet_billed_sql { "
4853 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4854 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4855 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4860 Returns an SQL expression identifying inactive packages (one-time packages
4861 that are otherwise unsuspended/uncancelled).
4865 sub inactive_sql { "
4866 ". $_[0]->onetime_sql(). "
4867 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4868 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4869 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4874 Returns an SQL expression identifying on-hold packages.
4879 #$_[0]->recurring_sql(). ' AND '.
4881 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4882 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4883 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4890 Returns an SQL expression identifying suspended packages.
4894 sub suspended_sql { susp_sql(@_); }
4896 #$_[0]->recurring_sql(). ' AND '.
4898 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4899 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4900 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4907 Returns an SQL exprression identifying cancelled packages.
4911 sub cancelled_sql { cancel_sql(@_); }
4913 #$_[0]->recurring_sql(). ' AND '.
4914 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4919 Returns an SQL expression to give the package status as a string.
4925 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4926 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4927 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4928 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4929 WHEN ".onetime_sql()." THEN 'one-time charge'
4934 =item search HASHREF
4938 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4939 Valid parameters are
4947 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
4951 Equivalent to "status", except that "canceled"/"cancelled" will exclude
4952 packages that were changed into a new package with the same pkgpart (i.e.
4953 location or quantity changes).
4957 boolean selects custom packages
4963 pkgpart or arrayref or hashref of pkgparts
4967 arrayref of beginning and ending epoch date
4971 arrayref of beginning and ending epoch date
4975 arrayref of beginning and ending epoch date
4979 arrayref of beginning and ending epoch date
4983 arrayref of beginning and ending epoch date
4987 arrayref of beginning and ending epoch date
4991 arrayref of beginning and ending epoch date
4995 pkgnum or APKG_pkgnum
4999 a value suited to passing to FS::UI::Web::cust_header
5003 specifies the user for agent virtualization
5007 boolean; if true, returns only packages with more than 0 FCC phone lines.
5009 =item state, country
5011 Limit to packages with a service location in the specified state and country.
5012 For FCC 477 reporting, mostly.
5016 Limit to packages whose service locations are the same as the customer's
5017 default service location.
5019 =item location_nocust
5021 Limit to packages whose service locations are not the customer's default
5024 =item location_census
5026 Limit to packages whose service locations have census tracts.
5028 =item location_nocensus
5030 Limit to packages whose service locations do not have a census tract.
5032 =item location_geocode
5034 Limit to packages whose locations have geocodes.
5036 =item location_geocode
5038 Limit to packages whose locations do not have geocodes.
5042 Limit to packages associated with a svc_broadband, associated with a sector,
5043 associated with this towernum (or any of these, if it's an arrayref) (or NO
5044 towernum, if it's zero). This is an extreme niche case.
5046 =item 477part, 477rownum, date
5048 Limit to packages included in a specific row of one of the FCC 477 reports.
5049 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
5050 is the report as-of date (completely unrelated to the package setup/bill/
5051 other date fields), and '477rownum' is the row number of the report starting
5052 with zero. Row numbers have no inherent meaning, so this is useful only
5053 for explaining a 477 report you've already run.
5060 my ($class, $params) = @_;
5067 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5069 "cust_main.agentnum = $1";
5076 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
5077 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
5081 # parse customer sales person
5084 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
5085 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
5086 : 'cust_main.salesnum IS NULL';
5091 # parse sales person
5094 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
5095 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
5096 : 'cust_pkg.salesnum IS NULL';
5103 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
5105 "cust_pkg.custnum = $1";
5112 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5114 "cust_pkg.pkgbatch = '$1'";
5121 if ( $params->{'magic'} eq 'active'
5122 || $params->{'status'} eq 'active' ) {
5124 push @where, FS::cust_pkg->active_sql();
5126 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
5127 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
5129 push @where, FS::cust_pkg->not_yet_billed_sql();
5131 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
5132 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
5134 push @where, FS::cust_pkg->inactive_sql();
5136 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
5137 || $params->{'status'} =~ /^on[ _]hold$/ ) {
5139 push @where, FS::cust_pkg->on_hold_sql();
5142 } elsif ( $params->{'magic'} eq 'suspended'
5143 || $params->{'status'} eq 'suspended' ) {
5145 push @where, FS::cust_pkg->suspended_sql();
5147 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
5148 || $params->{'status'} =~ /^cancell?ed$/ ) {
5150 push @where, FS::cust_pkg->cancelled_sql();
5154 ### special case: "magic" is used in detail links from browse/part_pkg,
5155 # where "cancelled" has the restriction "and not replaced with a package
5156 # of the same pkgpart". Be consistent with that.
5159 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
5160 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
5161 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
5162 # ...may not exist, if this was just canceled and not changed; in that
5163 # case give it a "new pkgpart" that never equals the old pkgpart
5164 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
5168 # parse package class
5171 if ( exists($params->{'classnum'}) ) {
5174 if ( ref($params->{'classnum'}) ) {
5176 if ( ref($params->{'classnum'}) eq 'HASH' ) {
5177 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
5178 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
5179 @classnum = @{ $params->{'classnum'} };
5181 die 'unhandled classnum ref '. $params->{'classnum'};
5185 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
5192 my @nums = grep $_, @classnum;
5193 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
5194 my $null = scalar( grep { $_ eq '' } @classnum );
5195 push @c_where, 'part_pkg.classnum IS NULL' if $null;
5197 if ( scalar(@c_where) == 1 ) {
5198 push @where, @c_where;
5199 } elsif ( @c_where ) {
5200 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
5209 # parse refnum (advertising source)
5212 if ( exists($params->{'refnum'}) ) {
5214 if (ref $params->{'refnum'}) {
5215 @refnum = @{ $params->{'refnum'} };
5217 @refnum = ( $params->{'refnum'} );
5219 my $in = join(',', grep /^\d+$/, @refnum);
5220 push @where, "refnum IN($in)" if length $in;
5224 # parse package report options
5227 my @report_option = ();
5228 if ( exists($params->{'report_option'}) ) {
5229 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
5230 @report_option = @{ $params->{'report_option'} };
5231 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
5232 @report_option = split(',', $1);
5237 if (@report_option) {
5238 # this will result in the empty set for the dangling comma case as it should
5240 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5241 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5242 AND optionname = 'report_option_$_'
5243 AND optionvalue = '1' )"
5247 foreach my $any ( grep /^report_option_any/, keys %$params ) {
5249 my @report_option_any = ();
5250 if ( ref($params->{$any}) eq 'ARRAY' ) {
5251 @report_option_any = @{ $params->{$any} };
5252 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
5253 @report_option_any = split(',', $1);
5256 if (@report_option_any) {
5257 # this will result in the empty set for the dangling comma case as it should
5258 push @where, ' ( '. join(' OR ',
5259 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5260 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5261 AND optionname = 'report_option_$_'
5262 AND optionvalue = '1' )"
5263 } @report_option_any
5273 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
5279 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
5280 if $params->{fcc_line};
5286 if ( exists($params->{'censustract'}) ) {
5287 $params->{'censustract'} =~ /^([.\d]*)$/;
5288 my $censustract = "cust_location.censustract = '$1'";
5289 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
5290 push @where, "( $censustract )";
5294 # parse censustract2
5296 if ( exists($params->{'censustract2'})
5297 && $params->{'censustract2'} =~ /^(\d*)$/
5301 push @where, "cust_location.censustract LIKE '$1%'";
5304 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
5309 # parse country/state/zip
5311 for (qw(state country)) { # parsing rules are the same for these
5312 if ( exists($params->{$_})
5313 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
5315 # XXX post-2.3 only--before that, state/country may be in cust_main
5316 push @where, "cust_location.$_ = '$1'";
5319 if ( exists($params->{zip}) ) {
5320 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
5326 if ( $params->{location_cust} xor $params->{location_nocust} ) {
5327 my $op = $params->{location_cust} ? '=' : '!=';
5328 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
5330 if ( $params->{location_census} xor $params->{location_nocensus} ) {
5331 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
5332 push @where, "cust_location.censustract $op";
5334 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
5335 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
5336 push @where, "cust_location.geocode $op";
5343 if ( ref($params->{'pkgpart'}) ) {
5346 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
5347 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
5348 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
5349 @pkgpart = @{ $params->{'pkgpart'} };
5351 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
5354 @pkgpart = grep /^(\d+)$/, @pkgpart;
5356 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
5358 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5359 push @where, "pkgpart = $1";
5368 #false laziness w/report_cust_pkg.html
5371 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
5372 'active' => { 'susp'=>1, 'cancel'=>1 },
5373 'suspended' => { 'cancel' => 1 },
5378 if( exists($params->{'active'} ) ) {
5379 # This overrides all the other date-related fields, and includes packages
5380 # that were active at some time during the interval. It excludes:
5381 # - packages that were set up after the end of the interval
5382 # - packages that were canceled before the start of the interval
5383 # - packages that were suspended before the start of the interval
5384 # and are still suspended now
5385 my($beginning, $ending) = @{$params->{'active'}};
5387 "cust_pkg.setup IS NOT NULL",
5388 "cust_pkg.setup <= $ending",
5389 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5390 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
5391 "NOT (".FS::cust_pkg->onetime_sql . ")";
5394 my $exclude_change_from = 0;
5395 my $exclude_change_to = 0;
5397 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5399 next unless exists($params->{$field});
5401 my($beginning, $ending) = @{$params->{$field}};
5403 next if $beginning == 0 && $ending == 4294967295;
5406 "cust_pkg.$field IS NOT NULL",
5407 "cust_pkg.$field >= $beginning",
5408 "cust_pkg.$field <= $ending";
5410 $orderby ||= "ORDER BY cust_pkg.$field";
5412 if ( $field eq 'setup' ) {
5413 $exclude_change_from = 1;
5414 } elsif ( $field eq 'cancel' ) {
5415 $exclude_change_to = 1;
5416 } elsif ( $field eq 'change_date' ) {
5417 # if we are given setup and change_date ranges, and the setup date
5418 # falls in _both_ ranges, then include the package whether it was
5420 $exclude_change_from = 0;
5424 if ($exclude_change_from) {
5425 push @where, "change_pkgnum IS NULL";
5427 if ($exclude_change_to) {
5428 # a join might be more efficient here
5429 push @where, "NOT EXISTS(
5430 SELECT 1 FROM cust_pkg AS changed_to_pkg
5431 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5436 $orderby ||= 'ORDER BY bill';
5439 # parse magic, legacy, etc.
5442 if ( $params->{'magic'} &&
5443 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5446 $orderby = 'ORDER BY pkgnum';
5448 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5449 push @where, "pkgpart = $1";
5452 } elsif ( $params->{'query'} eq 'pkgnum' ) {
5454 $orderby = 'ORDER BY pkgnum';
5456 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5458 $orderby = 'ORDER BY pkgnum';
5461 SELECT count(*) FROM pkg_svc
5462 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
5463 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5464 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
5465 AND cust_svc.svcpart = pkg_svc.svcpart
5472 # parse the extremely weird 'towernum' param
5475 if ($params->{towernum}) {
5476 my $towernum = $params->{towernum};
5477 $towernum = [ $towernum ] if !ref($towernum);
5478 my $in = join(',', grep /^\d+$/, @$towernum);
5480 # inefficient, but this is an obscure feature
5481 eval "use FS::Report::Table";
5482 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5483 push @where, "EXISTS(
5484 SELECT 1 FROM tower_pkg_cache
5485 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5486 AND tower_pkg_cache.towernum IN ($in)
5492 # parse the 477 report drill-down options
5495 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5497 my ($date, $rownum, $agentnum);
5498 if ($params->{'date'} =~ /^(\d+)$/) {
5501 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5504 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5507 if ($date and defined($rownum)) {
5508 my $report = FS::Report::FCC_477->report($section,
5510 'agentnum' => $agentnum,
5513 my $pkgnums = $report->{detail}->[$rownum]
5514 or die "row $rownum is past the end of the report";
5515 # '0' so that if there are no pkgnums (empty string) it will create
5516 # a valid query that returns nothing
5517 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5519 # and this overrides everything
5520 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5521 } # else we're missing some params, ignore the whole business
5525 # setup queries, links, subs, etc. for the search
5528 # here is the agent virtualization
5529 if ($params->{CurrentUser}) {
5531 qsearchs('access_user', { username => $params->{CurrentUser} });
5534 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5539 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5542 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5544 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5545 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5546 'LEFT JOIN cust_location USING ( locationnum ) '.
5547 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5551 if ( $params->{'select_zip5'} ) {
5552 my $zip = 'cust_location.zip';
5554 $select = "DISTINCT substr($zip,1,5) as zip";
5555 $orderby = "ORDER BY substr($zip,1,5)";
5556 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5558 $select = join(', ',
5560 ( map "part_pkg.$_", qw( pkg freq ) ),
5561 'pkg_class.classname',
5562 'cust_main.custnum AS cust_main_custnum',
5563 FS::UI::Web::cust_sql_fields(
5564 $params->{'cust_fields'}
5567 $count_query = 'SELECT COUNT(*)';
5570 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5573 'table' => 'cust_pkg',
5575 'select' => $select,
5576 'extra_sql' => $extra_sql,
5577 'order_by' => $orderby,
5578 'addl_from' => $addl_from,
5579 'count_query' => $count_query,
5586 Returns a list of two package counts. The first is a count of packages
5587 based on the supplied criteria and the second is the count of residential
5588 packages with those same criteria. Criteria are specified as in the search
5594 my ($class, $params) = @_;
5596 my $sql_query = $class->search( $params );
5598 my $count_sql = delete($sql_query->{'count_query'});
5599 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5600 or die "couldn't parse count_sql";
5602 my $count_sth = dbh->prepare($count_sql)
5603 or die "Error preparing $count_sql: ". dbh->errstr;
5605 or die "Error executing $count_sql: ". $count_sth->errstr;
5606 my $count_arrayref = $count_sth->fetchrow_arrayref;
5608 return ( @$count_arrayref );
5612 =item tax_locationnum_sql
5614 Returns an SQL expression for the tax location for a package, based
5615 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5619 sub tax_locationnum_sql {
5620 my $conf = FS::Conf->new;
5621 if ( $conf->exists('tax-pkg_address') ) {
5622 'cust_pkg.locationnum';
5624 elsif ( $conf->exists('tax-ship_address') ) {
5625 'cust_main.ship_locationnum';
5628 'cust_main.bill_locationnum';
5634 Returns a list: the first item is an SQL fragment identifying matching
5635 packages/customers via location (taking into account shipping and package
5636 address taxation, if enabled), and subsequent items are the parameters to
5637 substitute for the placeholders in that fragment.
5642 my($class, %opt) = @_;
5643 my $ornull = $opt{'ornull'};
5645 my $conf = new FS::Conf;
5647 # '?' placeholders in _location_sql_where
5648 my $x = $ornull ? 3 : 2;
5659 if ( $conf->exists('tax-ship_address') ) {
5662 ( ( ship_last IS NULL OR ship_last = '' )
5663 AND ". _location_sql_where('cust_main', '', $ornull ). "
5665 OR ( ship_last IS NOT NULL AND ship_last != ''
5666 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5669 # AND payby != 'COMP'
5671 @main_param = ( @bill_param, @bill_param );
5675 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5676 @main_param = @bill_param;
5682 if ( $conf->exists('tax-pkg_address') ) {
5684 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5687 ( cust_pkg.locationnum IS NULL AND $main_where )
5688 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5691 @param = ( @main_param, @bill_param );
5695 $where = $main_where;
5696 @param = @main_param;
5704 #subroutine, helper for location_sql
5705 sub _location_sql_where {
5707 my $prefix = @_ ? shift : '';
5708 my $ornull = @_ ? shift : '';
5710 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5712 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5714 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5715 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5716 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5718 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5720 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5722 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5723 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5724 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5725 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5726 AND $table.${prefix}country = ?
5731 my( $self, $what ) = @_;
5733 my $what_show_zero = $what. '_show_zero';
5734 length($self->$what_show_zero())
5735 ? ($self->$what_show_zero() eq 'Y')
5736 : $self->part_pkg->$what_show_zero();
5743 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5745 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5746 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5748 CUSTNUM is a customer (see L<FS::cust_main>)
5750 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5751 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5754 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5755 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5756 new billing items. An error is returned if this is not possible (see
5757 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5760 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5761 newly-created cust_pkg objects.
5763 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5764 and inserted. Multiple FS::pkg_referral records can be created by
5765 setting I<refnum> to an array reference of refnums or a hash reference with
5766 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5767 record will be created corresponding to cust_main.refnum.
5772 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5774 my $conf = new FS::Conf;
5776 # Transactionize this whole mess
5777 local $SIG{HUP} = 'IGNORE';
5778 local $SIG{INT} = 'IGNORE';
5779 local $SIG{QUIT} = 'IGNORE';
5780 local $SIG{TERM} = 'IGNORE';
5781 local $SIG{TSTP} = 'IGNORE';
5782 local $SIG{PIPE} = 'IGNORE';
5784 my $oldAutoCommit = $FS::UID::AutoCommit;
5785 local $FS::UID::AutoCommit = 0;
5789 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5790 # return "Customer not found: $custnum" unless $cust_main;
5792 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5795 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5798 my $change = scalar(@old_cust_pkg) != 0;
5801 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5803 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5804 " to pkgpart ". $pkgparts->[0]. "\n"
5807 my $err_or_cust_pkg =
5808 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5809 'refnum' => $refnum,
5812 unless (ref($err_or_cust_pkg)) {
5813 $dbh->rollback if $oldAutoCommit;
5814 return $err_or_cust_pkg;
5817 push @$return_cust_pkg, $err_or_cust_pkg;
5818 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5823 # Create the new packages.
5824 foreach my $pkgpart (@$pkgparts) {
5826 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5828 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5829 pkgpart => $pkgpart,
5833 $error = $cust_pkg->insert( 'change' => $change );
5834 push @$return_cust_pkg, $cust_pkg;
5836 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5837 my $supp_pkg = FS::cust_pkg->new({
5838 custnum => $custnum,
5839 pkgpart => $link->dst_pkgpart,
5841 main_pkgnum => $cust_pkg->pkgnum,
5844 $error ||= $supp_pkg->insert( 'change' => $change );
5845 push @$return_cust_pkg, $supp_pkg;
5849 $dbh->rollback if $oldAutoCommit;
5854 # $return_cust_pkg now contains refs to all of the newly
5857 # Transfer services and cancel old packages.
5858 foreach my $old_pkg (@old_cust_pkg) {
5860 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5863 foreach my $new_pkg (@$return_cust_pkg) {
5864 $error = $old_pkg->transfer($new_pkg);
5865 if ($error and $error == 0) {
5866 # $old_pkg->transfer failed.
5867 $dbh->rollback if $oldAutoCommit;
5872 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5873 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5874 foreach my $new_pkg (@$return_cust_pkg) {
5875 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5876 if ($error and $error == 0) {
5877 # $old_pkg->transfer failed.
5878 $dbh->rollback if $oldAutoCommit;
5885 # Transfers were successful, but we went through all of the
5886 # new packages and still had services left on the old package.
5887 # We can't cancel the package under the circumstances, so abort.
5888 $dbh->rollback if $oldAutoCommit;
5889 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5891 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5897 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5901 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5903 A bulk change method to change packages for multiple customers.
5905 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5906 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5909 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5910 replace. The services (see L<FS::cust_svc>) are moved to the
5911 new billing items. An error is returned if this is not possible (see
5914 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5915 newly-created cust_pkg objects.
5920 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5922 # Transactionize this whole mess
5923 local $SIG{HUP} = 'IGNORE';
5924 local $SIG{INT} = 'IGNORE';
5925 local $SIG{QUIT} = 'IGNORE';
5926 local $SIG{TERM} = 'IGNORE';
5927 local $SIG{TSTP} = 'IGNORE';
5928 local $SIG{PIPE} = 'IGNORE';
5930 my $oldAutoCommit = $FS::UID::AutoCommit;
5931 local $FS::UID::AutoCommit = 0;
5935 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5938 while(scalar(@old_cust_pkg)) {
5940 my $custnum = $old_cust_pkg[0]->custnum;
5941 my (@remove) = map { $_->pkgnum }
5942 grep { $_->custnum == $custnum } @old_cust_pkg;
5943 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5945 my $error = order $custnum, $pkgparts, \@remove, \@return;
5947 push @errors, $error
5949 push @$return_cust_pkg, @return;
5952 if (scalar(@errors)) {
5953 $dbh->rollback if $oldAutoCommit;
5954 return join(' / ', @errors);
5957 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5961 =item forward_emails
5963 Returns a hash of svcnums and corresponding email addresses
5964 for svc_acct services that can be used as source or dest
5965 for svc_forward services provisioned in this package.
5967 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5968 service; if included, will ensure the current values of the
5969 specified service are included in the list, even if for some
5970 other reason they wouldn't be. If called as a class method
5971 with a specified service, returns only these current values.
5973 Caution: does not actually check if svc_forward services are
5974 available to be provisioned on this package.
5978 sub forward_emails {
5982 #load optional service, thoroughly validated
5983 die "Use svcnum or svc_forward, not both"
5984 if $opt{'svcnum'} && $opt{'svc_forward'};
5985 my $svc_forward = $opt{'svc_forward'};
5986 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5988 die "Specified service is not a forward service"
5989 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5990 die "Specified service not found"
5991 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5995 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5996 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5998 #add current values from specified service, if there was one
6000 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
6001 my $svc_acct = $svc_forward->$method();
6002 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
6006 if (ref($self) eq 'FS::cust_pkg') {
6008 #and including the rest for this customer
6009 my($u_part_svc,@u_acct_svcparts);
6010 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
6011 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
6014 my $custnum = $self->getfield('custnum');
6015 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
6016 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
6017 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
6018 foreach my $acct_svcpart (@u_acct_svcparts) {
6019 foreach my $i_cust_svc (
6020 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
6021 'svcpart' => $acct_svcpart } )
6023 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
6024 $email{$svc_acct->svcnum} = $svc_acct->email;
6033 # Used by FS::Upgrade to migrate to a new database.
6034 sub _upgrade_data { # class method
6035 my ($class, %opts) = @_;
6036 $class->_upgrade_otaker(%opts);
6038 # RT#10139, bug resulting in contract_end being set when it shouldn't
6039 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
6040 # RT#10830, bad calculation of prorate date near end of year
6041 # the date range for bill is December 2009, and we move it forward
6042 # one year if it's before the previous bill date (which it should
6044 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
6045 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
6046 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
6047 # RT6628, add order_date to cust_pkg
6048 'update cust_pkg set order_date = (select history_date from h_cust_pkg
6049 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
6050 history_action = \'insert\') where order_date is null',
6052 foreach my $sql (@statements) {
6053 my $sth = dbh->prepare($sql);
6054 $sth->execute or die $sth->errstr;
6057 # RT31194: supplemental package links that are deleted don't clean up
6059 my @pkglinknums = qsearch({
6060 'select' => 'DISTINCT cust_pkg.pkglinknum',
6061 'table' => 'cust_pkg',
6062 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
6063 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
6064 AND part_pkg_link.pkglinknum IS NULL',
6066 foreach (@pkglinknums) {
6067 my $pkglinknum = $_->pkglinknum;
6068 warn "cleaning part_pkg_link #$pkglinknum\n";
6069 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
6070 my $error = $part_pkg_link->remove_linked;
6071 die $error if $error;
6079 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
6081 In sub order, the @pkgparts array (passed by reference) is clobbered.
6083 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
6084 method to pass dates to the recur_prog expression, it should do so.
6086 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
6087 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
6088 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
6089 configuration values. Probably need a subroutine which decides what to do
6090 based on whether or not we've fetched the user yet, rather than a hash. See
6091 FS::UID and the TODO.
6093 Now that things are transactional should the check in the insert method be
6098 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
6099 L<FS::pkg_svc>, schema.html from the base documentation