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 if ( length($self->classnum) && $self->classnum !~ /^(\d+)$/ ) {
236 my $pkg_class = qsearchs('pkg_class', { 'classname' => $self->classnum } )
237 || new FS::pkg_class { classname => $self->classnum };
238 unless ( $pkg_class->classnum ) {
239 my $error = $pkg_class->insert;
241 $dbh->rollback if $oldAutoCommit;
245 $self->classnum( $pkg_class->classnum );
248 warn " inserting part_pkg record" if $DEBUG;
249 my $error = $self->SUPER::insert( $options{options} );
251 $dbh->rollback if $oldAutoCommit;
256 if ( $self->get('family_pkgpart') eq '' ) {
257 $self->set('family_pkgpart' => $self->pkgpart);
258 $error = $self->SUPER::replace;
260 $dbh->rollback if $oldAutoCommit;
265 warn " inserting part_pkg_taxoverride records" if $DEBUG;
266 my %overrides = %{ $options{'tax_overrides'} || {} };
267 foreach my $usage_class ( keys %overrides ) {
269 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
270 ? $overrides{$usage_class}
272 my @overrides = (grep "$_", split(',', $override) );
273 my $error = $self->process_m2m (
274 'link_table' => 'part_pkg_taxoverride',
275 'target_table' => 'tax_class',
276 'hashref' => { 'usage_class' => $usage_class },
277 'params' => \@overrides,
280 $dbh->rollback if $oldAutoCommit;
285 warn " inserting part_pkg_currency records" if $DEBUG;
286 my %part_pkg_currency = %{ $options{'part_pkg_currency'} || {} };
287 foreach my $key ( keys %part_pkg_currency ) {
288 $key =~ /^(.+)_([A-Z]{3})$/ or next;
289 my( $optionname, $currency ) = ( $1, $2 );
290 if ( $part_pkg_currency{$key} =~ /^\s*$/ ) {
291 if ( $self->option($optionname) == 0 ) {
292 $part_pkg_currency{$key} = '0';
294 $dbh->rollback if $oldAutoCommit;
295 ( my $thing = $optionname ) =~ s/_/ /g;
296 return ucfirst($thing). " $currency is required";
299 my $part_pkg_currency = new FS::part_pkg_currency {
300 'pkgpart' => $self->pkgpart,
301 'optionname' => $optionname,
302 'currency' => $currency,
303 'optionvalue' => $part_pkg_currency{$key},
305 my $error = $part_pkg_currency->insert;
307 $dbh->rollback if $oldAutoCommit;
312 unless ( $skip_pkg_svc_hack ) {
314 warn " inserting pkg_svc records" if $DEBUG;
315 my $pkg_svc = $options{'pkg_svc'} || {};
316 my $hidden_svc = $options{'hidden_svc'} || {};
317 my $provision_hold = $options{'provision_hold'} || {};
318 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
319 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
321 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
325 my $pkg_svc = new FS::pkg_svc( {
326 'pkgpart' => $self->pkgpart,
327 'svcpart' => $part_svc->svcpart,
328 'quantity' => $quantity,
329 'primary_svc' => $primary_svc,
330 'hidden' => $hidden_svc->{$part_svc->svcpart},
331 'provision_hold' => $provision_hold->{$part_svc->svcpart},
333 my $error = $pkg_svc->insert;
335 $dbh->rollback if $oldAutoCommit;
340 my $error = $self->check_pkg_svc(%options);
342 $dbh->rollback if $oldAutoCommit;
348 if ( $options{'cust_pkg'} ) {
349 warn " updating cust_pkg record " if $DEBUG;
351 ref($options{'cust_pkg'})
352 ? $options{'cust_pkg'}
353 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
354 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
355 if $options{'custnum_ref'};
356 my %hash = $old_cust_pkg->hash;
357 $hash{'pkgpart'} = $self->pkgpart,
358 my $new_cust_pkg = new FS::cust_pkg \%hash;
359 local($FS::cust_pkg::disable_agentcheck) = 1;
360 my $error = $new_cust_pkg->replace($old_cust_pkg);
362 $dbh->rollback if $oldAutoCommit;
363 return "Error modifying cust_pkg record: $error";
367 if ( $options{'part_pkg_vendor'} ) {
368 while ( my ($exportnum, $vendor_pkg_id) =
369 each %{ $options{part_pkg_vendor} }
372 my $ppv = new FS::part_pkg_vendor( {
373 'pkgpart' => $self->pkgpart,
374 'exportnum' => $exportnum,
375 'vendor_pkg_id' => $vendor_pkg_id,
377 my $error = $ppv->insert;
379 $dbh->rollback if $oldAutoCommit;
380 return "Error inserting part_pkg_vendor record: $error";
385 if ( $options{fcc_options} ) {
386 warn " updating fcc options " if $DEBUG;
387 $self->set_fcc_options( $options{fcc_options} );
390 warn " committing transaction" if $DEBUG and $oldAutoCommit;
391 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
398 Currently unimplemented.
403 return "Can't (yet?) delete package definitions.";
404 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
407 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
409 Replaces OLD_RECORD with this one in the database. If there is an error,
410 returns the error, otherwise returns false.
412 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>,
413 I<bulk_skip>, I<provision_hold> and I<options>
415 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
416 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
417 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
418 'hidden' field in these records. I<bulk_skip> and I<provision_hold> can be
419 set to a hashref of svcparts and flag values ('Y' or '') to set the
420 respective field in those records.
422 If I<primary_svc> is set to the svcpart of the primary service, the
423 appropriate FS::pkg_svc record will be updated.
425 If I<options> is set to a hashref, the appropriate FS::part_pkg_option
426 records will be replaced.
428 If I<part_pkg_currency> is set to a hashref of options (with the keys as
429 option_CURRENCY), appropriate FS::part_pkg::currency records will be
437 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
442 ( ref($_[0]) eq 'HASH' )
446 $options->{options} = { $old->options } unless defined($options->{options});
448 warn "FS::part_pkg::replace called on $new to replace $old with options".
449 join(', ', map "$_ => ". $options->{$_}, keys %$options)
452 local $SIG{HUP} = 'IGNORE';
453 local $SIG{INT} = 'IGNORE';
454 local $SIG{QUIT} = 'IGNORE';
455 local $SIG{TERM} = 'IGNORE';
456 local $SIG{TSTP} = 'IGNORE';
457 local $SIG{PIPE} = 'IGNORE';
459 my $oldAutoCommit = $FS::UID::AutoCommit;
460 local $FS::UID::AutoCommit = 0;
463 my $conf = new FS::Conf;
464 if ( $conf->exists('part_pkg-lineage') ) {
465 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
466 qw(setup_fee recur_fee) #others? config?
469 warn " superseding package" if $DEBUG;
471 my $error = $new->supersede($old, %$options);
473 $dbh->rollback if $oldAutoCommit;
477 warn " committing transaction" if $DEBUG and $oldAutoCommit;
478 $dbh->commit if $oldAutoCommit;
485 #plandata shit stays in replace for upgrades until after 2.0 (or edit
487 warn " saving legacy plandata" if $DEBUG;
488 my $plandata = $new->get('plandata');
489 $new->set('plandata', '');
491 warn " deleting old part_pkg_option records" if $DEBUG;
492 foreach my $part_pkg_option ( $old->part_pkg_option ) {
493 my $error = $part_pkg_option->delete;
495 $dbh->rollback if $oldAutoCommit;
500 warn " replacing part_pkg record" if $DEBUG;
501 my $error = $new->SUPER::replace($old, $options->{options} );
503 $dbh->rollback if $oldAutoCommit;
507 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
508 foreach my $part_pkg_option (
509 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
510 return "illegal plandata: $plandata";
512 new FS::part_pkg_option {
513 'pkgpart' => $new->pkgpart,
518 split("\n", $plandata)
520 my $error = $part_pkg_option->insert;
522 $dbh->rollback if $oldAutoCommit;
527 #trivial nit: not the most efficient to delete and reinsert
528 warn " deleting old part_pkg_currency records" if $DEBUG;
529 foreach my $part_pkg_currency ( $old->part_pkg_currency ) {
530 my $error = $part_pkg_currency->delete;
532 $dbh->rollback if $oldAutoCommit;
533 return "error deleting part_pkg_currency record: $error";
537 warn " inserting new part_pkg_currency records" if $DEBUG;
538 my %part_pkg_currency = %{ $options->{'part_pkg_currency'} || {} };
539 foreach my $key ( keys %part_pkg_currency ) {
540 $key =~ /^(.+)_([A-Z]{3})$/ or next;
541 my $part_pkg_currency = new FS::part_pkg_currency {
542 'pkgpart' => $new->pkgpart,
545 'optionvalue' => $part_pkg_currency{$key},
547 my $error = $part_pkg_currency->insert;
549 $dbh->rollback if $oldAutoCommit;
550 return "error inserting part_pkg_currency record: $error";
555 warn " replacing pkg_svc records" if $DEBUG;
556 my $pkg_svc = $options->{'pkg_svc'};
557 my $hidden_svc = $options->{'hidden_svc'} || {};
558 my $bulk_skip = $options->{'bulk_skip'} || {};
559 my $provision_hold = $options->{'provision_hold'} || {};
560 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
562 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
563 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
564 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
565 my $bulk_skip = $bulk_skip->{$part_svc->svcpart} || '';
566 my $provision_hold = $provision_hold->{$part_svc->svcpart} || '';
568 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
569 && $options->{'primary_svc'} == $part_svc->svcpart
574 my $old_pkg_svc = qsearchs('pkg_svc', {
575 'pkgpart' => $old->pkgpart,
576 'svcpart' => $part_svc->svcpart,
579 my $old_quantity = 0;
580 my $old_primary_svc = '';
582 my $old_bulk_skip = '';
583 my $old_provision_hold = '';
584 if ( $old_pkg_svc ) {
585 $old_quantity = $old_pkg_svc->quantity;
586 $old_primary_svc = $old_pkg_svc->primary_svc
587 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
588 $old_hidden = $old_pkg_svc->hidden;
589 $old_bulk_skip = $old_pkg_svc->old_bulk_skip; # should this just be bulk_skip?
590 $old_provision_hold = $old_pkg_svc->provision_hold;
593 next unless $old_quantity != $quantity
594 || $old_primary_svc ne $primary_svc
595 || $old_hidden ne $hidden
596 || $old_bulk_skip ne $bulk_skip
597 || $old_provision_hold ne $provision_hold;
599 my $new_pkg_svc = new FS::pkg_svc( {
600 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
601 'pkgpart' => $new->pkgpart,
602 'svcpart' => $part_svc->svcpart,
603 'quantity' => $quantity,
604 'primary_svc' => $primary_svc,
606 'bulk_skip' => $bulk_skip,
607 'provision_hold' => $provision_hold,
609 my $error = $old_pkg_svc
610 ? $new_pkg_svc->replace($old_pkg_svc)
611 : $new_pkg_svc->insert;
613 $dbh->rollback if $oldAutoCommit;
618 my $error = $new->check_pkg_svc(%$options);
620 $dbh->rollback if $oldAutoCommit;
624 } #if $options->{pkg_svc}
626 my @part_pkg_vendor = $old->part_pkg_vendor;
627 my @current_exportnum = ();
628 if ( $options->{'part_pkg_vendor'} ) {
629 my($exportnum,$vendor_pkg_id);
630 while ( ($exportnum,$vendor_pkg_id)
631 = each %{$options->{'part_pkg_vendor'}} ) {
633 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
634 if($exportnum == $part_pkg_vendor->exportnum
635 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
636 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
637 my $error = $part_pkg_vendor->replace;
639 $dbh->rollback if $oldAutoCommit;
640 return "Error replacing part_pkg_vendor record: $error";
645 elsif($exportnum == $part_pkg_vendor->exportnum
646 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
651 unless ( $noinsert ) {
652 my $ppv = new FS::part_pkg_vendor( {
653 'pkgpart' => $new->pkgpart,
654 'exportnum' => $exportnum,
655 'vendor_pkg_id' => $vendor_pkg_id,
657 my $error = $ppv->insert;
659 $dbh->rollback if $oldAutoCommit;
660 return "Error inserting part_pkg_vendor record: $error";
663 push @current_exportnum, $exportnum;
666 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
667 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
668 my $error = $part_pkg_vendor->delete;
670 $dbh->rollback if $oldAutoCommit;
671 return "Error deleting part_pkg_vendor record: $error";
676 # propagate changes to certain core fields
677 if ( $conf->exists('part_pkg-lineage') ) {
678 warn " propagating changes to family" if $DEBUG;
679 my $error = $new->propagate($old);
681 $dbh->rollback if $oldAutoCommit;
686 if ( $options->{fcc_options} ) {
687 warn " updating fcc options " if $DEBUG;
688 $new->set_fcc_options( $options->{fcc_options} );
691 warn " committing transaction" if $DEBUG and $oldAutoCommit;
692 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
698 Checks all fields to make sure this is a valid package definition. If
699 there is an error, returns the error, otherwise returns false. Called by the
700 insert and replace methods.
706 warn "FS::part_pkg::check called on $self" if $DEBUG;
708 for (qw(setup recur plandata)) {
709 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
710 return "Use of $_ field is deprecated; set a plan and options: ".
712 if length($self->get($_));
716 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
717 my $error = $self->ut_number('freq');
718 return $error if $error;
720 $self->freq =~ /^(\d+[hdw]?)$/
721 or return "Illegal or empty freq: ". $self->freq;
725 my @null_agentnum_right = ( 'Edit global package definitions' );
726 push @null_agentnum_right, 'One-time charge'
727 if $self->freq =~ /^0/;
728 push @null_agentnum_right, 'Customize customer package'
729 if $self->disabled eq 'Y'; #good enough
731 my $error = $self->ut_numbern('pkgpart')
732 || $self->ut_text('pkg')
733 || $self->ut_textn('comment')
734 || $self->ut_textn('promo_code')
735 || $self->ut_alphan('plan')
736 || $self->ut_flag('setuptax')
737 || $self->ut_flag('recurtax')
738 || $self->ut_textn('taxclass')
739 || $self->ut_flag('disabled')
740 || $self->ut_flag('custom')
741 || $self->ut_flag('no_auto')
742 || $self->ut_flag('recur_show_zero')
743 || $self->ut_flag('setup_show_zero')
744 || $self->ut_flag('start_on_hold')
745 #|| $self->ut_moneyn('setup_cost')
746 #|| $self->ut_moneyn('recur_cost')
747 || $self->ut_floatn('setup_cost')
748 || $self->ut_floatn('recur_cost')
749 || $self->ut_floatn('pay_weight')
750 || $self->ut_floatn('credit_weight')
751 || $self->ut_numbern('taxproductnum')
752 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
753 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
754 || $self->ut_foreign_keyn('taxproductnum',
755 'part_pkg_taxproduct',
759 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
760 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
762 || $self->ut_numbern('fcc_ds0s')
763 || $self->ut_numbern('fcc_voip_class')
764 || $self->ut_numbern('delay_start')
765 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
766 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
767 || $self->ut_numbern('expire_months')
768 || $self->ut_numbern('adjourn_months')
769 || $self->ut_numbern('contract_end_months')
770 || $self->ut_numbern('change_to_pkgpart')
771 || $self->ut_foreign_keyn('change_to_pkgpart', 'part_pkg', 'pkgpart')
772 || $self->ut_alphan('agent_pkgpartid')
773 || $self->SUPER::check
775 return $error if $error;
777 return 'Unknown plan '. $self->plan
778 unless exists($plans{$self->plan});
780 my $conf = new FS::Conf;
781 return 'Taxclass is required'
782 if ! $self->taxclass && $conf->exists('require_taxclasses');
789 For a passed I<$options> hashref, validates any options that
790 have 'validate' subroutines defined in the info hash,
791 then validates the entire hashref if the price plan has
792 its own 'validate' subroutine defined in the info hash
793 (I<$options> values might be altered.)
795 Returns error message, or empty string if valid.
797 Invoked by L</insert> and L</replace> via the equivalent
798 methods in L<FS::option_Common>.
803 my ($self,$options) = @_;
804 foreach my $option (keys %$options) {
805 if (exists $plans{ $self->plan }->{fields}->{$option}) {
806 if (exists($plans{$self->plan}->{fields}->{$option}->{'validate'})) {
807 # pass option name for use in error message
808 # pass a reference to the $options value, so it can be cleaned up
809 my $error = &{$plans{$self->plan}->{fields}->{$option}->{'validate'}}($option,\($options->{$option}));
810 return $error if $error;
812 } # else "option does not exist" error?
814 if (exists($plans{$self->plan}->{'validate'})) {
815 my $error = &{$plans{$self->plan}->{'validate'}}($options);
816 return $error if $error;
823 Checks pkg_svc records as a whole (for part_svc_link dependencies).
825 If there is an error, returns the error, otherwise returns false.
830 my( $self, %opt ) = @_;
832 my $agentnum = $self->agentnum;
834 my %pkg_svc = map { $_->svcpart => $_ } $self->pkg_svc;
836 foreach my $svcpart ( keys %pkg_svc ) {
838 foreach my $part_svc_link ( $self->part_svc_link(
839 'src_svcpart' => $svcpart,
840 'link_type' => 'part_pkg_restrict',
844 return $part_svc_link->dst_svc. ' must be included with '.
845 $part_svc_link->src_svc
846 unless $pkg_svc{ $part_svc_link->dst_svcpart };
851 return '' if $opt{part_pkg_restrict_soft_override};
853 foreach my $svcpart ( keys %pkg_svc ) {
855 foreach my $part_svc_link ( $self->part_svc_link(
856 'src_svcpart' => $svcpart,
857 'link_type' => 'part_pkg_restrict_soft',
860 return $part_svc_link->dst_svc. ' is suggested with '.
861 $part_svc_link->src_svc
862 unless $pkg_svc{ $part_svc_link->dst_svcpart };
870 =item part_svc_link OPTION => VALUE ...
872 Returns the service dependencies (see L<FS::part_svc_link>) for the given
873 search options, taking into account this package definition's agent.
875 Available options are any field in part_svc_link. Typically used options are
876 src_svcpart and link_type.
881 FS::part_svc_link->by_agentnum( shift->agentnum, @_ );
884 =item supersede OLD [, OPTION => VALUE ... ]
886 Inserts this package as a successor to the package OLD. All options are as
887 for C<insert>. After inserting, disables OLD and sets the new package as its
893 my ($new, $old, %options) = @_;
896 $new->set('pkgpart' => '');
897 $new->set('family_pkgpart' => $old->family_pkgpart);
898 warn " inserting successor package\n" if $DEBUG;
899 $error = $new->insert(%options);
900 return $error if $error;
902 warn " disabling superseded package\n" if $DEBUG;
903 $old->set('successor' => $new->pkgpart);
904 $old->set('disabled' => 'Y');
905 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
906 return $error if $error;
908 warn " propagating changes to family" if $DEBUG;
909 $new->propagate($old);
914 If any of certain fields have changed from OLD to this package, then,
915 for all packages in the same lineage as this one, sets those fields
916 to their values in this package.
920 my @propagate_fields = (
921 qw( pkg classnum setup_cost recur_cost taxclass
922 setuptax recurtax pay_weight credit_weight
930 map { $_ => $new->get($_) }
931 grep { $new->get($_) ne $old->get($_) }
935 my @part_pkg = qsearch('part_pkg', {
936 'family_pkgpart' => $new->family_pkgpart
939 foreach my $part_pkg ( @part_pkg ) {
940 my $pkgpart = $part_pkg->pkgpart;
941 next if $pkgpart == $new->pkgpart; # don't modify $new
942 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
943 foreach ( keys %fields ) {
944 $part_pkg->set($_, $fields{$_});
946 # SUPER::replace to avoid changing non-core fields
947 my $error = $part_pkg->SUPER::replace;
948 push @error, "pkgpart $pkgpart: $error"
954 =item set_fcc_options HASHREF
956 Sets the FCC options on this package definition to the values specified
961 sub set_fcc_options {
963 my $pkgpart = $self->pkgpart;
971 my %existing_num = map { $_->fccoptionname => $_->num }
972 qsearch('part_pkg_fcc_option', { pkgpart => $pkgpart });
974 local $FS::Record::nowarn_identical = 1;
975 # set up params for process_o2m
978 foreach my $name (keys %$options ) {
979 $params->{ "num$i" } = $existing_num{$name} || '';
980 $params->{ "num$i".'_fccoptionname' } = $name;
981 $params->{ "num$i".'_optionvalue' } = $options->{$name};
986 table => 'part_pkg_fcc_option',
987 fields => [qw( fccoptionname optionvalue )],
992 =item pkg_locale LOCALE
994 Returns a customer-viewable string representing this package for the given
995 locale, from the part_pkg_msgcat table. If the given locale is empty or no
996 localized string is found, returns the base pkg field.
1001 my( $self, $locale ) = @_;
1002 return $self->pkg unless $locale;
1003 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
1004 $part_pkg_msgcat->pkg;
1007 =item part_pkg_msgcat LOCALE
1009 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
1013 sub part_pkg_msgcat {
1014 my( $self, $locale ) = @_;
1015 qsearchs( 'part_pkg_msgcat', {
1016 pkgpart => $self->pkgpart,
1021 =item pkg_comment [ OPTION => VALUE... ]
1023 Returns an (internal) string representing this package. Currently,
1024 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
1025 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
1028 If the option nopkgpart is true then the "pkgpart: ' is omitted.
1036 #$self->pkg. ' - '. $self->comment;
1037 #$self->pkg. ' ('. $self->comment. ')';
1038 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
1039 my $custom_comment = $self->custom_comment(%opt);
1040 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
1043 #without price info (so without hitting the DB again)
1044 sub pkg_comment_only {
1048 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
1049 my $comment = $self->comment;
1050 $pre. $self->pkg. ( $comment ? " - $comment" : '' );
1053 sub price_info { # safety, in case a part_pkg hasn't defined price_info
1057 sub custom_comment {
1059 my $price_info = $self->price_info(@_);
1060 ( $self->custom ? '(CUSTOM) ' : '' ).
1062 ( ($self->custom || $self->comment) ? ' - ' : '' ).
1063 ($price_info || 'No charge');
1066 sub pkg_price_info {
1068 $self->pkg. ' - '. ($self->price_info || 'No charge');
1073 Returns the package class, as an FS::pkg_class object, or the empty string
1074 if there is no package class.
1076 =item addon_pkg_class
1078 Returns the add-on package class, as an FS::pkg_class object, or the empty
1079 string if there is no add-on package class.
1083 sub addon_pkg_class {
1085 if ( $self->addon_classnum ) {
1086 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
1094 Returns the package category name, or the empty string if there is no package
1101 my $pkg_class = $self->pkg_class;
1103 ? $pkg_class->categoryname
1109 Returns the package class name, or the empty string if there is no package
1116 my $pkg_class = $self->pkg_class;
1118 ? $pkg_class->classname
1122 =item addon_classname
1124 Returns the add-on package class name, or the empty string if there is no
1125 add-on package class.
1129 sub addon_classname {
1131 my $pkg_class = $self->addon_pkg_class;
1133 ? $pkg_class->classname
1139 Returns the associated agent for this event, if any, as an FS::agent object.
1141 =item pkg_svc [ HASHREF | OPTION => VALUE ]
1143 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
1144 definition (with non-zero quantity).
1146 One option is available, I<disable_linked>. If set true it will return the
1147 services for this package definition alone, omitting services from any add-on
1154 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
1162 return @{ $cache_pkg_svc{$self->pkgpart} }
1163 if $cache_enabled && $cache_pkg_svc{$self->pkgpart};
1165 # #sort { $b->primary cmp $a->primary }
1166 # grep { $_->quantity }
1167 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
1169 my $opt = ref($_[0]) ? $_[0] : { @_ };
1170 my %pkg_svc = map { $_->svcpart => $_ } $self->_pkg_svc;
1172 unless ( $opt->{disable_linked} ) {
1173 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
1174 my @pkg_svc = $dst_pkg->_pkg_svc;
1175 foreach my $pkg_svc ( @pkg_svc ) {
1176 if ( $pkg_svc{$pkg_svc->svcpart} ) {
1177 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
1178 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
1180 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
1186 my @pkg_svc = values(%pkg_svc);
1188 $cache_pkg_svc{$self->pkgpart} = \@pkg_svc if $cache_enabled;
1196 grep { $_->quantity }
1198 'select' => 'pkg_svc.*, part_svc.*',
1199 'table' => 'pkg_svc',
1200 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
1201 'hashref' => { 'pkgpart' => $self->pkgpart },
1205 =item svcpart [ SVCDB ]
1207 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
1208 associated with this package definition (see L<FS::pkg_svc>). Returns
1209 false if there not a primary service definition or exactly one service
1210 definition with quantity 1, or if SVCDB is specified and does not match the
1211 svcdb of the service definition. SVCDB can be specified as a scalar table
1212 name, such as 'svc_acct', or as an arrayref of possible table names.
1217 my $pkg_svc = shift->_primary_pkg_svc(@_);
1218 $pkg_svc ? $pkg_svc->svcpart : '';
1221 =item part_svc [ SVCDB ]
1223 Like the B<svcpart> method, but returns the FS::part_svc object (see
1229 my $pkg_svc = shift->_primary_pkg_svc(@_);
1230 $pkg_svc ? $pkg_svc->part_svc : '';
1233 sub _primary_pkg_svc {
1236 my $svcdb = scalar(@_) ? shift : [];
1237 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1238 my %svcdb = map { $_=>1 } @$svcdb;
1241 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1244 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1245 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1247 return '' if scalar(@pkg_svc) != 1;
1251 =item svcpart_unique_svcdb SVCDB
1253 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1254 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1255 false if there not a primary service definition for SVCDB or there are multiple
1256 service definitions for SVCDB.
1260 sub svcpart_unique_svcdb {
1261 my( $self, $svcdb ) = @_;
1262 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1263 return '' if scalar(@svcdb_pkg_svc) != 1;
1264 $svcdb_pkg_svc[0]->svcpart;
1269 Returns a list of the acceptable payment types for this package. Eventually
1270 this should come out of a database table and be editable, but currently has the
1271 following logic instead:
1273 If the package is free, the single item B<BILL> is
1274 returned, otherwise, the single item B<CARD> is returned.
1276 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1282 if ( $self->is_free ) {
1291 Returns true if this package is free.
1297 if ( $self->can('is_free_options') ) {
1298 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1299 map { $self->option($_) }
1300 $self->is_free_options;
1302 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1303 "provides neither is_free_options nor is_free method; returning false";
1308 # whether the plan allows discounts to be applied to this package
1309 sub can_discount { 0; }
1311 # whether the plan allows changing the start date
1312 sub can_start_date {
1314 $self->start_on_hold ? 0 : 1;
1317 # whether the plan supports part_pkg_usageprice add-ons (a specific kind of
1318 # pre-selectable usage pricing, there's others this doesn't refer to)
1319 sub can_usageprice { 0; }
1321 # the delay start date if present
1322 sub delay_start_date {
1325 my $delay = $self->delay_start or return '';
1327 # avoid timelocal silliness
1328 my $dt = DateTime->today(time_zone => 'local');
1329 $dt->add(days => $delay);
1333 sub can_currency_exchange { 0; }
1336 # moved to FS::Misc to make this accessible to other packages
1338 FS::Misc::pkg_freqs();
1343 Returns an english representation of the I<freq> field, such as "monthly",
1344 "weekly", "semi-annually", etc.
1350 my $freq = $self->freq;
1352 #my $freqs_href = $self->freqs_href;
1353 my $freqs_href = freqs_href();
1355 if ( exists($freqs_href->{$freq}) ) {
1356 $freqs_href->{$freq};
1358 my $interval = 'month';
1359 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1360 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1361 $interval = $interval{$2};
1366 "every $freq ${interval}s";
1371 =item add_freq TIMESTAMP [ FREQ ]
1373 Adds a billing period of some frequency to the provided timestamp and
1374 returns the resulting timestamp, or -1 if the frequency could not be
1375 parsed (shouldn't happen). By default, the frequency of this package
1376 will be used; to override this, pass a different frequency as a second
1382 my( $self, $date, $freq ) = @_;
1383 $freq = $self->freq unless $freq;
1385 #change this bit to use Date::Manip? CAREFUL with timezones (see
1386 # mailing list archive)
1387 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1389 if ( $freq =~ /^\d+$/ ) {
1391 until ( $mon < 12 ) { $mon -= 12; $year++; }
1393 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1395 } elsif ( $freq =~ /^(\d+)w$/ ) {
1397 $mday += $weeks * 7;
1398 } elsif ( $freq =~ /^(\d+)d$/ ) {
1401 } elsif ( $freq =~ /^(\d+)h$/ ) {
1408 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1413 For backwards compatibility, returns the plandata field as well as all options
1414 from FS::part_pkg_option.
1420 carp "plandata is deprecated";
1422 $self->SUPER::plandata(@_);
1424 my $plandata = $self->get('plandata');
1425 my %options = $self->options;
1426 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1431 =item part_pkg_vendor
1433 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1434 L<FS::part_pkg_vendor>).
1436 =item vendor_pkg_ids
1438 Returns a list of vendor/external package ids by exportnum
1442 sub vendor_pkg_ids {
1444 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1447 =item part_pkg_option
1449 Returns all options as FS::part_pkg_option objects (see
1450 L<FS::part_pkg_option>).
1454 Returns a list of option names and values suitable for assigning to a hash.
1460 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1463 =item option OPTIONNAME [ QUIET ]
1465 Returns the option value for the given name, or the empty string. If a true
1466 value is passed as the second argument, warnings about missing the option
1472 my( $self, $opt, $ornull ) = @_;
1474 #cache: was pulled up in the original part_pkg query
1475 return $self->hashref->{"_opt_$opt"}
1476 if exists $self->hashref->{"_opt_$opt"};
1478 cluck "$self -> option: searching for $opt" if $DEBUG;
1479 my $part_pkg_option =
1480 qsearchs('part_pkg_option', {
1481 pkgpart => $self->pkgpart,
1484 return $part_pkg_option->optionvalue if $part_pkg_option;
1486 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1487 split("\n", $self->get('plandata') );
1488 return $plandata{$opt} if exists $plandata{$opt};
1490 # check whether the option is defined in plan info (if so, don't warn)
1491 if (exists $plans{ $self->plan }->{fields}->{$opt}) {
1494 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1495 "not found in options or plandata!\n"
1501 =item part_pkg_currency [ CURRENCY ]
1503 Returns all currency options as FS::part_pkg_currency objects (see
1504 L<FS::part_pkg_currency>), or, if a currency is specified, only return the
1505 objects for that currency.
1509 sub part_pkg_currency {
1511 my %hash = ( 'pkgpart' => $self->pkgpart );
1512 $hash{'currency'} = shift if @_;
1513 qsearch('part_pkg_currency', \%hash );
1516 =item part_pkg_currency_options CURRENCY
1518 Returns a list of option names and values from FS::part_pkg_currency for the
1523 sub part_pkg_currency_options {
1525 map { $_->optionname => $_->optionvalue } $self->part_pkg_currency(shift);
1528 =item part_pkg_currency_option CURRENCY OPTIONNAME
1530 Returns the option value for the given name and currency.
1534 sub part_pkg_currency_option {
1535 my( $self, $currency, $optionname ) = @_;
1536 my $part_pkg_currency =
1537 qsearchs('part_pkg_currency', { 'pkgpart' => $self->pkgpart,
1538 'currency' => $currency,
1539 'optionname' => $optionname,
1542 #fatal if not found? that works for our use cases from
1543 #part_pkg/currency_fixed, but isn't how we would typically/expect the method
1544 #to behave. have to catch it there if we change it here...
1545 or die "Unknown price for ". $self->pkg_comment. " in $currency\n";
1547 $part_pkg_currency->optionvalue;
1550 =item fcc_option OPTIONNAME
1552 Returns the FCC 477 report option value for the given name, or the empty
1558 my ($self, $name) = @_;
1559 my $part_pkg_fcc_option =
1560 qsearchs('part_pkg_fcc_option', {
1561 pkgpart => $self->pkgpart,
1562 fccoptionname => $name,
1564 $part_pkg_fcc_option ? $part_pkg_fcc_option->optionvalue : '';
1569 Returns all FCC 477 report options for this package, as a hash-like list.
1575 map { $_->fccoptionname => $_->optionvalue }
1576 qsearch('part_pkg_fcc_option', { pkgpart => $self->pkgpart });
1579 =item bill_part_pkg_link
1581 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1585 sub bill_part_pkg_link {
1586 shift->_part_pkg_link('bill', @_);
1589 =item svc_part_pkg_link
1591 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1595 sub svc_part_pkg_link {
1596 shift->_part_pkg_link('svc', @_);
1599 =item supp_part_pkg_link
1601 Returns the associated part_pkg_link records of type 'supp' (supplemental
1606 sub supp_part_pkg_link {
1607 shift->_part_pkg_link('supp', @_);
1610 sub _part_pkg_link {
1611 my( $self, $type ) = @_;
1613 return @{ $cache_link{$type}->{$self->pkgpart} }
1614 if $cache_enabled && $cache_link{$type}->{$self->pkgpart};
1616 cluck $type.'_part_pkg_link called' if $DEBUG;
1619 qsearch({ table => 'part_pkg_link',
1620 hashref => { src_pkgpart => $self->pkgpart,
1622 #protection against infinite recursive links
1623 dst_pkgpart => { op=>'!=', value=> $self->pkgpart },
1625 order_by => "ORDER BY hidden",
1628 $cache_link{$type}->{$self->pkgpart} = \@ppl if $cache_enabled;
1633 sub self_and_bill_linked {
1634 shift->_self_and_linked('bill', @_);
1637 sub self_and_svc_linked {
1638 shift->_self_and_linked('svc', @_);
1641 sub _self_and_linked {
1642 my( $self, $type, $hidden ) = @_;
1646 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1647 $self->_part_pkg_link($type) ) )
1649 $_->hidden($hidden) if $hidden;
1656 =item part_pkg_taxoverride [ CLASS ]
1658 Returns all associated FS::part_pkg_taxoverride objects (see
1659 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1660 of class CLASS if defined. Class may be one of 'setup', 'recur',
1661 the empty string (default), or a usage class number (see L<FS::usage_class>).
1662 When a class is specified, the empty string class (default) is returned
1663 if no more specific values exist.
1667 sub part_pkg_taxoverride {
1671 my $hashref = { 'pkgpart' => $self->pkgpart };
1672 $hashref->{'usage_class'} = $class if defined($class);
1673 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1675 unless ( scalar(@overrides) || !defined($class) || !$class ){
1676 $hashref->{'usage_class'} = '';
1677 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1683 =item has_taxproduct
1685 Returns true if this package has any taxproduct associated with it.
1689 sub has_taxproduct {
1692 $self->taxproductnum ||
1693 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1694 keys %{ {$self->options} }
1700 =item taxproduct [ CLASS ]
1702 Returns the associated tax product for this package definition (see
1703 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1704 the usage classnum (see L<FS::usage_class>). Returns the default
1705 tax product for this record if the more specific CLASS value does
1714 my $part_pkg_taxproduct;
1716 my $taxproductnum = $self->taxproductnum;
1718 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1719 $taxproductnum = $class_taxproductnum
1720 if $class_taxproductnum
1723 $part_pkg_taxproduct =
1724 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1726 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1727 $taxproductnum = $self->taxproductnum;
1728 $part_pkg_taxproduct =
1729 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1732 $part_pkg_taxproduct;
1735 =item taxproduct_description [ CLASS ]
1737 Returns the description of the associated tax product for this package
1738 definition (see L<FS::part_pkg_taxproduct>).
1742 sub taxproduct_description {
1744 my $part_pkg_taxproduct = $self->taxproduct(@_);
1745 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1749 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1751 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1752 package in the location specified by GEOCODE, for usage class CLASS (one of
1753 'setup', 'recur', null, or a C<usage_class> number).
1759 my ($vendor, $geocode, $class) = @_;
1760 # if this part_pkg is overridden into a specific taxclass, get that class
1761 my @taxclassnums = map { $_->taxclassnum }
1762 $self->part_pkg_taxoverride($class);
1763 # otherwise, get its tax product category
1764 if (!@taxclassnums) {
1765 my $part_pkg_taxproduct = $self->taxproduct($class);
1766 # If this isn't defined, then the class has no taxproduct designation,
1767 # so return no tax rates.
1768 return () if !$part_pkg_taxproduct;
1770 # convert the taxproduct to the tax classes that might apply to it in
1772 @taxclassnums = map { $_->taxclassnum }
1773 grep { $_->taxable eq 'Y' } # why do we need this?
1774 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1776 return unless @taxclassnums;
1778 # then look up the actual tax_rate entries
1779 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1781 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1782 my @taxes = qsearch({ 'table' => 'tax_rate',
1783 'hashref' => { 'geocode' => $geocode,
1784 'data_vendor' => $vendor,
1786 'extra_sql' => $extra_sql,
1788 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1794 =item part_pkg_discount
1796 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1799 =item part_pkg_usage
1801 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1806 Returns the automatic transfer target for this package, or an empty string
1813 my $pkgpart = $self->change_to_pkgpart or return '';
1814 FS::part_pkg->by_key($pkgpart);
1819 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1820 PLAN is the object's I<plan> field. There should be better docs
1821 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1827 my $plan = $self->plan;
1829 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1833 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1834 my $class = ref($self). "::$plan";
1835 warn "reblessing $self into $class" if $DEBUG > 1;
1838 bless($self, $class) unless $@;
1842 =item calc_setup CUST_PKG START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1844 =item calc_recur CUST_PKG START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1846 Calculates and returns the setup or recurring fees, respectively, for this
1847 package. Implementation is in the FS::part_pkg:* module specific to this price
1850 Adds invoicing details to the passed-in DETAILS_ARRAYREF
1852 Options are passed as a hashref. Available options:
1858 Frequency override (for calc_recur)
1862 This option is filled in by the method rather than controlling its operation.
1863 It is an arrayref. Applicable discounts will be added to the arrayref, as
1864 L<FS::cust_bill_pkg_discount|FS::cust_bill_pkg_discount records>.
1868 For package add-ons, is the base L<FS::part_pkg|package definition>, otherwise
1869 no different than pkgpart.
1871 =item precommit_hooks
1873 This option is filled in by the method rather than controlling its operation.
1874 It is an arrayref. Anonymous coderefs will be added to the arrayref. They
1875 need to be called before completing the billing operation. For calc_recur
1878 =item increment_next_bill
1880 Increment the next bill date (boolean, for calc_recur). Typically true except
1881 for particular situations.
1885 This option is filled in by the method rather than controlling its operation.
1886 It indicates a deferred setup fee that is billed at calc_recur time (see price
1887 plan option prorate_defer_bill).
1891 Note: Don't calculate prices when not actually billing the package. For that,
1892 see the L</base_setup|base_setup> and L</base_recur|base_recur> methods.
1897 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1898 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1900 =item calc_remain CUST_PKG [ OPTION => VALUE ... ]
1902 Calculates and returns the remaining value to be credited upon package
1903 suspension, change, or cancellation, if enabled.
1905 Options are passed as a list of keys and values. Available options:
1911 Override for the current time
1913 =item cust_credit_source_bill_pkg
1915 This option is filled in by the method rather than controlling its operation.
1917 L<FS::cust_credit_source_bill_pkg|FS::cust_credit_source_bill_pkg> records will
1918 be added to the arrayref indicating the specific line items and amounts which
1919 are the source of this remaining credit.
1923 Note: Don't calculate prices when not actually suspending or cancelling the
1928 #fallback that returns 0 for old legacy packages with no plan
1929 sub calc_remain { 0; }
1931 =item calc_units CUST_PKG
1933 This returns the number of provisioned svc_phone records, or, of the package
1934 count_available_phones option is set, the number available to be provisioned
1940 my($self, $cust_pkg ) = @_;
1942 if ( $self->option('count_available_phones', 1)) {
1943 foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) {
1944 if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx?
1945 $count += $pkg_svc->quantity || 0;
1948 $count *= $cust_pkg->quantity;
1951 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
1956 #fallback for everything not based on flat.pm
1957 sub recur_temporality { 'upcoming'; }
1959 =item calc_cancel START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1961 Runs any necessary billing on cancellation: another recurring cycle for
1962 recur_temporailty 'preceding' pacakges with the bill_recur_on_cancel option
1963 set (calc_recur), or, any outstanding usage for pacakges with the
1964 bill_usage_on_cancel option set (calc_usage).
1968 #fallback for everything not based on flat.pm, doesn't do this yet (which is
1969 #okay, nothing of ours not based on flat.pm does usage-on-cancel billing
1970 sub calc_cancel { 0; }
1972 #fallback for everything except bulk.pm
1973 sub hide_svc_detail { 0; }
1975 #fallback for packages that can't/won't summarize usage
1976 sub sum_usage { 0; }
1978 =item recur_cost_permonth CUST_PKG
1980 recur_cost divided by freq (only supported for monthly and longer frequencies)
1984 sub recur_cost_permonth {
1985 my($self, $cust_pkg) = @_;
1986 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1987 sprintf('%.2f', ($self->recur_cost || 0) / $self->freq );
1990 =item cust_bill_pkg_recur CUST_PKG
1992 Actual recurring charge for the specified customer package from customer's most
1997 sub cust_bill_pkg_recur {
1998 my($self, $cust_pkg) = @_;
1999 my $cust_bill_pkg = qsearchs({
2000 'table' => 'cust_bill_pkg',
2001 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
2002 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
2003 'recur' => { op=>'>', value=>'0' },
2005 'order_by' => 'ORDER BY cust_bill._date DESC,
2006 cust_bill_pkg.sdate DESC
2009 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
2010 $cust_bill_pkg->recur;
2013 =item unit_setup CUST_PKG
2015 Returns the setup fee for one unit of the package.
2020 my ($self, $cust_pkg) = @_;
2021 $self->option('setup_fee') || 0;
2026 unit_setup minus setup_cost
2032 $self->unit_setup(@_) - ($self->setup_cost || 0);
2035 =item recur_margin_permonth
2037 base_recur_permonth minus recur_cost_permonth
2041 sub recur_margin_permonth {
2043 $self->base_recur_permonth(@_) - $self->recur_cost_permonth(@_);
2046 =item intro_end PACKAGE
2048 Takes an L<FS::cust_pkg> object. If this plan has an introductory rate,
2049 returns the expected date the intro period will end. If there is no intro
2058 =item format OPTION DATA
2060 Returns data formatted according to the function 'format' described
2061 in the plan info. Returns DATA if no such function exists.
2066 my ($self, $option, $data) = (shift, shift, shift);
2067 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
2068 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
2074 =item parse OPTION DATA
2076 Returns data parsed according to the function 'parse' described
2077 in the plan info. Returns DATA if no such function exists.
2082 my ($self, $option, $data) = (shift, shift, shift);
2083 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
2084 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
2094 =head1 CLASS METHODS
2102 # Used by FS::Upgrade to migrate to a new database.
2104 sub _upgrade_data { # class method
2105 my($class, %opts) = @_;
2107 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
2109 my @part_pkg = qsearch({
2110 'table' => 'part_pkg',
2111 'extra_sql' => "WHERE ". join(' OR ',
2112 'plan IS NULL', "plan = '' ",
2116 foreach my $part_pkg (@part_pkg) {
2118 unless ( $part_pkg->plan ) {
2119 $part_pkg->plan('flat');
2126 # Convert RADIUS accounting usage metrics from megabytes to gigabytes
2128 my $upgrade = 'part_pkg_gigabyte_usage';
2129 if (!FS::upgrade_journal->is_done($upgrade)) {
2130 foreach my $part_pkg (qsearch('part_pkg',
2131 { plan => 'sqlradacct_hour' })
2134 my $pkgpart = $part_pkg->pkgpart;
2136 foreach my $opt (qsearch('part_pkg_option',
2137 { 'optionname' => { op => 'LIKE',
2138 value => 'recur_included_%',
2140 pkgpart => $pkgpart,
2143 next if $opt->optionname eq 'recur_included_hours'; # unfortunately named field
2144 next if $opt->optionvalue == 0;
2146 $opt->optionvalue($opt->optionvalue / 1024);
2148 my $error = $opt->replace;
2149 die $error if $error;
2152 foreach my $opt (qsearch('part_pkg_option',
2153 { 'optionname' => { op => 'LIKE',
2154 value => 'recur_%_charge',
2156 pkgpart => $pkgpart,
2158 $opt->optionvalue($opt->optionvalue * 1024);
2160 my $error = $opt->replace;
2161 die $error if $error;
2165 FS::upgrade_journal->set_done($upgrade);
2168 # the rest can be done asynchronously
2171 sub queueable_upgrade {
2172 # now upgrade to the explicit custom flag
2174 my $search = FS::Cursor->new({
2175 'table' => 'part_pkg',
2176 'hashref' => { disabled => 'Y', custom => '' },
2177 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
2181 while (my $part_pkg = $search->fetch) {
2182 my $new = new FS::part_pkg { $part_pkg->hash };
2184 my $comment = $part_pkg->comment;
2185 $comment =~ s/^\(CUSTOM\) //;
2186 $comment = '(none)' unless $comment =~ /\S/;
2187 $new->comment($comment);
2189 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
2190 my $primary = $part_pkg->svcpart;
2191 my $options = { $part_pkg->options };
2193 my $error = $new->replace( $part_pkg,
2194 'pkg_svc' => $pkg_svc,
2195 'primary_svc' => $primary,
2196 'options' => $options,
2199 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2206 # set family_pkgpart on any packages that don't have it
2207 $search = FS::Cursor->new('part_pkg', { 'family_pkgpart' => '' });
2208 while (my $part_pkg = $search->fetch) {
2209 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
2210 my $error = $part_pkg->SUPER::replace;
2212 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2219 my @part_pkg_option = qsearch('part_pkg_option',
2220 { 'optionname' => 'unused_credit',
2223 foreach my $old_opt (@part_pkg_option) {
2224 my $pkgpart = $old_opt->pkgpart;
2225 my $error = $old_opt->delete;
2226 die $error if $error;
2228 foreach (qw(unused_credit_cancel unused_credit_change)) {
2229 my $new_opt = new FS::part_pkg_option {
2230 'pkgpart' => $pkgpart,
2234 $error = $new_opt->insert;
2235 die $error if $error;
2239 # migrate use_disposition_taqua and use_disposition to disposition_in
2240 @part_pkg_option = qsearch('part_pkg_option',
2241 { 'optionname' => { op => 'LIKE',
2242 value => 'use_disposition%',
2246 my %newopts = map { $_->pkgpart => $_ }
2247 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
2248 foreach my $old_opt (@part_pkg_option) {
2249 my $pkgpart = $old_opt->pkgpart;
2250 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
2252 my $error = $old_opt->delete;
2253 die $error if $error;
2255 if ( exists($newopts{$pkgpart}) ) {
2256 my $opt = $newopts{$pkgpart};
2257 $opt->optionvalue($opt->optionvalue.",$newval");
2258 $error = $opt->replace;
2259 die $error if $error;
2261 my $new_opt = new FS::part_pkg_option {
2262 'pkgpart' => $pkgpart,
2263 'optionname' => 'disposition_in',
2264 'optionvalue' => $newval,
2266 $error = $new_opt->insert;
2267 die $error if $error;
2268 $newopts{$pkgpart} = $new_opt;
2272 # set any package with FCC voice lines to the "VoIP with broadband" category
2273 # for backward compatibility
2275 # recover from a bad upgrade bug
2276 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
2277 if (!FS::upgrade_journal->is_done($upgrade)) {
2278 my $bad_upgrade = qsearchs('upgrade_journal',
2279 { upgrade => 'part_pkg_fcc_voip_class' }
2281 if ( $bad_upgrade ) {
2282 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
2283 ' AND history_date > '.($bad_upgrade->_date - 3600);
2284 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
2287 'table' => 'h_part_pkg_option',
2289 'extra_sql' => "$where AND history_action = 'delete'",
2290 'order_by' => 'ORDER BY history_date ASC',
2292 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
2295 'table' => 'h_pkg_svc',
2297 'extra_sql' => "$where AND history_action = 'replace_old'",
2298 'order_by' => 'ORDER BY history_date ASC',
2301 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
2302 my $pkgpart ||= $deleted->pkgpart;
2303 $opt{$pkgpart} ||= {
2309 if ( $deleted->isa('FS::part_pkg_option') ) {
2310 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
2312 my $svcpart = $deleted->svcpart;
2313 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
2314 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
2315 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
2318 foreach my $pkgpart (keys %opt) {
2319 my $part_pkg = FS::part_pkg->by_key($pkgpart);
2320 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
2322 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
2325 } # $bad_upgrade exists
2326 else { # do the original upgrade, but correctly this time
2327 my @part_pkg = qsearch('part_pkg', {
2328 fcc_ds0s => { op => '>', value => 0 },
2329 fcc_voip_class => ''
2331 foreach my $part_pkg (@part_pkg) {
2332 $part_pkg->set(fcc_voip_class => 2);
2333 my @pkg_svc = $part_pkg->pkg_svc;
2334 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
2335 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
2336 my $error = $part_pkg->replace(
2337 $part_pkg->replace_old,
2338 options => { $part_pkg->options },
2339 pkg_svc => \%quantity,
2340 hidden_svc => \%hidden,
2341 primary_svc => ($part_pkg->svcpart || ''),
2343 die $error if $error;
2346 FS::upgrade_journal->set_done($upgrade);
2349 # migrate adjourn_months, expire_months, and contract_end_months to
2351 foreach my $field (qw(adjourn_months expire_months contract_end_months)) {
2352 foreach my $option (qsearch('part_pkg_option', { optionname => $field })) {
2353 my $part_pkg = $option->part_pkg;
2354 my $error = $option->delete;
2355 if ( $option->optionvalue and $part_pkg->get($field) eq '' ) {
2356 $part_pkg->set($field, $option->optionvalue);
2357 $error ||= $part_pkg->replace;
2359 die $error if $error;
2363 # remove custom flag from one-time charge packages that were accidentally
2365 $search = FS::Cursor->new({
2366 'table' => 'part_pkg',
2367 'hashref' => { 'freq' => '0',
2369 'family_pkgpart' => { op => '!=', value => '' },
2371 'addl_from' => ' JOIN
2372 (select pkgpart from cust_pkg group by pkgpart having count(*) = 1)
2373 AS singular_pkg USING (pkgpart)',
2375 my @fields = grep { $_ ne 'pkgpart'
2377 and $_ ne 'disabled' } FS::part_pkg->fields;
2378 PKGPART: while (my $part_pkg = $search->fetch) {
2379 # can't merge the package back into its parent (too late for that)
2380 # but we can remove the custom flag if it's not actually customized,
2381 # i.e. nothing has been changed.
2383 my $family_pkgpart = $part_pkg->family_pkgpart;
2384 next PKGPART if $family_pkgpart == $part_pkg->pkgpart;
2385 my $parent_pkg = FS::part_pkg->by_key($family_pkgpart);
2386 foreach my $field (@fields) {
2387 if ($part_pkg->get($field) ne $parent_pkg->get($field)) {
2391 # options have to be identical too
2392 # but links, FCC options, discount plans, and usage packages can't be
2393 # changed through the "modify charge" UI, so skip them
2394 my %newopt = $part_pkg->options;
2395 my %oldopt = $parent_pkg->options;
2396 OPTION: foreach my $option (keys %newopt) {
2397 if (delete $newopt{$option} ne delete $oldopt{$option}) {
2401 if (keys(%newopt) or keys(%oldopt)) {
2404 # okay, now replace it
2405 warn "Removing custom flag from part_pkg#".$part_pkg->pkgpart."\n";
2406 $part_pkg->set('custom', '');
2407 my $error = $part_pkg->replace;
2408 die $error if $error;
2414 =item curuser_pkgs_sql
2416 Returns an SQL fragment for searching for packages the current user can
2417 use, either via part_pkg.agentnum directly, or via agent type (see
2422 sub curuser_pkgs_sql {
2425 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
2429 =item agent_pkgs_sql AGENT | AGENTNUM, ...
2431 Returns an SQL fragment for searching for packages the provided agent or agents
2432 can use, either via part_pkg.agentnum directly, or via agent type (see
2437 sub agent_pkgs_sql {
2438 my $class = shift; #i'm a class method, not a sub (the question is... why??)
2439 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
2441 $class->_pkgs_sql(@agentnums); #is this why
2446 my( $class, @agentnums ) = @_;
2447 my $agentnums = join(',', @agentnums);
2451 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
2452 OR ( agentnum IS NULL
2453 AND EXISTS ( SELECT 1
2455 LEFT JOIN agent_type USING ( typenum )
2456 LEFT JOIN agent AS typeagent USING ( typenum )
2457 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
2458 AND typeagent.agentnum IN ($agentnums)
2466 =item join_options_sql
2468 Returns an SQL fragment for JOINing the part_pkg_option records for this
2469 package's setup_fee and recur_fee (as setup_option and recur_option,
2470 respectively). Useful for optimization.
2474 sub join_options_sql {
2477 LEFT JOIN part_pkg_option AS setup_option
2478 ON ( part_pkg.pkgpart = setup_option.pkgpart
2479 AND setup_option.optionname = 'setup_fee' )
2480 LEFT JOIN part_pkg_option AS recur_option
2481 ON ( part_pkg.pkgpart = recur_option.pkgpart
2482 AND recur_option.optionname = 'recur_fee' )
2496 #false laziness w/part_export & cdr
2498 foreach my $INC ( @INC ) {
2499 warn "globbing $INC/FS/part_pkg/[a-z]*.pm\n" if $DEBUG;
2500 foreach my $file ( glob("$INC/FS/part_pkg/[a-z]*.pm") ) {
2501 warn "attempting to load plan info from $file\n" if $DEBUG;
2502 $file =~ /\/(\w+)\.pm$/ or do {
2503 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
2507 my $info = eval "use FS::part_pkg::$mod; ".
2508 "\\%FS::part_pkg::$mod\::info;";
2510 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
2513 unless ( keys %$info ) {
2514 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
2517 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
2518 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
2519 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
2522 $info{$mod} = $info;
2523 $info->{'weight'} ||= 0; # quiet warnings
2527 # copy one level deep to allow replacement of fields and fieldorder
2528 tie %plans, 'Tie::IxHash',
2529 map { my %infohash = %{ $info{$_} };
2531 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
2534 # inheritance of plan options
2535 foreach my $name (keys(%info)) {
2536 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
2537 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
2538 delete $plans{$name};
2541 my $parents = $info{$name}->{'inherit_fields'} || [];
2542 my (%fields, %field_exists, @fieldorder);
2543 foreach my $parent ($name, @$parents) {
2544 if ( !exists($info{$parent}) ) {
2545 warn "$name tried to inherit from nonexistent '$parent'\n";
2548 %fields = ( # avoid replacing existing fields
2549 %{ $info{$parent}->{'fields'} || {} },
2552 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
2554 next if $field_exists{$_};
2555 $field_exists{$_} = 1;
2556 # allow inheritors to remove inherited fields from the fieldorder
2557 push @fieldorder, $_ if !exists($fields{$_}) or
2558 !exists($fields{$_}->{'disabled'});
2561 $plans{$name}->{'fields'} = \%fields;
2562 $plans{$name}->{'fieldorder'} = \@fieldorder;
2572 =head1 NEW PLAN CLASSES
2574 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
2575 found in eg/plan_template.pm. Until then, it is suggested that you use the
2576 other modules in FS/FS/part_pkg/ as a guide.
2580 The delete method is unimplemented.
2582 setup and recur semantics are not yet defined (and are implemented in
2583 FS::cust_bill. hmm.). now they're deprecated and need to go.
2587 part_pkg_taxrate is Pg specific
2589 replace should be smarter about managing the related tables (options, pkg_svc)
2593 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2594 schema.html from the base documentation.