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";
1095 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1096 locationnum, (other fields?). Attempts to re-provision cancelled services
1097 using history information (errors at this stage are not fatal).
1099 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1101 svc_fatal: service provisioning errors are fatal
1103 svc_errors: pass an array reference, will be filled in with any provisioning errors
1105 main_pkgnum: link the package as a supplemental package of this one. For
1111 my( $self, %options ) = @_;
1113 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1114 return '' unless $self->get('cancel');
1116 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1117 return $self->main_pkg->uncancel(%options);
1124 local $SIG{HUP} = 'IGNORE';
1125 local $SIG{INT} = 'IGNORE';
1126 local $SIG{QUIT} = 'IGNORE';
1127 local $SIG{TERM} = 'IGNORE';
1128 local $SIG{TSTP} = 'IGNORE';
1129 local $SIG{PIPE} = 'IGNORE';
1131 my $oldAutoCommit = $FS::UID::AutoCommit;
1132 local $FS::UID::AutoCommit = 0;
1136 # insert the new package
1139 my $cust_pkg = new FS::cust_pkg {
1140 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1141 bill => ( $options{'bill'} || $self->get('bill') ),
1143 uncancel_pkgnum => $self->pkgnum,
1144 main_pkgnum => ($options{'main_pkgnum'} || ''),
1145 map { $_ => $self->get($_) } qw(
1146 custnum pkgpart locationnum
1148 susp adjourn resume expire start_date contract_end dundate
1149 change_date change_pkgpart change_locationnum
1150 manual_flag no_auto separate_bill quantity agent_pkgid
1151 recur_show_zero setup_show_zero
1155 my $error = $cust_pkg->insert(
1156 'change' => 1, #supresses any referral credit to a referring customer
1157 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1160 $dbh->rollback if $oldAutoCommit;
1168 #find historical services within this timeframe before the package cancel
1169 # (incompatible with "time" option to cust_pkg->cancel?)
1170 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1171 # too little? (unprovisioing export delay?)
1172 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1173 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1176 foreach my $h_cust_svc (@h_cust_svc) {
1177 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1178 #next unless $h_svc_x; #should this happen?
1179 (my $table = $h_svc_x->table) =~ s/^h_//;
1180 require "FS/$table.pm";
1181 my $class = "FS::$table";
1182 my $svc_x = $class->new( {
1183 'pkgnum' => $cust_pkg->pkgnum,
1184 'svcpart' => $h_cust_svc->svcpart,
1185 map { $_ => $h_svc_x->get($_) } fields($table)
1189 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1190 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1193 my $svc_error = $svc_x->insert;
1195 if ( $options{svc_fatal} ) {
1196 $dbh->rollback if $oldAutoCommit;
1199 # if we've failed to insert the svc_x object, svc_Common->insert
1200 # will have removed the cust_svc already. if not, then both records
1201 # were inserted but we failed for some other reason (export, most
1202 # likely). in that case, report the error and delete the records.
1203 push @svc_errors, $svc_error;
1204 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1206 # except if export_insert failed, export_delete probably won't be
1208 local $FS::svc_Common::noexport_hack = 1;
1209 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1210 if ( $cleanup_error ) { # and if THAT fails, then run away
1211 $dbh->rollback if $oldAutoCommit;
1212 return $cleanup_error;
1217 } #foreach $h_cust_svc
1219 #these are pretty rare, but should handle them
1220 # - dsl_device (mac addresses)
1221 # - phone_device (mac addresses)
1222 # - dsl_note (ikano notes)
1223 # - domain_record (i.e. restore DNS information w/domains)
1224 # - inventory_item(?) (inventory w/un-cancelling service?)
1225 # - nas (svc_broaband nas stuff)
1226 #this stuff is unused in the wild afaik
1227 # - mailinglistmember
1229 # - svc_domain.parent_svcnum?
1230 # - acct_snarf (ancient mail fetching config)
1231 # - cgp_rule (communigate)
1232 # - cust_svc_option (used by our Tron stuff)
1233 # - acct_rt_transaction (used by our time worked stuff)
1236 # also move over any services that didn't unprovision at cancellation
1239 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1240 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1241 my $error = $cust_svc->replace;
1243 $dbh->rollback if $oldAutoCommit;
1249 # Uncancel any supplemental packages, and make them supplemental to the
1253 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1255 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1257 $dbh->rollback if $oldAutoCommit;
1258 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1266 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1268 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1269 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1276 Cancels any pending expiration (sets the expire field to null)
1277 for this package and any supplemental packages.
1279 If there is an error, returns the error, otherwise returns false.
1287 local $SIG{HUP} = 'IGNORE';
1288 local $SIG{INT} = 'IGNORE';
1289 local $SIG{QUIT} = 'IGNORE';
1290 local $SIG{TERM} = 'IGNORE';
1291 local $SIG{TSTP} = 'IGNORE';
1292 local $SIG{PIPE} = 'IGNORE';
1294 my $oldAutoCommit = $FS::UID::AutoCommit;
1295 local $FS::UID::AutoCommit = 0;
1298 my $old = $self->select_for_update;
1300 my $pkgnum = $old->pkgnum;
1301 if ( $old->get('cancel') || $self->get('cancel') ) {
1302 dbh->rollback if $oldAutoCommit;
1303 return "Can't unexpire cancelled package $pkgnum";
1304 # or at least it's pointless
1307 unless ( $old->get('expire') && $self->get('expire') ) {
1308 dbh->rollback if $oldAutoCommit;
1309 return ""; # no error
1312 my %hash = $self->hash;
1313 $hash{'expire'} = '';
1314 my $new = new FS::cust_pkg ( \%hash );
1315 $error = $new->replace( $self, options => { $self->options } );
1317 $dbh->rollback if $oldAutoCommit;
1321 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1322 $error = $supp_pkg->unexpire;
1324 $dbh->rollback if $oldAutoCommit;
1325 return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1329 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1335 =item suspend [ OPTION => VALUE ... ]
1337 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1338 package, then suspends the package itself (sets the susp field to now).
1340 Available options are:
1344 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1345 either a reasonnum of an existing reason, or passing a hashref will create
1346 a new reason. The hashref should have the following keys:
1347 - typenum - Reason type (see L<FS::reason_type>
1348 - reason - Text of the new reason.
1350 =item date - can be set to a unix style timestamp to specify when to
1353 =item time - can be set to override the current time, for calculation
1354 of final invoices or unused-time credits
1356 =item resume_date - can be set to a time when the package should be
1357 unsuspended. This may be more convenient than calling C<unsuspend()>
1360 =item from_main - allows a supplemental package to be suspended, rather
1361 than redirecting the method call to its main package. For internal use.
1363 =item from_cancel - used when suspending from the cancel method, forces
1364 this to skip everything besides basic suspension. For internal use.
1368 If there is an error, returns the error, otherwise returns false.
1373 my( $self, %options ) = @_;
1376 # pass all suspend/cancel actions to the main package
1377 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1378 return $self->main_pkg->suspend(%options);
1381 local $SIG{HUP} = 'IGNORE';
1382 local $SIG{INT} = 'IGNORE';
1383 local $SIG{QUIT} = 'IGNORE';
1384 local $SIG{TERM} = 'IGNORE';
1385 local $SIG{TSTP} = 'IGNORE';
1386 local $SIG{PIPE} = 'IGNORE';
1388 my $oldAutoCommit = $FS::UID::AutoCommit;
1389 local $FS::UID::AutoCommit = 0;
1392 my $old = $self->select_for_update;
1394 my $pkgnum = $old->pkgnum;
1395 if ( $old->get('cancel') || $self->get('cancel') ) {
1396 dbh->rollback if $oldAutoCommit;
1397 return "Can't suspend cancelled package $pkgnum";
1400 if ( $old->get('susp') || $self->get('susp') ) {
1401 dbh->rollback if $oldAutoCommit;
1402 return ""; # no error # complain on adjourn?
1405 my $suspend_time = $options{'time'} || time;
1406 my $date = $options{date} if $options{date}; # adjourn/suspend later
1407 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1409 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1410 dbh->rollback if $oldAutoCommit;
1411 return "Package $pkgnum expires before it would be suspended.";
1414 # some false laziness with sub cancel
1415 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1416 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1417 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1418 # make the entire cust_main->bill path recognize 'suspend' and
1419 # 'cancel' separately.
1420 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1421 my $copy = $self->new({$self->hash});
1423 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1425 'time' => $suspend_time );
1426 warn "Error billing during suspend, custnum ".
1427 #$self->cust_main->custnum. ": $error"
1432 my $cust_pkg_reason;
1433 if ( $options{'reason'} ) {
1434 $error = $self->insert_reason( 'reason' => $options{'reason'},
1435 'action' => $date ? 'adjourn' : 'suspend',
1436 'date' => $date ? $date : $suspend_time,
1437 'reason_otaker' => $options{'reason_otaker'},
1440 dbh->rollback if $oldAutoCommit;
1441 return "Error inserting cust_pkg_reason: $error";
1443 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1444 'date' => $date ? $date : $suspend_time,
1445 'action' => $date ? 'A' : 'S',
1446 'pkgnum' => $self->pkgnum,
1450 # if a reasonnum was passed, get the actual reason object so we can check
1452 # (passing a reason hashref is still allowed, but it can't be used with
1453 # the fancy behavioral options.)
1456 if ($options{'reason'} =~ /^\d+$/) {
1457 $reason = FS::reason->by_key($options{'reason'});
1460 my %hash = $self->hash;
1462 $hash{'adjourn'} = $date;
1464 $hash{'susp'} = $suspend_time;
1467 my $resume_date = $options{'resume_date'} || 0;
1468 if ( $resume_date > ($date || $suspend_time) ) {
1469 $hash{'resume'} = $resume_date;
1472 $options{options} ||= {};
1474 my $new = new FS::cust_pkg ( \%hash );
1475 $error = $new->replace( $self, options => { $self->options,
1476 %{ $options{options} },
1480 $dbh->rollback if $oldAutoCommit;
1484 unless ( $date ) { # then we are suspending now
1486 unless ($options{'from_cancel'}) {
1487 # credit remaining time if appropriate
1488 # (if required by the package def, or the suspend reason)
1489 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1490 || ( defined($reason) && $reason->unused_credit );
1492 if ( $unused_credit ) {
1493 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1494 my $error = $self->credit_remaining('suspend', $suspend_time);
1496 $dbh->rollback if $oldAutoCommit;
1504 foreach my $cust_svc (
1505 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1507 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1509 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1510 $dbh->rollback if $oldAutoCommit;
1511 return "Illegal svcdb value in part_svc!";
1514 require "FS/$svcdb.pm";
1516 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1518 $error = $svc->suspend;
1520 $dbh->rollback if $oldAutoCommit;
1523 my( $label, $value ) = $cust_svc->label;
1524 push @labels, "$label: $value";
1528 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1529 # and this is not a suspend-before-cancel
1530 if ( $cust_pkg_reason ) {
1531 my $reason_obj = $cust_pkg_reason->reason;
1532 if ( $reason_obj->feepart and
1533 ! $reason_obj->fee_on_unsuspend and
1534 ! $options{'from_cancel'} ) {
1536 # register the need to charge a fee, cust_main->bill will do the rest
1537 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1539 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1540 'pkgreasonnum' => $cust_pkg_reason->num,
1541 'pkgnum' => $self->pkgnum,
1542 'feepart' => $reason->feepart,
1543 'nextbill' => $reason->fee_hold,
1545 $error ||= $cust_pkg_reason_fee->insert;
1549 my $conf = new FS::Conf;
1550 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1552 my $error = send_email(
1553 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1554 #invoice_from ??? well as good as any
1555 'to' => $conf->config('suspend_email_admin'),
1556 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1558 "This is an automatic message from your Freeside installation\n",
1559 "informing you that the following customer package has been suspended:\n",
1561 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1562 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1563 ( map { "Service : $_\n" } @labels ),
1565 'custnum' => $self->custnum,
1566 'msgtype' => 'admin'
1570 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1578 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1579 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1581 $dbh->rollback if $oldAutoCommit;
1582 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1586 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1591 =item credit_remaining MODE TIME
1593 Generate a credit for this package for the time remaining in the current
1594 billing period. MODE is either "suspend" or "cancel" (determines the
1595 credit type). TIME is the time of suspension/cancellation. Both arguments
1600 # Implementation note:
1602 # If you pkgpart-change a package that has been billed, and it's set to give
1603 # credit on package change, then this method gets called and then the new
1604 # package will have no last_bill date. Therefore the customer will be credited
1605 # only once (per billing period) even if there are multiple package changes.
1607 # If you location-change a package that has been billed, this method will NOT
1608 # be called and the new package WILL have the last bill date of the old
1611 # If the new package is then canceled within the same billing cycle,
1612 # credit_remaining needs to run calc_remain on the OLD package to determine
1613 # the amount of unused time to credit.
1615 sub credit_remaining {
1616 # Add a credit for remaining service
1617 my ($self, $mode, $time) = @_;
1618 die 'credit_remaining requires suspend or cancel'
1619 unless $mode eq 'suspend' or $mode eq 'cancel';
1620 die 'no suspend/cancel time' unless $time > 0;
1622 my $conf = FS::Conf->new;
1623 my $reason_type = $conf->config($mode.'_credit_type');
1625 my $last_bill = $self->getfield('last_bill') || 0;
1626 my $next_bill = $self->getfield('bill') || 0;
1627 if ( $last_bill > 0 # the package has been billed
1628 and $next_bill > 0 # the package has a next bill date
1629 and $next_bill >= $time # which is in the future
1631 my $remaining_value = 0;
1633 my $remain_pkg = $self;
1634 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1636 # we may have to walk back past some package changes to get to the
1637 # one that actually has unused time
1638 while ( $remaining_value == 0 ) {
1639 if ( $remain_pkg->change_pkgnum ) {
1640 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1642 # the package has really never been billed
1645 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1648 if ( $remaining_value > 0 ) {
1649 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1651 my $error = $self->cust_main->credit(
1653 'Credit for unused time on '. $self->part_pkg->pkg,
1654 'reason_type' => $reason_type,
1656 return "Error crediting customer \$$remaining_value for unused time".
1657 " on ". $self->part_pkg->pkg. ": $error"
1659 } #if $remaining_value
1660 } #if $last_bill, etc.
1664 =item unsuspend [ OPTION => VALUE ... ]
1666 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1667 package, then unsuspends the package itself (clears the susp field and the
1668 adjourn field if it is in the past). If the suspend reason includes an
1669 unsuspension package, that package will be ordered.
1671 Available options are:
1677 Can be set to a date to unsuspend the package in the future (the 'resume'
1680 =item adjust_next_bill
1682 Can be set true to adjust the next bill date forward by
1683 the amount of time the account was inactive. This was set true by default
1684 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1685 explicitly requested with this option or in the price plan.
1689 If there is an error, returns the error, otherwise returns false.
1694 my( $self, %opt ) = @_;
1697 # pass all suspend/cancel actions to the main package
1698 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1699 return $self->main_pkg->unsuspend(%opt);
1702 local $SIG{HUP} = 'IGNORE';
1703 local $SIG{INT} = 'IGNORE';
1704 local $SIG{QUIT} = 'IGNORE';
1705 local $SIG{TERM} = 'IGNORE';
1706 local $SIG{TSTP} = 'IGNORE';
1707 local $SIG{PIPE} = 'IGNORE';
1709 my $oldAutoCommit = $FS::UID::AutoCommit;
1710 local $FS::UID::AutoCommit = 0;
1713 my $old = $self->select_for_update;
1715 my $pkgnum = $old->pkgnum;
1716 if ( $old->get('cancel') || $self->get('cancel') ) {
1717 $dbh->rollback if $oldAutoCommit;
1718 return "Can't unsuspend cancelled package $pkgnum";
1721 unless ( $old->get('susp') && $self->get('susp') ) {
1722 $dbh->rollback if $oldAutoCommit;
1723 return ""; # no error # complain instead?
1726 # handle the case of setting a future unsuspend (resume) date
1727 # and do not continue to actually unsuspend the package
1728 my $date = $opt{'date'};
1729 if ( $date and $date > time ) { # return an error if $date <= time?
1731 if ( $old->get('expire') && $old->get('expire') < $date ) {
1732 $dbh->rollback if $oldAutoCommit;
1733 return "Package $pkgnum expires before it would be unsuspended.";
1736 my $new = new FS::cust_pkg { $self->hash };
1737 $new->set('resume', $date);
1738 $error = $new->replace($self, options => $self->options);
1741 $dbh->rollback if $oldAutoCommit;
1745 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1751 if (!$self->setup) {
1752 # then this package is being released from on-hold status
1753 $self->set_initial_timers;
1758 foreach my $cust_svc (
1759 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1761 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1763 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1764 $dbh->rollback if $oldAutoCommit;
1765 return "Illegal svcdb value in part_svc!";
1768 require "FS/$svcdb.pm";
1770 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1772 $error = $svc->unsuspend;
1774 $dbh->rollback if $oldAutoCommit;
1777 my( $label, $value ) = $cust_svc->label;
1778 push @labels, "$label: $value";
1783 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1784 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1786 my %hash = $self->hash;
1787 my $inactive = time - $hash{'susp'};
1789 my $conf = new FS::Conf;
1791 # increment next bill date if certain conditions are met:
1792 # - it was due to be billed at some point
1793 # - either the global or local config says to do this
1794 my $adjust_bill = 0;
1797 && ( $hash{'bill'} || $hash{'setup'} )
1798 && ( $opt{'adjust_next_bill'}
1799 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1800 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1807 # - the package billed during suspension
1808 # - or it was ordered on hold
1809 # - or the customer was credited for the unused time
1811 if ( $self->option('suspend_bill',1)
1812 or ( $self->part_pkg->option('suspend_bill',1)
1813 and ! $self->option('no_suspend_bill',1)
1815 or $hash{'order_date'} == $hash{'susp'}
1820 if ( $adjust_bill ) {
1821 if ( $self->part_pkg->option('unused_credit_suspend')
1822 or ( $reason and $reason->unused_credit ) ) {
1823 # then the customer was credited for the unused time before suspending,
1824 # so their next bill should be immediate.
1825 $hash{'bill'} = time;
1827 # add the length of time suspended to the bill date
1828 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1833 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1834 $hash{'resume'} = '' if !$hash{'adjourn'};
1835 my $new = new FS::cust_pkg ( \%hash );
1836 $error = $new->replace( $self, options => { $self->options } );
1838 $dbh->rollback if $oldAutoCommit;
1845 if ( $reason->unsuspend_pkgpart ) {
1846 #warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n"; # in 4.x
1847 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1848 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1850 my $start_date = $self->cust_main->next_bill_date
1851 if $reason->unsuspend_hold;
1854 $unsusp_pkg = FS::cust_pkg->new({
1855 'custnum' => $self->custnum,
1856 'pkgpart' => $reason->unsuspend_pkgpart,
1857 'start_date' => $start_date,
1858 'locationnum' => $self->locationnum,
1859 # discount? probably not...
1862 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1865 # new way, using fees
1866 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1867 # register the need to charge a fee, cust_main->bill will do the rest
1868 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1870 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1871 'pkgreasonnum' => $cust_pkg_reason->num,
1872 'pkgnum' => $self->pkgnum,
1873 'feepart' => $reason->feepart,
1874 'nextbill' => $reason->fee_hold,
1876 $error ||= $cust_pkg_reason_fee->insert;
1880 $dbh->rollback if $oldAutoCommit;
1885 if ( $conf->config('unsuspend_email_admin') ) {
1887 my $error = send_email(
1888 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1889 #invoice_from ??? well as good as any
1890 'to' => $conf->config('unsuspend_email_admin'),
1891 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1892 "This is an automatic message from your Freeside installation\n",
1893 "informing you that the following customer package has been unsuspended:\n",
1895 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1896 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1897 ( map { "Service : $_\n" } @labels ),
1899 "An unsuspension fee was charged: ".
1900 $unsusp_pkg->part_pkg->pkg_comment."\n"
1904 'custnum' => $self->custnum,
1905 'msgtype' => 'admin',
1909 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1915 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1916 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1918 $dbh->rollback if $oldAutoCommit;
1919 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1923 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1930 Cancels any pending suspension (sets the adjourn field to null)
1931 for this package and any supplemental packages.
1933 If there is an error, returns the error, otherwise returns false.
1941 local $SIG{HUP} = 'IGNORE';
1942 local $SIG{INT} = 'IGNORE';
1943 local $SIG{QUIT} = 'IGNORE';
1944 local $SIG{TERM} = 'IGNORE';
1945 local $SIG{TSTP} = 'IGNORE';
1946 local $SIG{PIPE} = 'IGNORE';
1948 my $oldAutoCommit = $FS::UID::AutoCommit;
1949 local $FS::UID::AutoCommit = 0;
1952 my $old = $self->select_for_update;
1954 my $pkgnum = $old->pkgnum;
1955 if ( $old->get('cancel') || $self->get('cancel') ) {
1956 dbh->rollback if $oldAutoCommit;
1957 return "Can't unadjourn cancelled package $pkgnum";
1958 # or at least it's pointless
1961 if ( $old->get('susp') || $self->get('susp') ) {
1962 dbh->rollback if $oldAutoCommit;
1963 return "Can't unadjourn suspended package $pkgnum";
1964 # perhaps this is arbitrary
1967 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1968 dbh->rollback if $oldAutoCommit;
1969 return ""; # no error
1972 my %hash = $self->hash;
1973 $hash{'adjourn'} = '';
1974 $hash{'resume'} = '';
1975 my $new = new FS::cust_pkg ( \%hash );
1976 $error = $new->replace( $self, options => { $self->options } );
1978 $dbh->rollback if $oldAutoCommit;
1982 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1983 $error = $supp_pkg->unadjourn;
1985 $dbh->rollback if $oldAutoCommit;
1986 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
1990 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1997 =item change HASHREF | OPTION => VALUE ...
1999 Changes this package: cancels it and creates a new one, with a different
2000 pkgpart or locationnum or both. All services are transferred to the new
2001 package (no change will be made if this is not possible).
2003 Options may be passed as a list of key/value pairs or as a hash reference.
2010 New locationnum, to change the location for this package.
2014 New FS::cust_location object, to create a new location and assign it
2019 New FS::cust_main object, to create a new customer and assign the new package
2024 New pkgpart (see L<FS::part_pkg>).
2028 New refnum (see L<FS::part_referral>).
2032 New quantity; if unspecified, the new package will have the same quantity
2037 "New" (existing) FS::cust_pkg object. The package's services and other
2038 attributes will be transferred to this package.
2042 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2043 susp, adjourn, cancel, expire, and contract_end) to the new package.
2045 =item unprotect_svcs
2047 Normally, change() will rollback and return an error if some services
2048 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2049 If unprotect_svcs is true, this method will transfer as many services as
2050 it can and then unconditionally cancel the old package.
2054 If specified, sets this value for the contract_end date on the new package
2055 (without regard for keep_dates or the usual date-preservation behavior.)
2056 Will throw an error if defined but false; the UI doesn't allow editing
2057 this unless it already exists, making removal impossible to undo.
2061 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2062 cust_pkg must be specified (otherwise, what's the point?)
2064 Returns either the new FS::cust_pkg object or a scalar error.
2068 my $err_or_new_cust_pkg = $old_cust_pkg->change
2072 #used by change and change_later
2073 #didn't put with documented check methods because it depends on change-specific opts
2074 #and it also possibly edits the value of opts
2078 if ( defined($opt->{'contract_end'}) ) {
2079 my $current_contract_end = $self->get('contract_end');
2080 unless ($opt->{'contract_end'}) {
2081 if ($current_contract_end) {
2082 return "Cannot remove contract end date when changing packages";
2084 #shouldn't even pass this option if there's not a current value
2085 #but can be handled gracefully if the option is empty
2086 warn "Contract end date passed unexpectedly";
2087 delete $opt->{'contract_end'};
2091 unless ($current_contract_end) {
2092 #option shouldn't be passed, throw error if it's non-empty
2093 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2099 #some false laziness w/order
2102 my $opt = ref($_[0]) ? shift : { @_ };
2104 my $conf = new FS::Conf;
2106 # handle contract_end on cust_pkg same as passed option
2107 if ( $opt->{'cust_pkg'} ) {
2108 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2109 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2112 # check contract_end, prevent adding/removing
2113 my $error = $self->_check_change($opt);
2114 return $error if $error;
2116 # Transactionize this whole mess
2117 local $SIG{HUP} = 'IGNORE';
2118 local $SIG{INT} = 'IGNORE';
2119 local $SIG{QUIT} = 'IGNORE';
2120 local $SIG{TERM} = 'IGNORE';
2121 local $SIG{TSTP} = 'IGNORE';
2122 local $SIG{PIPE} = 'IGNORE';
2124 my $oldAutoCommit = $FS::UID::AutoCommit;
2125 local $FS::UID::AutoCommit = 0;
2128 if ( $opt->{'cust_location'} ) {
2129 $error = $opt->{'cust_location'}->find_or_insert;
2131 $dbh->rollback if $oldAutoCommit;
2132 return "creating location record: $error";
2134 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2137 # Before going any further here: if the package is still in the pre-setup
2138 # state, it's safe to modify it in place. No need to charge/credit for
2139 # partial period, transfer services, transfer usage pools, copy invoice
2140 # details, or change any dates.
2141 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2142 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2143 if ( length($opt->{$_}) ) {
2144 $self->set($_, $opt->{$_});
2147 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2149 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2150 $self->set_initial_timers;
2152 # but if contract_end was explicitly specified, that overrides all else
2153 $self->set('contract_end', $opt->{'contract_end'})
2154 if $opt->{'contract_end'};
2155 $error = $self->replace;
2157 $dbh->rollback if $oldAutoCommit;
2158 return "modifying package: $error";
2160 $dbh->commit if $oldAutoCommit;
2169 $hash{'setup'} = $time if $self->get('setup');
2171 $hash{'change_date'} = $time;
2172 $hash{"change_$_"} = $self->$_()
2173 foreach qw( pkgnum pkgpart locationnum );
2175 if ( $opt->{'cust_pkg'} ) {
2176 # treat changing to a package with a different pkgpart as a
2177 # pkgpart change (because it is)
2178 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2181 # whether to override pkgpart checking on the new package
2182 my $same_pkgpart = 1;
2183 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2187 my $unused_credit = 0;
2188 my $keep_dates = $opt->{'keep_dates'};
2190 # Special case. If the pkgpart is changing, and the customer is going to be
2191 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2192 # and DO pass the flag to cancel() to credit the customer. If the old
2193 # package had a setup date, set the new package's setup to the package
2194 # change date so that it has the same status as before.
2195 if ( $opt->{'pkgpart'}
2196 and $opt->{'pkgpart'} != $self->pkgpart
2197 and $self->part_pkg->option('unused_credit_change', 1) ) {
2200 $hash{'last_bill'} = '';
2204 if ( $keep_dates ) {
2205 foreach my $date ( qw(setup bill last_bill) ) {
2206 $hash{$date} = $self->getfield($date);
2209 # always keep the following dates
2210 foreach my $date (qw(order_date susp adjourn cancel expire resume
2211 start_date contract_end)) {
2212 $hash{$date} = $self->getfield($date);
2214 # but if contract_end was explicitly specified, that overrides all else
2215 $hash{'contract_end'} = $opt->{'contract_end'}
2216 if $opt->{'contract_end'};
2218 # allow $opt->{'locationnum'} = '' to specifically set it to null
2219 # (i.e. customer default location)
2220 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2222 # usually this doesn't matter. the two cases where it does are:
2223 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2225 # 2. (more importantly) changing a package before it's billed
2226 $hash{'waive_setup'} = $self->waive_setup;
2228 # if this package is scheduled for a future package change, preserve that
2229 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2231 my $custnum = $self->custnum;
2232 if ( $opt->{cust_main} ) {
2233 my $cust_main = $opt->{cust_main};
2234 unless ( $cust_main->custnum ) {
2235 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2237 $dbh->rollback if $oldAutoCommit;
2238 return "inserting customer record: $error";
2241 $custnum = $cust_main->custnum;
2244 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2247 if ( $opt->{'cust_pkg'} ) {
2248 # The target package already exists; update it to show that it was
2249 # changed from this package.
2250 $cust_pkg = $opt->{'cust_pkg'};
2252 # follow all the above rules for date changes, etc.
2253 foreach (keys %hash) {
2254 $cust_pkg->set($_, $hash{$_});
2256 # except those that implement the future package change behavior
2257 foreach (qw(change_to_pkgnum start_date expire)) {
2258 $cust_pkg->set($_, '');
2261 $error = $cust_pkg->replace;
2264 # Create the new package.
2265 $cust_pkg = new FS::cust_pkg {
2266 custnum => $custnum,
2267 locationnum => $opt->{'locationnum'},
2268 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2269 qw( pkgpart quantity refnum salesnum )
2273 $error = $cust_pkg->insert( 'change' => 1,
2274 'allow_pkgpart' => $same_pkgpart );
2277 $dbh->rollback if $oldAutoCommit;
2278 return "inserting new package: $error";
2281 # Transfer services and cancel old package.
2282 # Enforce service limits only if this is a pkgpart change.
2283 local $FS::cust_svc::ignore_quantity;
2284 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2285 $error = $self->transfer($cust_pkg);
2286 if ($error and $error == 0) {
2287 # $old_pkg->transfer failed.
2288 $dbh->rollback if $oldAutoCommit;
2289 return "transferring $error";
2292 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2293 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2294 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2295 if ($error and $error == 0) {
2296 # $old_pkg->transfer failed.
2297 $dbh->rollback if $oldAutoCommit;
2298 return "converting $error";
2302 # We set unprotect_svcs when executing a "future package change". It's
2303 # not a user-interactive operation, so returning an error means the
2304 # package change will just fail. Rather than have that happen, we'll
2305 # let leftover services be deleted.
2306 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2307 # Transfers were successful, but we still had services left on the old
2308 # package. We can't change the package under this circumstances, so abort.
2309 $dbh->rollback if $oldAutoCommit;
2310 return "unable to transfer all services";
2313 #reset usage if changing pkgpart
2314 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2315 if ($self->pkgpart != $cust_pkg->pkgpart) {
2316 my $part_pkg = $cust_pkg->part_pkg;
2317 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2321 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2324 $dbh->rollback if $oldAutoCommit;
2325 return "setting usage values: $error";
2328 # if NOT changing pkgpart, transfer any usage pools over
2329 foreach my $usage ($self->cust_pkg_usage) {
2330 $usage->set('pkgnum', $cust_pkg->pkgnum);
2331 $error = $usage->replace;
2333 $dbh->rollback if $oldAutoCommit;
2334 return "transferring usage pools: $error";
2339 # transfer discounts, if we're not changing pkgpart
2340 if ( $same_pkgpart ) {
2341 foreach my $old_discount ($self->cust_pkg_discount_active) {
2342 # don't remove the old discount, we may still need to bill that package.
2343 my $new_discount = new FS::cust_pkg_discount {
2344 'pkgnum' => $cust_pkg->pkgnum,
2345 'discountnum' => $old_discount->discountnum,
2346 'months_used' => $old_discount->months_used,
2348 $error = $new_discount->insert;
2350 $dbh->rollback if $oldAutoCommit;
2351 return "transferring discounts: $error";
2356 # transfer (copy) invoice details
2357 foreach my $detail ($self->cust_pkg_detail) {
2358 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2359 $new_detail->set('pkgdetailnum', '');
2360 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2361 $error = $new_detail->insert;
2363 $dbh->rollback if $oldAutoCommit;
2364 return "transferring package notes: $error";
2368 # transfer scheduled expire/adjourn reasons
2369 foreach my $action ('expire', 'adjourn') {
2370 if ( $cust_pkg->get($action) ) {
2371 my $reason = $self->last_cust_pkg_reason($action);
2373 $reason->set('pkgnum', $cust_pkg->pkgnum);
2374 $error = $reason->replace;
2376 $dbh->rollback if $oldAutoCommit;
2377 return "transferring $action reason: $error";
2385 if ( !$opt->{'cust_pkg'} ) {
2386 # Order any supplemental packages.
2387 my $part_pkg = $cust_pkg->part_pkg;
2388 my @old_supp_pkgs = $self->supplemental_pkgs;
2389 foreach my $link ($part_pkg->supp_part_pkg_link) {
2391 foreach (@old_supp_pkgs) {
2392 if ($_->pkgpart == $link->dst_pkgpart) {
2394 $_->pkgpart(0); # so that it can't match more than once
2398 # false laziness with FS::cust_main::Packages::order_pkg
2399 my $new = FS::cust_pkg->new({
2400 pkgpart => $link->dst_pkgpart,
2401 pkglinknum => $link->pkglinknum,
2402 custnum => $custnum,
2403 main_pkgnum => $cust_pkg->pkgnum,
2404 locationnum => $cust_pkg->locationnum,
2405 start_date => $cust_pkg->start_date,
2406 order_date => $cust_pkg->order_date,
2407 expire => $cust_pkg->expire,
2408 adjourn => $cust_pkg->adjourn,
2409 contract_end => $cust_pkg->contract_end,
2410 refnum => $cust_pkg->refnum,
2411 discountnum => $cust_pkg->discountnum,
2412 waive_setup => $cust_pkg->waive_setup,
2414 if ( $old and $opt->{'keep_dates'} ) {
2415 foreach (qw(setup bill last_bill)) {
2416 $new->set($_, $old->get($_));
2419 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2422 $error ||= $old->transfer($new);
2424 if ( $error and $error > 0 ) {
2425 # no reason why this should ever fail, but still...
2426 $error = "Unable to transfer all services from supplemental package ".
2430 $dbh->rollback if $oldAutoCommit;
2433 push @new_supp_pkgs, $new;
2435 } # if !$opt->{'cust_pkg'}
2436 # because if there is one, then supplemental packages would already
2437 # have been created for it.
2439 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2441 #Don't allow billing the package (preceding period packages and/or
2442 #outstanding usage) if we are keeping dates (i.e. location changing),
2443 #because the new package will be billed for the same date range.
2444 #Supplemental packages are also canceled here.
2446 # during scheduled changes, avoid canceling the package we just
2448 $self->set('change_to_pkgnum' => '');
2450 $error = $self->cancel(
2452 unused_credit => $unused_credit,
2453 nobill => $keep_dates,
2454 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2455 no_delay_cancel => 1,
2458 $dbh->rollback if $oldAutoCommit;
2459 return "canceling old package: $error";
2462 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2464 my $error = $cust_pkg->cust_main->bill(
2465 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2468 $dbh->rollback if $oldAutoCommit;
2469 return "billing new package: $error";
2473 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2479 =item change_later OPTION => VALUE...
2481 Schedule a package change for a later date. This actually orders the new
2482 package immediately, but sets its start date for a future date, and sets
2483 the current package to expire on the same date.
2485 If the package is already scheduled for a change, this can be called with
2486 'start_date' to change the scheduled date, or with pkgpart and/or
2487 locationnum to modify the package change. To cancel the scheduled change
2488 entirely, see C<abort_change>.
2496 The date for the package change. Required, and must be in the future.
2506 The pkgpart, locationnum, quantity and optional contract_end of the new
2507 package, with the same meaning as in C<change>.
2515 my $opt = ref($_[0]) ? shift : { @_ };
2517 # check contract_end, prevent adding/removing
2518 my $error = $self->_check_change($opt);
2519 return $error if $error;
2521 my $oldAutoCommit = $FS::UID::AutoCommit;
2522 local $FS::UID::AutoCommit = 0;
2525 my $cust_main = $self->cust_main;
2527 my $date = delete $opt->{'start_date'} or return 'start_date required';
2529 if ( $date <= time ) {
2530 $dbh->rollback if $oldAutoCommit;
2531 return "start_date $date is in the past";
2534 # If the user entered a new location, set it up now.
2535 if ( $opt->{'cust_location'} ) {
2536 $error = $opt->{'cust_location'}->find_or_insert;
2538 $dbh->rollback if $oldAutoCommit;
2539 return "creating location record: $error";
2541 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2544 if ( $self->change_to_pkgnum ) {
2545 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2546 my $new_pkgpart = $opt->{'pkgpart'}
2547 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2548 my $new_locationnum = $opt->{'locationnum'}
2549 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2550 my $new_quantity = $opt->{'quantity'}
2551 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2552 my $new_contract_end = $opt->{'contract_end'}
2553 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2554 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2555 # it hasn't been billed yet, so in principle we could just edit
2556 # it in place (w/o a package change), but that's bad form.
2557 # So change the package according to the new options...
2558 my $err_or_pkg = $change_to->change(%$opt);
2559 if ( ref $err_or_pkg ) {
2560 # Then set that package up for a future start.
2561 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2562 $self->set('expire', $date); # in case it's different
2563 $err_or_pkg->set('start_date', $date);
2564 $err_or_pkg->set('change_date', '');
2565 $err_or_pkg->set('change_pkgnum', '');
2567 $error = $self->replace ||
2568 $err_or_pkg->replace ||
2569 #because change() might've edited existing scheduled change in place
2570 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2571 $change_to->cancel('no_delay_cancel' => 1) ||
2572 $change_to->delete);
2574 $error = $err_or_pkg;
2576 } else { # change the start date only.
2577 $self->set('expire', $date);
2578 $change_to->set('start_date', $date);
2579 $error = $self->replace || $change_to->replace;
2582 $dbh->rollback if $oldAutoCommit;
2585 $dbh->commit if $oldAutoCommit;
2588 } # if $self->change_to_pkgnum
2590 my $new_pkgpart = $opt->{'pkgpart'}
2591 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2592 my $new_locationnum = $opt->{'locationnum'}
2593 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2594 my $new_quantity = $opt->{'quantity'}
2595 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2596 my $new_contract_end = $opt->{'contract_end'}
2597 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2599 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2601 # allow $opt->{'locationnum'} = '' to specifically set it to null
2602 # (i.e. customer default location)
2603 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2605 my $new = FS::cust_pkg->new( {
2606 custnum => $self->custnum,
2607 locationnum => $opt->{'locationnum'},
2608 start_date => $date,
2609 map { $_ => ( $opt->{$_} || $self->$_() ) }
2610 qw( pkgpart quantity refnum salesnum contract_end )
2612 $error = $new->insert('change' => 1,
2613 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2615 $self->set('change_to_pkgnum', $new->pkgnum);
2616 $self->set('expire', $date);
2617 $error = $self->replace;
2620 $dbh->rollback if $oldAutoCommit;
2622 $dbh->commit if $oldAutoCommit;
2630 Cancels a future package change scheduled by C<change_later>.
2636 my $pkgnum = $self->change_to_pkgnum;
2637 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2640 $error = $change_to->cancel || $change_to->delete;
2641 return $error if $error;
2643 $self->set('change_to_pkgnum', '');
2644 $self->set('expire', '');
2648 =item set_quantity QUANTITY
2650 Change the package's quantity field. This is one of the few package properties
2651 that can safely be changed without canceling and reordering the package
2652 (because it doesn't affect tax eligibility). Returns an error or an
2659 $self = $self->replace_old; # just to make sure
2660 $self->quantity(shift);
2664 =item set_salesnum SALESNUM
2666 Change the package's salesnum (sales person) field. This is one of the few
2667 package properties that can safely be changed without canceling and reordering
2668 the package (because it doesn't affect tax eligibility). Returns an error or
2675 $self = $self->replace_old; # just to make sure
2676 $self->salesnum(shift);
2678 # XXX this should probably reassign any credit that's already been given
2681 =item modify_charge OPTIONS
2683 Change the properties of a one-time charge. The following properties can
2684 be changed this way:
2685 - pkg: the package description
2686 - classnum: the package class
2687 - additional: arrayref of additional invoice details to add to this package
2689 and, I<if the charge has not yet been billed>:
2690 - start_date: the date when it will be billed
2691 - amount: the setup fee to be charged
2692 - quantity: the multiplier for the setup fee
2693 - separate_bill: whether to put the charge on a separate invoice
2695 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2696 commission credits linked to this charge, they will be recalculated.
2703 my $part_pkg = $self->part_pkg;
2704 my $pkgnum = $self->pkgnum;
2707 my $oldAutoCommit = $FS::UID::AutoCommit;
2708 local $FS::UID::AutoCommit = 0;
2710 return "Can't use modify_charge except on one-time charges"
2711 unless $part_pkg->freq eq '0';
2713 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2714 $part_pkg->set('pkg', $opt{'pkg'});
2717 my %pkg_opt = $part_pkg->options;
2718 my $pkg_opt_modified = 0;
2720 $opt{'additional'} ||= [];
2723 foreach (grep /^additional/, keys %pkg_opt) {
2724 ($i) = ($_ =~ /^additional_info(\d+)$/);
2725 $old_additional[$i] = $pkg_opt{$_} if $i;
2726 delete $pkg_opt{$_};
2729 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2730 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2731 if (!exists($old_additional[$i])
2732 or $old_additional[$i] ne $opt{'additional'}->[$i])
2734 $pkg_opt_modified = 1;
2737 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2738 $pkg_opt{'additional_count'} = $i if $i > 0;
2741 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2744 $old_classnum = $part_pkg->classnum;
2745 $part_pkg->set('classnum', $opt{'classnum'});
2748 if ( !$self->get('setup') ) {
2749 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2752 if ( exists($opt{'amount'})
2753 and $part_pkg->option('setup_fee') != $opt{'amount'}
2754 and $opt{'amount'} > 0 ) {
2756 $pkg_opt{'setup_fee'} = $opt{'amount'};
2757 $pkg_opt_modified = 1;
2760 if ( exists($opt{'setup_cost'})
2761 and $part_pkg->setup_cost != $opt{'setup_cost'}
2762 and $opt{'setup_cost'} > 0 ) {
2764 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2767 if ( exists($opt{'quantity'})
2768 and $opt{'quantity'} != $self->quantity
2769 and $opt{'quantity'} > 0 ) {
2771 $self->set('quantity', $opt{'quantity'});
2774 if ( exists($opt{'start_date'})
2775 and $opt{'start_date'} != $self->start_date ) {
2777 $self->set('start_date', $opt{'start_date'});
2780 if ( exists($opt{'separate_bill'})
2781 and $opt{'separate_bill'} ne $self->separate_bill ) {
2783 $self->set('separate_bill', $opt{'separate_bill'});
2787 } # else simply ignore them; the UI shouldn't allow editing the fields
2789 if ( exists($opt{'taxclass'})
2790 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2792 $part_pkg->set('taxclass', $opt{'taxclass'});
2796 if ( $part_pkg->modified or $pkg_opt_modified ) {
2797 # can we safely modify the package def?
2798 # Yes, if it's not available for purchase, and this is the only instance
2800 if ( $part_pkg->disabled
2801 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2802 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2804 $error = $part_pkg->replace( options => \%pkg_opt );
2807 $part_pkg = $part_pkg->clone;
2808 $part_pkg->set('disabled' => 'Y');
2809 $error = $part_pkg->insert( options => \%pkg_opt );
2810 # and associate this as yet-unbilled package to the new package def
2811 $self->set('pkgpart' => $part_pkg->pkgpart);
2814 $dbh->rollback if $oldAutoCommit;
2819 if ($self->modified) { # for quantity or start_date change, or if we had
2820 # to clone the existing package def
2821 my $error = $self->replace;
2822 return $error if $error;
2824 if (defined $old_classnum) {
2825 # fix invoice grouping records
2826 my $old_catname = $old_classnum
2827 ? FS::pkg_class->by_key($old_classnum)->categoryname
2829 my $new_catname = $opt{'classnum'}
2830 ? $part_pkg->pkg_class->categoryname
2832 if ( $old_catname ne $new_catname ) {
2833 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2834 # (there should only be one...)
2835 my @display = qsearch( 'cust_bill_pkg_display', {
2836 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2837 'section' => $old_catname,
2839 foreach (@display) {
2840 $_->set('section', $new_catname);
2841 $error = $_->replace;
2843 $dbh->rollback if $oldAutoCommit;
2847 } # foreach $cust_bill_pkg
2850 if ( $opt{'adjust_commission'} ) {
2851 # fix commission credits...tricky.
2852 foreach my $cust_event ($self->cust_event) {
2853 my $part_event = $cust_event->part_event;
2854 foreach my $table (qw(sales agent)) {
2856 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2857 my $credit = qsearchs('cust_credit', {
2858 'eventnum' => $cust_event->eventnum,
2860 if ( $part_event->isa($class) ) {
2861 # Yes, this results in current commission rates being applied
2862 # retroactively to a one-time charge. For accounting purposes
2863 # there ought to be some kind of time limit on doing this.
2864 my $amount = $part_event->_calc_credit($self);
2865 if ( $credit and $credit->amount ne $amount ) {
2866 # Void the old credit.
2867 $error = $credit->void('Package class changed');
2869 $dbh->rollback if $oldAutoCommit;
2870 return "$error (adjusting commission credit)";
2873 # redo the event action to recreate the credit.
2875 eval { $part_event->do_action( $self, $cust_event ) };
2877 $dbh->rollback if $oldAutoCommit;
2880 } # if $part_event->isa($class)
2882 } # foreach $cust_event
2883 } # if $opt{'adjust_commission'}
2884 } # if defined $old_classnum
2886 $dbh->commit if $oldAutoCommit;
2892 use Storable 'thaw';
2895 sub process_bulk_cust_pkg {
2897 my $param = thaw(decode_base64(shift));
2898 warn Dumper($param) if $DEBUG;
2900 my $old_part_pkg = qsearchs('part_pkg',
2901 { pkgpart => $param->{'old_pkgpart'} });
2902 my $new_part_pkg = qsearchs('part_pkg',
2903 { pkgpart => $param->{'new_pkgpart'} });
2904 die "Must select a new package type\n" unless $new_part_pkg;
2905 #my $keep_dates = $param->{'keep_dates'} || 0;
2906 my $keep_dates = 1; # there is no good reason to turn this off
2908 local $SIG{HUP} = 'IGNORE';
2909 local $SIG{INT} = 'IGNORE';
2910 local $SIG{QUIT} = 'IGNORE';
2911 local $SIG{TERM} = 'IGNORE';
2912 local $SIG{TSTP} = 'IGNORE';
2913 local $SIG{PIPE} = 'IGNORE';
2915 my $oldAutoCommit = $FS::UID::AutoCommit;
2916 local $FS::UID::AutoCommit = 0;
2919 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2922 foreach my $old_cust_pkg ( @cust_pkgs ) {
2924 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2925 if ( $old_cust_pkg->getfield('cancel') ) {
2926 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2927 $old_cust_pkg->pkgnum."\n"
2931 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2933 my $error = $old_cust_pkg->change(
2934 'pkgpart' => $param->{'new_pkgpart'},
2935 'keep_dates' => $keep_dates
2937 if ( !ref($error) ) { # change returns the cust_pkg on success
2939 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2942 $dbh->commit if $oldAutoCommit;
2948 Returns the last bill date, or if there is no last bill date, the setup date.
2949 Useful for billing metered services.
2955 return $self->setfield('last_bill', $_[0]) if @_;
2956 return $self->getfield('last_bill') if $self->getfield('last_bill');
2957 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2958 'edate' => $self->bill, } );
2959 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2962 =item last_cust_pkg_reason ACTION
2964 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2965 Returns false if there is no reason or the package is not currenly ACTION'd
2966 ACTION is one of adjourn, susp, cancel, or expire.
2970 sub last_cust_pkg_reason {
2971 my ( $self, $action ) = ( shift, shift );
2972 my $date = $self->get($action);
2974 'table' => 'cust_pkg_reason',
2975 'hashref' => { 'pkgnum' => $self->pkgnum,
2976 'action' => substr(uc($action), 0, 1),
2979 'order_by' => 'ORDER BY num DESC LIMIT 1',
2983 =item last_reason ACTION
2985 Returns the most recent ACTION FS::reason associated with the package.
2986 Returns false if there is no reason or the package is not currenly ACTION'd
2987 ACTION is one of adjourn, susp, cancel, or expire.
2992 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2993 $cust_pkg_reason->reason
2994 if $cust_pkg_reason;
2999 Returns the definition for this billing item, as an FS::part_pkg object (see
3006 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3007 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3008 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3013 Returns the cancelled package this package was changed from, if any.
3019 return '' unless $self->change_pkgnum;
3020 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3023 =item change_cust_main
3025 Returns the customter this package was detached to, if any.
3029 sub change_cust_main {
3031 return '' unless $self->change_custnum;
3032 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3037 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3044 $self->part_pkg->calc_setup($self, @_);
3049 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3056 $self->part_pkg->calc_recur($self, @_);
3061 Returns the base setup fee (per unit) of this package, from the package
3066 # minimal version for 3.x; in 4.x this can invoke currency conversion
3070 $self->part_pkg->unit_setup($self);
3075 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3082 $self->part_pkg->base_recur($self, @_);
3087 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3094 $self->part_pkg->calc_remain($self, @_);
3099 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3106 $self->part_pkg->calc_cancel($self, @_);
3111 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3117 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3120 =item cust_pkg_detail [ DETAILTYPE ]
3122 Returns any customer package details for this package (see
3123 L<FS::cust_pkg_detail>).
3125 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3129 sub cust_pkg_detail {
3131 my %hash = ( 'pkgnum' => $self->pkgnum );
3132 $hash{detailtype} = shift if @_;
3134 'table' => 'cust_pkg_detail',
3135 'hashref' => \%hash,
3136 'order_by' => 'ORDER BY weight, pkgdetailnum',
3140 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3142 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3144 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3146 If there is an error, returns the error, otherwise returns false.
3150 sub set_cust_pkg_detail {
3151 my( $self, $detailtype, @details ) = @_;
3153 local $SIG{HUP} = 'IGNORE';
3154 local $SIG{INT} = 'IGNORE';
3155 local $SIG{QUIT} = 'IGNORE';
3156 local $SIG{TERM} = 'IGNORE';
3157 local $SIG{TSTP} = 'IGNORE';
3158 local $SIG{PIPE} = 'IGNORE';
3160 my $oldAutoCommit = $FS::UID::AutoCommit;
3161 local $FS::UID::AutoCommit = 0;
3164 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3165 my $error = $current->delete;
3167 $dbh->rollback if $oldAutoCommit;
3168 return "error removing old detail: $error";
3172 foreach my $detail ( @details ) {
3173 my $cust_pkg_detail = new FS::cust_pkg_detail {
3174 'pkgnum' => $self->pkgnum,
3175 'detailtype' => $detailtype,
3176 'detail' => $detail,
3178 my $error = $cust_pkg_detail->insert;
3180 $dbh->rollback if $oldAutoCommit;
3181 return "error adding new detail: $error";
3186 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3193 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3197 #false laziness w/cust_bill.pm
3201 'table' => 'cust_event',
3202 'addl_from' => 'JOIN part_event USING ( eventpart )',
3203 'hashref' => { 'tablenum' => $self->pkgnum },
3204 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3208 =item num_cust_event
3210 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3214 #false laziness w/cust_bill.pm
3215 sub num_cust_event {
3217 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3218 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3221 =item exists_cust_event
3223 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3227 sub exists_cust_event {
3229 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3230 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3231 $row ? $row->[0] : '';
3234 sub _from_cust_event_where {
3236 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3237 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3241 my( $self, $sql, @args ) = @_;
3242 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3243 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3247 =item cust_svc [ SVCPART ] (old, deprecated usage)
3249 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3251 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3253 Returns the services for this package, as FS::cust_svc objects (see
3254 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3255 spcififed, returns only the matching services.
3257 As an optimization, use the cust_svc_unsorted version if you are not displaying
3264 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3265 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3268 sub cust_svc_unsorted {
3270 @{ $self->cust_svc_unsorted_arrayref(@_) };
3273 sub cust_svc_unsorted_arrayref {
3276 return [] unless $self->num_cust_svc(@_);
3279 if ( @_ && $_[0] =~ /^\d+/ ) {
3280 $opt{svcpart} = shift;
3281 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3288 'select' => 'cust_svc.*, part_svc.*',
3289 'table' => 'cust_svc',
3290 'hashref' => { 'pkgnum' => $self->pkgnum },
3291 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3293 $search{hashref}->{svcpart} = $opt{svcpart}
3295 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3298 [ qsearch(\%search) ];
3302 =item overlimit [ SVCPART ]
3304 Returns the services for this package which have exceeded their
3305 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3306 is specified, return only the matching services.
3312 return () unless $self->num_cust_svc(@_);
3313 grep { $_->overlimit } $self->cust_svc(@_);
3316 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3318 Returns historical services for this package created before END TIMESTAMP and
3319 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3320 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3321 I<pkg_svc.hidden> flag will be omitted.
3327 warn "$me _h_cust_svc called on $self\n"
3330 my ($end, $start, $mode) = @_;
3331 my @cust_svc = $self->_sort_cust_svc(
3332 [ qsearch( 'h_cust_svc',
3333 { 'pkgnum' => $self->pkgnum, },
3334 FS::h_cust_svc->sql_h_search(@_),
3337 if ( defined($mode) && $mode eq 'I' ) {
3338 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3339 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3345 sub _sort_cust_svc {
3346 my( $self, $arrayref ) = @_;
3349 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3351 my %pkg_svc = map { $_->svcpart => $_ }
3352 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3357 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3359 $pkg_svc ? $pkg_svc->primary_svc : '',
3360 $pkg_svc ? $pkg_svc->quantity : 0,
3367 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3369 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3371 Returns the number of services for this package. Available options are svcpart
3372 and svcdb. If either is spcififed, returns only the matching services.
3379 return $self->{'_num_cust_svc'}
3381 && exists($self->{'_num_cust_svc'})
3382 && $self->{'_num_cust_svc'} =~ /\d/;
3384 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3388 if ( @_ && $_[0] =~ /^\d+/ ) {
3389 $opt{svcpart} = shift;
3390 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3396 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3397 my $where = ' WHERE pkgnum = ? ';
3398 my @param = ($self->pkgnum);
3400 if ( $opt{'svcpart'} ) {
3401 $where .= ' AND svcpart = ? ';
3402 push @param, $opt{'svcpart'};
3404 if ( $opt{'svcdb'} ) {
3405 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3406 $where .= ' AND svcdb = ? ';
3407 push @param, $opt{'svcdb'};
3410 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3411 $sth->execute(@param) or die $sth->errstr;
3412 $sth->fetchrow_arrayref->[0];
3415 =item available_part_svc
3417 Returns a list of FS::part_svc objects representing services included in this
3418 package but not yet provisioned. Each FS::part_svc object also has an extra
3419 field, I<num_avail>, which specifies the number of available services.
3421 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3422 associated pkg_svc has the provision_hold flag set.
3426 sub available_part_svc {
3430 my $pkg_quantity = $self->quantity || 1;
3432 grep { $_->num_avail > 0 }
3434 my $part_svc = $_->part_svc;
3435 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3436 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3438 # more evil encapsulation breakage
3439 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3440 my @exports = $part_svc->part_export_did;
3441 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3446 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3447 $self->part_pkg->pkg_svc;
3450 =item part_svc [ OPTION => VALUE ... ]
3452 Returns a list of FS::part_svc objects representing provisioned and available
3453 services included in this package. Each FS::part_svc object also has the
3454 following extra fields:
3468 (services) - array reference containing the provisioned services, as cust_svc objects
3472 Accepts two options:
3476 =item summarize_size
3478 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3479 is this size or greater.
3481 =item hide_discontinued
3483 If true, will omit looking for services that are no longer avaialble in the
3491 #label -> ($cust_svc->label)[1]
3497 my $pkg_quantity = $self->quantity || 1;
3499 #XXX some sort of sort order besides numeric by svcpart...
3500 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3502 my $part_svc = $pkg_svc->part_svc;
3503 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3504 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3505 $part_svc->{'Hash'}{'num_avail'} =
3506 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3507 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3508 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3509 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3510 && $num_cust_svc >= $opt{summarize_size};
3511 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3513 } $self->part_pkg->pkg_svc;
3515 unless ( $opt{hide_discontinued} ) {
3517 push @part_svc, map {
3519 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3520 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3521 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3522 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3523 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3525 } $self->extra_part_svc;
3532 =item extra_part_svc
3534 Returns a list of FS::part_svc objects corresponding to services in this
3535 package which are still provisioned but not (any longer) available in the
3540 sub extra_part_svc {
3543 my $pkgnum = $self->pkgnum;
3544 #my $pkgpart = $self->pkgpart;
3547 # 'table' => 'part_svc',
3550 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3551 # WHERE pkg_svc.svcpart = part_svc.svcpart
3552 # AND pkg_svc.pkgpart = ?
3555 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3556 # LEFT JOIN cust_pkg USING ( pkgnum )
3557 # WHERE cust_svc.svcpart = part_svc.svcpart
3560 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3563 #seems to benchmark slightly faster... (or did?)
3565 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3566 my $pkgparts = join(',', @pkgparts);
3569 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3570 #MySQL doesn't grok DISINCT ON
3571 'select' => 'DISTINCT part_svc.*',
3572 'table' => 'part_svc',
3574 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3575 AND pkg_svc.pkgpart IN ($pkgparts)
3578 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3579 LEFT JOIN cust_pkg USING ( pkgnum )
3582 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3583 'extra_param' => [ [$self->pkgnum=>'int'] ],
3589 Returns a short status string for this package, currently:
3595 =item not yet billed
3597 =item one-time charge
3612 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3614 return 'cancelled' if $self->get('cancel');
3615 return 'on hold' if $self->susp && ! $self->setup;
3616 return 'suspended' if $self->susp;
3617 return 'not yet billed' unless $self->setup;
3618 return 'one-time charge' if $freq =~ /^(0|$)/;
3622 =item ucfirst_status
3624 Returns the status with the first character capitalized.
3628 sub ucfirst_status {
3629 ucfirst(shift->status);
3634 Class method that returns the list of possible status strings for packages
3635 (see L<the status method|/status>). For example:
3637 @statuses = FS::cust_pkg->statuses();
3641 tie my %statuscolor, 'Tie::IxHash',
3642 'on hold' => 'FF00F5', #brighter purple!
3643 'not yet billed' => '009999', #teal? cyan?
3644 'one-time charge' => '0000CC', #blue #'000000',
3645 'active' => '00CC00',
3646 'suspended' => 'FF9900',
3647 'cancelled' => 'FF0000',
3651 my $self = shift; #could be class...
3652 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3653 # # mayble split btw one-time vs. recur
3664 Returns a hex triplet color string for this package's status.
3670 $statuscolor{$self->status};
3673 =item is_status_delay_cancel
3675 Returns true if part_pkg has option delay_cancel,
3676 cust_pkg status is 'suspended' and expire is set
3677 to cancel package within the next day (or however
3678 many days are set in global config part_pkg-delay_cancel-days.
3680 Accepts option I<part_pkg-delay_cancel-days> which should be
3681 the value of the config setting, to avoid looking it up again.
3683 This is not a real status, this only meant for hacking display
3684 values, because otherwise treating the package as suspended is
3685 really the whole point of the delay_cancel option.
3689 sub is_status_delay_cancel {
3690 my ($self,%opt) = @_;
3691 if ( $self->main_pkgnum and $self->pkglinknum ) {
3692 return $self->main_pkg->is_status_delay_cancel;
3694 return 0 unless $self->part_pkg->option('delay_cancel',1);
3695 return 0 unless $self->status eq 'suspended';
3696 return 0 unless $self->expire;
3697 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3699 my $conf = new FS::Conf;
3700 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3702 my $expsecs = 60*60*24*$expdays;
3703 return 0 unless $self->expire < time + $expsecs;
3709 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3710 "pkg - comment" depending on user preference).
3716 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3717 $label = $self->pkgnum. ": $label"
3718 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3722 =item pkg_label_long
3724 Returns a long label for this package, adding the primary service's label to
3729 sub pkg_label_long {
3731 my $label = $self->pkg_label;
3732 my $cust_svc = $self->primary_cust_svc;
3733 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3739 Returns a customer-localized label for this package.
3745 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3748 =item primary_cust_svc
3750 Returns a primary service (as FS::cust_svc object) if one can be identified.
3754 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3756 sub primary_cust_svc {
3759 my @cust_svc = $self->cust_svc;
3761 return '' unless @cust_svc; #no serivces - irrelevant then
3763 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3765 # primary service as specified in the package definition
3766 # or exactly one service definition with quantity one
3767 my $svcpart = $self->part_pkg->svcpart;
3768 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3769 return $cust_svc[0] if scalar(@cust_svc) == 1;
3771 #couldn't identify one thing..
3777 Returns a list of lists, calling the label method for all services
3778 (see L<FS::cust_svc>) of this billing item.
3784 map { [ $_->label ] } $self->cust_svc;
3787 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
3789 Like the labels method, but returns historical information on services that
3790 were active as of END_TIMESTAMP and (optionally) not cancelled before
3791 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3792 I<pkg_svc.hidden> flag will be omitted.
3794 If LOCALE is passed, service definition names will be localized.
3796 Returns a list of lists, calling the label method for all (historical)
3797 services (see L<FS::h_cust_svc>) of this billing item.
3803 my ($end, $start, $mode, $locale) = @_;
3804 warn "$me h_labels\n"
3806 map { [ $_->label($end, $start, $locale) ] }
3807 $self->h_cust_svc($end, $start, $mode);
3812 Like labels, except returns a simple flat list, and shortens long
3813 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3814 identical services to one line that lists the service label and the number of
3815 individual services rather than individual items.
3820 shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
3823 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
3825 Like h_labels, except returns a simple flat list, and shortens long
3826 (currently >5 or the cust_bill-max_same_services configuration value) lists
3827 of identical services to one line that lists the service label and the
3828 number of individual services rather than individual items.
3832 sub h_labels_short {
3833 shift->_labels_short( 'h_labels', @_ );
3836 # takes a method name ('labels' or 'h_labels') and all its arguments;
3837 # maybe should be "shorten($self->h_labels( ... ) )"
3840 my( $self, $method ) = ( shift, shift );
3842 warn "$me _labels_short called on $self with $method method\n"
3845 my $conf = new FS::Conf;
3846 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3848 warn "$me _labels_short populating \%labels\n"
3852 #tie %labels, 'Tie::IxHash';
3853 push @{ $labels{$_->[0]} }, $_->[1]
3854 foreach $self->$method(@_);
3856 warn "$me _labels_short populating \@labels\n"
3860 foreach my $label ( keys %labels ) {
3862 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3863 my $num = scalar(@values);
3864 warn "$me _labels_short $num items for $label\n"
3867 if ( $num > $max_same_services ) {
3868 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3870 push @labels, "$label ($num)";
3872 if ( $conf->exists('cust_bill-consolidate_services') ) {
3873 warn "$me _labels_short consolidating services\n"
3875 # push @labels, "$label: ". join(', ', @values);
3877 my $detail = "$label: ";
3878 $detail .= shift(@values). ', '
3880 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3882 push @labels, $detail;
3884 warn "$me _labels_short done consolidating services\n"
3887 warn "$me _labels_short adding service data\n"
3889 push @labels, map { "$label: $_" } @values;
3900 Returns the parent customer object (see L<FS::cust_main>).
3906 cluck 'cust_pkg->cust_main called' if $DEBUG;
3907 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3912 Returns the balance for this specific package, when using
3913 experimental package balance.
3919 $self->cust_main->balance_pkgnum( $self->pkgnum );
3922 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3926 Returns the location object, if any (see L<FS::cust_location>).
3928 =item cust_location_or_main
3930 If this package is associated with a location, returns the locaiton (see
3931 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3933 =item location_label [ OPTION => VALUE ... ]
3935 Returns the label of the location object (see L<FS::cust_location>).
3939 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3941 =item tax_locationnum
3943 Returns the foreign key to a L<FS::cust_location> object for calculating
3944 tax on this package, as determined by the C<tax-pkg_address> and
3945 C<tax-ship_address> configuration flags.
3949 sub tax_locationnum {
3951 my $conf = FS::Conf->new;
3952 if ( $conf->exists('tax-pkg_address') ) {
3953 return $self->locationnum;
3955 elsif ( $conf->exists('tax-ship_address') ) {
3956 return $self->cust_main->ship_locationnum;
3959 return $self->cust_main->bill_locationnum;
3965 Returns the L<FS::cust_location> object for tax_locationnum.
3971 my $conf = FS::Conf->new;
3972 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3973 return FS::cust_location->by_key($self->locationnum);
3975 elsif ( $conf->exists('tax-ship_address') ) {
3976 return $self->cust_main->ship_location;
3979 return $self->cust_main->bill_location;
3983 =item seconds_since TIMESTAMP
3985 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3986 package have been online since TIMESTAMP, according to the session monitor.
3988 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3989 L<Time::Local> and L<Date::Parse> for conversion functions.
3994 my($self, $since) = @_;
3997 foreach my $cust_svc (
3998 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4000 $seconds += $cust_svc->seconds_since($since);
4007 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4009 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4010 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4013 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4014 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4020 sub seconds_since_sqlradacct {
4021 my($self, $start, $end) = @_;
4025 foreach my $cust_svc (
4027 my $part_svc = $_->part_svc;
4028 $part_svc->svcdb eq 'svc_acct'
4029 && scalar($part_svc->part_export_usage);
4032 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4039 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4041 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4042 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4046 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4047 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4052 sub attribute_since_sqlradacct {
4053 my($self, $start, $end, $attrib) = @_;
4057 foreach my $cust_svc (
4059 my $part_svc = $_->part_svc;
4060 scalar($part_svc->part_export_usage);
4063 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4075 my( $self, $value ) = @_;
4076 if ( defined($value) ) {
4077 $self->setfield('quantity', $value);
4079 $self->getfield('quantity') || 1;
4082 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4084 Transfers as many services as possible from this package to another package.
4086 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4087 object. The destination package must already exist.
4089 Services are moved only if the destination allows services with the correct
4090 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4091 this option with caution! No provision is made for export differences
4092 between the old and new service definitions. Probably only should be used
4093 when your exports for all service definitions of a given svcdb are identical.
4094 (attempt a transfer without it first, to move all possible svcpart-matching
4097 Any services that can't be moved remain in the original package.
4099 Returns an error, if there is one; otherwise, returns the number of services
4100 that couldn't be moved.
4105 my ($self, $dest_pkgnum, %opt) = @_;
4111 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4112 $dest = $dest_pkgnum;
4113 $dest_pkgnum = $dest->pkgnum;
4115 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4118 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4120 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4121 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4124 foreach my $cust_svc ($dest->cust_svc) {
4125 $target{$cust_svc->svcpart}--;
4128 my %svcpart2svcparts = ();
4129 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4130 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4131 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4132 next if exists $svcpart2svcparts{$svcpart};
4133 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4134 $svcpart2svcparts{$svcpart} = [
4136 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4138 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4139 'svcpart' => $_ } );
4141 $pkg_svc ? $pkg_svc->primary_svc : '',
4142 $pkg_svc ? $pkg_svc->quantity : 0,
4146 grep { $_ != $svcpart }
4148 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4150 warn "alternates for svcpart $svcpart: ".
4151 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4157 foreach my $cust_svc ($self->cust_svc) {
4158 my $svcnum = $cust_svc->svcnum;
4159 if($target{$cust_svc->svcpart} > 0
4160 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4161 $target{$cust_svc->svcpart}--;
4162 my $new = new FS::cust_svc { $cust_svc->hash };
4163 $new->pkgnum($dest_pkgnum);
4164 $error = $new->replace($cust_svc);
4165 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4167 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4168 warn "alternates to consider: ".
4169 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4171 my @alternate = grep {
4172 warn "considering alternate svcpart $_: ".
4173 "$target{$_} available in new package\n"
4176 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4178 warn "alternate(s) found\n" if $DEBUG;
4179 my $change_svcpart = $alternate[0];
4180 $target{$change_svcpart}--;
4181 my $new = new FS::cust_svc { $cust_svc->hash };
4182 $new->svcpart($change_svcpart);
4183 $new->pkgnum($dest_pkgnum);
4184 $error = $new->replace($cust_svc);
4192 my @label = $cust_svc->label;
4193 return "service $label[1]: $error";
4199 =item grab_svcnums SVCNUM, SVCNUM ...
4201 Change the pkgnum for the provided services to this packages. If there is an
4202 error, returns the error, otherwise returns false.
4210 local $SIG{HUP} = 'IGNORE';
4211 local $SIG{INT} = 'IGNORE';
4212 local $SIG{QUIT} = 'IGNORE';
4213 local $SIG{TERM} = 'IGNORE';
4214 local $SIG{TSTP} = 'IGNORE';
4215 local $SIG{PIPE} = 'IGNORE';
4217 my $oldAutoCommit = $FS::UID::AutoCommit;
4218 local $FS::UID::AutoCommit = 0;
4221 foreach my $svcnum (@svcnum) {
4222 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4223 $dbh->rollback if $oldAutoCommit;
4224 return "unknown svcnum $svcnum";
4226 $cust_svc->pkgnum( $self->pkgnum );
4227 my $error = $cust_svc->replace;
4229 $dbh->rollback if $oldAutoCommit;
4234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4241 This method is deprecated. See the I<depend_jobnum> option to the insert and
4242 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4249 local $SIG{HUP} = 'IGNORE';
4250 local $SIG{INT} = 'IGNORE';
4251 local $SIG{QUIT} = 'IGNORE';
4252 local $SIG{TERM} = 'IGNORE';
4253 local $SIG{TSTP} = 'IGNORE';
4254 local $SIG{PIPE} = 'IGNORE';
4256 my $oldAutoCommit = $FS::UID::AutoCommit;
4257 local $FS::UID::AutoCommit = 0;
4260 foreach my $cust_svc ( $self->cust_svc ) {
4261 #false laziness w/svc_Common::insert
4262 my $svc_x = $cust_svc->svc_x;
4263 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4264 my $error = $part_export->export_insert($svc_x);
4266 $dbh->rollback if $oldAutoCommit;
4272 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4277 =item export_pkg_change OLD_CUST_PKG
4279 Calls the "pkg_change" export action for all services attached to this package.
4283 sub export_pkg_change {
4284 my( $self, $old ) = ( shift, shift );
4286 local $SIG{HUP} = 'IGNORE';
4287 local $SIG{INT} = 'IGNORE';
4288 local $SIG{QUIT} = 'IGNORE';
4289 local $SIG{TERM} = 'IGNORE';
4290 local $SIG{TSTP} = 'IGNORE';
4291 local $SIG{PIPE} = 'IGNORE';
4293 my $oldAutoCommit = $FS::UID::AutoCommit;
4294 local $FS::UID::AutoCommit = 0;
4297 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4298 my $error = $svc_x->export('pkg_change', $self, $old);
4300 $dbh->rollback if $oldAutoCommit;
4305 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4312 Associates this package with a (suspension or cancellation) reason (see
4313 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4316 Available options are:
4322 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.
4326 the access_user (see L<FS::access_user>) providing the reason
4334 the action (cancel, susp, adjourn, expire) associated with the reason
4338 If there is an error, returns the error, otherwise returns false.
4343 my ($self, %options) = @_;
4345 my $otaker = $options{reason_otaker} ||
4346 $FS::CurrentUser::CurrentUser->username;
4349 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4353 } elsif ( ref($options{'reason'}) ) {
4355 return 'Enter a new reason (or select an existing one)'
4356 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4358 my $reason = new FS::reason({
4359 'reason_type' => $options{'reason'}->{'typenum'},
4360 'reason' => $options{'reason'}->{'reason'},
4362 my $error = $reason->insert;
4363 return $error if $error;
4365 $reasonnum = $reason->reasonnum;
4368 return "Unparseable reason: ". $options{'reason'};
4371 my $cust_pkg_reason =
4372 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4373 'reasonnum' => $reasonnum,
4374 'otaker' => $otaker,
4375 'action' => substr(uc($options{'action'}),0,1),
4376 'date' => $options{'date'}
4381 $cust_pkg_reason->insert;
4384 =item insert_discount
4386 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4387 inserting a new discount on the fly (see L<FS::discount>).
4389 Available options are:
4397 If there is an error, returns the error, otherwise returns false.
4401 sub insert_discount {
4402 #my ($self, %options) = @_;
4405 my $cust_pkg_discount = new FS::cust_pkg_discount {
4406 'pkgnum' => $self->pkgnum,
4407 'discountnum' => $self->discountnum,
4409 'end_date' => '', #XXX
4410 #for the create a new discount case
4411 '_type' => $self->discountnum__type,
4412 'amount' => $self->discountnum_amount,
4413 'percent' => $self->discountnum_percent,
4414 'months' => $self->discountnum_months,
4415 'setup' => $self->discountnum_setup,
4416 #'disabled' => $self->discountnum_disabled,
4419 $cust_pkg_discount->insert;
4422 =item set_usage USAGE_VALUE_HASHREF
4424 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4425 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4426 upbytes, downbytes, and totalbytes are appropriate keys.
4428 All svc_accts which are part of this package have their values reset.
4433 my ($self, $valueref, %opt) = @_;
4435 #only svc_acct can set_usage for now
4436 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4437 my $svc_x = $cust_svc->svc_x;
4438 $svc_x->set_usage($valueref, %opt)
4439 if $svc_x->can("set_usage");
4443 =item recharge USAGE_VALUE_HASHREF
4445 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4446 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4447 upbytes, downbytes, and totalbytes are appropriate keys.
4449 All svc_accts which are part of this package have their values incremented.
4454 my ($self, $valueref) = @_;
4456 #only svc_acct can set_usage for now
4457 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4458 my $svc_x = $cust_svc->svc_x;
4459 $svc_x->recharge($valueref)
4460 if $svc_x->can("recharge");
4464 =item cust_pkg_discount
4468 sub cust_pkg_discount {
4470 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4473 =item cust_pkg_discount_active
4477 sub cust_pkg_discount_active {
4479 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4482 =item cust_pkg_usage
4484 Returns a list of all voice usage counters attached to this package.
4488 sub cust_pkg_usage {
4490 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4493 =item apply_usage OPTIONS
4495 Takes the following options:
4496 - cdr: a call detail record (L<FS::cdr>)
4497 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4498 - minutes: the maximum number of minutes to be charged
4500 Finds available usage minutes for a call of this class, and subtracts
4501 up to that many minutes from the usage pool. If the usage pool is empty,
4502 and the C<cdr-minutes_priority> global config option is set, minutes may
4503 be taken from other calls as well. Either way, an allocation record will
4504 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4505 number of minutes of usage applied to the call.
4510 my ($self, %opt) = @_;
4511 my $cdr = $opt{cdr};
4512 my $rate_detail = $opt{rate_detail};
4513 my $minutes = $opt{minutes};
4514 my $classnum = $rate_detail->classnum;
4515 my $pkgnum = $self->pkgnum;
4516 my $custnum = $self->custnum;
4518 local $SIG{HUP} = 'IGNORE';
4519 local $SIG{INT} = 'IGNORE';
4520 local $SIG{QUIT} = 'IGNORE';
4521 local $SIG{TERM} = 'IGNORE';
4522 local $SIG{TSTP} = 'IGNORE';
4523 local $SIG{PIPE} = 'IGNORE';
4525 my $oldAutoCommit = $FS::UID::AutoCommit;
4526 local $FS::UID::AutoCommit = 0;
4528 my $order = FS::Conf->new->config('cdr-minutes_priority');
4532 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4534 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4536 my @usage_recs = qsearch({
4537 'table' => 'cust_pkg_usage',
4538 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4539 ' JOIN cust_pkg USING (pkgnum)'.
4540 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4541 'select' => 'cust_pkg_usage.*',
4542 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4543 " ( cust_pkg.custnum = $custnum AND ".
4544 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4545 $is_classnum . ' AND '.
4546 " cust_pkg_usage.minutes > 0",
4547 'order_by' => " ORDER BY priority ASC",
4550 my $orig_minutes = $minutes;
4552 while (!$error and $minutes > 0 and @usage_recs) {
4553 my $cust_pkg_usage = shift @usage_recs;
4554 $cust_pkg_usage->select_for_update;
4555 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4556 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4557 acctid => $cdr->acctid,
4558 minutes => min($cust_pkg_usage->minutes, $minutes),
4560 $cust_pkg_usage->set('minutes',
4561 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4563 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4564 $minutes -= $cdr_cust_pkg_usage->minutes;
4566 if ( $order and $minutes > 0 and !$error ) {
4567 # then try to steal minutes from another call
4569 'table' => 'cdr_cust_pkg_usage',
4570 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4571 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4572 ' JOIN cust_pkg USING (pkgnum)'.
4573 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4574 ' JOIN cdr USING (acctid)',
4575 'select' => 'cdr_cust_pkg_usage.*',
4576 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4577 " ( cust_pkg.pkgnum = $pkgnum OR ".
4578 " ( cust_pkg.custnum = $custnum AND ".
4579 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4580 " part_pkg_usage_class.classnum = $classnum",
4581 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4583 if ( $order eq 'time' ) {
4584 # find CDRs that are using minutes, but have a later startdate
4586 my $startdate = $cdr->startdate;
4587 if ($startdate !~ /^\d+$/) {
4588 die "bad cdr startdate '$startdate'";
4590 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4591 # minimize needless reshuffling
4592 $search{'order_by'} .= ', cdr.startdate DESC';
4594 # XXX may not work correctly with rate_time schedules. Could
4595 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4597 $search{'addl_from'} .=
4598 ' JOIN rate_detail'.
4599 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4600 if ( $order eq 'rate_high' ) {
4601 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4602 $rate_detail->min_charge;
4603 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4604 } elsif ( $order eq 'rate_low' ) {
4605 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4606 $rate_detail->min_charge;
4607 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4609 # this should really never happen
4610 die "invalid cdr-minutes_priority value '$order'\n";
4613 my @cdr_usage_recs = qsearch(\%search);
4615 while (!$error and @cdr_usage_recs and $minutes > 0) {
4616 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4617 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4618 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4619 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4620 $cdr_cust_pkg_usage->select_for_update;
4621 $old_cdr->select_for_update;
4622 $cust_pkg_usage->select_for_update;
4623 # in case someone else stole the usage from this CDR
4624 # while waiting for the lock...
4625 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4626 # steal the usage allocation and flag the old CDR for reprocessing
4627 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4628 # if the allocation is more minutes than we need, adjust it...
4629 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4631 $cdr_cust_pkg_usage->set('minutes', $minutes);
4632 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4633 $error = $cust_pkg_usage->replace;
4635 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4636 $error ||= $cdr_cust_pkg_usage->replace;
4637 # deduct the stolen minutes
4638 $minutes -= $cdr_cust_pkg_usage->minutes;
4640 # after all minute-stealing is done, reset the affected CDRs
4641 foreach (values %reproc_cdrs) {
4642 $error ||= $_->set_status('');
4643 # XXX or should we just call $cdr->rate right here?
4644 # it's not like we can create a loop this way, since the min_charge
4645 # or call time has to go monotonically in one direction.
4646 # we COULD get some very deep recursions going, though...
4648 } # if $order and $minutes
4651 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4653 $dbh->commit if $oldAutoCommit;
4654 return $orig_minutes - $minutes;
4658 =item supplemental_pkgs
4660 Returns a list of all packages supplemental to this one.
4664 sub supplemental_pkgs {
4666 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4671 Returns the package that this one is supplemental to, if any.
4677 if ( $self->main_pkgnum ) {
4678 return FS::cust_pkg->by_key($self->main_pkgnum);
4685 =head1 CLASS METHODS
4691 Returns an SQL expression identifying recurring packages.
4695 sub recurring_sql { "
4696 '0' != ( select freq from part_pkg
4697 where cust_pkg.pkgpart = part_pkg.pkgpart )
4702 Returns an SQL expression identifying one-time packages.
4707 '0' = ( select freq from part_pkg
4708 where cust_pkg.pkgpart = part_pkg.pkgpart )
4713 Returns an SQL expression identifying ordered packages (recurring packages not
4719 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4724 Returns an SQL expression identifying active packages.
4729 $_[0]->recurring_sql. "
4730 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4731 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4732 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4735 =item not_yet_billed_sql
4737 Returns an SQL expression identifying packages which have not yet been billed.
4741 sub not_yet_billed_sql { "
4742 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4743 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4744 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4749 Returns an SQL expression identifying inactive packages (one-time packages
4750 that are otherwise unsuspended/uncancelled).
4754 sub inactive_sql { "
4755 ". $_[0]->onetime_sql(). "
4756 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4757 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4758 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4763 Returns an SQL expression identifying on-hold packages.
4768 #$_[0]->recurring_sql(). ' AND '.
4770 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4771 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4772 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4779 Returns an SQL expression identifying suspended packages.
4783 sub suspended_sql { susp_sql(@_); }
4785 #$_[0]->recurring_sql(). ' AND '.
4787 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4788 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4789 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4796 Returns an SQL exprression identifying cancelled packages.
4800 sub cancelled_sql { cancel_sql(@_); }
4802 #$_[0]->recurring_sql(). ' AND '.
4803 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4808 Returns an SQL expression to give the package status as a string.
4814 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4815 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4816 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4817 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4818 WHEN ".onetime_sql()." THEN 'one-time charge'
4823 =item search HASHREF
4827 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4828 Valid parameters are
4836 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
4840 Equivalent to "status", except that "canceled"/"cancelled" will exclude
4841 packages that were changed into a new package with the same pkgpart (i.e.
4842 location or quantity changes).
4846 boolean selects custom packages
4852 pkgpart or arrayref or hashref of pkgparts
4856 arrayref of beginning and ending epoch date
4860 arrayref of beginning and ending epoch date
4864 arrayref of beginning and ending epoch date
4868 arrayref of beginning and ending epoch date
4872 arrayref of beginning and ending epoch date
4876 arrayref of beginning and ending epoch date
4880 arrayref of beginning and ending epoch date
4884 pkgnum or APKG_pkgnum
4888 a value suited to passing to FS::UI::Web::cust_header
4892 specifies the user for agent virtualization
4896 boolean; if true, returns only packages with more than 0 FCC phone lines.
4898 =item state, country
4900 Limit to packages with a service location in the specified state and country.
4901 For FCC 477 reporting, mostly.
4905 Limit to packages whose service locations are the same as the customer's
4906 default service location.
4908 =item location_nocust
4910 Limit to packages whose service locations are not the customer's default
4913 =item location_census
4915 Limit to packages whose service locations have census tracts.
4917 =item location_nocensus
4919 Limit to packages whose service locations do not have a census tract.
4921 =item location_geocode
4923 Limit to packages whose locations have geocodes.
4925 =item location_geocode
4927 Limit to packages whose locations do not have geocodes.
4931 Limit to packages associated with a svc_broadband, associated with a sector,
4932 associated with this towernum (or any of these, if it's an arrayref) (or NO
4933 towernum, if it's zero). This is an extreme niche case.
4935 =item 477part, 477rownum, date
4937 Limit to packages included in a specific row of one of the FCC 477 reports.
4938 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
4939 is the report as-of date (completely unrelated to the package setup/bill/
4940 other date fields), and '477rownum' is the row number of the report starting
4941 with zero. Row numbers have no inherent meaning, so this is useful only
4942 for explaining a 477 report you've already run.
4949 my ($class, $params) = @_;
4956 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4958 "cust_main.agentnum = $1";
4965 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4966 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4970 # parse customer sales person
4973 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4974 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4975 : 'cust_main.salesnum IS NULL';
4980 # parse sales person
4983 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4984 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4985 : 'cust_pkg.salesnum IS NULL';
4992 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4994 "cust_pkg.custnum = $1";
5001 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5003 "cust_pkg.pkgbatch = '$1'";
5010 if ( $params->{'magic'} eq 'active'
5011 || $params->{'status'} eq 'active' ) {
5013 push @where, FS::cust_pkg->active_sql();
5015 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
5016 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
5018 push @where, FS::cust_pkg->not_yet_billed_sql();
5020 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
5021 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
5023 push @where, FS::cust_pkg->inactive_sql();
5025 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
5026 || $params->{'status'} =~ /^on[ _]hold$/ ) {
5028 push @where, FS::cust_pkg->on_hold_sql();
5031 } elsif ( $params->{'magic'} eq 'suspended'
5032 || $params->{'status'} eq 'suspended' ) {
5034 push @where, FS::cust_pkg->suspended_sql();
5036 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
5037 || $params->{'status'} =~ /^cancell?ed$/ ) {
5039 push @where, FS::cust_pkg->cancelled_sql();
5043 ### special case: "magic" is used in detail links from browse/part_pkg,
5044 # where "cancelled" has the restriction "and not replaced with a package
5045 # of the same pkgpart". Be consistent with that.
5048 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
5049 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
5050 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
5051 # ...may not exist, if this was just canceled and not changed; in that
5052 # case give it a "new pkgpart" that never equals the old pkgpart
5053 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
5057 # parse package class
5060 if ( exists($params->{'classnum'}) ) {
5063 if ( ref($params->{'classnum'}) ) {
5065 if ( ref($params->{'classnum'}) eq 'HASH' ) {
5066 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
5067 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
5068 @classnum = @{ $params->{'classnum'} };
5070 die 'unhandled classnum ref '. $params->{'classnum'};
5074 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
5081 my @nums = grep $_, @classnum;
5082 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
5083 my $null = scalar( grep { $_ eq '' } @classnum );
5084 push @c_where, 'part_pkg.classnum IS NULL' if $null;
5086 if ( scalar(@c_where) == 1 ) {
5087 push @where, @c_where;
5088 } elsif ( @c_where ) {
5089 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
5098 # parse refnum (advertising source)
5101 if ( exists($params->{'refnum'}) ) {
5103 if (ref $params->{'refnum'}) {
5104 @refnum = @{ $params->{'refnum'} };
5106 @refnum = ( $params->{'refnum'} );
5108 my $in = join(',', grep /^\d+$/, @refnum);
5109 push @where, "refnum IN($in)" if length $in;
5113 # parse package report options
5116 my @report_option = ();
5117 if ( exists($params->{'report_option'}) ) {
5118 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
5119 @report_option = @{ $params->{'report_option'} };
5120 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
5121 @report_option = split(',', $1);
5126 if (@report_option) {
5127 # this will result in the empty set for the dangling comma case as it should
5129 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5130 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5131 AND optionname = 'report_option_$_'
5132 AND optionvalue = '1' )"
5136 foreach my $any ( grep /^report_option_any/, keys %$params ) {
5138 my @report_option_any = ();
5139 if ( ref($params->{$any}) eq 'ARRAY' ) {
5140 @report_option_any = @{ $params->{$any} };
5141 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
5142 @report_option_any = split(',', $1);
5145 if (@report_option_any) {
5146 # this will result in the empty set for the dangling comma case as it should
5147 push @where, ' ( '. join(' OR ',
5148 map{ "0 < ( SELECT count(*) FROM part_pkg_option
5149 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5150 AND optionname = 'report_option_$_'
5151 AND optionvalue = '1' )"
5152 } @report_option_any
5162 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
5168 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
5169 if $params->{fcc_line};
5175 if ( exists($params->{'censustract'}) ) {
5176 $params->{'censustract'} =~ /^([.\d]*)$/;
5177 my $censustract = "cust_location.censustract = '$1'";
5178 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
5179 push @where, "( $censustract )";
5183 # parse censustract2
5185 if ( exists($params->{'censustract2'})
5186 && $params->{'censustract2'} =~ /^(\d*)$/
5190 push @where, "cust_location.censustract LIKE '$1%'";
5193 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
5198 # parse country/state/zip
5200 for (qw(state country)) { # parsing rules are the same for these
5201 if ( exists($params->{$_})
5202 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
5204 # XXX post-2.3 only--before that, state/country may be in cust_main
5205 push @where, "cust_location.$_ = '$1'";
5208 if ( exists($params->{zip}) ) {
5209 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
5215 if ( $params->{location_cust} xor $params->{location_nocust} ) {
5216 my $op = $params->{location_cust} ? '=' : '!=';
5217 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
5219 if ( $params->{location_census} xor $params->{location_nocensus} ) {
5220 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
5221 push @where, "cust_location.censustract $op";
5223 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
5224 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
5225 push @where, "cust_location.geocode $op";
5232 if ( ref($params->{'pkgpart'}) ) {
5235 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
5236 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
5237 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
5238 @pkgpart = @{ $params->{'pkgpart'} };
5240 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
5243 @pkgpart = grep /^(\d+)$/, @pkgpart;
5245 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
5247 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5248 push @where, "pkgpart = $1";
5257 #false laziness w/report_cust_pkg.html
5260 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
5261 'active' => { 'susp'=>1, 'cancel'=>1 },
5262 'suspended' => { 'cancel' => 1 },
5267 if( exists($params->{'active'} ) ) {
5268 # This overrides all the other date-related fields, and includes packages
5269 # that were active at some time during the interval. It excludes:
5270 # - packages that were set up after the end of the interval
5271 # - packages that were canceled before the start of the interval
5272 # - packages that were suspended before the start of the interval
5273 # and are still suspended now
5274 my($beginning, $ending) = @{$params->{'active'}};
5276 "cust_pkg.setup IS NOT NULL",
5277 "cust_pkg.setup <= $ending",
5278 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5279 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
5280 "NOT (".FS::cust_pkg->onetime_sql . ")";
5283 my $exclude_change_from = 0;
5284 my $exclude_change_to = 0;
5286 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5288 next unless exists($params->{$field});
5290 my($beginning, $ending) = @{$params->{$field}};
5292 next if $beginning == 0 && $ending == 4294967295;
5295 "cust_pkg.$field IS NOT NULL",
5296 "cust_pkg.$field >= $beginning",
5297 "cust_pkg.$field <= $ending";
5299 $orderby ||= "ORDER BY cust_pkg.$field";
5301 if ( $field eq 'setup' ) {
5302 $exclude_change_from = 1;
5303 } elsif ( $field eq 'cancel' ) {
5304 $exclude_change_to = 1;
5305 } elsif ( $field eq 'change_date' ) {
5306 # if we are given setup and change_date ranges, and the setup date
5307 # falls in _both_ ranges, then include the package whether it was
5309 $exclude_change_from = 0;
5313 if ($exclude_change_from) {
5314 push @where, "change_pkgnum IS NULL";
5316 if ($exclude_change_to) {
5317 # a join might be more efficient here
5318 push @where, "NOT EXISTS(
5319 SELECT 1 FROM cust_pkg AS changed_to_pkg
5320 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5325 $orderby ||= 'ORDER BY bill';
5328 # parse magic, legacy, etc.
5331 if ( $params->{'magic'} &&
5332 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5335 $orderby = 'ORDER BY pkgnum';
5337 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5338 push @where, "pkgpart = $1";
5341 } elsif ( $params->{'query'} eq 'pkgnum' ) {
5343 $orderby = 'ORDER BY pkgnum';
5345 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5347 $orderby = 'ORDER BY pkgnum';
5350 SELECT count(*) FROM pkg_svc
5351 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
5352 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5353 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
5354 AND cust_svc.svcpart = pkg_svc.svcpart
5361 # parse the extremely weird 'towernum' param
5364 if ($params->{towernum}) {
5365 my $towernum = $params->{towernum};
5366 $towernum = [ $towernum ] if !ref($towernum);
5367 my $in = join(',', grep /^\d+$/, @$towernum);
5369 # inefficient, but this is an obscure feature
5370 eval "use FS::Report::Table";
5371 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5372 push @where, "EXISTS(
5373 SELECT 1 FROM tower_pkg_cache
5374 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5375 AND tower_pkg_cache.towernum IN ($in)
5381 # parse the 477 report drill-down options
5384 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5386 my ($date, $rownum, $agentnum);
5387 if ($params->{'date'} =~ /^(\d+)$/) {
5390 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5393 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5396 if ($date and defined($rownum)) {
5397 my $report = FS::Report::FCC_477->report($section,
5399 'agentnum' => $agentnum,
5402 my $pkgnums = $report->{detail}->[$rownum]
5403 or die "row $rownum is past the end of the report";
5404 # '0' so that if there are no pkgnums (empty string) it will create
5405 # a valid query that returns nothing
5406 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5408 # and this overrides everything
5409 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5410 } # else we're missing some params, ignore the whole business
5414 # setup queries, links, subs, etc. for the search
5417 # here is the agent virtualization
5418 if ($params->{CurrentUser}) {
5420 qsearchs('access_user', { username => $params->{CurrentUser} });
5423 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5428 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5431 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5433 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5434 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5435 'LEFT JOIN cust_location USING ( locationnum ) '.
5436 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5440 if ( $params->{'select_zip5'} ) {
5441 my $zip = 'cust_location.zip';
5443 $select = "DISTINCT substr($zip,1,5) as zip";
5444 $orderby = "ORDER BY substr($zip,1,5)";
5445 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5447 $select = join(', ',
5449 ( map "part_pkg.$_", qw( pkg freq ) ),
5450 'pkg_class.classname',
5451 'cust_main.custnum AS cust_main_custnum',
5452 FS::UI::Web::cust_sql_fields(
5453 $params->{'cust_fields'}
5456 $count_query = 'SELECT COUNT(*)';
5459 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5462 'table' => 'cust_pkg',
5464 'select' => $select,
5465 'extra_sql' => $extra_sql,
5466 'order_by' => $orderby,
5467 'addl_from' => $addl_from,
5468 'count_query' => $count_query,
5475 Returns a list of two package counts. The first is a count of packages
5476 based on the supplied criteria and the second is the count of residential
5477 packages with those same criteria. Criteria are specified as in the search
5483 my ($class, $params) = @_;
5485 my $sql_query = $class->search( $params );
5487 my $count_sql = delete($sql_query->{'count_query'});
5488 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5489 or die "couldn't parse count_sql";
5491 my $count_sth = dbh->prepare($count_sql)
5492 or die "Error preparing $count_sql: ". dbh->errstr;
5494 or die "Error executing $count_sql: ". $count_sth->errstr;
5495 my $count_arrayref = $count_sth->fetchrow_arrayref;
5497 return ( @$count_arrayref );
5501 =item tax_locationnum_sql
5503 Returns an SQL expression for the tax location for a package, based
5504 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5508 sub tax_locationnum_sql {
5509 my $conf = FS::Conf->new;
5510 if ( $conf->exists('tax-pkg_address') ) {
5511 'cust_pkg.locationnum';
5513 elsif ( $conf->exists('tax-ship_address') ) {
5514 'cust_main.ship_locationnum';
5517 'cust_main.bill_locationnum';
5523 Returns a list: the first item is an SQL fragment identifying matching
5524 packages/customers via location (taking into account shipping and package
5525 address taxation, if enabled), and subsequent items are the parameters to
5526 substitute for the placeholders in that fragment.
5531 my($class, %opt) = @_;
5532 my $ornull = $opt{'ornull'};
5534 my $conf = new FS::Conf;
5536 # '?' placeholders in _location_sql_where
5537 my $x = $ornull ? 3 : 2;
5548 if ( $conf->exists('tax-ship_address') ) {
5551 ( ( ship_last IS NULL OR ship_last = '' )
5552 AND ". _location_sql_where('cust_main', '', $ornull ). "
5554 OR ( ship_last IS NOT NULL AND ship_last != ''
5555 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5558 # AND payby != 'COMP'
5560 @main_param = ( @bill_param, @bill_param );
5564 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5565 @main_param = @bill_param;
5571 if ( $conf->exists('tax-pkg_address') ) {
5573 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5576 ( cust_pkg.locationnum IS NULL AND $main_where )
5577 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5580 @param = ( @main_param, @bill_param );
5584 $where = $main_where;
5585 @param = @main_param;
5593 #subroutine, helper for location_sql
5594 sub _location_sql_where {
5596 my $prefix = @_ ? shift : '';
5597 my $ornull = @_ ? shift : '';
5599 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5601 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5603 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5604 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5605 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5607 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5609 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5611 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5612 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5613 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5614 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5615 AND $table.${prefix}country = ?
5620 my( $self, $what ) = @_;
5622 my $what_show_zero = $what. '_show_zero';
5623 length($self->$what_show_zero())
5624 ? ($self->$what_show_zero() eq 'Y')
5625 : $self->part_pkg->$what_show_zero();
5632 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5634 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5635 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5637 CUSTNUM is a customer (see L<FS::cust_main>)
5639 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5640 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5643 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5644 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5645 new billing items. An error is returned if this is not possible (see
5646 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5649 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5650 newly-created cust_pkg objects.
5652 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5653 and inserted. Multiple FS::pkg_referral records can be created by
5654 setting I<refnum> to an array reference of refnums or a hash reference with
5655 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5656 record will be created corresponding to cust_main.refnum.
5661 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5663 my $conf = new FS::Conf;
5665 # Transactionize this whole mess
5666 local $SIG{HUP} = 'IGNORE';
5667 local $SIG{INT} = 'IGNORE';
5668 local $SIG{QUIT} = 'IGNORE';
5669 local $SIG{TERM} = 'IGNORE';
5670 local $SIG{TSTP} = 'IGNORE';
5671 local $SIG{PIPE} = 'IGNORE';
5673 my $oldAutoCommit = $FS::UID::AutoCommit;
5674 local $FS::UID::AutoCommit = 0;
5678 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5679 # return "Customer not found: $custnum" unless $cust_main;
5681 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5684 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5687 my $change = scalar(@old_cust_pkg) != 0;
5690 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5692 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5693 " to pkgpart ". $pkgparts->[0]. "\n"
5696 my $err_or_cust_pkg =
5697 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5698 'refnum' => $refnum,
5701 unless (ref($err_or_cust_pkg)) {
5702 $dbh->rollback if $oldAutoCommit;
5703 return $err_or_cust_pkg;
5706 push @$return_cust_pkg, $err_or_cust_pkg;
5707 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5712 # Create the new packages.
5713 foreach my $pkgpart (@$pkgparts) {
5715 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5717 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5718 pkgpart => $pkgpart,
5722 $error = $cust_pkg->insert( 'change' => $change );
5723 push @$return_cust_pkg, $cust_pkg;
5725 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5726 my $supp_pkg = FS::cust_pkg->new({
5727 custnum => $custnum,
5728 pkgpart => $link->dst_pkgpart,
5730 main_pkgnum => $cust_pkg->pkgnum,
5733 $error ||= $supp_pkg->insert( 'change' => $change );
5734 push @$return_cust_pkg, $supp_pkg;
5738 $dbh->rollback if $oldAutoCommit;
5743 # $return_cust_pkg now contains refs to all of the newly
5746 # Transfer services and cancel old packages.
5747 foreach my $old_pkg (@old_cust_pkg) {
5749 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5752 foreach my $new_pkg (@$return_cust_pkg) {
5753 $error = $old_pkg->transfer($new_pkg);
5754 if ($error and $error == 0) {
5755 # $old_pkg->transfer failed.
5756 $dbh->rollback if $oldAutoCommit;
5761 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5762 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5763 foreach my $new_pkg (@$return_cust_pkg) {
5764 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5765 if ($error and $error == 0) {
5766 # $old_pkg->transfer failed.
5767 $dbh->rollback if $oldAutoCommit;
5774 # Transfers were successful, but we went through all of the
5775 # new packages and still had services left on the old package.
5776 # We can't cancel the package under the circumstances, so abort.
5777 $dbh->rollback if $oldAutoCommit;
5778 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5780 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5786 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5790 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5792 A bulk change method to change packages for multiple customers.
5794 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5795 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5798 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5799 replace. The services (see L<FS::cust_svc>) are moved to the
5800 new billing items. An error is returned if this is not possible (see
5803 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5804 newly-created cust_pkg objects.
5809 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5811 # Transactionize this whole mess
5812 local $SIG{HUP} = 'IGNORE';
5813 local $SIG{INT} = 'IGNORE';
5814 local $SIG{QUIT} = 'IGNORE';
5815 local $SIG{TERM} = 'IGNORE';
5816 local $SIG{TSTP} = 'IGNORE';
5817 local $SIG{PIPE} = 'IGNORE';
5819 my $oldAutoCommit = $FS::UID::AutoCommit;
5820 local $FS::UID::AutoCommit = 0;
5824 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5827 while(scalar(@old_cust_pkg)) {
5829 my $custnum = $old_cust_pkg[0]->custnum;
5830 my (@remove) = map { $_->pkgnum }
5831 grep { $_->custnum == $custnum } @old_cust_pkg;
5832 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5834 my $error = order $custnum, $pkgparts, \@remove, \@return;
5836 push @errors, $error
5838 push @$return_cust_pkg, @return;
5841 if (scalar(@errors)) {
5842 $dbh->rollback if $oldAutoCommit;
5843 return join(' / ', @errors);
5846 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5850 =item forward_emails
5852 Returns a hash of svcnums and corresponding email addresses
5853 for svc_acct services that can be used as source or dest
5854 for svc_forward services provisioned in this package.
5856 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5857 service; if included, will ensure the current values of the
5858 specified service are included in the list, even if for some
5859 other reason they wouldn't be. If called as a class method
5860 with a specified service, returns only these current values.
5862 Caution: does not actually check if svc_forward services are
5863 available to be provisioned on this package.
5867 sub forward_emails {
5871 #load optional service, thoroughly validated
5872 die "Use svcnum or svc_forward, not both"
5873 if $opt{'svcnum'} && $opt{'svc_forward'};
5874 my $svc_forward = $opt{'svc_forward'};
5875 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5877 die "Specified service is not a forward service"
5878 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5879 die "Specified service not found"
5880 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5884 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5885 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5887 #add current values from specified service, if there was one
5889 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5890 my $svc_acct = $svc_forward->$method();
5891 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5895 if (ref($self) eq 'FS::cust_pkg') {
5897 #and including the rest for this customer
5898 my($u_part_svc,@u_acct_svcparts);
5899 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5900 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5903 my $custnum = $self->getfield('custnum');
5904 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5905 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5906 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5907 foreach my $acct_svcpart (@u_acct_svcparts) {
5908 foreach my $i_cust_svc (
5909 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5910 'svcpart' => $acct_svcpart } )
5912 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5913 $email{$svc_acct->svcnum} = $svc_acct->email;
5922 # Used by FS::Upgrade to migrate to a new database.
5923 sub _upgrade_data { # class method
5924 my ($class, %opts) = @_;
5925 $class->_upgrade_otaker(%opts);
5927 # RT#10139, bug resulting in contract_end being set when it shouldn't
5928 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5929 # RT#10830, bad calculation of prorate date near end of year
5930 # the date range for bill is December 2009, and we move it forward
5931 # one year if it's before the previous bill date (which it should
5933 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5934 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5935 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5936 # RT6628, add order_date to cust_pkg
5937 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5938 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5939 history_action = \'insert\') where order_date is null',
5941 foreach my $sql (@statements) {
5942 my $sth = dbh->prepare($sql);
5943 $sth->execute or die $sth->errstr;
5946 # RT31194: supplemental package links that are deleted don't clean up
5948 my @pkglinknums = qsearch({
5949 'select' => 'DISTINCT cust_pkg.pkglinknum',
5950 'table' => 'cust_pkg',
5951 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5952 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5953 AND part_pkg_link.pkglinknum IS NULL',
5955 foreach (@pkglinknums) {
5956 my $pkglinknum = $_->pkglinknum;
5957 warn "cleaning part_pkg_link #$pkglinknum\n";
5958 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5959 my $error = $part_pkg_link->remove_linked;
5960 die $error if $error;
5968 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5970 In sub order, the @pkgparts array (passed by reference) is clobbered.
5972 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5973 method to pass dates to the recur_prog expression, it should do so.
5975 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5976 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5977 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5978 configuration values. Probably need a subroutine which decides what to do
5979 based on whether or not we've fetched the user yet, rather than a hash. See
5980 FS::UID and the TODO.
5982 Now that things are transactional should the check in the insert method be
5987 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5988 L<FS::pkg_svc>, schema.html from the base documentation