2 use base qw( FS::part_pkg::API
3 FS::m2m_Common FS::o2m_Common FS::option_Common
7 use vars qw( %plans $DEBUG $setup_hack $skip_pkg_svc_hack
8 $cache_enabled %cache_link %cache_pkg_svc
10 use Carp qw(carp cluck confess);
11 use Scalar::Util qw( blessed );
13 use Time::Local qw( timelocal timelocal_nocheck ); # eventually replace with DateTime
16 use FS::Record qw( qsearch qsearchs dbh dbdef );
17 use FS::Cursor; # for upgrade
23 use FS::part_pkg_option;
24 use FS::part_pkg_fcc_option;
27 use FS::part_pkg_msgcat;
28 use FS::part_pkg_taxrate;
29 use FS::part_pkg_taxoverride;
30 use FS::part_pkg_taxproduct;
31 use FS::part_pkg_link;
32 use FS::part_pkg_discount;
33 use FS::part_pkg_vendor;
34 use FS::part_pkg_currency;
35 use FS::part_svc_link;
40 $skip_pkg_svc_hack = 0;
48 FS::part_pkg - Object methods for part_pkg objects
54 $record = new FS::part_pkg \%hash
55 $record = new FS::part_pkg { 'column' => 'value' };
57 $custom_record = $template_record->clone;
59 $error = $record->insert;
61 $error = $new_record->replace($old_record);
63 $error = $record->delete;
65 $error = $record->check;
67 @pkg_svc = $record->pkg_svc;
69 $svcnum = $record->svcpart;
70 $svcnum = $record->svcpart( 'svc_acct' );
74 An FS::part_pkg object represents a package definition. FS::part_pkg
75 inherits from FS::Record. The following fields are currently supported:
79 =item pkgpart - primary key (assigned automatically for new package definitions)
81 =item pkg - Text name of this package definition (customer-viewable)
83 =item comment - Text name of this package definition (non-customer-viewable)
85 =item classnum - Optional package class (see L<FS::pkg_class>)
87 =item promo_code - Promotional code
89 =item setup - Setup fee expression (deprecated)
91 =item freq - Frequency of recurring fee
93 =item recur - Recurring fee expression (deprecated)
95 =item setuptax - Setup fee tax exempt flag, empty or `Y'
97 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
99 =item taxclass - Tax class
101 =item plan - Price plan
103 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
105 =item disabled - Disabled flag, empty or `Y'
107 =item custom - Custom flag, empty or `Y'
109 =item setup_cost - for cost tracking
111 =item recur_cost - for cost tracking
113 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
115 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
117 =item agentnum - Optional agentnum (see L<FS::agent>)
119 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
121 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
124 =item successor - Foreign key for the part_pkg that replaced this record.
125 If this record is not obsolete, will be null.
127 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
128 ancestor of this record. If this record is not a successor to another
129 part_pkg, will be equal to pkgpart.
131 =item delay_start - Number of days to delay package start, by default
133 =item start_on_hold - 'Y' to suspend this package immediately when it is
134 ordered. The package will not start billing or have a setup fee charged
135 until it is manually unsuspended.
137 =item change_to_pkgpart - When this package is ordered, schedule a future
138 package change. The 'expire_months' field will determine when the package
141 =item expire_months - Number of months until this package expires (or changes
144 =item adjourn_months - Number of months until this package becomes suspended.
146 =item contract_end_months - Number of months until the package's contract
157 Creates a new package definition. To add the package definition to
158 the database, see L<"insert">.
162 sub table { 'part_pkg'; }
166 An alternate constructor. Creates a new package definition by duplicating
167 an existing definition. A new pkgpart is assigned and the custom flag is
168 set to Y. To add the package definition to the database, see L<"insert">.
174 my $class = ref($self);
175 my %hash = $self->hash;
176 $hash{'pkgpart'} = '';
177 $hash{'custom'} = 'Y';
178 #new FS::part_pkg ( \%hash ); # ?
179 new $class ( \%hash ); # ?
182 =item insert [ , OPTION => VALUE ... ]
184 Adds this package definition to the database. If there is an error,
185 returns the error, otherwise returns false.
187 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
188 I<custnum_ref> and I<options>.
190 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
191 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
192 be set to a hashref of svcparts and flag values ('Y' or '') to set the
193 'hidden' field in these records, and I<provision_hold> can be set similarly
194 for the 'provision_hold' field in these records.
196 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
197 FS::pkg_svc record will be updated.
199 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
200 record itself), the object will be updated to point to this package definition.
202 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
203 the scalar will be updated with the custnum value from the cust_pkg record.
205 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
206 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
207 records will be inserted.
209 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
210 records will be inserted.
212 If I<part_pkg_currency> is set to a hashref of options (with the keys as
213 option_CURRENCY), appropriate FS::part_pkg::currency records will be inserted.
220 warn "FS::part_pkg::insert called on $self with options ".
221 join(', ', map "$_=>$options{$_}", keys %options)
224 local $SIG{HUP} = 'IGNORE';
225 local $SIG{INT} = 'IGNORE';
226 local $SIG{QUIT} = 'IGNORE';
227 local $SIG{TERM} = 'IGNORE';
228 local $SIG{TSTP} = 'IGNORE';
229 local $SIG{PIPE} = 'IGNORE';
231 my $oldAutoCommit = $FS::UID::AutoCommit;
232 local $FS::UID::AutoCommit = 0;
235 warn " inserting part_pkg record" if $DEBUG;
236 my $error = $self->SUPER::insert( $options{options} );
238 $dbh->rollback if $oldAutoCommit;
243 if ( $self->get('family_pkgpart') eq '' ) {
244 $self->set('family_pkgpart' => $self->pkgpart);
245 $error = $self->SUPER::replace;
247 $dbh->rollback if $oldAutoCommit;
252 warn " inserting part_pkg_taxoverride records" if $DEBUG;
253 my %overrides = %{ $options{'tax_overrides'} || {} };
254 foreach my $usage_class ( keys %overrides ) {
256 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
257 ? $overrides{$usage_class}
259 my @overrides = (grep "$_", split(',', $override) );
260 my $error = $self->process_m2m (
261 'link_table' => 'part_pkg_taxoverride',
262 'target_table' => 'tax_class',
263 'hashref' => { 'usage_class' => $usage_class },
264 'params' => \@overrides,
267 $dbh->rollback if $oldAutoCommit;
272 warn " inserting part_pkg_currency records" if $DEBUG;
273 my %part_pkg_currency = %{ $options{'part_pkg_currency'} || {} };
274 foreach my $key ( keys %part_pkg_currency ) {
275 $key =~ /^(.+)_([A-Z]{3})$/ or next;
276 my( $optionname, $currency ) = ( $1, $2 );
277 if ( $part_pkg_currency{$key} =~ /^\s*$/ ) {
278 if ( $self->option($optionname) == 0 ) {
279 $part_pkg_currency{$key} = '0';
281 $dbh->rollback if $oldAutoCommit;
282 ( my $thing = $optionname ) =~ s/_/ /g;
283 return ucfirst($thing). " $currency is required";
286 my $part_pkg_currency = new FS::part_pkg_currency {
287 'pkgpart' => $self->pkgpart,
288 'optionname' => $optionname,
289 'currency' => $currency,
290 'optionvalue' => $part_pkg_currency{$key},
292 my $error = $part_pkg_currency->insert;
294 $dbh->rollback if $oldAutoCommit;
299 unless ( $skip_pkg_svc_hack ) {
301 warn " inserting pkg_svc records" if $DEBUG;
302 my $pkg_svc = $options{'pkg_svc'} || {};
303 my $hidden_svc = $options{'hidden_svc'} || {};
304 my $provision_hold = $options{'provision_hold'} || {};
305 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
306 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
308 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
312 my $pkg_svc = new FS::pkg_svc( {
313 'pkgpart' => $self->pkgpart,
314 'svcpart' => $part_svc->svcpart,
315 'quantity' => $quantity,
316 'primary_svc' => $primary_svc,
317 'hidden' => $hidden_svc->{$part_svc->svcpart},
318 'provision_hold' => $provision_hold->{$part_svc->svcpart},
320 my $error = $pkg_svc->insert;
322 $dbh->rollback if $oldAutoCommit;
327 my $error = $self->check_pkg_svc(%options);
329 $dbh->rollback if $oldAutoCommit;
335 if ( $options{'cust_pkg'} ) {
336 warn " updating cust_pkg record " if $DEBUG;
338 ref($options{'cust_pkg'})
339 ? $options{'cust_pkg'}
340 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
341 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
342 if $options{'custnum_ref'};
343 my %hash = $old_cust_pkg->hash;
344 $hash{'pkgpart'} = $self->pkgpart,
345 my $new_cust_pkg = new FS::cust_pkg \%hash;
346 local($FS::cust_pkg::disable_agentcheck) = 1;
347 my $error = $new_cust_pkg->replace($old_cust_pkg);
349 $dbh->rollback if $oldAutoCommit;
350 return "Error modifying cust_pkg record: $error";
354 if ( $options{'part_pkg_vendor'} ) {
355 while ( my ($exportnum, $vendor_pkg_id) =
356 each %{ $options{part_pkg_vendor} }
359 my $ppv = new FS::part_pkg_vendor( {
360 'pkgpart' => $self->pkgpart,
361 'exportnum' => $exportnum,
362 'vendor_pkg_id' => $vendor_pkg_id,
364 my $error = $ppv->insert;
366 $dbh->rollback if $oldAutoCommit;
367 return "Error inserting part_pkg_vendor record: $error";
372 if ( $options{fcc_options} ) {
373 warn " updating fcc options " if $DEBUG;
374 $self->set_fcc_options( $options{fcc_options} );
377 warn " committing transaction" if $DEBUG and $oldAutoCommit;
378 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
385 Currently unimplemented.
390 return "Can't (yet?) delete package definitions.";
391 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
394 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
396 Replaces OLD_RECORD with this one in the database. If there is an error,
397 returns the error, otherwise returns false.
399 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>,
400 I<bulk_skip>, I<provision_hold> and I<options>
402 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
403 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
404 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
405 'hidden' field in these records. I<bulk_skip> and I<provision_hold> can be set
406 to a hashref of svcparts and flag values ('Y' or '') to set the respective field
409 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
410 FS::pkg_svc record will be updated.
412 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
415 If I<part_pkg_currency> is set to a hashref of options (with the keys as
416 option_CURRENCY), appropriate FS::part_pkg::currency records will be replaced.
423 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
428 ( ref($_[0]) eq 'HASH' )
432 $options->{options} = { $old->options } unless defined($options->{options});
434 warn "FS::part_pkg::replace called on $new to replace $old with options".
435 join(', ', map "$_ => ". $options->{$_}, keys %$options)
438 local $SIG{HUP} = 'IGNORE';
439 local $SIG{INT} = 'IGNORE';
440 local $SIG{QUIT} = 'IGNORE';
441 local $SIG{TERM} = 'IGNORE';
442 local $SIG{TSTP} = 'IGNORE';
443 local $SIG{PIPE} = 'IGNORE';
445 my $oldAutoCommit = $FS::UID::AutoCommit;
446 local $FS::UID::AutoCommit = 0;
449 my $conf = new FS::Conf;
450 if ( $conf->exists('part_pkg-lineage') ) {
451 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
452 qw(setup_fee recur_fee) #others? config?
455 warn " superseding package" if $DEBUG;
457 my $error = $new->supersede($old, %$options);
459 $dbh->rollback if $oldAutoCommit;
463 warn " committing transaction" if $DEBUG and $oldAutoCommit;
464 $dbh->commit if $oldAutoCommit;
471 #plandata shit stays in replace for upgrades until after 2.0 (or edit
473 warn " saving legacy plandata" if $DEBUG;
474 my $plandata = $new->get('plandata');
475 $new->set('plandata', '');
477 warn " deleting old part_pkg_option records" if $DEBUG;
478 foreach my $part_pkg_option ( $old->part_pkg_option ) {
479 my $error = $part_pkg_option->delete;
481 $dbh->rollback if $oldAutoCommit;
486 warn " replacing part_pkg record" if $DEBUG;
487 my $error = $new->SUPER::replace($old, $options->{options} );
489 $dbh->rollback if $oldAutoCommit;
493 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
494 foreach my $part_pkg_option (
495 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
496 return "illegal plandata: $plandata";
498 new FS::part_pkg_option {
499 'pkgpart' => $new->pkgpart,
504 split("\n", $plandata)
506 my $error = $part_pkg_option->insert;
508 $dbh->rollback if $oldAutoCommit;
513 #trivial nit: not the most efficient to delete and reinsert
514 warn " deleting old part_pkg_currency records" if $DEBUG;
515 foreach my $part_pkg_currency ( $old->part_pkg_currency ) {
516 my $error = $part_pkg_currency->delete;
518 $dbh->rollback if $oldAutoCommit;
519 return "error deleting part_pkg_currency record: $error";
523 warn " inserting new part_pkg_currency records" if $DEBUG;
524 my %part_pkg_currency = %{ $options->{'part_pkg_currency'} || {} };
525 foreach my $key ( keys %part_pkg_currency ) {
526 $key =~ /^(.+)_([A-Z]{3})$/ or next;
527 my $part_pkg_currency = new FS::part_pkg_currency {
528 'pkgpart' => $new->pkgpart,
531 'optionvalue' => $part_pkg_currency{$key},
533 my $error = $part_pkg_currency->insert;
535 $dbh->rollback if $oldAutoCommit;
536 return "error inserting part_pkg_currency record: $error";
541 warn " replacing pkg_svc records" if $DEBUG;
542 my $pkg_svc = $options->{'pkg_svc'};
543 my $hidden_svc = $options->{'hidden_svc'} || {};
544 my $bulk_skip = $options->{'bulk_skip'} || {};
545 my $provision_hold = $options->{'provision_hold'} || {};
546 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
548 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
549 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
550 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
551 my $bulk_skip = $bulk_skip->{$part_svc->svcpart} || '';
552 my $provision_hold = $provision_hold->{$part_svc->svcpart} || '';
554 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
555 && $options->{'primary_svc'} == $part_svc->svcpart
560 my $old_pkg_svc = qsearchs('pkg_svc', {
561 'pkgpart' => $old->pkgpart,
562 'svcpart' => $part_svc->svcpart,
565 my $old_quantity = 0;
566 my $old_primary_svc = '';
568 my $old_bulk_skip = '';
569 my $old_provision_hold = '';
570 if ( $old_pkg_svc ) {
571 $old_quantity = $old_pkg_svc->quantity;
572 $old_primary_svc = $old_pkg_svc->primary_svc
573 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
574 $old_hidden = $old_pkg_svc->hidden;
575 $old_bulk_skip = $old_pkg_svc->old_bulk_skip; # should this just be bulk_skip?
576 $old_provision_hold = $old_pkg_svc->provision_hold;
579 next unless $old_quantity != $quantity
580 || $old_primary_svc ne $primary_svc
581 || $old_hidden ne $hidden
582 || $old_bulk_skip ne $bulk_skip
583 || $old_provision_hold ne $provision_hold;
585 my $new_pkg_svc = new FS::pkg_svc( {
586 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
587 'pkgpart' => $new->pkgpart,
588 'svcpart' => $part_svc->svcpart,
589 'quantity' => $quantity,
590 'primary_svc' => $primary_svc,
592 'bulk_skip' => $bulk_skip,
593 'provision_hold' => $provision_hold,
595 my $error = $old_pkg_svc
596 ? $new_pkg_svc->replace($old_pkg_svc)
597 : $new_pkg_svc->insert;
599 $dbh->rollback if $oldAutoCommit;
604 my $error = $new->check_pkg_svc(%$options);
606 $dbh->rollback if $oldAutoCommit;
610 } #if $options->{pkg_svc}
612 my @part_pkg_vendor = $old->part_pkg_vendor;
613 my @current_exportnum = ();
614 if ( $options->{'part_pkg_vendor'} ) {
615 my($exportnum,$vendor_pkg_id);
616 while ( ($exportnum,$vendor_pkg_id)
617 = each %{$options->{'part_pkg_vendor'}} ) {
619 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
620 if($exportnum == $part_pkg_vendor->exportnum
621 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
622 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
623 my $error = $part_pkg_vendor->replace;
625 $dbh->rollback if $oldAutoCommit;
626 return "Error replacing part_pkg_vendor record: $error";
631 elsif($exportnum == $part_pkg_vendor->exportnum
632 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
637 unless ( $noinsert ) {
638 my $ppv = new FS::part_pkg_vendor( {
639 'pkgpart' => $new->pkgpart,
640 'exportnum' => $exportnum,
641 'vendor_pkg_id' => $vendor_pkg_id,
643 my $error = $ppv->insert;
645 $dbh->rollback if $oldAutoCommit;
646 return "Error inserting part_pkg_vendor record: $error";
649 push @current_exportnum, $exportnum;
652 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
653 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
654 my $error = $part_pkg_vendor->delete;
656 $dbh->rollback if $oldAutoCommit;
657 return "Error deleting part_pkg_vendor record: $error";
662 # propagate changes to certain core fields
663 if ( $conf->exists('part_pkg-lineage') ) {
664 warn " propagating changes to family" if $DEBUG;
665 my $error = $new->propagate($old);
667 $dbh->rollback if $oldAutoCommit;
672 if ( $options->{fcc_options} ) {
673 warn " updating fcc options " if $DEBUG;
674 $new->set_fcc_options( $options->{fcc_options} );
677 warn " committing transaction" if $DEBUG and $oldAutoCommit;
678 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
684 Checks all fields to make sure this is a valid package definition. If
685 there is an error, returns the error, otherwise returns false. Called by the
686 insert and replace methods.
692 warn "FS::part_pkg::check called on $self" if $DEBUG;
694 for (qw(setup recur plandata)) {
695 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
696 return "Use of $_ field is deprecated; set a plan and options: ".
698 if length($self->get($_));
702 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
703 my $error = $self->ut_number('freq');
704 return $error if $error;
706 $self->freq =~ /^(\d+[hdw]?)$/
707 or return "Illegal or empty freq: ". $self->freq;
711 my @null_agentnum_right = ( 'Edit global package definitions' );
712 push @null_agentnum_right, 'One-time charge'
713 if $self->freq =~ /^0/;
714 push @null_agentnum_right, 'Customize customer package'
715 if $self->disabled eq 'Y'; #good enough
717 my $error = $self->ut_numbern('pkgpart')
718 || $self->ut_text('pkg')
719 || $self->ut_textn('comment')
720 || $self->ut_textn('promo_code')
721 || $self->ut_alphan('plan')
722 || $self->ut_flag('setuptax')
723 || $self->ut_flag('recurtax')
724 || $self->ut_textn('taxclass')
725 || $self->ut_flag('disabled')
726 || $self->ut_flag('custom')
727 || $self->ut_flag('no_auto')
728 || $self->ut_flag('recur_show_zero')
729 || $self->ut_flag('setup_show_zero')
730 || $self->ut_flag('start_on_hold')
731 #|| $self->ut_moneyn('setup_cost')
732 #|| $self->ut_moneyn('recur_cost')
733 || $self->ut_floatn('setup_cost')
734 || $self->ut_floatn('recur_cost')
735 || $self->ut_floatn('pay_weight')
736 || $self->ut_floatn('credit_weight')
737 || $self->ut_numbern('taxproductnum')
738 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
739 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
740 || $self->ut_foreign_keyn('taxproductnum',
741 'part_pkg_taxproduct',
745 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
746 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
748 || $self->ut_numbern('fcc_ds0s')
749 || $self->ut_numbern('fcc_voip_class')
750 || $self->ut_numbern('delay_start')
751 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
752 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
753 || $self->ut_numbern('expire_months')
754 || $self->ut_numbern('adjourn_months')
755 || $self->ut_numbern('contract_end_months')
756 || $self->ut_numbern('change_to_pkgpart')
757 || $self->ut_foreign_keyn('change_to_pkgpart', 'part_pkg', 'pkgpart')
758 || $self->ut_alphan('agent_pkgpartid')
759 || $self->SUPER::check
761 return $error if $error;
763 return 'Unknown plan '. $self->plan
764 unless exists($plans{$self->plan});
766 my $conf = new FS::Conf;
767 return 'Taxclass is required'
768 if ! $self->taxclass && $conf->exists('require_taxclasses');
775 For a passed I<$options> hashref, validates any options that
776 have 'validate' subroutines defined in the info hash,
777 then validates the entire hashref if the price plan has
778 its own 'validate' subroutine defined in the info hash
779 (I<$options> values might be altered.)
781 Returns error message, or empty string if valid.
783 Invoked by L</insert> and L</replace> via the equivalent
784 methods in L<FS::option_Common>.
789 my ($self,$options) = @_;
790 foreach my $option (keys %$options) {
791 if (exists $plans{ $self->plan }->{fields}->{$option}) {
792 if (exists($plans{$self->plan}->{fields}->{$option}->{'validate'})) {
793 # pass option name for use in error message
794 # pass a reference to the $options value, so it can be cleaned up
795 my $error = &{$plans{$self->plan}->{fields}->{$option}->{'validate'}}($option,\($options->{$option}));
796 return $error if $error;
798 } # else "option does not exist" error?
800 if (exists($plans{$self->plan}->{'validate'})) {
801 my $error = &{$plans{$self->plan}->{'validate'}}($options);
802 return $error if $error;
809 Checks pkg_svc records as a whole (for part_svc_link dependencies).
811 If there is an error, returns the error, otherwise returns false.
816 my( $self, %opt ) = @_;
818 my $agentnum = $self->agentnum;
820 my %pkg_svc = map { $_->svcpart => $_ } $self->pkg_svc;
822 foreach my $svcpart ( keys %pkg_svc ) {
824 foreach my $part_svc_link ( $self->part_svc_link(
825 'src_svcpart' => $svcpart,
826 'link_type' => 'part_pkg_restrict',
830 return $part_svc_link->dst_svc. ' must be included with '.
831 $part_svc_link->src_svc
832 unless $pkg_svc{ $part_svc_link->dst_svcpart };
837 return '' if $opt{part_pkg_restrict_soft_override};
839 foreach my $svcpart ( keys %pkg_svc ) {
841 foreach my $part_svc_link ( $self->part_svc_link(
842 'src_svcpart' => $svcpart,
843 'link_type' => 'part_pkg_restrict_soft',
846 return $part_svc_link->dst_svc. ' is suggested with '.
847 $part_svc_link->src_svc
848 unless $pkg_svc{ $part_svc_link->dst_svcpart };
856 =item part_svc_link OPTION => VALUE ...
858 Returns the service dependencies (see L<FS::part_svc_link>) for the given
859 search options, taking into account this package definition's agent.
861 Available options are any field in part_svc_link. Typically used options are
862 src_svcpart and link_type.
867 FS::part_svc_link->by_agentnum( shift->agentnum, @_ );
870 =item supersede OLD [, OPTION => VALUE ... ]
872 Inserts this package as a successor to the package OLD. All options are as
873 for C<insert>. After inserting, disables OLD and sets the new package as its
879 my ($new, $old, %options) = @_;
882 $new->set('pkgpart' => '');
883 $new->set('family_pkgpart' => $old->family_pkgpart);
884 warn " inserting successor package\n" if $DEBUG;
885 $error = $new->insert(%options);
886 return $error if $error;
888 warn " disabling superseded package\n" if $DEBUG;
889 $old->set('successor' => $new->pkgpart);
890 $old->set('disabled' => 'Y');
891 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
892 return $error if $error;
894 warn " propagating changes to family" if $DEBUG;
895 $new->propagate($old);
900 If any of certain fields have changed from OLD to this package, then,
901 for all packages in the same lineage as this one, sets those fields
902 to their values in this package.
906 my @propagate_fields = (
907 qw( pkg classnum setup_cost recur_cost taxclass
908 setuptax recurtax pay_weight credit_weight
916 map { $_ => $new->get($_) }
917 grep { $new->get($_) ne $old->get($_) }
921 my @part_pkg = qsearch('part_pkg', {
922 'family_pkgpart' => $new->family_pkgpart
925 foreach my $part_pkg ( @part_pkg ) {
926 my $pkgpart = $part_pkg->pkgpart;
927 next if $pkgpart == $new->pkgpart; # don't modify $new
928 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
929 foreach ( keys %fields ) {
930 $part_pkg->set($_, $fields{$_});
932 # SUPER::replace to avoid changing non-core fields
933 my $error = $part_pkg->SUPER::replace;
934 push @error, "pkgpart $pkgpart: $error"
940 =item set_fcc_options HASHREF
942 Sets the FCC options on this package definition to the values specified
947 sub set_fcc_options {
949 my $pkgpart = $self->pkgpart;
957 my %existing_num = map { $_->fccoptionname => $_->num }
958 qsearch('part_pkg_fcc_option', { pkgpart => $pkgpart });
960 local $FS::Record::nowarn_identical = 1;
961 # set up params for process_o2m
964 foreach my $name (keys %$options ) {
965 $params->{ "num$i" } = $existing_num{$name} || '';
966 $params->{ "num$i".'_fccoptionname' } = $name;
967 $params->{ "num$i".'_optionvalue' } = $options->{$name};
972 table => 'part_pkg_fcc_option',
973 fields => [qw( fccoptionname optionvalue )],
978 =item pkg_locale LOCALE
980 Returns a customer-viewable string representing this package for the given
981 locale, from the part_pkg_msgcat table. If the given locale is empty or no
982 localized string is found, returns the base pkg field.
987 my( $self, $locale ) = @_;
988 return $self->pkg unless $locale;
989 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
990 $part_pkg_msgcat->pkg;
993 =item part_pkg_msgcat LOCALE
995 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
999 sub part_pkg_msgcat {
1000 my( $self, $locale ) = @_;
1001 qsearchs( 'part_pkg_msgcat', {
1002 pkgpart => $self->pkgpart,
1007 =item pkg_comment [ OPTION => VALUE... ]
1009 Returns an (internal) string representing this package. Currently,
1010 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
1011 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
1014 If the option nopkgpart is true then the "pkgpart: ' is omitted.
1022 #$self->pkg. ' - '. $self->comment;
1023 #$self->pkg. ' ('. $self->comment. ')';
1024 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
1025 my $custom_comment = $self->custom_comment(%opt);
1026 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
1029 #without price info (so without hitting the DB again)
1030 sub pkg_comment_only {
1034 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
1035 my $comment = $self->comment;
1036 $pre. $self->pkg. ( $comment ? " - $comment" : '' );
1039 sub price_info { # safety, in case a part_pkg hasn't defined price_info
1043 sub custom_comment {
1045 my $price_info = $self->price_info(@_);
1046 ( $self->custom ? '(CUSTOM) ' : '' ).
1048 ( ($self->custom || $self->comment) ? ' - ' : '' ).
1049 ($price_info || 'No charge');
1052 sub pkg_price_info {
1054 $self->pkg. ' - '. ($self->price_info || 'No charge');
1059 Returns the package class, as an FS::pkg_class object, or the empty string
1060 if there is no package class.
1062 =item addon_pkg_class
1064 Returns the add-on package class, as an FS::pkg_class object, or the empty
1065 string if there is no add-on package class.
1069 sub addon_pkg_class {
1071 if ( $self->addon_classnum ) {
1072 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
1080 Returns the package category name, or the empty string if there is no package
1087 my $pkg_class = $self->pkg_class;
1089 ? $pkg_class->categoryname
1095 Returns the package class name, or the empty string if there is no package
1102 my $pkg_class = $self->pkg_class;
1104 ? $pkg_class->classname
1108 =item addon_classname
1110 Returns the add-on package class name, or the empty string if there is no
1111 add-on package class.
1115 sub addon_classname {
1117 my $pkg_class = $self->addon_pkg_class;
1119 ? $pkg_class->classname
1125 Returns the associated agent for this event, if any, as an FS::agent object.
1127 =item pkg_svc [ HASHREF | OPTION => VALUE ]
1129 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
1130 definition (with non-zero quantity).
1132 One option is available, I<disable_linked>. If set true it will return the
1133 services for this package definition alone, omitting services from any add-on
1140 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
1148 return @{ $cache_pkg_svc{$self->pkgpart} }
1149 if $cache_enabled && $cache_pkg_svc{$self->pkgpart};
1151 # #sort { $b->primary cmp $a->primary }
1152 # grep { $_->quantity }
1153 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
1155 my $opt = ref($_[0]) ? $_[0] : { @_ };
1156 my %pkg_svc = map { $_->svcpart => $_ } $self->_pkg_svc;
1158 unless ( $opt->{disable_linked} ) {
1159 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
1160 my @pkg_svc = $dst_pkg->_pkg_svc;
1161 foreach my $pkg_svc ( @pkg_svc ) {
1162 if ( $pkg_svc{$pkg_svc->svcpart} ) {
1163 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
1164 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
1166 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
1172 my @pkg_svc = values(%pkg_svc);
1174 $cache_pkg_svc{$self->pkgpart} = \@pkg_svc if $cache_enabled;
1182 grep { $_->quantity }
1184 'select' => 'pkg_svc.*, part_svc.*',
1185 'table' => 'pkg_svc',
1186 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
1187 'hashref' => { 'pkgpart' => $self->pkgpart },
1191 =item svcpart [ SVCDB ]
1193 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
1194 associated with this package definition (see L<FS::pkg_svc>). Returns
1195 false if there not a primary service definition or exactly one service
1196 definition with quantity 1, or if SVCDB is specified and does not match the
1197 svcdb of the service definition. SVCDB can be specified as a scalar table
1198 name, such as 'svc_acct', or as an arrayref of possible table names.
1203 my $pkg_svc = shift->_primary_pkg_svc(@_);
1204 $pkg_svc ? $pkg_svc->svcpart : '';
1207 =item part_svc [ SVCDB ]
1209 Like the B<svcpart> method, but returns the FS::part_svc object (see
1215 my $pkg_svc = shift->_primary_pkg_svc(@_);
1216 $pkg_svc ? $pkg_svc->part_svc : '';
1219 sub _primary_pkg_svc {
1222 my $svcdb = scalar(@_) ? shift : [];
1223 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1224 my %svcdb = map { $_=>1 } @$svcdb;
1227 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1230 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1231 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1233 return '' if scalar(@pkg_svc) != 1;
1237 =item svcpart_unique_svcdb SVCDB
1239 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1240 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1241 false if there not a primary service definition for SVCDB or there are multiple
1242 service definitions for SVCDB.
1246 sub svcpart_unique_svcdb {
1247 my( $self, $svcdb ) = @_;
1248 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1249 return '' if scalar(@svcdb_pkg_svc) != 1;
1250 $svcdb_pkg_svc[0]->svcpart;
1255 Returns a list of the acceptable payment types for this package. Eventually
1256 this should come out of a database table and be editable, but currently has the
1257 following logic instead:
1259 If the package is free, the single item B<BILL> is
1260 returned, otherwise, the single item B<CARD> is returned.
1262 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1268 if ( $self->is_free ) {
1277 Returns true if this package is free.
1283 if ( $self->can('is_free_options') ) {
1284 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1285 map { $self->option($_) }
1286 $self->is_free_options;
1288 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1289 "provides neither is_free_options nor is_free method; returning false";
1294 # whether the plan allows discounts to be applied to this package
1295 sub can_discount { 0; }
1297 # whether the plan allows changing the start date
1298 sub can_start_date {
1300 $self->start_on_hold ? 0 : 1;
1303 # whether the plan supports part_pkg_usageprice add-ons (a specific kind of
1304 # pre-selectable usage pricing, there's others this doesn't refer to)
1305 sub can_usageprice { 0; }
1307 # the delay start date if present
1308 sub delay_start_date {
1311 my $delay = $self->delay_start or return '';
1313 # avoid timelocal silliness
1314 my $dt = DateTime->today(time_zone => 'local');
1315 $dt->add(days => $delay);
1319 sub can_currency_exchange { 0; }
1322 # moved to FS::Misc to make this accessible to other packages
1324 FS::Misc::pkg_freqs();
1329 Returns an english representation of the I<freq> field, such as "monthly",
1330 "weekly", "semi-annually", etc.
1336 my $freq = $self->freq;
1338 #my $freqs_href = $self->freqs_href;
1339 my $freqs_href = freqs_href();
1341 if ( exists($freqs_href->{$freq}) ) {
1342 $freqs_href->{$freq};
1344 my $interval = 'month';
1345 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1346 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1347 $interval = $interval{$2};
1352 "every $freq ${interval}s";
1357 =item add_freq TIMESTAMP [ FREQ ]
1359 Adds a billing period of some frequency to the provided timestamp and
1360 returns the resulting timestamp, or -1 if the frequency could not be
1361 parsed (shouldn't happen). By default, the frequency of this package
1362 will be used; to override this, pass a different frequency as a second
1368 my( $self, $date, $freq ) = @_;
1369 $freq = $self->freq unless $freq;
1371 #change this bit to use Date::Manip? CAREFUL with timezones (see
1372 # mailing list archive)
1373 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1375 if ( $freq =~ /^\d+$/ ) {
1377 until ( $mon < 12 ) { $mon -= 12; $year++; }
1379 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1381 } elsif ( $freq =~ /^(\d+)w$/ ) {
1383 $mday += $weeks * 7;
1384 } elsif ( $freq =~ /^(\d+)d$/ ) {
1387 } elsif ( $freq =~ /^(\d+)h$/ ) {
1394 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1399 For backwards compatibility, returns the plandata field as well as all options
1400 from FS::part_pkg_option.
1406 carp "plandata is deprecated";
1408 $self->SUPER::plandata(@_);
1410 my $plandata = $self->get('plandata');
1411 my %options = $self->options;
1412 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1417 =item part_pkg_vendor
1419 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1420 L<FS::part_pkg_vendor>).
1422 =item vendor_pkg_ids
1424 Returns a list of vendor/external package ids by exportnum
1428 sub vendor_pkg_ids {
1430 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1433 =item part_pkg_option
1435 Returns all options as FS::part_pkg_option objects (see
1436 L<FS::part_pkg_option>).
1440 Returns a list of option names and values suitable for assigning to a hash.
1446 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1449 =item option OPTIONNAME [ QUIET ]
1451 Returns the option value for the given name, or the empty string. If a true
1452 value is passed as the second argument, warnings about missing the option
1458 my( $self, $opt, $ornull ) = @_;
1460 #cache: was pulled up in the original part_pkg query
1461 return $self->hashref->{"_opt_$opt"}
1462 if exists $self->hashref->{"_opt_$opt"};
1464 cluck "$self -> option: searching for $opt" if $DEBUG;
1465 my $part_pkg_option =
1466 qsearchs('part_pkg_option', {
1467 pkgpart => $self->pkgpart,
1470 return $part_pkg_option->optionvalue if $part_pkg_option;
1472 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1473 split("\n", $self->get('plandata') );
1474 return $plandata{$opt} if exists $plandata{$opt};
1476 # check whether the option is defined in plan info (if so, don't warn)
1477 if (exists $plans{ $self->plan }->{fields}->{$opt}) {
1480 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1481 "not found in options or plandata!\n"
1487 =item part_pkg_currency [ CURRENCY ]
1489 Returns all currency options as FS::part_pkg_currency objects (see
1490 L<FS::part_pkg_currency>), or, if a currency is specified, only return the
1491 objects for that currency.
1495 sub part_pkg_currency {
1497 my %hash = ( 'pkgpart' => $self->pkgpart );
1498 $hash{'currency'} = shift if @_;
1499 qsearch('part_pkg_currency', \%hash );
1502 =item part_pkg_currency_options CURRENCY
1504 Returns a list of option names and values from FS::part_pkg_currency for the
1509 sub part_pkg_currency_options {
1511 map { $_->optionname => $_->optionvalue } $self->part_pkg_currency(shift);
1514 =item part_pkg_currency_option CURRENCY OPTIONNAME
1516 Returns the option value for the given name and currency.
1520 sub part_pkg_currency_option {
1521 my( $self, $currency, $optionname ) = @_;
1522 my $part_pkg_currency =
1523 qsearchs('part_pkg_currency', { 'pkgpart' => $self->pkgpart,
1524 'currency' => $currency,
1525 'optionname' => $optionname,
1528 #fatal if not found? that works for our use cases from
1529 #part_pkg/currency_fixed, but isn't how we would typically/expect the method
1530 #to behave. have to catch it there if we change it here...
1531 or die "Unknown price for ". $self->pkg_comment. " in $currency\n";
1533 $part_pkg_currency->optionvalue;
1536 =item fcc_option OPTIONNAME
1538 Returns the FCC 477 report option value for the given name, or the empty
1544 my ($self, $name) = @_;
1545 my $part_pkg_fcc_option =
1546 qsearchs('part_pkg_fcc_option', {
1547 pkgpart => $self->pkgpart,
1548 fccoptionname => $name,
1550 $part_pkg_fcc_option ? $part_pkg_fcc_option->optionvalue : '';
1555 Returns all FCC 477 report options for this package, as a hash-like list.
1561 map { $_->fccoptionname => $_->optionvalue }
1562 qsearch('part_pkg_fcc_option', { pkgpart => $self->pkgpart });
1565 =item bill_part_pkg_link
1567 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1571 sub bill_part_pkg_link {
1572 shift->_part_pkg_link('bill', @_);
1575 =item svc_part_pkg_link
1577 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1581 sub svc_part_pkg_link {
1582 shift->_part_pkg_link('svc', @_);
1585 =item supp_part_pkg_link
1587 Returns the associated part_pkg_link records of type 'supp' (supplemental
1592 sub supp_part_pkg_link {
1593 shift->_part_pkg_link('supp', @_);
1596 sub _part_pkg_link {
1597 my( $self, $type ) = @_;
1599 return @{ $cache_link{$type}->{$self->pkgpart} }
1600 if $cache_enabled && $cache_link{$type}->{$self->pkgpart};
1602 cluck $type.'_part_pkg_link called' if $DEBUG;
1605 qsearch({ table => 'part_pkg_link',
1606 hashref => { src_pkgpart => $self->pkgpart,
1608 #protection against infinite recursive links
1609 dst_pkgpart => { op=>'!=', value=> $self->pkgpart },
1611 order_by => "ORDER BY hidden",
1614 $cache_link{$type}->{$self->pkgpart} = \@ppl if $cache_enabled;
1619 sub self_and_bill_linked {
1620 shift->_self_and_linked('bill', @_);
1623 sub self_and_svc_linked {
1624 shift->_self_and_linked('svc', @_);
1627 sub _self_and_linked {
1628 my( $self, $type, $hidden ) = @_;
1632 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1633 $self->_part_pkg_link($type) ) )
1635 $_->hidden($hidden) if $hidden;
1642 =item part_pkg_taxoverride [ CLASS ]
1644 Returns all associated FS::part_pkg_taxoverride objects (see
1645 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1646 of class CLASS if defined. Class may be one of 'setup', 'recur',
1647 the empty string (default), or a usage class number (see L<FS::usage_class>).
1648 When a class is specified, the empty string class (default) is returned
1649 if no more specific values exist.
1653 sub part_pkg_taxoverride {
1657 my $hashref = { 'pkgpart' => $self->pkgpart };
1658 $hashref->{'usage_class'} = $class if defined($class);
1659 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1661 unless ( scalar(@overrides) || !defined($class) || !$class ){
1662 $hashref->{'usage_class'} = '';
1663 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1669 =item has_taxproduct
1671 Returns true if this package has any taxproduct associated with it.
1675 sub has_taxproduct {
1678 $self->taxproductnum ||
1679 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1680 keys %{ {$self->options} }
1686 =item taxproduct [ CLASS ]
1688 Returns the associated tax product for this package definition (see
1689 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1690 the usage classnum (see L<FS::usage_class>). Returns the default
1691 tax product for this record if the more specific CLASS value does
1700 my $part_pkg_taxproduct;
1702 my $taxproductnum = $self->taxproductnum;
1704 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1705 $taxproductnum = $class_taxproductnum
1706 if $class_taxproductnum
1709 $part_pkg_taxproduct =
1710 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1712 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1713 $taxproductnum = $self->taxproductnum;
1714 $part_pkg_taxproduct =
1715 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1718 $part_pkg_taxproduct;
1721 =item taxproduct_description [ CLASS ]
1723 Returns the description of the associated tax product for this package
1724 definition (see L<FS::part_pkg_taxproduct>).
1728 sub taxproduct_description {
1730 my $part_pkg_taxproduct = $self->taxproduct(@_);
1731 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1735 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1737 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1738 package in the location specified by GEOCODE, for usage class CLASS (one of
1739 'setup', 'recur', null, or a C<usage_class> number).
1745 my ($vendor, $geocode, $class) = @_;
1746 # if this part_pkg is overridden into a specific taxclass, get that class
1747 my @taxclassnums = map { $_->taxclassnum }
1748 $self->part_pkg_taxoverride($class);
1749 # otherwise, get its tax product category
1750 if (!@taxclassnums) {
1751 my $part_pkg_taxproduct = $self->taxproduct($class);
1752 # If this isn't defined, then the class has no taxproduct designation,
1753 # so return no tax rates.
1754 return () if !$part_pkg_taxproduct;
1756 # convert the taxproduct to the tax classes that might apply to it in
1758 @taxclassnums = map { $_->taxclassnum }
1759 grep { $_->taxable eq 'Y' } # why do we need this?
1760 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1762 return unless @taxclassnums;
1764 # then look up the actual tax_rate entries
1765 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1767 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1768 my @taxes = qsearch({ 'table' => 'tax_rate',
1769 'hashref' => { 'geocode' => $geocode,
1770 'data_vendor' => $vendor,
1772 'extra_sql' => $extra_sql,
1774 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1780 =item part_pkg_discount
1782 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1785 =item part_pkg_usage
1787 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1792 Returns the automatic transfer target for this package, or an empty string
1799 my $pkgpart = $self->change_to_pkgpart or return '';
1800 FS::part_pkg->by_key($pkgpart);
1805 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1806 PLAN is the object's I<plan> field. There should be better docs
1807 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1813 my $plan = $self->plan;
1815 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1819 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1820 my $class = ref($self). "::$plan";
1821 warn "reblessing $self into $class" if $DEBUG > 1;
1824 bless($self, $class) unless $@;
1828 =item calc_setup CUST_PKG START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1830 =item calc_recur CUST_PKG START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1832 Calculates and returns the setup or recurring fees, respectively, for this
1833 package. Implementation is in the FS::part_pkg:* module specific to this price
1836 Adds invoicing details to the passed-in DETAILS_ARRAYREF
1838 Options are passed as a hashref. Available options:
1844 Frequency override (for calc_recur)
1848 This option is filled in by the method rather than controlling its operation.
1849 It is an arrayref. Applicable discounts will be added to the arrayref, as
1850 L<FS::cust_bill_pkg_discount|FS::cust_bill_pkg_discount records>.
1854 For package add-ons, is the base L<FS::part_pkg|package definition>, otherwise
1855 no different than pkgpart.
1857 =item precommit_hooks
1859 This option is filled in by the method rather than controlling its operation.
1860 It is an arrayref. Anonymous coderefs will be added to the arrayref. They
1861 need to be called before completing the billing operation. For calc_recur
1864 =item increment_next_bill
1866 Increment the next bill date (boolean, for calc_recur). Typically true except
1867 for particular situations.
1871 This option is filled in by the method rather than controlling its operation.
1872 It indicates a deferred setup fee that is billed at calc_recur time (see price
1873 plan option prorate_defer_bill).
1877 Note: Don't calculate prices when not actually billing the package. For that,
1878 see the L</base_setup|base_setup> and L</base_recur|base_recur> methods.
1883 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1884 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1886 =item calc_remain CUST_PKG [ OPTION => VALUE ... ]
1888 Calculates and returns the remaining value to be credited upon package
1889 suspension, change, or cancellation, if enabled.
1891 Options are passed as a list of keys and values. Available options:
1897 Override for the current time
1899 =item cust_credit_source_bill_pkg
1901 This option is filled in by the method rather than controlling its operation.
1903 L<FS::cust_credit_source_bill_pkg|FS::cust_credit_source_bill_pkg> records will
1904 be added to the arrayref indicating the specific line items and amounts which
1905 are the source of this remaining credit.
1909 Note: Don't calculate prices when not actually suspending or cancelling the
1914 #fallback that returns 0 for old legacy packages with no plan
1915 sub calc_remain { 0; }
1917 =item calc_units CUST_PKG
1919 This returns the number of provisioned svc_phone records, or, of the package
1920 count_available_phones option is set, the number available to be provisioned
1926 my($self, $cust_pkg ) = @_;
1928 if ( $self->option('count_available_phones', 1)) {
1929 foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) {
1930 if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx?
1931 $count += $pkg_svc->quantity || 0;
1934 $count *= $cust_pkg->quantity;
1937 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
1942 #fallback for everything not based on flat.pm
1943 sub recur_temporality { 'upcoming'; }
1945 =item calc_cancel START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1947 Runs any necessary billing on cancellation: another recurring cycle for
1948 recur_temporailty 'preceding' pacakges with the bill_recur_on_cancel option
1949 set (calc_recur), or, any outstanding usage for pacakges with the
1950 bill_usage_on_cancel option set (calc_usage).
1954 #fallback for everything not based on flat.pm, doesn't do this yet (which is
1955 #okay, nothing of ours not based on flat.pm does usage-on-cancel billing
1956 sub calc_cancel { 0; }
1958 #fallback for everything except bulk.pm
1959 sub hide_svc_detail { 0; }
1961 #fallback for packages that can't/won't summarize usage
1962 sub sum_usage { 0; }
1964 =item recur_cost_permonth CUST_PKG
1966 recur_cost divided by freq (only supported for monthly and longer frequencies)
1970 sub recur_cost_permonth {
1971 my($self, $cust_pkg) = @_;
1972 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1973 sprintf('%.2f', ($self->recur_cost || 0) / $self->freq );
1976 =item cust_bill_pkg_recur CUST_PKG
1978 Actual recurring charge for the specified customer package from customer's most
1983 sub cust_bill_pkg_recur {
1984 my($self, $cust_pkg) = @_;
1985 my $cust_bill_pkg = qsearchs({
1986 'table' => 'cust_bill_pkg',
1987 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1988 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1989 'recur' => { op=>'>', value=>'0' },
1991 'order_by' => 'ORDER BY cust_bill._date DESC,
1992 cust_bill_pkg.sdate DESC
1995 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1996 $cust_bill_pkg->recur;
1999 =item unit_setup CUST_PKG
2001 Returns the setup fee for one unit of the package.
2006 my ($self, $cust_pkg) = @_;
2007 $self->option('setup_fee') || 0;
2012 unit_setup minus setup_cost
2018 $self->unit_setup(@_) - ($self->setup_cost || 0);
2021 =item recur_margin_permonth
2023 base_recur_permonth minus recur_cost_permonth
2027 sub recur_margin_permonth {
2029 $self->base_recur_permonth(@_) - $self->recur_cost_permonth(@_);
2032 =item intro_end PACKAGE
2034 Takes an L<FS::cust_pkg> object. If this plan has an introductory rate,
2035 returns the expected date the intro period will end. If there is no intro
2044 =item format OPTION DATA
2046 Returns data formatted according to the function 'format' described
2047 in the plan info. Returns DATA if no such function exists.
2052 my ($self, $option, $data) = (shift, shift, shift);
2053 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
2054 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
2060 =item parse OPTION DATA
2062 Returns data parsed according to the function 'parse' described
2063 in the plan info. Returns DATA if no such function exists.
2068 my ($self, $option, $data) = (shift, shift, shift);
2069 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
2070 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
2080 =head1 CLASS METHODS
2088 # Used by FS::Upgrade to migrate to a new database.
2090 sub _upgrade_data { # class method
2091 my($class, %opts) = @_;
2093 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
2095 my @part_pkg = qsearch({
2096 'table' => 'part_pkg',
2097 'extra_sql' => "WHERE ". join(' OR ',
2098 'plan IS NULL', "plan = '' ",
2102 foreach my $part_pkg (@part_pkg) {
2104 unless ( $part_pkg->plan ) {
2105 $part_pkg->plan('flat');
2112 # Convert RADIUS accounting usage metrics from megabytes to gigabytes
2114 my $upgrade = 'part_pkg_gigabyte_usage';
2115 if (!FS::upgrade_journal->is_done($upgrade)) {
2116 foreach my $part_pkg (qsearch('part_pkg',
2117 { plan => 'sqlradacct_hour' })
2120 my $pkgpart = $part_pkg->pkgpart;
2122 foreach my $opt (qsearch('part_pkg_option',
2123 { 'optionname' => { op => 'LIKE',
2124 value => 'recur_included_%',
2126 pkgpart => $pkgpart,
2129 next if $opt->optionname eq 'recur_included_hours'; # unfortunately named field
2130 next if $opt->optionvalue == 0;
2132 $opt->optionvalue($opt->optionvalue / 1024);
2134 my $error = $opt->replace;
2135 die $error if $error;
2138 foreach my $opt (qsearch('part_pkg_option',
2139 { 'optionname' => { op => 'LIKE',
2140 value => 'recur_%_charge',
2142 pkgpart => $pkgpart,
2144 $opt->optionvalue($opt->optionvalue * 1024);
2146 my $error = $opt->replace;
2147 die $error if $error;
2151 FS::upgrade_journal->set_done($upgrade);
2154 # the rest can be done asynchronously
2157 sub queueable_upgrade {
2158 # now upgrade to the explicit custom flag
2160 my $search = FS::Cursor->new({
2161 'table' => 'part_pkg',
2162 'hashref' => { disabled => 'Y', custom => '' },
2163 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
2167 while (my $part_pkg = $search->fetch) {
2168 my $new = new FS::part_pkg { $part_pkg->hash };
2170 my $comment = $part_pkg->comment;
2171 $comment =~ s/^\(CUSTOM\) //;
2172 $comment = '(none)' unless $comment =~ /\S/;
2173 $new->comment($comment);
2175 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
2176 my $primary = $part_pkg->svcpart;
2177 my $options = { $part_pkg->options };
2179 my $error = $new->replace( $part_pkg,
2180 'pkg_svc' => $pkg_svc,
2181 'primary_svc' => $primary,
2182 'options' => $options,
2185 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2192 # set family_pkgpart on any packages that don't have it
2193 $search = FS::Cursor->new('part_pkg', { 'family_pkgpart' => '' });
2194 while (my $part_pkg = $search->fetch) {
2195 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
2196 my $error = $part_pkg->SUPER::replace;
2198 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2205 my @part_pkg_option = qsearch('part_pkg_option',
2206 { 'optionname' => 'unused_credit',
2209 foreach my $old_opt (@part_pkg_option) {
2210 my $pkgpart = $old_opt->pkgpart;
2211 my $error = $old_opt->delete;
2212 die $error if $error;
2214 foreach (qw(unused_credit_cancel unused_credit_change)) {
2215 my $new_opt = new FS::part_pkg_option {
2216 'pkgpart' => $pkgpart,
2220 $error = $new_opt->insert;
2221 die $error if $error;
2225 # migrate use_disposition_taqua and use_disposition to disposition_in
2226 @part_pkg_option = qsearch('part_pkg_option',
2227 { 'optionname' => { op => 'LIKE',
2228 value => 'use_disposition%',
2232 my %newopts = map { $_->pkgpart => $_ }
2233 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
2234 foreach my $old_opt (@part_pkg_option) {
2235 my $pkgpart = $old_opt->pkgpart;
2236 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
2238 my $error = $old_opt->delete;
2239 die $error if $error;
2241 if ( exists($newopts{$pkgpart}) ) {
2242 my $opt = $newopts{$pkgpart};
2243 $opt->optionvalue($opt->optionvalue.",$newval");
2244 $error = $opt->replace;
2245 die $error if $error;
2247 my $new_opt = new FS::part_pkg_option {
2248 'pkgpart' => $pkgpart,
2249 'optionname' => 'disposition_in',
2250 'optionvalue' => $newval,
2252 $error = $new_opt->insert;
2253 die $error if $error;
2254 $newopts{$pkgpart} = $new_opt;
2258 # set any package with FCC voice lines to the "VoIP with broadband" category
2259 # for backward compatibility
2261 # recover from a bad upgrade bug
2262 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
2263 if (!FS::upgrade_journal->is_done($upgrade)) {
2264 my $bad_upgrade = qsearchs('upgrade_journal',
2265 { upgrade => 'part_pkg_fcc_voip_class' }
2267 if ( $bad_upgrade ) {
2268 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
2269 ' AND history_date > '.($bad_upgrade->_date - 3600);
2270 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
2273 'table' => 'h_part_pkg_option',
2275 'extra_sql' => "$where AND history_action = 'delete'",
2276 'order_by' => 'ORDER BY history_date ASC',
2278 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
2281 'table' => 'h_pkg_svc',
2283 'extra_sql' => "$where AND history_action = 'replace_old'",
2284 'order_by' => 'ORDER BY history_date ASC',
2287 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
2288 my $pkgpart ||= $deleted->pkgpart;
2289 $opt{$pkgpart} ||= {
2295 if ( $deleted->isa('FS::part_pkg_option') ) {
2296 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
2298 my $svcpart = $deleted->svcpart;
2299 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
2300 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
2301 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
2304 foreach my $pkgpart (keys %opt) {
2305 my $part_pkg = FS::part_pkg->by_key($pkgpart);
2306 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
2308 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
2311 } # $bad_upgrade exists
2312 else { # do the original upgrade, but correctly this time
2313 my @part_pkg = qsearch('part_pkg', {
2314 fcc_ds0s => { op => '>', value => 0 },
2315 fcc_voip_class => ''
2317 foreach my $part_pkg (@part_pkg) {
2318 $part_pkg->set(fcc_voip_class => 2);
2319 my @pkg_svc = $part_pkg->pkg_svc;
2320 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
2321 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
2322 my $error = $part_pkg->replace(
2323 $part_pkg->replace_old,
2324 options => { $part_pkg->options },
2325 pkg_svc => \%quantity,
2326 hidden_svc => \%hidden,
2327 primary_svc => ($part_pkg->svcpart || ''),
2329 die $error if $error;
2332 FS::upgrade_journal->set_done($upgrade);
2335 # migrate adjourn_months, expire_months, and contract_end_months to
2337 foreach my $field (qw(adjourn_months expire_months contract_end_months)) {
2338 foreach my $option (qsearch('part_pkg_option', { optionname => $field })) {
2339 my $part_pkg = $option->part_pkg;
2340 my $error = $option->delete;
2341 if ( $option->optionvalue and $part_pkg->get($field) eq '' ) {
2342 $part_pkg->set($field, $option->optionvalue);
2343 $error ||= $part_pkg->replace;
2345 die $error if $error;
2350 =item curuser_pkgs_sql
2352 Returns an SQL fragment for searching for packages the current user can
2353 use, either via part_pkg.agentnum directly, or via agent type (see
2358 sub curuser_pkgs_sql {
2361 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
2365 =item agent_pkgs_sql AGENT | AGENTNUM, ...
2367 Returns an SQL fragment for searching for packages the provided agent or agents
2368 can use, either via part_pkg.agentnum directly, or via agent type (see
2373 sub agent_pkgs_sql {
2374 my $class = shift; #i'm a class method, not a sub (the question is... why??)
2375 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
2377 $class->_pkgs_sql(@agentnums); #is this why
2382 my( $class, @agentnums ) = @_;
2383 my $agentnums = join(',', @agentnums);
2387 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
2388 OR ( agentnum IS NULL
2389 AND EXISTS ( SELECT 1
2391 LEFT JOIN agent_type USING ( typenum )
2392 LEFT JOIN agent AS typeagent USING ( typenum )
2393 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
2394 AND typeagent.agentnum IN ($agentnums)
2402 =item join_options_sql
2404 Returns an SQL fragment for JOINing the part_pkg_option records for this
2405 package's setup_fee and recur_fee (as setup_option and recur_option,
2406 respectively). Useful for optimization.
2410 sub join_options_sql {
2413 LEFT JOIN part_pkg_option AS setup_option
2414 ON ( part_pkg.pkgpart = setup_option.pkgpart
2415 AND setup_option.optionname = 'setup_fee' )
2416 LEFT JOIN part_pkg_option AS recur_option
2417 ON ( part_pkg.pkgpart = recur_option.pkgpart
2418 AND recur_option.optionname = 'recur_fee' )
2432 #false laziness w/part_export & cdr
2434 foreach my $INC ( @INC ) {
2435 warn "globbing $INC/FS/part_pkg/[a-z]*.pm\n" if $DEBUG;
2436 foreach my $file ( glob("$INC/FS/part_pkg/[a-z]*.pm") ) {
2437 warn "attempting to load plan info from $file\n" if $DEBUG;
2438 $file =~ /\/(\w+)\.pm$/ or do {
2439 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
2443 my $info = eval "use FS::part_pkg::$mod; ".
2444 "\\%FS::part_pkg::$mod\::info;";
2446 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
2449 unless ( keys %$info ) {
2450 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
2453 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
2454 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
2455 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
2458 $info{$mod} = $info;
2459 $info->{'weight'} ||= 0; # quiet warnings
2463 # copy one level deep to allow replacement of fields and fieldorder
2464 tie %plans, 'Tie::IxHash',
2465 map { my %infohash = %{ $info{$_} };
2467 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
2470 # inheritance of plan options
2471 foreach my $name (keys(%info)) {
2472 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
2473 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
2474 delete $plans{$name};
2477 my $parents = $info{$name}->{'inherit_fields'} || [];
2478 my (%fields, %field_exists, @fieldorder);
2479 foreach my $parent ($name, @$parents) {
2480 if ( !exists($info{$parent}) ) {
2481 warn "$name tried to inherit from nonexistent '$parent'\n";
2484 %fields = ( # avoid replacing existing fields
2485 %{ $info{$parent}->{'fields'} || {} },
2488 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
2490 next if $field_exists{$_};
2491 $field_exists{$_} = 1;
2492 # allow inheritors to remove inherited fields from the fieldorder
2493 push @fieldorder, $_ if !exists($fields{$_}) or
2494 !exists($fields{$_}->{'disabled'});
2497 $plans{$name}->{'fields'} = \%fields;
2498 $plans{$name}->{'fieldorder'} = \@fieldorder;
2508 =head1 NEW PLAN CLASSES
2510 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
2511 found in eg/plan_template.pm. Until then, it is suggested that you use the
2512 other modules in FS/FS/part_pkg/ as a guide.
2516 The delete method is unimplemented.
2518 setup and recur semantics are not yet defined (and are implemented in
2519 FS::cust_bill. hmm.). now they're deprecated and need to go.
2523 part_pkg_taxrate is Pg specific
2525 replace should be smarter about managing the related tables (options, pkg_svc)
2529 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2530 schema.html from the base documentation.