2 use base qw( FS::cust_pkg::Search FS::cust_pkg::API
3 FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
4 FS::contact_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common
10 use Scalar::Util qw( blessed );
11 use List::Util qw(min max);
13 use Time::Local qw( timelocal timelocal_nocheck );
15 use FS::UID qw( dbh driver_name );
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_usageprice;
35 use FS::cust_pkg_discount;
41 # temporary fix; remove this once (un)suspend admin notices are cleaned up
42 use FS::Misc qw(send_email);
44 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
46 # because they load configuration by setting FS::UID::callback (see TODO)
52 # for sending cancel emails in sub cancel
55 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
57 our $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.
260 If the package has an automatic transfer rule (C<change_to_pkgnum>), then
261 this will also order the package and set its start date.
265 sub set_initial_timers {
267 my $part_pkg = $self->part_pkg;
268 my $start = $self->start_date || $self->setup || time;
270 foreach my $action ( qw(expire adjourn contract_end) ) {
271 my $months = $part_pkg->get("${action}_months");
272 if($months and !$self->get($action)) {
273 $self->set($action, $part_pkg->add_freq($start, $months) );
277 # if this package has an expire date and a change_to_pkgpart, set automatic
279 # (but don't call change_later, as that would call $self->replace, and we're
280 # probably in the middle of $self->insert right now)
281 if ( $part_pkg->expire_months and $part_pkg->change_to_pkgpart ) {
282 if ( $self->change_to_pkgnum ) {
283 # this can happen if a package is ordered on hold, scheduled for a
284 # future change _while on hold_, and then released from hold, causing
285 # the automatic transfer to schedule.
287 # what's correct behavior in that case? I think it's to disallow
288 # future-changing an on-hold package that has an automatic transfer.
289 # but if we DO get into this situation, let the manual package change
291 warn "pkgnum ".$self->pkgnum.": manual future package change blocks ".
292 "automatic transfer.\n";
294 my $change_to = FS::cust_pkg->new( {
295 start_date => $self->get('expire'),
296 pkgpart => $part_pkg->change_to_pkgpart,
297 map { $_ => $self->get($_) }
298 qw( custnum locationnum quantity refnum salesnum contract_end )
300 my $error = $change_to->insert;
302 return $error if $error;
303 $self->set('change_to_pkgnum', $change_to->pkgnum);
307 # if this package has "free days" and delayed setup fee, then
308 # set start date that many days in the future.
309 # (this should have been set in the UI, but enforce it here)
310 if ( $part_pkg->option('free_days',1)
311 && $part_pkg->option('delay_setup',1)
314 $self->start_date( $part_pkg->default_start_date );
320 =item insert [ OPTION => VALUE ... ]
322 Adds this billing item to the database ("Orders" the item). If there is an
323 error, returns the error, otherwise returns false.
325 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
326 will be used to look up the package definition and agent restrictions will be
329 If the additional field I<refnum> is defined, an FS::pkg_referral record will
330 be created and inserted. Multiple FS::pkg_referral records can be created by
331 setting I<refnum> to an array reference of refnums or a hash reference with
332 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
333 record will be created corresponding to cust_main.refnum.
335 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
336 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
337 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
338 It can be set as part of the hash when creating the object, or with the B<set>
341 The following options are available:
347 If set true, supresses actions that should only be taken for new package
348 orders. (Currently this includes: intro periods when delay_setup is on,
349 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
353 cust_pkg_option records will be created
357 a ticket will be added to this customer with this subject
361 an optional queue name for ticket additions
365 Don't check the legality of the package definition. This should be used
366 when performing a package change that doesn't change the pkgpart (i.e.
374 my( $self, %options ) = @_;
376 my $oldAutoCommit = $FS::UID::AutoCommit;
377 local $FS::UID::AutoCommit = 0;
381 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
383 my $part_pkg = $self->part_pkg;
385 if ( ! $import && ! $options{'change'} ) {
387 # set order date to now
388 $self->order_date(time) unless ($import && $self->order_date);
390 # if the package def says to start only on the first of the month:
391 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
392 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
393 $mon += 1 unless $mday == 1;
394 until ( $mon < 12 ) { $mon -= 12; $year++; }
395 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
398 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
399 # if the package was ordered on hold:
401 # - don't set the start date (it will be started manually)
402 $self->set('susp', $self->order_date);
403 $self->set('start_date', '');
405 # set expire/adjourn/contract_end timers, and free days, if appropriate
406 # and automatic package transfer, which can fail, so capture the result
407 $error = $self->set_initial_timers;
409 } # else this is a package change, and shouldn't have "new package" behavior
411 $error ||= $self->SUPER::insert($options{options} ? %{$options{options}} : ());
413 $dbh->rollback if $oldAutoCommit;
417 $self->refnum($self->cust_main->refnum) unless $self->refnum;
418 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
419 $self->process_m2m( 'link_table' => 'pkg_referral',
420 'target_table' => 'part_referral',
421 'params' => $self->refnum,
424 if ( $self->hashref->{cust_pkg_usageprice} ) {
425 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
426 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
427 my $error = $cust_pkg_usageprice->insert;
429 $dbh->rollback if $oldAutoCommit;
435 if ( $self->setup_discountnum || $self->recur_discountnum ) {
436 my $error = $self->insert_discount();
438 $dbh->rollback if $oldAutoCommit;
443 my $conf = new FS::Conf;
445 if ($self->locationnum) {
447 map qsearch( 'part_export', {exportnum=>$_} ),
448 $conf->config('cust_location-exports'); #, $agentnum
450 foreach my $part_export ( @part_export ) {
451 my $error = $part_export->export_pkg_location($self); #, @$export_args);
453 $dbh->rollback if $oldAutoCommit;
454 return "exporting to ". $part_export->exporttype.
455 " (transaction rolled back): $error";
460 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
462 #this init stuff is still inefficient, but at least its limited to
463 # the small number (any?) folks using ticket emailing on pkg order
466 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
473 use FS::TicketSystem;
474 FS::TicketSystem->init();
476 my $q = new RT::Queue($RT::SystemUser);
477 $q->Load($options{ticket_queue}) if $options{ticket_queue};
478 my $t = new RT::Ticket($RT::SystemUser);
479 my $mime = new MIME::Entity;
480 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
481 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
482 Subject => $options{ticket_subject},
485 $t->AddLink( Type => 'MemberOf',
486 Target => 'freeside://freeside/cust_main/'. $self->custnum,
490 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
491 my $queue = new FS::queue {
492 'job' => 'FS::cust_main::queueable_print',
494 $error = $queue->insert(
495 'custnum' => $self->custnum,
496 'template' => 'welcome_letter',
500 warn "can't send welcome letter: $error";
505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
512 This method now works but you probably shouldn't use it.
514 You don't want to delete packages, because there would then be no record
515 the customer ever purchased the package. Instead, see the cancel method and
516 hide cancelled packages.
520 # this is still used internally to abort future package changes, so it
526 # The following foreign keys to cust_pkg are not cleaned up here, and will
527 # cause package deletion to fail:
529 # cust_credit.pkgnum and commission_pkgnum (and cust_credit_void)
530 # cust_credit_bill.pkgnum
531 # cust_pay_pending.pkgnum
532 # cust_pay.pkgnum (and cust_pay_void)
533 # cust_bill_pay.pkgnum (wtf, shouldn't reference pkgnum)
534 # cust_pkg_usage.pkgnum
535 # cust_pkg.uncancel_pkgnum, change_pkgnum, main_pkgnum, and change_to_pkgnum
537 # cust_svc is handled by canceling the package before deleting it
538 # cust_pkg_option is handled via option_Common
540 my $oldAutoCommit = $FS::UID::AutoCommit;
541 local $FS::UID::AutoCommit = 0;
544 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
545 my $error = $cust_pkg_discount->delete;
547 $dbh->rollback if $oldAutoCommit;
551 #cust_bill_pkg_discount?
553 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
554 my $error = $cust_pkg_detail->delete;
556 $dbh->rollback if $oldAutoCommit;
561 foreach my $cust_pkg_reason (
563 'table' => 'cust_pkg_reason',
564 'hashref' => { 'pkgnum' => $self->pkgnum },
568 my $error = $cust_pkg_reason->delete;
570 $dbh->rollback if $oldAutoCommit;
575 foreach my $pkg_referral ( $self->pkg_referral ) {
576 my $error = $pkg_referral->delete;
578 $dbh->rollback if $oldAutoCommit;
583 my $error = $self->SUPER::delete(@_);
585 $dbh->rollback if $oldAutoCommit;
589 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
595 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
597 Replaces the OLD_RECORD with this one in the database. If there is an error,
598 returns the error, otherwise returns false.
600 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
602 Changing pkgpart may have disasterous effects. See the order subroutine.
604 setup and bill are normally updated by calling the bill method of a customer
605 object (see L<FS::cust_main>).
607 suspend is normally updated by the suspend and unsuspend methods.
609 cancel is normally updated by the cancel method (and also the order subroutine
612 Available options are:
618 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.
622 the access_user (see L<FS::access_user>) providing the reason
626 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
635 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
640 ( ref($_[0]) eq 'HASH' )
644 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
645 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
648 #return "Can't change setup once it exists!"
649 # if $old->getfield('setup') &&
650 # $old->getfield('setup') != $new->getfield('setup');
652 #some logic for bill, susp, cancel?
654 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
656 my $oldAutoCommit = $FS::UID::AutoCommit;
657 local $FS::UID::AutoCommit = 0;
660 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
661 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
662 my $error = $new->insert_reason(
663 'reason' => $options->{'reason'},
664 'date' => $new->$method,
666 'reason_otaker' => $options->{'reason_otaker'},
669 dbh->rollback if $oldAutoCommit;
670 return "Error inserting cust_pkg_reason: $error";
675 #save off and freeze RADIUS attributes for any associated svc_acct records
677 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
679 #also check for specific exports?
680 # to avoid spurious modify export events
681 @svc_acct = map { $_->svc_x }
682 grep { $_->part_svc->svcdb eq 'svc_acct' }
685 $_->snapshot foreach @svc_acct;
689 my $error = $new->export_pkg_change($old)
690 || $new->SUPER::replace( $old,
692 ? $options->{options}
696 $dbh->rollback if $oldAutoCommit;
700 #for prepaid packages,
701 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
702 foreach my $old_svc_acct ( @svc_acct ) {
703 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
705 $new_svc_acct->replace( $old_svc_acct,
706 'depend_jobnum' => $options->{depend_jobnum},
709 $dbh->rollback if $oldAutoCommit;
714 # also run exports if removing locationnum?
715 # doesn't seem to happen, and we don't export blank locationnum on insert...
716 if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
717 my $conf = new FS::Conf;
719 map qsearch( 'part_export', {exportnum=>$_} ),
720 $conf->config('cust_location-exports'); #, $agentnum
722 foreach my $part_export ( @part_export ) {
723 my $error = $part_export->export_pkg_location($new); #, @$export_args);
725 $dbh->rollback if $oldAutoCommit;
726 return "exporting to ". $part_export->exporttype.
727 " (transaction rolled back): $error";
732 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
739 Checks all fields to make sure this is a valid billing item. If there is an
740 error, returns the error, otherwise returns false. Called by the insert and
748 if ( !$self->locationnum or $self->locationnum == -1 ) {
749 $self->set('locationnum', $self->cust_main->ship_locationnum);
753 $self->ut_numbern('pkgnum')
754 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
755 || $self->ut_numbern('pkgpart')
756 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
757 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
758 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
759 || $self->ut_numbern('quantity')
760 || $self->ut_numbern('start_date')
761 || $self->ut_numbern('setup')
762 || $self->ut_numbern('bill')
763 || $self->ut_numbern('susp')
764 || $self->ut_numbern('cancel')
765 || $self->ut_numbern('adjourn')
766 || $self->ut_numbern('resume')
767 || $self->ut_numbern('expire')
768 || $self->ut_numbern('dundate')
769 || $self->ut_flag('no_auto', [ '', 'Y' ])
770 || $self->ut_flag('waive_setup', [ '', 'Y' ])
771 || $self->ut_flag('separate_bill')
772 || $self->ut_textn('agent_pkgid')
773 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
774 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
775 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
776 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
777 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
779 return $error if $error;
781 return "A package with both start date (future start) and setup date (already started) will never bill"
782 if $self->start_date && $self->setup && ! $upgrade;
784 return "A future unsuspend date can only be set for a package with a suspend date"
785 if $self->resume and !$self->susp and !$self->adjourn;
787 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
789 if ( $self->dbdef_table->column('manual_flag') ) {
790 $self->manual_flag('') if $self->manual_flag eq ' ';
791 $self->manual_flag =~ /^([01]?)$/
792 or return "Illegal manual_flag ". $self->manual_flag;
793 $self->manual_flag($1);
801 Check the pkgpart to make sure it's allowed with the reg_code and/or
802 promo_code of the package (if present) and with the customer's agent.
803 Called from C<insert>, unless we are doing a package change that doesn't
811 # my $error = $self->ut_numbern('pkgpart'); # already done
814 if ( $self->reg_code ) {
816 unless ( grep { $self->pkgpart == $_->pkgpart }
817 map { $_->reg_code_pkg }
818 qsearchs( 'reg_code', { 'code' => $self->reg_code,
819 'agentnum' => $self->cust_main->agentnum })
821 return "Unknown registration code";
824 } elsif ( $self->promo_code ) {
827 qsearchs('part_pkg', {
828 'pkgpart' => $self->pkgpart,
829 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
831 return 'Unknown promotional code' unless $promo_part_pkg;
835 unless ( $disable_agentcheck ) {
837 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
838 return "agent ". $agent->agentnum. ':'. $agent->agent.
839 " can't purchase pkgpart ". $self->pkgpart
840 unless $agent->pkgpart_hashref->{ $self->pkgpart }
841 || $agent->agentnum == $self->part_pkg->agentnum;
844 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
845 return $error if $error;
853 =item cancel [ OPTION => VALUE ... ]
855 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
856 in this package, then cancels the package itself (sets the cancel field to
859 Available options are:
863 =item quiet - can be set true to supress email cancellation notices.
865 =item time - can be set to cancel the package based on a specific future or
866 historical date. Using time ensures that the remaining amount is calculated
867 correctly. Note however that this is an immediate cancel and just changes
868 the date. You are PROBABLY looking to expire the account instead of using
871 =item reason - can be set to a cancellation reason (see L<FS:reason>),
872 either a reasonnum of an existing reason, or passing a hashref will create
873 a new reason. The hashref should have the following keys: typenum - Reason
874 type (see L<FS::reason_type>, reason - Text of the new reason.
876 =item date - can be set to a unix style timestamp to specify when to
879 =item nobill - can be set true to skip billing if it might otherwise be done.
881 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
882 not credit it. This must be set (by change()) when changing the package
883 to a different pkgpart or location, and probably shouldn't be in any other
884 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
887 =item no_delay_cancel - prevents delay_cancel behavior
888 no matter what other options say, for use when changing packages (or any
889 other time you're really sure you want an immediate cancel)
893 If there is an error, returns the error, otherwise returns false.
897 #NOT DOCUMENTING - this should only be used when calling recursively
898 #=item delay_cancel - for internal use, to allow proper handling of
899 #supplemental packages when the main package is flagged to suspend
900 #before cancelling, probably shouldn't be used otherwise (set the
901 #corresponding package option instead)
904 my( $self, %options ) = @_;
907 # supplemental packages can now be separately canceled, though the UI
908 # shouldn't permit it
910 ## pass all suspend/cancel actions to the main package
911 ## (unless the pkglinknum has been removed, then the link is defunct and
912 ## this package can be canceled on its own)
913 #if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
914 # return $self->main_pkg->cancel(%options);
917 my $conf = new FS::Conf;
919 warn "cust_pkg::cancel called with options".
920 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
923 my $oldAutoCommit = $FS::UID::AutoCommit;
924 local $FS::UID::AutoCommit = 0;
927 my $old = $self->select_for_update;
929 if ( $old->get('cancel') || $self->get('cancel') ) {
930 dbh->rollback if $oldAutoCommit;
931 return ""; # no error
934 # XXX possibly set cancel_time to the expire date?
935 my $cancel_time = $options{'time'} || time;
936 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
937 $date = '' if ($date && $date <= $cancel_time); # complain instead?
939 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
940 if ( !$date && $self->part_pkg->option('delay_cancel',1)
941 && (($self->status eq 'active') || ($self->status eq 'suspended'))
942 && !$options{'no_delay_cancel'}
944 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
945 my $expsecs = 60*60*24*$expdays;
946 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
947 $expsecs = $expsecs - $suspfor if $suspfor;
948 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
950 $date = $cancel_time + $expsecs;
954 #race condition: usage could be ongoing until unprovisioned
955 #resolved by performing a change package instead (which unprovisions) and
957 if ( !$options{nobill} && !$date ) {
958 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
959 my $copy = $self->new({$self->hash});
961 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
963 'time' => $cancel_time );
964 warn "Error billing during cancel, custnum ".
965 #$self->cust_main->custnum. ": $error"
970 if ( $options{'reason'} ) {
971 $error = $self->insert_reason( 'reason' => $options{'reason'},
972 'action' => $date ? 'expire' : 'cancel',
973 'date' => $date ? $date : $cancel_time,
974 'reason_otaker' => $options{'reason_otaker'},
977 dbh->rollback if $oldAutoCommit;
978 return "Error inserting cust_pkg_reason: $error";
982 my %svc_cancel_opt = ();
983 $svc_cancel_opt{'date'} = $date if $date;
984 foreach my $cust_svc (
987 sort { $a->[1] <=> $b->[1] }
988 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
989 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
991 my $part_svc = $cust_svc->part_svc;
992 next if ( defined($part_svc) and $part_svc->preserve );
993 my $error = $cust_svc->cancel( %svc_cancel_opt );
996 $dbh->rollback if $oldAutoCommit;
997 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
1002 # if a reasonnum was passed, get the actual reason object so we can check
1006 if ($options{'reason'} =~ /^\d+$/) {
1007 $reason = FS::reason->by_key($options{'reason'});
1011 # credit remaining time if any of these are true:
1012 # - unused_credit => 1 was passed (this happens when canceling a package
1013 # for a package change when unused_credit_change is set)
1014 # - no unused_credit option, and there is a cancel reason, and the cancel
1015 # reason says to credit the package
1016 # - no unused_credit option, and the package definition says to credit the
1017 # package on cancellation
1019 if ( exists($options{'unused_credit'}) ) {
1020 $do_credit = $options{'unused_credit'};
1021 } elsif ( defined($reason) && $reason->unused_credit ) {
1024 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
1027 my $error = $self->credit_remaining('cancel', $cancel_time);
1029 $dbh->rollback if $oldAutoCommit;
1035 my %hash = $self->hash;
1037 $hash{'expire'} = $date;
1038 if ($delay_cancel) {
1039 # just to be sure these are clear
1040 $hash{'adjourn'} = undef;
1041 $hash{'resume'} = undef;
1044 $hash{'cancel'} = $cancel_time;
1046 $hash{'change_custnum'} = $options{'change_custnum'};
1048 # if this is a supplemental package that's lost its part_pkg_link, and it's
1049 # being canceled for real, unlink it completely
1050 if ( !$date and ! $self->pkglinknum ) {
1051 $hash{main_pkgnum} = '';
1054 # if there is a future package change scheduled, unlink from it (like
1055 # abort_change) first, then delete it.
1056 $hash{'change_to_pkgnum'} = '';
1058 # save the package state
1059 my $new = new FS::cust_pkg ( \%hash );
1060 $error = $new->replace( $self, options => { $self->options } );
1062 if ( $self->change_to_pkgnum ) {
1063 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1064 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1067 $dbh->rollback if $oldAutoCommit;
1071 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1072 $error = $supp_pkg->cancel(%options,
1074 'date' => $date, #in case it got changed by delay_cancel
1075 'delay_cancel' => $delay_cancel,
1078 $dbh->rollback if $oldAutoCommit;
1079 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1083 if ($delay_cancel && !$options{'from_main'}) {
1084 $error = $new->suspend(
1086 'time' => $cancel_time
1091 foreach my $usage ( $self->cust_pkg_usage ) {
1092 $error = $usage->delete;
1094 $dbh->rollback if $oldAutoCommit;
1095 return "deleting usage pools: $error";
1100 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1101 return '' if $date; #no errors
1103 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
1104 if ( !$options{'quiet'} &&
1105 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
1107 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1110 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1111 $error = $msg_template->send( 'cust_main' => $self->cust_main,
1112 'object' => $self );
1114 #should this do something on errors?
1121 =item cancel_if_expired [ NOW_TIMESTAMP ]
1123 Cancels this package if its expire date has been reached.
1127 sub cancel_if_expired {
1129 my $time = shift || time;
1130 return '' unless $self->expire && $self->expire <= $time;
1131 my $error = $self->cancel;
1133 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1134 $self->custnum. ": $error";
1141 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1142 locationnum, (other fields?). Attempts to re-provision cancelled services
1143 using history information (errors at this stage are not fatal).
1145 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1147 svc_fatal: service provisioning errors are fatal
1149 svc_errors: pass an array reference, will be filled in with any provisioning errors
1151 main_pkgnum: link the package as a supplemental package of this one. For
1157 my( $self, %options ) = @_;
1159 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1160 return '' unless $self->get('cancel');
1162 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1163 return $self->main_pkg->uncancel(%options);
1170 my $oldAutoCommit = $FS::UID::AutoCommit;
1171 local $FS::UID::AutoCommit = 0;
1175 # insert the new package
1178 my $cust_pkg = new FS::cust_pkg {
1179 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1180 bill => ( $options{'bill'} || $self->get('bill') ),
1182 uncancel_pkgnum => $self->pkgnum,
1183 main_pkgnum => ($options{'main_pkgnum'} || ''),
1184 map { $_ => $self->get($_) } qw(
1185 custnum pkgpart locationnum
1187 susp adjourn resume expire start_date contract_end dundate
1188 change_date change_pkgpart change_locationnum
1189 manual_flag no_auto separate_bill quantity agent_pkgid
1190 recur_show_zero setup_show_zero
1194 my $error = $cust_pkg->insert(
1195 'change' => 1, #supresses any referral credit to a referring customer
1196 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1199 $dbh->rollback if $oldAutoCommit;
1207 #find historical services within this timeframe before the package cancel
1208 # (incompatible with "time" option to cust_pkg->cancel?)
1209 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1210 # too little? (unprovisioing export delay?)
1211 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1212 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1215 foreach my $h_cust_svc (@h_cust_svc) {
1216 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1217 #next unless $h_svc_x; #should this happen?
1218 (my $table = $h_svc_x->table) =~ s/^h_//;
1219 require "FS/$table.pm";
1220 my $class = "FS::$table";
1221 my $svc_x = $class->new( {
1222 'pkgnum' => $cust_pkg->pkgnum,
1223 'svcpart' => $h_cust_svc->svcpart,
1224 map { $_ => $h_svc_x->get($_) } fields($table)
1228 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1229 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1232 my $svc_error = $svc_x->insert;
1234 if ( $options{svc_fatal} ) {
1235 $dbh->rollback if $oldAutoCommit;
1238 # if we've failed to insert the svc_x object, svc_Common->insert
1239 # will have removed the cust_svc already. if not, then both records
1240 # were inserted but we failed for some other reason (export, most
1241 # likely). in that case, report the error and delete the records.
1242 push @svc_errors, $svc_error;
1243 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1245 # except if export_insert failed, export_delete probably won't be
1247 local $FS::svc_Common::noexport_hack = 1;
1248 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1249 if ( $cleanup_error ) { # and if THAT fails, then run away
1250 $dbh->rollback if $oldAutoCommit;
1251 return $cleanup_error;
1256 } #foreach $h_cust_svc
1258 #these are pretty rare, but should handle them
1259 # - dsl_device (mac addresses)
1260 # - phone_device (mac addresses)
1261 # - dsl_note (ikano notes)
1262 # - domain_record (i.e. restore DNS information w/domains)
1263 # - inventory_item(?) (inventory w/un-cancelling service?)
1264 # - nas (svc_broaband nas stuff)
1265 #this stuff is unused in the wild afaik
1266 # - mailinglistmember
1268 # - svc_domain.parent_svcnum?
1269 # - acct_snarf (ancient mail fetching config)
1270 # - cgp_rule (communigate)
1271 # - cust_svc_option (used by our Tron stuff)
1272 # - acct_rt_transaction (used by our time worked stuff)
1275 # also move over any services that didn't unprovision at cancellation
1278 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1279 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1280 my $error = $cust_svc->replace;
1282 $dbh->rollback if $oldAutoCommit;
1288 # Uncancel any supplemental packages, and make them supplemental to the
1292 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1294 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1296 $dbh->rollback if $oldAutoCommit;
1297 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1305 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1307 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1308 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1315 Cancels any pending expiration (sets the expire field to null).
1317 If there is an error, returns the error, otherwise returns false.
1322 my( $self, %options ) = @_;
1325 my $oldAutoCommit = $FS::UID::AutoCommit;
1326 local $FS::UID::AutoCommit = 0;
1329 my $old = $self->select_for_update;
1331 my $pkgnum = $old->pkgnum;
1332 if ( $old->get('cancel') || $self->get('cancel') ) {
1333 dbh->rollback if $oldAutoCommit;
1334 return "Can't unexpire cancelled package $pkgnum";
1335 # or at least it's pointless
1338 unless ( $old->get('expire') && $self->get('expire') ) {
1339 dbh->rollback if $oldAutoCommit;
1340 return ""; # no error
1343 my %hash = $self->hash;
1344 $hash{'expire'} = '';
1345 my $new = new FS::cust_pkg ( \%hash );
1346 $error = $new->replace( $self, options => { $self->options } );
1348 $dbh->rollback if $oldAutoCommit;
1352 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1358 =item suspend [ OPTION => VALUE ... ]
1360 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1361 package, then suspends the package itself (sets the susp field to now).
1363 Available options are:
1367 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1368 either a reasonnum of an existing reason, or passing a hashref will create
1369 a new reason. The hashref should have the following keys:
1370 - typenum - Reason type (see L<FS::reason_type>
1371 - reason - Text of the new reason.
1373 =item date - can be set to a unix style timestamp to specify when to
1376 =item time - can be set to override the current time, for calculation
1377 of final invoices or unused-time credits
1379 =item resume_date - can be set to a time when the package should be
1380 unsuspended. This may be more convenient than calling C<unsuspend()>
1383 =item from_main - allows a supplemental package to be suspended, rather
1384 than redirecting the method call to its main package. For internal use.
1386 =item from_cancel - used when suspending from the cancel method, forces
1387 this to skip everything besides basic suspension. For internal use.
1391 If there is an error, returns the error, otherwise returns false.
1396 my( $self, %options ) = @_;
1399 # supplemental packages still can't be separately suspended, but silently
1400 # exit instead of failing or passing the action to the main package (so
1401 # that the "Suspend customer" action doesn't trip over the supplemental
1404 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1408 my $oldAutoCommit = $FS::UID::AutoCommit;
1409 local $FS::UID::AutoCommit = 0;
1412 my $old = $self->select_for_update;
1414 my $pkgnum = $old->pkgnum;
1415 if ( $old->get('cancel') || $self->get('cancel') ) {
1416 dbh->rollback if $oldAutoCommit;
1417 return "Can't suspend cancelled package $pkgnum";
1420 if ( $old->get('susp') || $self->get('susp') ) {
1421 dbh->rollback if $oldAutoCommit;
1422 return ""; # no error # complain on adjourn?
1425 my $suspend_time = $options{'time'} || time;
1426 my $date = $options{date} if $options{date}; # adjourn/suspend later
1427 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1429 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1430 dbh->rollback if $oldAutoCommit;
1431 return "Package $pkgnum expires before it would be suspended.";
1434 # some false laziness with sub cancel
1435 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1436 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1437 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1438 # make the entire cust_main->bill path recognize 'suspend' and
1439 # 'cancel' separately.
1440 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1441 my $copy = $self->new({$self->hash});
1443 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1445 'time' => $suspend_time );
1446 warn "Error billing during suspend, custnum ".
1447 #$self->cust_main->custnum. ": $error"
1452 my $cust_pkg_reason;
1453 if ( $options{'reason'} ) {
1454 $error = $self->insert_reason( 'reason' => $options{'reason'},
1455 'action' => $date ? 'adjourn' : 'suspend',
1456 'date' => $date ? $date : $suspend_time,
1457 'reason_otaker' => $options{'reason_otaker'},
1460 dbh->rollback if $oldAutoCommit;
1461 return "Error inserting cust_pkg_reason: $error";
1463 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1464 'date' => $date ? $date : $suspend_time,
1465 'action' => $date ? 'A' : 'S',
1466 'pkgnum' => $self->pkgnum,
1470 # if a reasonnum was passed, get the actual reason object so we can check
1472 # (passing a reason hashref is still allowed, but it can't be used with
1473 # the fancy behavioral options.)
1476 if ($options{'reason'} =~ /^\d+$/) {
1477 $reason = FS::reason->by_key($options{'reason'});
1480 my %hash = $self->hash;
1482 $hash{'adjourn'} = $date;
1484 $hash{'susp'} = $suspend_time;
1487 my $resume_date = $options{'resume_date'} || 0;
1488 if ( $resume_date > ($date || $suspend_time) ) {
1489 $hash{'resume'} = $resume_date;
1492 $options{options} ||= {};
1494 my $new = new FS::cust_pkg ( \%hash );
1495 $error = $new->replace( $self, options => { $self->options,
1496 %{ $options{options} },
1500 $dbh->rollback if $oldAutoCommit;
1504 unless ( $date ) { # then we are suspending now
1506 unless ($options{'from_cancel'}) {
1507 # credit remaining time if appropriate
1508 # (if required by the package def, or the suspend reason)
1509 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1510 || ( defined($reason) && $reason->unused_credit );
1512 if ( $unused_credit ) {
1513 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1514 my $error = $self->credit_remaining('suspend', $suspend_time);
1516 $dbh->rollback if $oldAutoCommit;
1522 my @cust_svc = qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
1524 #attempt ordering ala cust_svc_suspend_cascade (without infinite-looping
1525 # on the circular dep case)
1526 # (this is too simple for multi-level deps, we need to use something
1527 # to resolve the DAG properly when possible)
1529 $svcpart{$_->svcpart} = 0 foreach @cust_svc;
1530 foreach my $svcpart ( keys %svcpart ) {
1531 foreach my $part_svc_link (
1532 FS::part_svc_link->by_agentnum($self->cust_main->agentnum,
1533 src_svcpart => $svcpart,
1534 link_type => 'cust_svc_suspend_cascade'
1537 $svcpart{$part_svc_link->dst_svcpart} = max(
1538 $svcpart{$part_svc_link->dst_svcpart},
1539 $svcpart{$part_svc_link->src_svcpart} + 1
1543 @cust_svc = sort { $svcpart{ $a->svcpart } <=> $svcpart{ $b->svcpart } }
1547 foreach my $cust_svc ( @cust_svc ) {
1548 $cust_svc->suspend( 'labels_arrayref' => \@labels );
1551 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1552 # and this is not a suspend-before-cancel
1553 if ( $cust_pkg_reason ) {
1554 my $reason_obj = $cust_pkg_reason->reason;
1555 if ( $reason_obj->feepart and
1556 ! $reason_obj->fee_on_unsuspend and
1557 ! $options{'from_cancel'} ) {
1559 # register the need to charge a fee, cust_main->bill will do the rest
1560 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1562 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1563 'pkgreasonnum' => $cust_pkg_reason->num,
1564 'pkgnum' => $self->pkgnum,
1565 'feepart' => $reason->feepart,
1566 'nextbill' => $reason->fee_hold,
1568 $error ||= $cust_pkg_reason_fee->insert;
1572 my $conf = new FS::Conf;
1573 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1575 my $error = send_email(
1576 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1577 #invoice_from ??? well as good as any
1578 'to' => $conf->config('suspend_email_admin'),
1579 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1581 "This is an automatic message from your Freeside installation\n",
1582 "informing you that the following customer package has been suspended:\n",
1584 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1585 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1586 ( map { "Service : $_\n" } @labels ),
1588 'custnum' => $self->custnum,
1589 'msgtype' => 'admin'
1593 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1601 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1602 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1604 $dbh->rollback if $oldAutoCommit;
1605 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1609 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1614 =item credit_remaining MODE TIME
1616 Generate a credit for this package for the time remaining in the current
1617 billing period. MODE is either "suspend" or "cancel" (determines the
1618 credit type). TIME is the time of suspension/cancellation. Both arguments
1623 # Implementation note:
1625 # If you pkgpart-change a package that has been billed, and it's set to give
1626 # credit on package change, then this method gets called and then the new
1627 # package will have no last_bill date. Therefore the customer will be credited
1628 # only once (per billing period) even if there are multiple package changes.
1630 # If you location-change a package that has been billed, this method will NOT
1631 # be called and the new package WILL have the last bill date of the old
1634 # If the new package is then canceled within the same billing cycle,
1635 # credit_remaining needs to run calc_remain on the OLD package to determine
1636 # the amount of unused time to credit.
1638 sub credit_remaining {
1639 # Add a credit for remaining service
1640 my ($self, $mode, $time) = @_;
1641 die 'credit_remaining requires suspend or cancel'
1642 unless $mode eq 'suspend' or $mode eq 'cancel';
1643 die 'no suspend/cancel time' unless $time > 0;
1645 my $conf = FS::Conf->new;
1646 my $reason_type = $conf->config($mode.'_credit_type');
1648 my $last_bill = $self->getfield('last_bill') || 0;
1649 my $next_bill = $self->getfield('bill') || 0;
1650 if ( $last_bill > 0 # the package has been billed
1651 and $next_bill > 0 # the package has a next bill date
1652 and $next_bill >= $time # which is in the future
1654 my @cust_credit_source_bill_pkg = ();
1655 my $remaining_value = 0;
1657 my $remain_pkg = $self;
1658 $remaining_value = $remain_pkg->calc_remain(
1660 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1663 # we may have to walk back past some package changes to get to the
1664 # one that actually has unused time
1665 while ( $remaining_value == 0 ) {
1666 if ( $remain_pkg->change_pkgnum ) {
1667 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1669 # the package has really never been billed
1672 $remaining_value = $remain_pkg->calc_remain(
1674 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1678 if ( $remaining_value > 0 ) {
1679 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1681 my $error = $self->cust_main->credit(
1683 'Credit for unused time on '. $self->part_pkg->pkg,
1684 'reason_type' => $reason_type,
1685 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1687 return "Error crediting customer \$$remaining_value for unused time".
1688 " on ". $self->part_pkg->pkg. ": $error"
1690 } #if $remaining_value
1691 } #if $last_bill, etc.
1695 =item unsuspend [ OPTION => VALUE ... ]
1697 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1698 package, then unsuspends the package itself (clears the susp field and the
1699 adjourn field if it is in the past). If the suspend reason includes an
1700 unsuspension package, that package will be ordered.
1702 Available options are:
1708 Can be set to a date to unsuspend the package in the future (the 'resume'
1711 =item adjust_next_bill
1713 Can be set true to adjust the next bill date forward by
1714 the amount of time the account was inactive. This was set true by default
1715 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1716 explicitly requested with this option or in the price plan.
1720 If there is an error, returns the error, otherwise returns false.
1725 my( $self, %opt ) = @_;
1728 # pass all suspend/cancel actions to the main package
1729 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1730 return $self->main_pkg->unsuspend(%opt);
1733 my $oldAutoCommit = $FS::UID::AutoCommit;
1734 local $FS::UID::AutoCommit = 0;
1737 my $old = $self->select_for_update;
1739 my $pkgnum = $old->pkgnum;
1740 if ( $old->get('cancel') || $self->get('cancel') ) {
1741 $dbh->rollback if $oldAutoCommit;
1742 return "Can't unsuspend cancelled package $pkgnum";
1745 unless ( $old->get('susp') && $self->get('susp') ) {
1746 $dbh->rollback if $oldAutoCommit;
1747 return ""; # no error # complain instead?
1750 # handle the case of setting a future unsuspend (resume) date
1751 # and do not continue to actually unsuspend the package
1752 my $date = $opt{'date'};
1753 if ( $date and $date > time ) { # return an error if $date <= time?
1755 if ( $old->get('expire') && $old->get('expire') < $date ) {
1756 $dbh->rollback if $oldAutoCommit;
1757 return "Package $pkgnum expires before it would be unsuspended.";
1760 my $new = new FS::cust_pkg { $self->hash };
1761 $new->set('resume', $date);
1762 $error = $new->replace($self, options => $self->options);
1765 $dbh->rollback if $oldAutoCommit;
1769 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1775 if (!$self->setup) {
1776 # then this package is being released from on-hold status
1777 $error = $self->set_initial_timers;
1779 $dbh->rollback if $oldAutoCommit;
1786 foreach my $cust_svc (
1787 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1789 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1791 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1792 $dbh->rollback if $oldAutoCommit;
1793 return "Illegal svcdb value in part_svc!";
1796 require "FS/$svcdb.pm";
1798 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1800 $error = $svc->unsuspend;
1802 $dbh->rollback if $oldAutoCommit;
1805 my( $label, $value ) = $cust_svc->label;
1806 push @labels, "$label: $value";
1811 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1812 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1814 my %hash = $self->hash;
1815 my $inactive = time - $hash{'susp'};
1817 my $conf = new FS::Conf;
1819 #adjust the next bill date forward
1820 # increment next bill date if certain conditions are met:
1821 # - it was due to be billed at some point
1822 # - either the global or local config says to do this
1823 my $adjust_bill = 0;
1826 && ( $hash{'bill'} || $hash{'setup'} )
1827 && ( $opt{'adjust_next_bill'}
1828 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1829 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1836 # - the package billed during suspension
1837 # - or it was ordered on hold
1838 # - or the customer was credited for the unused time
1840 if ( $self->option('suspend_bill',1)
1841 or ( $self->part_pkg->option('suspend_bill',1)
1842 and ! $self->option('no_suspend_bill',1)
1844 or $hash{'order_date'} == $hash{'susp'}
1849 if ( $adjust_bill ) {
1850 if ( $self->part_pkg->option('unused_credit_suspend')
1851 or ( ref($reason) and $reason->unused_credit ) ) {
1852 # then the customer was credited for the unused time before suspending,
1853 # so their next bill should be immediate
1854 $hash{'bill'} = time;
1856 # add the length of time suspended to the bill date
1857 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1862 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1863 $hash{'resume'} = '' if !$hash{'adjourn'};
1864 my $new = new FS::cust_pkg ( \%hash );
1865 $error = $new->replace( $self, options => { $self->options } );
1867 $dbh->rollback if $oldAutoCommit;
1874 if ( $reason->unsuspend_pkgpart ) {
1875 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
1876 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1877 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1879 my $start_date = $self->cust_main->next_bill_date
1880 if $reason->unsuspend_hold;
1883 $unsusp_pkg = FS::cust_pkg->new({
1884 'custnum' => $self->custnum,
1885 'pkgpart' => $reason->unsuspend_pkgpart,
1886 'start_date' => $start_date,
1887 'locationnum' => $self->locationnum,
1888 # discount? probably not...
1891 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1894 # new way, using fees
1895 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1896 # register the need to charge a fee, cust_main->bill will do the rest
1897 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1899 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1900 'pkgreasonnum' => $cust_pkg_reason->num,
1901 'pkgnum' => $self->pkgnum,
1902 'feepart' => $reason->feepart,
1903 'nextbill' => $reason->fee_hold,
1905 $error ||= $cust_pkg_reason_fee->insert;
1909 $dbh->rollback if $oldAutoCommit;
1914 if ( $conf->config('unsuspend_email_admin') ) {
1916 my $error = send_email(
1917 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1918 #invoice_from ??? well as good as any
1919 'to' => $conf->config('unsuspend_email_admin'),
1920 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1921 "This is an automatic message from your Freeside installation\n",
1922 "informing you that the following customer package has been unsuspended:\n",
1924 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1925 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1926 ( map { "Service : $_\n" } @labels ),
1928 "An unsuspension fee was charged: ".
1929 $unsusp_pkg->part_pkg->pkg_comment."\n"
1933 'custnum' => $self->custnum,
1934 'msgtype' => 'admin',
1938 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1944 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1945 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1947 $dbh->rollback if $oldAutoCommit;
1948 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1952 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1959 Cancels any pending suspension (sets the adjourn field to null).
1961 If there is an error, returns the error, otherwise returns false.
1966 my( $self, %options ) = @_;
1969 my $oldAutoCommit = $FS::UID::AutoCommit;
1970 local $FS::UID::AutoCommit = 0;
1973 my $old = $self->select_for_update;
1975 my $pkgnum = $old->pkgnum;
1976 if ( $old->get('cancel') || $self->get('cancel') ) {
1977 dbh->rollback if $oldAutoCommit;
1978 return "Can't unadjourn cancelled package $pkgnum";
1979 # or at least it's pointless
1982 if ( $old->get('susp') || $self->get('susp') ) {
1983 dbh->rollback if $oldAutoCommit;
1984 return "Can't unadjourn suspended package $pkgnum";
1985 # perhaps this is arbitrary
1988 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1989 dbh->rollback if $oldAutoCommit;
1990 return ""; # no error
1993 my %hash = $self->hash;
1994 $hash{'adjourn'} = '';
1995 $hash{'resume'} = '';
1996 my $new = new FS::cust_pkg ( \%hash );
1997 $error = $new->replace( $self, options => { $self->options } );
1999 $dbh->rollback if $oldAutoCommit;
2003 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2010 =item change HASHREF | OPTION => VALUE ...
2012 Changes this package: cancels it and creates a new one, with a different
2013 pkgpart or locationnum or both. All services are transferred to the new
2014 package (no change will be made if this is not possible).
2016 Options may be passed as a list of key/value pairs or as a hash reference.
2023 New locationnum, to change the location for this package.
2027 New FS::cust_location object, to create a new location and assign it
2032 New FS::cust_main object, to create a new customer and assign the new package
2037 New pkgpart (see L<FS::part_pkg>).
2041 New refnum (see L<FS::part_referral>).
2045 New quantity; if unspecified, the new package will have the same quantity
2050 "New" (existing) FS::cust_pkg object. The package's services and other
2051 attributes will be transferred to this package.
2055 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2056 susp, adjourn, cancel, expire, and contract_end) to the new package.
2058 =item unprotect_svcs
2060 Normally, change() will rollback and return an error if some services
2061 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2062 If unprotect_svcs is true, this method will transfer as many services as
2063 it can and then unconditionally cancel the old package.
2067 If specified, sets this value for the contract_end date on the new package
2068 (without regard for keep_dates or the usual date-preservation behavior.)
2069 Will throw an error if defined but false; the UI doesn't allow editing
2070 this unless it already exists, making removal impossible to undo.
2074 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2075 cust_pkg must be specified (otherwise, what's the point?)
2077 Returns either the new FS::cust_pkg object or a scalar error.
2081 my $err_or_new_cust_pkg = $old_cust_pkg->change
2085 #used by change and change_later
2086 #didn't put with documented check methods because it depends on change-specific opts
2087 #and it also possibly edits the value of opts
2091 if ( defined($opt->{'contract_end'}) ) {
2092 my $current_contract_end = $self->get('contract_end');
2093 unless ($opt->{'contract_end'}) {
2094 if ($current_contract_end) {
2095 return "Cannot remove contract end date when changing packages";
2097 #shouldn't even pass this option if there's not a current value
2098 #but can be handled gracefully if the option is empty
2099 warn "Contract end date passed unexpectedly";
2100 delete $opt->{'contract_end'};
2104 unless ($current_contract_end) {
2105 #option shouldn't be passed, throw error if it's non-empty
2106 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2112 #some false laziness w/order
2115 my $opt = ref($_[0]) ? shift : { @_ };
2117 my $conf = new FS::Conf;
2119 # handle contract_end on cust_pkg same as passed option
2120 if ( $opt->{'cust_pkg'} ) {
2121 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2122 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2125 # check contract_end, prevent adding/removing
2126 my $error = $self->_check_change($opt);
2127 return $error if $error;
2129 # Transactionize this whole mess
2130 my $oldAutoCommit = $FS::UID::AutoCommit;
2131 local $FS::UID::AutoCommit = 0;
2134 if ( $opt->{'cust_location'} ) {
2135 $error = $opt->{'cust_location'}->find_or_insert;
2137 $dbh->rollback if $oldAutoCommit;
2138 return "creating location record: $error";
2140 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2143 # Before going any further here: if the package is still in the pre-setup
2144 # state, it's safe to modify it in place. No need to charge/credit for
2145 # partial period, transfer services, transfer usage pools, copy invoice
2146 # details, or change any dates.
2147 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2148 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2149 if ( length($opt->{$_}) ) {
2150 $self->set($_, $opt->{$_});
2153 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2155 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2156 $error ||= $self->set_initial_timers;
2158 # but if contract_end was explicitly specified, that overrides all else
2159 $self->set('contract_end', $opt->{'contract_end'})
2160 if $opt->{'contract_end'};
2161 $error ||= $self->replace;
2163 $dbh->rollback if $oldAutoCommit;
2164 return "modifying package: $error";
2166 $dbh->commit if $oldAutoCommit;
2175 $hash{'setup'} = $time if $self->get('setup');
2177 $hash{'change_date'} = $time;
2178 $hash{"change_$_"} = $self->$_()
2179 foreach qw( pkgnum pkgpart locationnum );
2181 if ( $opt->{'cust_pkg'} ) {
2182 # treat changing to a package with a different pkgpart as a
2183 # pkgpart change (because it is)
2184 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2187 # whether to override pkgpart checking on the new package
2188 my $same_pkgpart = 1;
2189 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2193 my $unused_credit = 0;
2194 my $keep_dates = $opt->{'keep_dates'};
2196 # Special case. If the pkgpart is changing, and the customer is going to be
2197 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2198 # and DO pass the flag to cancel() to credit the customer. If the old
2199 # package had a setup date, set the new package's setup to the package
2200 # change date so that it has the same status as before.
2201 if ( $opt->{'pkgpart'}
2202 and $opt->{'pkgpart'} != $self->pkgpart
2203 and $self->part_pkg->option('unused_credit_change', 1) ) {
2206 $hash{'last_bill'} = '';
2210 if ( $keep_dates ) {
2211 foreach my $date ( qw(setup bill last_bill) ) {
2212 $hash{$date} = $self->getfield($date);
2215 # always keep the following dates
2216 foreach my $date (qw(order_date susp adjourn cancel expire resume
2217 start_date contract_end)) {
2218 $hash{$date} = $self->getfield($date);
2220 # but if contract_end was explicitly specified, that overrides all else
2221 $hash{'contract_end'} = $opt->{'contract_end'}
2222 if $opt->{'contract_end'};
2224 # allow $opt->{'locationnum'} = '' to specifically set it to null
2225 # (i.e. customer default location)
2226 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2228 # usually this doesn't matter. the two cases where it does are:
2229 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2231 # 2. (more importantly) changing a package before it's billed
2232 $hash{'waive_setup'} = $self->waive_setup;
2234 # if this package is scheduled for a future package change, preserve that
2235 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2237 my $custnum = $self->custnum;
2238 if ( $opt->{cust_main} ) {
2239 my $cust_main = $opt->{cust_main};
2240 unless ( $cust_main->custnum ) {
2241 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2243 $dbh->rollback if $oldAutoCommit;
2244 return "inserting customer record: $error";
2247 $custnum = $cust_main->custnum;
2250 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2253 if ( $opt->{'cust_pkg'} ) {
2254 # The target package already exists; update it to show that it was
2255 # changed from this package.
2256 $cust_pkg = $opt->{'cust_pkg'};
2258 # follow all the above rules for date changes, etc.
2259 foreach (keys %hash) {
2260 $cust_pkg->set($_, $hash{$_});
2262 # except those that implement the future package change behavior
2263 foreach (qw(change_to_pkgnum start_date expire)) {
2264 $cust_pkg->set($_, '');
2267 $error = $cust_pkg->replace;
2270 # Create the new package.
2271 $cust_pkg = new FS::cust_pkg {
2272 custnum => $custnum,
2273 locationnum => $opt->{'locationnum'},
2274 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2275 qw( pkgpart quantity refnum salesnum )
2279 $error = $cust_pkg->insert( 'change' => 1,
2280 'allow_pkgpart' => $same_pkgpart );
2283 $dbh->rollback if $oldAutoCommit;
2284 return "inserting new package: $error";
2287 # Transfer services and cancel old package.
2288 # Enforce service limits only if this is a pkgpart change.
2289 local $FS::cust_svc::ignore_quantity;
2290 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2291 $error = $self->transfer($cust_pkg);
2292 if ($error and $error == 0) {
2293 # $old_pkg->transfer failed.
2294 $dbh->rollback if $oldAutoCommit;
2295 return "transferring $error";
2298 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2299 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2300 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2301 if ($error and $error == 0) {
2302 # $old_pkg->transfer failed.
2303 $dbh->rollback if $oldAutoCommit;
2304 return "converting $error";
2308 # We set unprotect_svcs when executing a "future package change". It's
2309 # not a user-interactive operation, so returning an error means the
2310 # package change will just fail. Rather than have that happen, we'll
2311 # let leftover services be deleted.
2312 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2313 # Transfers were successful, but we still had services left on the old
2314 # package. We can't change the package under this circumstances, so abort.
2315 $dbh->rollback if $oldAutoCommit;
2316 return "unable to transfer all services";
2319 #reset usage if changing pkgpart
2320 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2321 if ($self->pkgpart != $cust_pkg->pkgpart) {
2322 my $part_pkg = $cust_pkg->part_pkg;
2323 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2327 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2330 $dbh->rollback if $oldAutoCommit;
2331 return "setting usage values: $error";
2334 # if NOT changing pkgpart, transfer any usage pools over
2335 foreach my $usage ($self->cust_pkg_usage) {
2336 $usage->set('pkgnum', $cust_pkg->pkgnum);
2337 $error = $usage->replace;
2339 $dbh->rollback if $oldAutoCommit;
2340 return "transferring usage pools: $error";
2345 # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2346 if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2347 my @old_cust_pkg_usageprice;
2348 if ($opt->{'cust_pkg_usageprice'}) {
2349 @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2351 @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2353 foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2354 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2355 'pkgnum' => $cust_pkg->pkgnum,
2356 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2357 'quantity' => $old_cust_pkg_usageprice->quantity,
2359 $error = $new_cust_pkg_usageprice->insert;
2361 $dbh->rollback if $oldAutoCommit;
2362 return "Error transferring usage pricing add-on: $error";
2367 # transfer discounts, if we're not changing pkgpart
2368 if ( $same_pkgpart ) {
2369 foreach my $old_discount ($self->cust_pkg_discount_active) {
2370 # don't remove the old discount, we may still need to bill that package.
2371 my $new_discount = new FS::cust_pkg_discount {
2372 'pkgnum' => $cust_pkg->pkgnum,
2373 'discountnum' => $old_discount->discountnum,
2374 'months_used' => $old_discount->months_used,
2376 $error = $new_discount->insert;
2378 $dbh->rollback if $oldAutoCommit;
2379 return "transferring discounts: $error";
2384 # transfer (copy) invoice details
2385 foreach my $detail ($self->cust_pkg_detail) {
2386 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2387 $new_detail->set('pkgdetailnum', '');
2388 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2389 $error = $new_detail->insert;
2391 $dbh->rollback if $oldAutoCommit;
2392 return "transferring package notes: $error";
2398 if ( !$opt->{'cust_pkg'} ) {
2399 # Order any supplemental packages.
2400 my $part_pkg = $cust_pkg->part_pkg;
2401 my @old_supp_pkgs = $self->supplemental_pkgs;
2402 foreach my $link ($part_pkg->supp_part_pkg_link) {
2404 foreach (@old_supp_pkgs) {
2405 if ($_->pkgpart == $link->dst_pkgpart) {
2407 $_->pkgpart(0); # so that it can't match more than once
2411 # false laziness with FS::cust_main::Packages::order_pkg
2412 my $new = FS::cust_pkg->new({
2413 pkgpart => $link->dst_pkgpart,
2414 pkglinknum => $link->pkglinknum,
2415 custnum => $custnum,
2416 main_pkgnum => $cust_pkg->pkgnum,
2417 locationnum => $cust_pkg->locationnum,
2418 start_date => $cust_pkg->start_date,
2419 order_date => $cust_pkg->order_date,
2420 expire => $cust_pkg->expire,
2421 adjourn => $cust_pkg->adjourn,
2422 contract_end => $cust_pkg->contract_end,
2423 refnum => $cust_pkg->refnum,
2424 discountnum => $cust_pkg->discountnum,
2425 waive_setup => $cust_pkg->waive_setup,
2427 if ( $old and $opt->{'keep_dates'} ) {
2428 foreach (qw(setup bill last_bill)) {
2429 $new->set($_, $old->get($_));
2432 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2435 $error ||= $old->transfer($new);
2437 if ( $error and $error > 0 ) {
2438 # no reason why this should ever fail, but still...
2439 $error = "Unable to transfer all services from supplemental package ".
2443 $dbh->rollback if $oldAutoCommit;
2446 push @new_supp_pkgs, $new;
2448 } # if !$opt->{'cust_pkg'}
2449 # because if there is one, then supplemental packages would already
2450 # have been created for it.
2452 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2454 #Don't allow billing the package (preceding period packages and/or
2455 #outstanding usage) if we are keeping dates (i.e. location changing),
2456 #because the new package will be billed for the same date range.
2457 #Supplemental packages are also canceled here.
2459 # during scheduled changes, avoid canceling the package we just
2461 $self->set('change_to_pkgnum' => '');
2463 $error = $self->cancel(
2465 unused_credit => $unused_credit,
2466 nobill => $keep_dates,
2467 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2468 no_delay_cancel => 1,
2471 $dbh->rollback if $oldAutoCommit;
2472 return "canceling old package: $error";
2475 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2477 my $error = $cust_pkg->cust_main->bill(
2478 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2481 $dbh->rollback if $oldAutoCommit;
2482 return "billing new package: $error";
2486 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2492 =item change_later OPTION => VALUE...
2494 Schedule a package change for a later date. This actually orders the new
2495 package immediately, but sets its start date for a future date, and sets
2496 the current package to expire on the same date.
2498 If the package is already scheduled for a change, this can be called with
2499 'start_date' to change the scheduled date, or with pkgpart and/or
2500 locationnum to modify the package change. To cancel the scheduled change
2501 entirely, see C<abort_change>.
2509 The date for the package change. Required, and must be in the future.
2519 The pkgpart, locationnum, quantity and optional contract_end of the new
2520 package, with the same meaning as in C<change>.
2528 my $opt = ref($_[0]) ? shift : { @_ };
2530 # check contract_end, prevent adding/removing
2531 my $error = $self->_check_change($opt);
2532 return $error if $error;
2534 my $oldAutoCommit = $FS::UID::AutoCommit;
2535 local $FS::UID::AutoCommit = 0;
2538 my $cust_main = $self->cust_main;
2540 my $date = delete $opt->{'start_date'} or return 'start_date required';
2542 if ( $date <= time ) {
2543 $dbh->rollback if $oldAutoCommit;
2544 return "start_date $date is in the past";
2547 # If the user entered a new location, set it up now.
2548 if ( $opt->{'cust_location'} ) {
2549 $error = $opt->{'cust_location'}->find_or_insert;
2551 $dbh->rollback if $oldAutoCommit;
2552 return "creating location record: $error";
2554 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2557 if ( $self->change_to_pkgnum ) {
2558 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2559 my $new_pkgpart = $opt->{'pkgpart'}
2560 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2561 my $new_locationnum = $opt->{'locationnum'}
2562 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2563 my $new_quantity = $opt->{'quantity'}
2564 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2565 my $new_contract_end = $opt->{'contract_end'}
2566 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2567 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2568 # it hasn't been billed yet, so in principle we could just edit
2569 # it in place (w/o a package change), but that's bad form.
2570 # So change the package according to the new options...
2571 my $err_or_pkg = $change_to->change(%$opt);
2572 if ( ref $err_or_pkg ) {
2573 # Then set that package up for a future start.
2574 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2575 $self->set('expire', $date); # in case it's different
2576 $err_or_pkg->set('start_date', $date);
2577 $err_or_pkg->set('change_date', '');
2578 $err_or_pkg->set('change_pkgnum', '');
2580 $error = $self->replace ||
2581 $err_or_pkg->replace ||
2582 #because change() might've edited existing scheduled change in place
2583 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2584 $change_to->cancel('no_delay_cancel' => 1) ||
2585 $change_to->delete);
2587 $error = $err_or_pkg;
2589 } else { # change the start date only.
2590 $self->set('expire', $date);
2591 $change_to->set('start_date', $date);
2592 $error = $self->replace || $change_to->replace;
2595 $dbh->rollback if $oldAutoCommit;
2598 $dbh->commit if $oldAutoCommit;
2601 } # if $self->change_to_pkgnum
2603 my $new_pkgpart = $opt->{'pkgpart'}
2604 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2605 my $new_locationnum = $opt->{'locationnum'}
2606 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2607 my $new_quantity = $opt->{'quantity'}
2608 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2609 my $new_contract_end = $opt->{'contract_end'}
2610 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2612 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2614 # allow $opt->{'locationnum'} = '' to specifically set it to null
2615 # (i.e. customer default location)
2616 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2618 my $new = FS::cust_pkg->new( {
2619 custnum => $self->custnum,
2620 locationnum => $opt->{'locationnum'},
2621 start_date => $date,
2622 map { $_ => ( $opt->{$_} || $self->$_() ) }
2623 qw( pkgpart quantity refnum salesnum contract_end )
2625 $error = $new->insert('change' => 1,
2626 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2628 $self->set('change_to_pkgnum', $new->pkgnum);
2629 $self->set('expire', $date);
2630 $error = $self->replace;
2633 $dbh->rollback if $oldAutoCommit;
2635 $dbh->commit if $oldAutoCommit;
2643 Cancels a future package change scheduled by C<change_later>.
2649 my $oldAutoCommit = $FS::UID::AutoCommit;
2650 local $FS::UID::AutoCommit = 0;
2652 my $pkgnum = $self->change_to_pkgnum;
2653 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2655 $self->set('change_to_pkgnum', '');
2656 $self->set('expire', '');
2657 $error = $self->replace;
2659 $error ||= $change_to->cancel || $change_to->delete;
2662 if ( $oldAutoCommit ) {
2673 =item set_quantity QUANTITY
2675 Change the package's quantity field. This is one of the few package properties
2676 that can safely be changed without canceling and reordering the package
2677 (because it doesn't affect tax eligibility). Returns an error or an
2684 $self = $self->replace_old; # just to make sure
2685 $self->quantity(shift);
2689 =item set_salesnum SALESNUM
2691 Change the package's salesnum (sales person) field. This is one of the few
2692 package properties that can safely be changed without canceling and reordering
2693 the package (because it doesn't affect tax eligibility). Returns an error or
2700 $self = $self->replace_old; # just to make sure
2701 $self->salesnum(shift);
2703 # XXX this should probably reassign any credit that's already been given
2706 =item modify_charge OPTIONS
2708 Change the properties of a one-time charge. The following properties can
2709 be changed this way:
2710 - pkg: the package description
2711 - classnum: the package class
2712 - additional: arrayref of additional invoice details to add to this package
2714 and, I<if the charge has not yet been billed>:
2715 - start_date: the date when it will be billed
2716 - amount: the setup fee to be charged
2717 - quantity: the multiplier for the setup fee
2718 - separate_bill: whether to put the charge on a separate invoice
2720 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2721 commission credits linked to this charge, they will be recalculated.
2728 my $part_pkg = $self->part_pkg;
2729 my $pkgnum = $self->pkgnum;
2732 my $oldAutoCommit = $FS::UID::AutoCommit;
2733 local $FS::UID::AutoCommit = 0;
2735 return "Can't use modify_charge except on one-time charges"
2736 unless $part_pkg->freq eq '0';
2738 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2739 $part_pkg->set('pkg', $opt{'pkg'});
2742 my %pkg_opt = $part_pkg->options;
2743 my $pkg_opt_modified = 0;
2745 $opt{'additional'} ||= [];
2748 foreach (grep /^additional/, keys %pkg_opt) {
2749 ($i) = ($_ =~ /^additional_info(\d+)$/);
2750 $old_additional[$i] = $pkg_opt{$_} if $i;
2751 delete $pkg_opt{$_};
2754 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2755 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2756 if (!exists($old_additional[$i])
2757 or $old_additional[$i] ne $opt{'additional'}->[$i])
2759 $pkg_opt_modified = 1;
2762 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2763 $pkg_opt{'additional_count'} = $i if $i > 0;
2766 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2769 $old_classnum = $part_pkg->classnum;
2770 $part_pkg->set('classnum', $opt{'classnum'});
2773 if ( !$self->get('setup') ) {
2774 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2777 if ( exists($opt{'amount'})
2778 and $part_pkg->option('setup_fee') != $opt{'amount'}
2779 and $opt{'amount'} > 0 ) {
2781 $pkg_opt{'setup_fee'} = $opt{'amount'};
2782 $pkg_opt_modified = 1;
2785 if ( exists($opt{'setup_cost'})
2786 and $part_pkg->setup_cost != $opt{'setup_cost'}
2787 and $opt{'setup_cost'} > 0 ) {
2789 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2792 if ( exists($opt{'quantity'})
2793 and $opt{'quantity'} != $self->quantity
2794 and $opt{'quantity'} > 0 ) {
2796 $self->set('quantity', $opt{'quantity'});
2799 if ( exists($opt{'start_date'})
2800 and $opt{'start_date'} != $self->start_date ) {
2802 $self->set('start_date', $opt{'start_date'});
2805 if ( exists($opt{'separate_bill'})
2806 and $opt{'separate_bill'} ne $self->separate_bill ) {
2808 $self->set('separate_bill', $opt{'separate_bill'});
2812 } # else simply ignore them; the UI shouldn't allow editing the fields
2815 if ( exists($opt{'taxclass'})
2816 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2818 $part_pkg->set('taxclass', $opt{'taxclass'});
2822 if ( $part_pkg->modified or $pkg_opt_modified ) {
2823 # can we safely modify the package def?
2824 # Yes, if it's not available for purchase, and this is the only instance
2826 if ( $part_pkg->disabled
2827 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2828 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2830 $error = $part_pkg->replace( options => \%pkg_opt );
2833 $part_pkg = $part_pkg->clone;
2834 $part_pkg->set('disabled' => 'Y');
2835 $error = $part_pkg->insert( options => \%pkg_opt );
2836 # and associate this as yet-unbilled package to the new package def
2837 $self->set('pkgpart' => $part_pkg->pkgpart);
2840 $dbh->rollback if $oldAutoCommit;
2845 if ($self->modified) { # for quantity or start_date change, or if we had
2846 # to clone the existing package def
2847 my $error = $self->replace;
2848 return $error if $error;
2850 if (defined $old_classnum) {
2851 # fix invoice grouping records
2852 my $old_catname = $old_classnum
2853 ? FS::pkg_class->by_key($old_classnum)->categoryname
2855 my $new_catname = $opt{'classnum'}
2856 ? $part_pkg->pkg_class->categoryname
2858 if ( $old_catname ne $new_catname ) {
2859 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2860 # (there should only be one...)
2861 my @display = qsearch( 'cust_bill_pkg_display', {
2862 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2863 'section' => $old_catname,
2865 foreach (@display) {
2866 $_->set('section', $new_catname);
2867 $error = $_->replace;
2869 $dbh->rollback if $oldAutoCommit;
2873 } # foreach $cust_bill_pkg
2876 if ( $opt{'adjust_commission'} ) {
2877 # fix commission credits...tricky.
2878 foreach my $cust_event ($self->cust_event) {
2879 my $part_event = $cust_event->part_event;
2880 foreach my $table (qw(sales agent)) {
2882 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2883 my $credit = qsearchs('cust_credit', {
2884 'eventnum' => $cust_event->eventnum,
2886 if ( $part_event->isa($class) ) {
2887 # Yes, this results in current commission rates being applied
2888 # retroactively to a one-time charge. For accounting purposes
2889 # there ought to be some kind of time limit on doing this.
2890 my $amount = $part_event->_calc_credit($self);
2891 if ( $credit and $credit->amount ne $amount ) {
2892 # Void the old credit.
2893 $error = $credit->void('Package class changed');
2895 $dbh->rollback if $oldAutoCommit;
2896 return "$error (adjusting commission credit)";
2899 # redo the event action to recreate the credit.
2901 eval { $part_event->do_action( $self, $cust_event ) };
2903 $dbh->rollback if $oldAutoCommit;
2906 } # if $part_event->isa($class)
2908 } # foreach $cust_event
2909 } # if $opt{'adjust_commission'}
2910 } # if defined $old_classnum
2912 $dbh->commit if $oldAutoCommit;
2919 sub process_bulk_cust_pkg {
2922 warn Dumper($param) if $DEBUG;
2924 my $old_part_pkg = qsearchs('part_pkg',
2925 { pkgpart => $param->{'old_pkgpart'} });
2926 my $new_part_pkg = qsearchs('part_pkg',
2927 { pkgpart => $param->{'new_pkgpart'} });
2928 die "Must select a new package type\n" unless $new_part_pkg;
2929 #my $keep_dates = $param->{'keep_dates'} || 0;
2930 my $keep_dates = 1; # there is no good reason to turn this off
2932 my $oldAutoCommit = $FS::UID::AutoCommit;
2933 local $FS::UID::AutoCommit = 0;
2936 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2939 foreach my $old_cust_pkg ( @cust_pkgs ) {
2941 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2942 if ( $old_cust_pkg->getfield('cancel') ) {
2943 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2944 $old_cust_pkg->pkgnum."\n"
2948 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2950 my $error = $old_cust_pkg->change(
2951 'pkgpart' => $param->{'new_pkgpart'},
2952 'keep_dates' => $keep_dates
2954 if ( !ref($error) ) { # change returns the cust_pkg on success
2956 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2959 $dbh->commit if $oldAutoCommit;
2965 Returns the last bill date, or if there is no last bill date, the setup date.
2966 Useful for billing metered services.
2972 return $self->setfield('last_bill', $_[0]) if @_;
2973 return $self->getfield('last_bill') if $self->getfield('last_bill');
2974 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2975 'edate' => $self->bill, } );
2976 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2979 =item last_cust_pkg_reason ACTION
2981 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2982 Returns false if there is no reason or the package is not currenly ACTION'd
2983 ACTION is one of adjourn, susp, cancel, or expire.
2987 sub last_cust_pkg_reason {
2988 my ( $self, $action ) = ( shift, shift );
2989 my $date = $self->get($action);
2991 'table' => 'cust_pkg_reason',
2992 'hashref' => { 'pkgnum' => $self->pkgnum,
2993 'action' => substr(uc($action), 0, 1),
2996 'order_by' => 'ORDER BY num DESC LIMIT 1',
3000 =item last_reason ACTION
3002 Returns the most recent ACTION FS::reason associated with the package.
3003 Returns false if there is no reason or the package is not currenly ACTION'd
3004 ACTION is one of adjourn, susp, cancel, or expire.
3009 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3010 $cust_pkg_reason->reason
3011 if $cust_pkg_reason;
3016 Returns the definition for this billing item, as an FS::part_pkg object (see
3023 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3024 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3025 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3030 Returns the cancelled package this package was changed from, if any.
3036 return '' unless $self->change_pkgnum;
3037 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3040 =item change_cust_main
3042 Returns the customter this package was detached to, if any.
3046 sub change_cust_main {
3048 return '' unless $self->change_custnum;
3049 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3054 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3061 $self->part_pkg->calc_setup($self, @_);
3066 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3073 $self->part_pkg->calc_recur($self, @_);
3078 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3085 $self->part_pkg->base_setup($self, @_);
3090 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3097 $self->part_pkg->base_recur($self, @_);
3102 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3109 $self->part_pkg->calc_remain($self, @_);
3114 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3121 $self->part_pkg->calc_cancel($self, @_);
3126 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3132 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3135 =item cust_pkg_detail [ DETAILTYPE ]
3137 Returns any customer package details for this package (see
3138 L<FS::cust_pkg_detail>).
3140 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3144 sub cust_pkg_detail {
3146 my %hash = ( 'pkgnum' => $self->pkgnum );
3147 $hash{detailtype} = shift if @_;
3149 'table' => 'cust_pkg_detail',
3150 'hashref' => \%hash,
3151 'order_by' => 'ORDER BY weight, pkgdetailnum',
3155 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3157 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3159 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3161 If there is an error, returns the error, otherwise returns false.
3165 sub set_cust_pkg_detail {
3166 my( $self, $detailtype, @details ) = @_;
3168 my $oldAutoCommit = $FS::UID::AutoCommit;
3169 local $FS::UID::AutoCommit = 0;
3172 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3173 my $error = $current->delete;
3175 $dbh->rollback if $oldAutoCommit;
3176 return "error removing old detail: $error";
3180 foreach my $detail ( @details ) {
3181 my $cust_pkg_detail = new FS::cust_pkg_detail {
3182 'pkgnum' => $self->pkgnum,
3183 'detailtype' => $detailtype,
3184 'detail' => $detail,
3186 my $error = $cust_pkg_detail->insert;
3188 $dbh->rollback if $oldAutoCommit;
3189 return "error adding new detail: $error";
3194 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3201 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3205 #false laziness w/cust_bill.pm
3209 'table' => 'cust_event',
3210 'addl_from' => 'JOIN part_event USING ( eventpart )',
3211 'hashref' => { 'tablenum' => $self->pkgnum },
3212 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3216 =item num_cust_event
3218 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3222 #false laziness w/cust_bill.pm
3223 sub num_cust_event {
3225 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3226 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3229 =item exists_cust_event
3231 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3235 sub exists_cust_event {
3237 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3238 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3239 $row ? $row->[0] : '';
3242 sub _from_cust_event_where {
3244 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3245 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3249 my( $self, $sql, @args ) = @_;
3250 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3251 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3255 =item part_pkg_currency_option OPTIONNAME
3257 Returns a two item list consisting of the currency of this customer, if any,
3258 and a value for the provided option. If the customer has a currency, the value
3259 is the option value the given name and the currency (see
3260 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3261 regular option value for the given name (see L<FS::part_pkg_option>).
3265 sub part_pkg_currency_option {
3266 my( $self, $optionname ) = @_;
3267 my $part_pkg = $self->part_pkg;
3268 if ( my $currency = $self->cust_main->currency ) {
3269 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3271 ('', $part_pkg->option($optionname) );
3275 =item cust_svc [ SVCPART ] (old, deprecated usage)
3277 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3279 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3281 Returns the services for this package, as FS::cust_svc objects (see
3282 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3283 spcififed, returns only the matching services.
3285 As an optimization, use the cust_svc_unsorted version if you are not displaying
3292 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3293 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3296 sub cust_svc_unsorted {
3298 @{ $self->cust_svc_unsorted_arrayref(@_) };
3301 sub cust_svc_unsorted_arrayref {
3304 return [] unless $self->num_cust_svc(@_);
3307 if ( @_ && $_[0] =~ /^\d+/ ) {
3308 $opt{svcpart} = shift;
3309 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3316 'select' => 'cust_svc.*, part_svc.*',
3317 'table' => 'cust_svc',
3318 'hashref' => { 'pkgnum' => $self->pkgnum },
3319 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3321 $search{hashref}->{svcpart} = $opt{svcpart}
3323 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3326 [ qsearch(\%search) ];
3330 =item overlimit [ SVCPART ]
3332 Returns the services for this package which have exceeded their
3333 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3334 is specified, return only the matching services.
3340 return () unless $self->num_cust_svc(@_);
3341 grep { $_->overlimit } $self->cust_svc(@_);
3344 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3346 Returns historical services for this package created before END TIMESTAMP and
3347 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3348 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3349 I<pkg_svc.hidden> flag will be omitted.
3355 warn "$me _h_cust_svc called on $self\n"
3358 my ($end, $start, $mode) = @_;
3360 local($FS::Record::qsearch_qualify_columns) = 0;
3362 my @cust_svc = $self->_sort_cust_svc(
3363 [ qsearch( 'h_cust_svc',
3364 { 'pkgnum' => $self->pkgnum, },
3365 FS::h_cust_svc->sql_h_search(@_),
3369 if ( defined($mode) && $mode eq 'I' ) {
3370 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3371 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3377 sub _sort_cust_svc {
3378 my( $self, $arrayref ) = @_;
3381 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3383 my %pkg_svc = map { $_->svcpart => $_ }
3384 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3389 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3391 $pkg_svc ? $pkg_svc->primary_svc : '',
3392 $pkg_svc ? $pkg_svc->quantity : 0,
3399 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3401 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3403 Returns the number of services for this package. Available options are svcpart
3404 and svcdb. If either is spcififed, returns only the matching services.
3411 return $self->{'_num_cust_svc'}
3413 && exists($self->{'_num_cust_svc'})
3414 && $self->{'_num_cust_svc'} =~ /\d/;
3416 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3420 if ( @_ && $_[0] =~ /^\d+/ ) {
3421 $opt{svcpart} = shift;
3422 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3428 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3429 my $where = ' WHERE pkgnum = ? ';
3430 my @param = ($self->pkgnum);
3432 if ( $opt{'svcpart'} ) {
3433 $where .= ' AND svcpart = ? ';
3434 push @param, $opt{'svcpart'};
3436 if ( $opt{'svcdb'} ) {
3437 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3438 $where .= ' AND svcdb = ? ';
3439 push @param, $opt{'svcdb'};
3442 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3443 $sth->execute(@param) or die $sth->errstr;
3444 $sth->fetchrow_arrayref->[0];
3447 =item available_part_svc
3449 Returns a list of FS::part_svc objects representing services included in this
3450 package but not yet provisioned. Each FS::part_svc object also has an extra
3451 field, I<num_avail>, which specifies the number of available services.
3453 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3454 associated pkg_svc has the provision_hold flag set.
3458 sub available_part_svc {
3462 my $pkg_quantity = $self->quantity || 1;
3464 grep { $_->num_avail > 0 }
3466 my $part_svc = $_->part_svc;
3467 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3468 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3470 # more evil encapsulation breakage
3471 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3472 my @exports = $part_svc->part_export_did;
3473 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3478 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3479 $self->part_pkg->pkg_svc;
3482 =item part_svc [ OPTION => VALUE ... ]
3484 Returns a list of FS::part_svc objects representing provisioned and available
3485 services included in this package. Each FS::part_svc object also has the
3486 following extra fields:
3500 (services) - array reference containing the provisioned services, as cust_svc objects
3504 Accepts two options:
3508 =item summarize_size
3510 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3511 is this size or greater.
3513 =item hide_discontinued
3515 If true, will omit looking for services that are no longer avaialble in the
3523 #label -> ($cust_svc->label)[1]
3529 my $pkg_quantity = $self->quantity || 1;
3531 #XXX some sort of sort order besides numeric by svcpart...
3532 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3534 my $part_svc = $pkg_svc->part_svc;
3535 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3536 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3537 $part_svc->{'Hash'}{'num_avail'} =
3538 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3539 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3540 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3541 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3542 && $num_cust_svc >= $opt{summarize_size};
3543 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3545 } $self->part_pkg->pkg_svc;
3547 unless ( $opt{hide_discontinued} ) {
3549 push @part_svc, map {
3551 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3552 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3553 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3554 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3555 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3557 } $self->extra_part_svc;
3564 =item extra_part_svc
3566 Returns a list of FS::part_svc objects corresponding to services in this
3567 package which are still provisioned but not (any longer) available in the
3572 sub extra_part_svc {
3575 my $pkgnum = $self->pkgnum;
3576 #my $pkgpart = $self->pkgpart;
3579 # 'table' => 'part_svc',
3582 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3583 # WHERE pkg_svc.svcpart = part_svc.svcpart
3584 # AND pkg_svc.pkgpart = ?
3587 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3588 # LEFT JOIN cust_pkg USING ( pkgnum )
3589 # WHERE cust_svc.svcpart = part_svc.svcpart
3592 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3595 #seems to benchmark slightly faster... (or did?)
3597 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3598 my $pkgparts = join(',', @pkgparts);
3601 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3602 #MySQL doesn't grok DISINCT ON
3603 'select' => 'DISTINCT part_svc.*',
3604 'table' => 'part_svc',
3606 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3607 AND pkg_svc.pkgpart IN ($pkgparts)
3610 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3611 LEFT JOIN cust_pkg USING ( pkgnum )
3614 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3615 'extra_param' => [ [$self->pkgnum=>'int'] ],
3621 Returns a short status string for this package, currently:
3627 =item not yet billed
3629 =item one-time charge
3644 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3646 return 'cancelled' if $self->get('cancel');
3647 return 'on hold' if $self->susp && ! $self->setup;
3648 return 'suspended' if $self->susp;
3649 return 'not yet billed' unless $self->setup;
3650 return 'one-time charge' if $freq =~ /^(0|$)/;
3654 =item ucfirst_status
3656 Returns the status with the first character capitalized.
3660 sub ucfirst_status {
3661 ucfirst(shift->status);
3666 Class method that returns the list of possible status strings for packages
3667 (see L<the status method|/status>). For example:
3669 @statuses = FS::cust_pkg->statuses();
3673 tie my %statuscolor, 'Tie::IxHash',
3674 'on hold' => 'FF00F5', #brighter purple!
3675 'not yet billed' => '009999', #teal? cyan?
3676 'one-time charge' => '0000CC', #blue #'000000',
3677 'active' => '00CC00',
3678 'suspended' => 'FF9900',
3679 'cancelled' => 'FF0000',
3683 my $self = shift; #could be class...
3684 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3685 # # mayble split btw one-time vs. recur
3696 Returns a hex triplet color string for this package's status.
3702 $statuscolor{$self->status};
3705 =item is_status_delay_cancel
3707 Returns true if part_pkg has option delay_cancel,
3708 cust_pkg status is 'suspended' and expire is set
3709 to cancel package within the next day (or however
3710 many days are set in global config part_pkg-delay_cancel-days.
3712 Accepts option I<part_pkg-delay_cancel-days> which should be
3713 the value of the config setting, to avoid looking it up again.
3715 This is not a real status, this only meant for hacking display
3716 values, because otherwise treating the package as suspended is
3717 really the whole point of the delay_cancel option.
3721 sub is_status_delay_cancel {
3722 my ($self,%opt) = @_;
3723 if ( $self->main_pkgnum and $self->pkglinknum ) {
3724 return $self->main_pkg->is_status_delay_cancel;
3726 return 0 unless $self->part_pkg->option('delay_cancel',1);
3727 return 0 unless $self->status eq 'suspended';
3728 return 0 unless $self->expire;
3729 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3731 my $conf = new FS::Conf;
3732 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3734 my $expsecs = 60*60*24*$expdays;
3735 return 0 unless $self->expire < time + $expsecs;
3741 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3742 "pkg - comment" depending on user preference).
3748 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3749 $label = $self->pkgnum. ": $label"
3750 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3754 =item pkg_label_long
3756 Returns a long label for this package, adding the primary service's label to
3761 sub pkg_label_long {
3763 my $label = $self->pkg_label;
3764 my $cust_svc = $self->primary_cust_svc;
3765 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3771 Returns a customer-localized label for this package.
3777 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3780 =item primary_cust_svc
3782 Returns a primary service (as FS::cust_svc object) if one can be identified.
3786 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3788 sub primary_cust_svc {
3791 my @cust_svc = $self->cust_svc;
3793 return '' unless @cust_svc; #no serivces - irrelevant then
3795 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3797 # primary service as specified in the package definition
3798 # or exactly one service definition with quantity one
3799 my $svcpart = $self->part_pkg->svcpart;
3800 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3801 return $cust_svc[0] if scalar(@cust_svc) == 1;
3803 #couldn't identify one thing..
3809 Returns a list of lists, calling the label method for all services
3810 (see L<FS::cust_svc>) of this billing item.
3816 map { [ $_->label ] } $self->cust_svc;
3819 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3821 Like the labels method, but returns historical information on services that
3822 were active as of END_TIMESTAMP and (optionally) not cancelled before
3823 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3824 I<pkg_svc.hidden> flag will be omitted.
3826 Returns a list of lists, calling the label method for all (historical) services
3827 (see L<FS::h_cust_svc>) of this billing item.
3833 warn "$me _h_labels called on $self\n"
3835 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3840 Like labels, except returns a simple flat list, and shortens long
3841 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3842 identical services to one line that lists the service label and the number of
3843 individual services rather than individual items.
3848 shift->_labels_short( 'labels', @_ );
3851 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3853 Like h_labels, except returns a simple flat list, and shortens long
3854 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3855 identical services to one line that lists the service label and the number of
3856 individual services rather than individual items.
3860 sub h_labels_short {
3861 shift->_labels_short( 'h_labels', @_ );
3865 my( $self, $method ) = ( shift, shift );
3867 warn "$me _labels_short called on $self with $method method\n"
3870 my $conf = new FS::Conf;
3871 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3873 warn "$me _labels_short populating \%labels\n"
3877 #tie %labels, 'Tie::IxHash';
3878 push @{ $labels{$_->[0]} }, $_->[1]
3879 foreach $self->$method(@_);
3881 warn "$me _labels_short populating \@labels\n"
3885 foreach my $label ( keys %labels ) {
3887 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3888 my $num = scalar(@values);
3889 warn "$me _labels_short $num items for $label\n"
3892 if ( $num > $max_same_services ) {
3893 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3895 push @labels, "$label ($num)";
3897 if ( $conf->exists('cust_bill-consolidate_services') ) {
3898 warn "$me _labels_short consolidating services\n"
3900 # push @labels, "$label: ". join(', ', @values);
3902 my $detail = "$label: ";
3903 $detail .= shift(@values). ', '
3905 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3907 push @labels, $detail;
3909 warn "$me _labels_short done consolidating services\n"
3912 warn "$me _labels_short adding service data\n"
3914 push @labels, map { "$label: $_" } @values;
3925 Returns the parent customer object (see L<FS::cust_main>).
3929 Returns the balance for this specific package, when using
3930 experimental package balance.
3936 $self->cust_main->balance_pkgnum( $self->pkgnum );
3939 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3943 Returns the location object, if any (see L<FS::cust_location>).
3945 =item cust_location_or_main
3947 If this package is associated with a location, returns the locaiton (see
3948 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3950 =item location_label [ OPTION => VALUE ... ]
3952 Returns the label of the location object (see L<FS::cust_location>).
3956 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3958 =item tax_locationnum
3960 Returns the foreign key to a L<FS::cust_location> object for calculating
3961 tax on this package, as determined by the C<tax-pkg_address> and
3962 C<tax-ship_address> configuration flags.
3966 sub tax_locationnum {
3968 my $conf = FS::Conf->new;
3969 if ( $conf->exists('tax-pkg_address') ) {
3970 return $self->locationnum;
3972 elsif ( $conf->exists('tax-ship_address') ) {
3973 return $self->cust_main->ship_locationnum;
3976 return $self->cust_main->bill_locationnum;
3982 Returns the L<FS::cust_location> object for tax_locationnum.
3988 my $conf = FS::Conf->new;
3989 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3990 return FS::cust_location->by_key($self->locationnum);
3992 elsif ( $conf->exists('tax-ship_address') ) {
3993 return $self->cust_main->ship_location;
3996 return $self->cust_main->bill_location;
4000 =item seconds_since TIMESTAMP
4002 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4003 package have been online since TIMESTAMP, according to the session monitor.
4005 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4006 L<Time::Local> and L<Date::Parse> for conversion functions.
4011 my($self, $since) = @_;
4014 foreach my $cust_svc (
4015 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4017 $seconds += $cust_svc->seconds_since($since);
4024 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4026 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4027 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4030 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4031 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4037 sub seconds_since_sqlradacct {
4038 my($self, $start, $end) = @_;
4042 foreach my $cust_svc (
4044 my $part_svc = $_->part_svc;
4045 $part_svc->svcdb eq 'svc_acct'
4046 && scalar($part_svc->part_export_usage);
4049 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4056 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4058 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4059 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4063 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4064 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4069 sub attribute_since_sqlradacct {
4070 my($self, $start, $end, $attrib) = @_;
4074 foreach my $cust_svc (
4076 my $part_svc = $_->part_svc;
4077 scalar($part_svc->part_export_usage);
4080 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4092 my( $self, $value ) = @_;
4093 if ( defined($value) ) {
4094 $self->setfield('quantity', $value);
4096 $self->getfield('quantity') || 1;
4099 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4101 Transfers as many services as possible from this package to another package.
4103 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4104 object. The destination package must already exist.
4106 Services are moved only if the destination allows services with the correct
4107 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4108 this option with caution! No provision is made for export differences
4109 between the old and new service definitions. Probably only should be used
4110 when your exports for all service definitions of a given svcdb are identical.
4111 (attempt a transfer without it first, to move all possible svcpart-matching
4114 Any services that can't be moved remain in the original package.
4116 Returns an error, if there is one; otherwise, returns the number of services
4117 that couldn't be moved.
4122 my ($self, $dest_pkgnum, %opt) = @_;
4128 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4129 $dest = $dest_pkgnum;
4130 $dest_pkgnum = $dest->pkgnum;
4132 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4135 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4137 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4138 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4141 foreach my $cust_svc ($dest->cust_svc) {
4142 $target{$cust_svc->svcpart}--;
4145 my %svcpart2svcparts = ();
4146 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4147 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4148 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4149 next if exists $svcpart2svcparts{$svcpart};
4150 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4151 $svcpart2svcparts{$svcpart} = [
4153 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4155 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4156 'svcpart' => $_ } );
4158 $pkg_svc ? $pkg_svc->primary_svc : '',
4159 $pkg_svc ? $pkg_svc->quantity : 0,
4163 grep { $_ != $svcpart }
4165 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4167 warn "alternates for svcpart $svcpart: ".
4168 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4174 foreach my $cust_svc ($self->cust_svc) {
4175 my $svcnum = $cust_svc->svcnum;
4176 if($target{$cust_svc->svcpart} > 0
4177 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4178 $target{$cust_svc->svcpart}--;
4179 my $new = new FS::cust_svc { $cust_svc->hash };
4180 $new->pkgnum($dest_pkgnum);
4181 $error = $new->replace($cust_svc);
4182 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4184 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4185 warn "alternates to consider: ".
4186 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4188 my @alternate = grep {
4189 warn "considering alternate svcpart $_: ".
4190 "$target{$_} available in new package\n"
4193 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4195 warn "alternate(s) found\n" if $DEBUG;
4196 my $change_svcpart = $alternate[0];
4197 $target{$change_svcpart}--;
4198 my $new = new FS::cust_svc { $cust_svc->hash };
4199 $new->svcpart($change_svcpart);
4200 $new->pkgnum($dest_pkgnum);
4201 $error = $new->replace($cust_svc);
4209 my @label = $cust_svc->label;
4210 return "$label[0] $label[1]: $error";
4216 =item grab_svcnums SVCNUM, SVCNUM ...
4218 Change the pkgnum for the provided services to this packages. If there is an
4219 error, returns the error, otherwise returns false.
4227 my $oldAutoCommit = $FS::UID::AutoCommit;
4228 local $FS::UID::AutoCommit = 0;
4231 foreach my $svcnum (@svcnum) {
4232 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4233 $dbh->rollback if $oldAutoCommit;
4234 return "unknown svcnum $svcnum";
4236 $cust_svc->pkgnum( $self->pkgnum );
4237 my $error = $cust_svc->replace;
4239 $dbh->rollback if $oldAutoCommit;
4244 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4251 This method is deprecated. See the I<depend_jobnum> option to the insert and
4252 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4256 #looks like this is still used by the order_pkg and change_pkg methods in
4257 # ClientAPI/MyAccount, need to look into those before removing
4261 my $oldAutoCommit = $FS::UID::AutoCommit;
4262 local $FS::UID::AutoCommit = 0;
4265 foreach my $cust_svc ( $self->cust_svc ) {
4266 #false laziness w/svc_Common::insert
4267 my $svc_x = $cust_svc->svc_x;
4268 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4269 my $error = $part_export->export_insert($svc_x);
4271 $dbh->rollback if $oldAutoCommit;
4277 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4282 =item export_pkg_change OLD_CUST_PKG
4284 Calls the "pkg_change" export action for all services attached to this package.
4288 sub export_pkg_change {
4289 my( $self, $old ) = ( shift, shift );
4291 my $oldAutoCommit = $FS::UID::AutoCommit;
4292 local $FS::UID::AutoCommit = 0;
4295 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4296 my $error = $svc_x->export('pkg_change', $self, $old);
4298 $dbh->rollback if $oldAutoCommit;
4303 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4310 Associates this package with a (suspension or cancellation) reason (see
4311 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4314 Available options are:
4320 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.
4324 the access_user (see L<FS::access_user>) providing the reason
4332 the action (cancel, susp, adjourn, expire) associated with the reason
4336 If there is an error, returns the error, otherwise returns false.
4341 my ($self, %options) = @_;
4343 my $otaker = $options{reason_otaker} ||
4344 $FS::CurrentUser::CurrentUser->username;
4347 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4351 } elsif ( ref($options{'reason'}) ) {
4353 return 'Enter a new reason (or select an existing one)'
4354 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4356 my $reason = new FS::reason({
4357 'reason_type' => $options{'reason'}->{'typenum'},
4358 'reason' => $options{'reason'}->{'reason'},
4360 my $error = $reason->insert;
4361 return $error if $error;
4363 $reasonnum = $reason->reasonnum;
4366 return "Unparseable reason: ". $options{'reason'};
4369 my $cust_pkg_reason =
4370 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4371 'reasonnum' => $reasonnum,
4372 'otaker' => $otaker,
4373 'action' => substr(uc($options{'action'}),0,1),
4374 'date' => $options{'date'}
4379 $cust_pkg_reason->insert;
4382 =item insert_discount
4384 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4385 inserting a new discount on the fly (see L<FS::discount>).
4387 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4388 and if present, will create a setup discount. If the discountnum is -1,
4389 a new discount definition will be inserted using the value in
4390 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4392 If there is an error, returns the error, otherwise returns false.
4396 sub insert_discount {
4397 #my ($self, %options) = @_;
4400 foreach my $x (qw(setup recur)) {
4401 if ( my $discountnum = $self->get("${x}_discountnum") ) {
4402 my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4403 'pkgnum' => $self->pkgnum,
4404 'discountnum' => $discountnum,
4407 'end_date' => '', #XXX
4408 #for the create a new discount case
4409 'amount' => $self->get("${x}_discountnum_amount"),
4410 'percent' => $self->get("${x}_discountnum_percent"),
4411 'months' => $self->get("${x}_discountnum_months"),
4413 if ( $x eq 'setup' ) {
4414 $cust_pkg_discount->setup('Y');
4415 $cust_pkg_discount->months('');
4417 my $error = $cust_pkg_discount->insert;
4418 return $error if $error;
4425 =item set_usage USAGE_VALUE_HASHREF
4427 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4428 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4429 upbytes, downbytes, and totalbytes are appropriate keys.
4431 All svc_accts which are part of this package have their values reset.
4436 my ($self, $valueref, %opt) = @_;
4438 #only svc_acct can set_usage for now
4439 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4440 my $svc_x = $cust_svc->svc_x;
4441 $svc_x->set_usage($valueref, %opt)
4442 if $svc_x->can("set_usage");
4446 =item recharge USAGE_VALUE_HASHREF
4448 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4449 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4450 upbytes, downbytes, and totalbytes are appropriate keys.
4452 All svc_accts which are part of this package have their values incremented.
4457 my ($self, $valueref) = @_;
4459 #only svc_acct can set_usage for now
4460 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4461 my $svc_x = $cust_svc->svc_x;
4462 $svc_x->recharge($valueref)
4463 if $svc_x->can("recharge");
4467 =item apply_usageprice
4471 sub apply_usageprice {
4474 my $oldAutoCommit = $FS::UID::AutoCommit;
4475 local $FS::UID::AutoCommit = 0;
4480 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4481 $error ||= $cust_pkg_usageprice->apply;
4485 $dbh->rollback if $oldAutoCommit;
4486 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4489 $dbh->commit if $oldAutoCommit;
4495 =item cust_pkg_discount
4497 =item cust_pkg_discount_active
4501 sub cust_pkg_discount_active {
4503 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4506 =item cust_pkg_usage
4508 Returns a list of all voice usage counters attached to this package.
4510 =item apply_usage OPTIONS
4512 Takes the following options:
4513 - cdr: a call detail record (L<FS::cdr>)
4514 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4515 - minutes: the maximum number of minutes to be charged
4517 Finds available usage minutes for a call of this class, and subtracts
4518 up to that many minutes from the usage pool. If the usage pool is empty,
4519 and the C<cdr-minutes_priority> global config option is set, minutes may
4520 be taken from other calls as well. Either way, an allocation record will
4521 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4522 number of minutes of usage applied to the call.
4527 my ($self, %opt) = @_;
4528 my $cdr = $opt{cdr};
4529 my $rate_detail = $opt{rate_detail};
4530 my $minutes = $opt{minutes};
4531 my $classnum = $rate_detail->classnum;
4532 my $pkgnum = $self->pkgnum;
4533 my $custnum = $self->custnum;
4535 my $oldAutoCommit = $FS::UID::AutoCommit;
4536 local $FS::UID::AutoCommit = 0;
4539 my $order = FS::Conf->new->config('cdr-minutes_priority');
4543 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4545 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4547 my @usage_recs = qsearch({
4548 'table' => 'cust_pkg_usage',
4549 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4550 ' JOIN cust_pkg USING (pkgnum)'.
4551 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4552 'select' => 'cust_pkg_usage.*',
4553 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4554 " ( cust_pkg.custnum = $custnum AND ".
4555 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4556 $is_classnum . ' AND '.
4557 " cust_pkg_usage.minutes > 0",
4558 'order_by' => " ORDER BY priority ASC",
4561 my $orig_minutes = $minutes;
4563 while (!$error and $minutes > 0 and @usage_recs) {
4564 my $cust_pkg_usage = shift @usage_recs;
4565 $cust_pkg_usage->select_for_update;
4566 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4567 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4568 acctid => $cdr->acctid,
4569 minutes => min($cust_pkg_usage->minutes, $minutes),
4571 $cust_pkg_usage->set('minutes',
4572 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4574 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4575 $minutes -= $cdr_cust_pkg_usage->minutes;
4577 if ( $order and $minutes > 0 and !$error ) {
4578 # then try to steal minutes from another call
4580 'table' => 'cdr_cust_pkg_usage',
4581 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4582 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4583 ' JOIN cust_pkg USING (pkgnum)'.
4584 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4585 ' JOIN cdr USING (acctid)',
4586 'select' => 'cdr_cust_pkg_usage.*',
4587 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4588 " ( cust_pkg.pkgnum = $pkgnum OR ".
4589 " ( cust_pkg.custnum = $custnum AND ".
4590 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4591 " part_pkg_usage_class.classnum = $classnum",
4592 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4594 if ( $order eq 'time' ) {
4595 # find CDRs that are using minutes, but have a later startdate
4597 my $startdate = $cdr->startdate;
4598 if ($startdate !~ /^\d+$/) {
4599 die "bad cdr startdate '$startdate'";
4601 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4602 # minimize needless reshuffling
4603 $search{'order_by'} .= ', cdr.startdate DESC';
4605 # XXX may not work correctly with rate_time schedules. Could
4606 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4608 $search{'addl_from'} .=
4609 ' JOIN rate_detail'.
4610 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4611 if ( $order eq 'rate_high' ) {
4612 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4613 $rate_detail->min_charge;
4614 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4615 } elsif ( $order eq 'rate_low' ) {
4616 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4617 $rate_detail->min_charge;
4618 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4620 # this should really never happen
4621 die "invalid cdr-minutes_priority value '$order'\n";
4624 my @cdr_usage_recs = qsearch(\%search);
4626 while (!$error and @cdr_usage_recs and $minutes > 0) {
4627 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4628 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4629 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4630 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4631 $cdr_cust_pkg_usage->select_for_update;
4632 $old_cdr->select_for_update;
4633 $cust_pkg_usage->select_for_update;
4634 # in case someone else stole the usage from this CDR
4635 # while waiting for the lock...
4636 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4637 # steal the usage allocation and flag the old CDR for reprocessing
4638 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4639 # if the allocation is more minutes than we need, adjust it...
4640 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4642 $cdr_cust_pkg_usage->set('minutes', $minutes);
4643 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4644 $error = $cust_pkg_usage->replace;
4646 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4647 $error ||= $cdr_cust_pkg_usage->replace;
4648 # deduct the stolen minutes
4649 $minutes -= $cdr_cust_pkg_usage->minutes;
4651 # after all minute-stealing is done, reset the affected CDRs
4652 foreach (values %reproc_cdrs) {
4653 $error ||= $_->set_status('');
4654 # XXX or should we just call $cdr->rate right here?
4655 # it's not like we can create a loop this way, since the min_charge
4656 # or call time has to go monotonically in one direction.
4657 # we COULD get some very deep recursions going, though...
4659 } # if $order and $minutes
4662 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4664 $dbh->commit if $oldAutoCommit;
4665 return $orig_minutes - $minutes;
4669 =item supplemental_pkgs
4671 Returns a list of all packages supplemental to this one.
4675 sub supplemental_pkgs {
4677 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4682 Returns the package that this one is supplemental to, if any.
4688 if ( $self->main_pkgnum ) {
4689 return FS::cust_pkg->by_key($self->main_pkgnum);
4696 =head1 CLASS METHODS
4702 Returns an SQL expression identifying recurring packages.
4706 sub recurring_sql { "
4707 '0' != ( select freq from part_pkg
4708 where cust_pkg.pkgpart = part_pkg.pkgpart )
4713 Returns an SQL expression identifying one-time packages.
4718 '0' = ( select freq from part_pkg
4719 where cust_pkg.pkgpart = part_pkg.pkgpart )
4724 Returns an SQL expression identifying ordered packages (recurring packages not
4730 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4735 Returns an SQL expression identifying active packages.
4740 $_[0]->recurring_sql. "
4741 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4742 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4743 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4746 =item not_yet_billed_sql
4748 Returns an SQL expression identifying packages which have not yet been billed.
4752 sub not_yet_billed_sql { "
4753 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4754 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4755 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4760 Returns an SQL expression identifying inactive packages (one-time packages
4761 that are otherwise unsuspended/uncancelled).
4765 sub inactive_sql { "
4766 ". $_[0]->onetime_sql(). "
4767 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4768 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4769 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4774 Returns an SQL expression identifying on-hold packages.
4779 #$_[0]->recurring_sql(). ' AND '.
4781 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4782 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4783 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4790 Returns an SQL expression identifying suspended packages.
4794 sub suspended_sql { susp_sql(@_); }
4796 #$_[0]->recurring_sql(). ' AND '.
4798 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4799 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4800 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4807 Returns an SQL exprression identifying cancelled packages.
4811 sub cancelled_sql { cancel_sql(@_); }
4813 #$_[0]->recurring_sql(). ' AND '.
4814 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4819 Returns an SQL expression to give the package status as a string.
4825 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4826 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4827 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4828 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4829 WHEN ".onetime_sql()." THEN 'one-time charge'
4836 Returns a list of two package counts. The first is a count of packages
4837 based on the supplied criteria and the second is the count of residential
4838 packages with those same criteria. Criteria are specified as in the search
4844 my ($class, $params) = @_;
4846 my $sql_query = $class->search( $params );
4848 my $count_sql = delete($sql_query->{'count_query'});
4849 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4850 or die "couldn't parse count_sql";
4852 my $count_sth = dbh->prepare($count_sql)
4853 or die "Error preparing $count_sql: ". dbh->errstr;
4855 or die "Error executing $count_sql: ". $count_sth->errstr;
4856 my $count_arrayref = $count_sth->fetchrow_arrayref;
4858 return ( @$count_arrayref );
4862 =item tax_locationnum_sql
4864 Returns an SQL expression for the tax location for a package, based
4865 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4869 sub tax_locationnum_sql {
4870 my $conf = FS::Conf->new;
4871 if ( $conf->exists('tax-pkg_address') ) {
4872 'cust_pkg.locationnum';
4874 elsif ( $conf->exists('tax-ship_address') ) {
4875 'cust_main.ship_locationnum';
4878 'cust_main.bill_locationnum';
4884 Returns a list: the first item is an SQL fragment identifying matching
4885 packages/customers via location (taking into account shipping and package
4886 address taxation, if enabled), and subsequent items are the parameters to
4887 substitute for the placeholders in that fragment.
4892 my($class, %opt) = @_;
4893 my $ornull = $opt{'ornull'};
4895 my $conf = new FS::Conf;
4897 # '?' placeholders in _location_sql_where
4898 my $x = $ornull ? 3 : 2;
4909 if ( $conf->exists('tax-ship_address') ) {
4912 ( ( ship_last IS NULL OR ship_last = '' )
4913 AND ". _location_sql_where('cust_main', '', $ornull ). "
4915 OR ( ship_last IS NOT NULL AND ship_last != ''
4916 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4919 # AND payby != 'COMP'
4921 @main_param = ( @bill_param, @bill_param );
4925 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4926 @main_param = @bill_param;
4932 if ( $conf->exists('tax-pkg_address') ) {
4934 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4937 ( cust_pkg.locationnum IS NULL AND $main_where )
4938 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4941 @param = ( @main_param, @bill_param );
4945 $where = $main_where;
4946 @param = @main_param;
4954 #subroutine, helper for location_sql
4955 sub _location_sql_where {
4957 my $prefix = @_ ? shift : '';
4958 my $ornull = @_ ? shift : '';
4960 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4962 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4964 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4965 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4966 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4968 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4970 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4972 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4973 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4974 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4975 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4976 AND $table.${prefix}country = ?
4981 my( $self, $what ) = @_;
4983 my $what_show_zero = $what. '_show_zero';
4984 length($self->$what_show_zero())
4985 ? ($self->$what_show_zero() eq 'Y')
4986 : $self->part_pkg->$what_show_zero();
4993 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4995 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
4996 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
4998 CUSTNUM is a customer (see L<FS::cust_main>)
5000 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5001 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5004 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5005 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5006 new billing items. An error is returned if this is not possible (see
5007 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5010 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5011 newly-created cust_pkg objects.
5013 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5014 and inserted. Multiple FS::pkg_referral records can be created by
5015 setting I<refnum> to an array reference of refnums or a hash reference with
5016 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5017 record will be created corresponding to cust_main.refnum.
5022 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5024 my $conf = new FS::Conf;
5026 # Transactionize this whole mess
5027 my $oldAutoCommit = $FS::UID::AutoCommit;
5028 local $FS::UID::AutoCommit = 0;
5032 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5033 # return "Customer not found: $custnum" unless $cust_main;
5035 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5038 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5041 my $change = scalar(@old_cust_pkg) != 0;
5044 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5046 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5047 " to pkgpart ". $pkgparts->[0]. "\n"
5050 my $err_or_cust_pkg =
5051 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5052 'refnum' => $refnum,
5055 unless (ref($err_or_cust_pkg)) {
5056 $dbh->rollback if $oldAutoCommit;
5057 return $err_or_cust_pkg;
5060 push @$return_cust_pkg, $err_or_cust_pkg;
5061 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5066 # Create the new packages.
5067 foreach my $pkgpart (@$pkgparts) {
5069 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5071 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5072 pkgpart => $pkgpart,
5076 $error = $cust_pkg->insert( 'change' => $change );
5077 push @$return_cust_pkg, $cust_pkg;
5079 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5080 my $supp_pkg = FS::cust_pkg->new({
5081 custnum => $custnum,
5082 pkgpart => $link->dst_pkgpart,
5084 main_pkgnum => $cust_pkg->pkgnum,
5087 $error ||= $supp_pkg->insert( 'change' => $change );
5088 push @$return_cust_pkg, $supp_pkg;
5092 $dbh->rollback if $oldAutoCommit;
5097 # $return_cust_pkg now contains refs to all of the newly
5100 # Transfer services and cancel old packages.
5101 foreach my $old_pkg (@old_cust_pkg) {
5103 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5106 foreach my $new_pkg (@$return_cust_pkg) {
5107 $error = $old_pkg->transfer($new_pkg);
5108 if ($error and $error == 0) {
5109 # $old_pkg->transfer failed.
5110 $dbh->rollback if $oldAutoCommit;
5115 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5116 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5117 foreach my $new_pkg (@$return_cust_pkg) {
5118 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5119 if ($error and $error == 0) {
5120 # $old_pkg->transfer failed.
5121 $dbh->rollback if $oldAutoCommit;
5128 # Transfers were successful, but we went through all of the
5129 # new packages and still had services left on the old package.
5130 # We can't cancel the package under the circumstances, so abort.
5131 $dbh->rollback if $oldAutoCommit;
5132 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5134 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5140 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5144 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5146 A bulk change method to change packages for multiple customers.
5148 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5149 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5152 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5153 replace. The services (see L<FS::cust_svc>) are moved to the
5154 new billing items. An error is returned if this is not possible (see
5157 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5158 newly-created cust_pkg objects.
5163 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5165 # Transactionize this whole mess
5166 my $oldAutoCommit = $FS::UID::AutoCommit;
5167 local $FS::UID::AutoCommit = 0;
5171 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5174 while(scalar(@old_cust_pkg)) {
5176 my $custnum = $old_cust_pkg[0]->custnum;
5177 my (@remove) = map { $_->pkgnum }
5178 grep { $_->custnum == $custnum } @old_cust_pkg;
5179 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5181 my $error = order $custnum, $pkgparts, \@remove, \@return;
5183 push @errors, $error
5185 push @$return_cust_pkg, @return;
5188 if (scalar(@errors)) {
5189 $dbh->rollback if $oldAutoCommit;
5190 return join(' / ', @errors);
5193 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5197 =item forward_emails
5199 Returns a hash of svcnums and corresponding email addresses
5200 for svc_acct services that can be used as source or dest
5201 for svc_forward services provisioned in this package.
5203 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5204 service; if included, will ensure the current values of the
5205 specified service are included in the list, even if for some
5206 other reason they wouldn't be. If called as a class method
5207 with a specified service, returns only these current values.
5209 Caution: does not actually check if svc_forward services are
5210 available to be provisioned on this package.
5214 sub forward_emails {
5218 #load optional service, thoroughly validated
5219 die "Use svcnum or svc_forward, not both"
5220 if $opt{'svcnum'} && $opt{'svc_forward'};
5221 my $svc_forward = $opt{'svc_forward'};
5222 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5224 die "Specified service is not a forward service"
5225 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5226 die "Specified service not found"
5227 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5231 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5232 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5234 #add current values from specified service, if there was one
5236 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5237 my $svc_acct = $svc_forward->$method();
5238 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5242 if (ref($self) eq 'FS::cust_pkg') {
5244 #and including the rest for this customer
5245 my($u_part_svc,@u_acct_svcparts);
5246 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5247 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5250 my $custnum = $self->getfield('custnum');
5251 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5252 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5253 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5254 foreach my $acct_svcpart (@u_acct_svcparts) {
5255 foreach my $i_cust_svc (
5256 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5257 'svcpart' => $acct_svcpart } )
5259 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5260 $email{$svc_acct->svcnum} = $svc_acct->email;
5269 # Used by FS::Upgrade to migrate to a new database.
5270 sub _upgrade_data { # class method
5271 my ($class, %opts) = @_;
5272 $class->_upgrade_otaker(%opts);
5274 # RT#10139, bug resulting in contract_end being set when it shouldn't
5275 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5276 # RT#10830, bad calculation of prorate date near end of year
5277 # the date range for bill is December 2009, and we move it forward
5278 # one year if it's before the previous bill date (which it should
5280 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5281 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5282 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5283 # RT6628, add order_date to cust_pkg
5284 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5285 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5286 history_action = \'insert\') where order_date is null',
5288 foreach my $sql (@statements) {
5289 my $sth = dbh->prepare($sql);
5290 $sth->execute or die $sth->errstr;
5293 # RT31194: supplemental package links that are deleted don't clean up
5295 my @pkglinknums = qsearch({
5296 'select' => 'DISTINCT cust_pkg.pkglinknum',
5297 'table' => 'cust_pkg',
5298 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5299 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5300 AND part_pkg_link.pkglinknum IS NULL',
5302 foreach (@pkglinknums) {
5303 my $pkglinknum = $_->pkglinknum;
5304 warn "cleaning part_pkg_link #$pkglinknum\n";
5305 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5306 my $error = $part_pkg_link->remove_linked;
5307 die $error if $error;
5315 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5317 In sub order, the @pkgparts array (passed by reference) is clobbered.
5319 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5320 method to pass dates to the recur_prog expression, it should do so.
5322 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5323 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5324 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5325 configuration values. Probably need a subroutine which decides what to do
5326 based on whether or not we've fetched the user yet, rather than a hash. See
5327 FS::UID and the TODO.
5329 Now that things are transactional should the check in the insert method be
5334 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5335 L<FS::pkg_svc>, schema.html from the base documentation