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;
696 sub validate_number {
697 my ($option, $valref) = @_;
699 $$valref = 0 unless $$valref;
700 return "Invalid $option"
701 unless ($$valref) = ($$valref =~ /^\s*(\d+)\s*$/);
705 sub validate_number_blank {
706 my ($option, $valref) = @_;
709 return "Invalid $option"
710 unless ($$valref) = ($$valref =~ /^\s*(\d+)\s*$/);
717 Checks all fields to make sure this is a valid package definition. If
718 there is an error, returns the error, otherwise returns false. Called by the
719 insert and replace methods.
725 warn "FS::part_pkg::check called on $self" if $DEBUG;
727 for (qw(setup recur plandata)) {
728 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
729 return "Use of $_ field is deprecated; set a plan and options: ".
731 if length($self->get($_));
735 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
736 my $error = $self->ut_number('freq');
737 return $error if $error;
739 $self->freq =~ /^(\d+[hdw]?)$/
740 or return "Illegal or empty freq: ". $self->freq;
744 my @null_agentnum_right = ( 'Edit global package definitions' );
745 push @null_agentnum_right, 'One-time charge'
746 if $self->freq =~ /^0/;
747 push @null_agentnum_right, 'Customize customer package'
748 if $self->disabled eq 'Y'; #good enough
750 my $error = $self->ut_numbern('pkgpart')
751 || $self->ut_text('pkg')
752 || $self->ut_textn('comment')
753 || $self->ut_textn('promo_code')
754 || $self->ut_alphan('plan')
755 || $self->ut_flag('setuptax')
756 || $self->ut_flag('recurtax')
757 || $self->ut_textn('taxclass')
758 || $self->ut_flag('disabled')
759 || $self->ut_flag('custom')
760 || $self->ut_flag('no_auto')
761 || $self->ut_flag('recur_show_zero')
762 || $self->ut_flag('setup_show_zero')
763 || $self->ut_flag('start_on_hold')
764 #|| $self->ut_moneyn('setup_cost')
765 #|| $self->ut_moneyn('recur_cost')
766 || $self->ut_floatn('setup_cost')
767 || $self->ut_floatn('recur_cost')
768 || $self->ut_floatn('pay_weight')
769 || $self->ut_floatn('credit_weight')
770 || $self->ut_numbern('taxproductnum')
771 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
772 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
773 || $self->ut_foreign_keyn('taxproductnum',
774 'part_pkg_taxproduct',
778 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
779 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
781 || $self->ut_numbern('fcc_ds0s')
782 || $self->ut_numbern('fcc_voip_class')
783 || $self->ut_numbern('delay_start')
784 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
785 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
786 || $self->ut_numbern('expire_months')
787 || $self->ut_numbern('adjourn_months')
788 || $self->ut_numbern('contract_end_months')
789 || $self->ut_numbern('change_to_pkgpart')
790 || $self->ut_foreign_keyn('change_to_pkgpart', 'part_pkg', 'pkgpart')
791 || $self->ut_alphan('agent_pkgpartid')
792 || $self->SUPER::check
794 return $error if $error;
796 return 'Unknown plan '. $self->plan
797 unless exists($plans{$self->plan});
799 my $conf = new FS::Conf;
800 return 'Taxclass is required'
801 if ! $self->taxclass && $conf->exists('require_taxclasses');
808 Pass an I<$options> hashref that contains the values to be
809 inserted or updated for any FS::part_pkg::MODULE.pm.
811 For each key in I<$options>, validates the value by calling
812 the 'validate' subroutine defined for that option e.g.
813 FS::part_pkg::MODULE::plan_info()->{$KEY}->{validate}. The
814 option validation function is only called when the hashkey for
815 that option exists in I<$options>.
817 Then the module validation function is called, from
818 FS::part_pkg::MODULE::plan_info()->{validate}
820 Returns error message, or empty string if valid.
822 Invoked by L</insert> and L</replace> via the equivalent
823 methods in L<FS::option_Common>.
828 my ($self,$options) = @_;
829 foreach my $option (keys %$options) {
830 if (exists $plans{ $self->plan }->{fields}->{$option}) {
831 if (exists($plans{$self->plan}->{fields}->{$option}->{'validate'})) {
832 # pass option name for use in error message
833 # pass a reference to the $options value, so it can be cleaned up
834 my $error = &{$plans{$self->plan}->{fields}->{$option}->{'validate'}}($option,\($options->{$option}));
835 return $error if $error;
837 } # else "option does not exist" error?
839 if (exists($plans{$self->plan}->{'validate'})) {
840 my $error = &{$plans{$self->plan}->{'validate'}}($options);
841 return $error if $error;
848 Checks pkg_svc records as a whole (for part_svc_link dependencies).
850 If there is an error, returns the error, otherwise returns false.
855 my( $self, %opt ) = @_;
857 my $agentnum = $self->agentnum;
859 my %pkg_svc = map { $_->svcpart => $_ } $self->pkg_svc;
861 foreach my $svcpart ( keys %pkg_svc ) {
863 foreach my $part_svc_link ( $self->part_svc_link(
864 'src_svcpart' => $svcpart,
865 'link_type' => 'part_pkg_restrict',
869 return $part_svc_link->dst_svc. ' must be included with '.
870 $part_svc_link->src_svc
871 unless $pkg_svc{ $part_svc_link->dst_svcpart };
876 return '' if $opt{part_pkg_restrict_soft_override};
878 foreach my $svcpart ( keys %pkg_svc ) {
880 foreach my $part_svc_link ( $self->part_svc_link(
881 'src_svcpart' => $svcpart,
882 'link_type' => 'part_pkg_restrict_soft',
885 return $part_svc_link->dst_svc. ' is suggested with '.
886 $part_svc_link->src_svc
887 unless $pkg_svc{ $part_svc_link->dst_svcpart };
895 =item part_svc_link OPTION => VALUE ...
897 Returns the service dependencies (see L<FS::part_svc_link>) for the given
898 search options, taking into account this package definition's agent.
900 Available options are any field in part_svc_link. Typically used options are
901 src_svcpart and link_type.
906 FS::part_svc_link->by_agentnum( shift->agentnum, @_ );
909 =item supersede OLD [, OPTION => VALUE ... ]
911 Inserts this package as a successor to the package OLD. All options are as
912 for C<insert>. After inserting, disables OLD and sets the new package as its
918 my ($new, $old, %options) = @_;
921 $new->set('pkgpart' => '');
922 $new->set('family_pkgpart' => $old->family_pkgpart);
923 warn " inserting successor package\n" if $DEBUG;
924 $error = $new->insert(%options);
925 return $error if $error;
927 warn " disabling superseded package\n" if $DEBUG;
928 $old->set('successor' => $new->pkgpart);
929 $old->set('disabled' => 'Y');
930 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
931 return $error if $error;
933 warn " propagating changes to family" if $DEBUG;
934 $new->propagate($old);
939 If any of certain fields have changed from OLD to this package, then,
940 for all packages in the same lineage as this one, sets those fields
941 to their values in this package.
945 my @propagate_fields = (
946 qw( pkg classnum setup_cost recur_cost taxclass
947 setuptax recurtax pay_weight credit_weight
955 map { $_ => $new->get($_) }
956 grep { $new->get($_) ne $old->get($_) }
960 my @part_pkg = qsearch('part_pkg', {
961 'family_pkgpart' => $new->family_pkgpart
964 foreach my $part_pkg ( @part_pkg ) {
965 my $pkgpart = $part_pkg->pkgpart;
966 next if $pkgpart == $new->pkgpart; # don't modify $new
967 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
968 foreach ( keys %fields ) {
969 $part_pkg->set($_, $fields{$_});
971 # SUPER::replace to avoid changing non-core fields
972 my $error = $part_pkg->SUPER::replace;
973 push @error, "pkgpart $pkgpart: $error"
979 =item set_fcc_options HASHREF
981 Sets the FCC options on this package definition to the values specified
986 sub set_fcc_options {
988 my $pkgpart = $self->pkgpart;
996 my %existing_num = map { $_->fccoptionname => $_->num }
997 qsearch('part_pkg_fcc_option', { pkgpart => $pkgpart });
999 local $FS::Record::nowarn_identical = 1;
1000 # set up params for process_o2m
1003 foreach my $name (keys %$options ) {
1004 $params->{ "num$i" } = $existing_num{$name} || '';
1005 $params->{ "num$i".'_fccoptionname' } = $name;
1006 $params->{ "num$i".'_optionvalue' } = $options->{$name};
1011 table => 'part_pkg_fcc_option',
1012 fields => [qw( fccoptionname optionvalue )],
1017 =item pkg_locale LOCALE
1019 Returns a customer-viewable string representing this package for the given
1020 locale, from the part_pkg_msgcat table. If the given locale is empty or no
1021 localized string is found, returns the base pkg field.
1026 my( $self, $locale ) = @_;
1027 return $self->pkg unless $locale;
1028 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
1029 $part_pkg_msgcat->pkg;
1032 =item part_pkg_msgcat LOCALE
1034 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
1038 sub part_pkg_msgcat {
1039 my( $self, $locale ) = @_;
1040 qsearchs( 'part_pkg_msgcat', {
1041 pkgpart => $self->pkgpart,
1046 =item pkg_comment [ OPTION => VALUE... ]
1048 Returns an (internal) string representing this package. Currently,
1049 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
1050 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
1053 If the option nopkgpart is true then the "pkgpart: ' is omitted.
1061 #$self->pkg. ' - '. $self->comment;
1062 #$self->pkg. ' ('. $self->comment. ')';
1063 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
1064 my $custom_comment = $self->custom_comment(%opt);
1065 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
1068 #without price info (so without hitting the DB again)
1069 sub pkg_comment_only {
1073 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
1074 my $comment = $self->comment;
1075 $pre. $self->pkg. ( $comment ? " - $comment" : '' );
1078 sub price_info { # safety, in case a part_pkg hasn't defined price_info
1082 sub custom_comment {
1084 my $price_info = $self->price_info(@_);
1085 ( $self->custom ? '(CUSTOM) ' : '' ).
1087 ( ($self->custom || $self->comment) ? ' - ' : '' ).
1088 ($price_info || 'No charge');
1091 sub pkg_price_info {
1093 $self->pkg. ' - '. ($self->price_info || 'No charge');
1098 Returns the package class, as an FS::pkg_class object, or the empty string
1099 if there is no package class.
1101 =item addon_pkg_class
1103 Returns the add-on package class, as an FS::pkg_class object, or the empty
1104 string if there is no add-on package class.
1108 sub addon_pkg_class {
1110 if ( $self->addon_classnum ) {
1111 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
1119 Returns the package category name, or the empty string if there is no package
1126 my $pkg_class = $self->pkg_class;
1128 ? $pkg_class->categoryname
1134 Returns the package class name, or the empty string if there is no package
1141 my $pkg_class = $self->pkg_class;
1143 ? $pkg_class->classname
1147 =item addon_classname
1149 Returns the add-on package class name, or the empty string if there is no
1150 add-on package class.
1154 sub addon_classname {
1156 my $pkg_class = $self->addon_pkg_class;
1158 ? $pkg_class->classname
1164 Returns the associated agent for this event, if any, as an FS::agent object.
1166 =item pkg_svc [ HASHREF | OPTION => VALUE ]
1168 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
1169 definition (with non-zero quantity).
1171 One option is available, I<disable_linked>. If set true it will return the
1172 services for this package definition alone, omitting services from any add-on
1179 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
1187 return @{ $cache_pkg_svc{$self->pkgpart} }
1188 if $cache_enabled && $cache_pkg_svc{$self->pkgpart};
1190 # #sort { $b->primary cmp $a->primary }
1191 # grep { $_->quantity }
1192 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
1194 my $opt = ref($_[0]) ? $_[0] : { @_ };
1195 my %pkg_svc = map { $_->svcpart => $_ } $self->_pkg_svc;
1197 unless ( $opt->{disable_linked} ) {
1198 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
1199 my @pkg_svc = $dst_pkg->_pkg_svc;
1200 foreach my $pkg_svc ( @pkg_svc ) {
1201 if ( $pkg_svc{$pkg_svc->svcpart} ) {
1202 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
1203 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
1205 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
1211 my @pkg_svc = values(%pkg_svc);
1213 $cache_pkg_svc{$self->pkgpart} = \@pkg_svc if $cache_enabled;
1221 grep { $_->quantity }
1223 'select' => 'pkg_svc.*, part_svc.*',
1224 'table' => 'pkg_svc',
1225 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
1226 'hashref' => { 'pkgpart' => $self->pkgpart },
1230 =item svcpart [ SVCDB ]
1232 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
1233 associated with this package definition (see L<FS::pkg_svc>). Returns
1234 false if there not a primary service definition or exactly one service
1235 definition with quantity 1, or if SVCDB is specified and does not match the
1236 svcdb of the service definition. SVCDB can be specified as a scalar table
1237 name, such as 'svc_acct', or as an arrayref of possible table names.
1242 my $pkg_svc = shift->_primary_pkg_svc(@_);
1243 $pkg_svc ? $pkg_svc->svcpart : '';
1246 =item part_svc [ SVCDB ]
1248 Like the B<svcpart> method, but returns the FS::part_svc object (see
1254 my $pkg_svc = shift->_primary_pkg_svc(@_);
1255 $pkg_svc ? $pkg_svc->part_svc : '';
1258 sub _primary_pkg_svc {
1261 my $svcdb = scalar(@_) ? shift : [];
1262 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1263 my %svcdb = map { $_=>1 } @$svcdb;
1266 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1269 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1270 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1272 return '' if scalar(@pkg_svc) != 1;
1276 =item svcpart_unique_svcdb SVCDB
1278 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1279 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1280 false if there not a primary service definition for SVCDB or there are multiple
1281 service definitions for SVCDB.
1285 sub svcpart_unique_svcdb {
1286 my( $self, $svcdb ) = @_;
1287 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1288 return '' if scalar(@svcdb_pkg_svc) != 1;
1289 $svcdb_pkg_svc[0]->svcpart;
1294 Returns a list of the acceptable payment types for this package. Eventually
1295 this should come out of a database table and be editable, but currently has the
1296 following logic instead:
1298 If the package is free, the single item B<BILL> is
1299 returned, otherwise, the single item B<CARD> is returned.
1301 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1307 if ( $self->is_free ) {
1316 Returns true if this package is free.
1322 if ( $self->can('is_free_options') ) {
1323 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1324 map { $self->option($_) }
1325 $self->is_free_options;
1327 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1328 "provides neither is_free_options nor is_free method; returning false";
1333 # whether the plan allows discounts to be applied to this package
1334 sub can_discount { 0; }
1336 # whether the plan allows changing the start date
1337 sub can_start_date {
1339 $self->start_on_hold ? 0 : 1;
1342 # whether the plan supports part_pkg_usageprice add-ons (a specific kind of
1343 # pre-selectable usage pricing, there's others this doesn't refer to)
1344 sub can_usageprice { 0; }
1346 # the delay start date if present
1347 sub delay_start_date {
1350 my $delay = $self->delay_start or return '';
1352 # avoid timelocal silliness
1353 my $dt = DateTime->today(time_zone => 'local');
1354 $dt->add(days => $delay);
1358 sub can_currency_exchange { 0; }
1361 # moved to FS::Misc to make this accessible to other packages
1363 FS::Misc::pkg_freqs();
1368 Returns an english representation of the I<freq> field, such as "monthly",
1369 "weekly", "semi-annually", etc.
1375 my $freq = $self->freq;
1377 #my $freqs_href = $self->freqs_href;
1378 my $freqs_href = freqs_href();
1380 if ( exists($freqs_href->{$freq}) ) {
1381 $freqs_href->{$freq};
1383 my $interval = 'month';
1384 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1385 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1386 $interval = $interval{$2};
1391 "every $freq ${interval}s";
1396 =item add_freq TIMESTAMP [ FREQ ]
1398 Adds a billing period of some frequency to the provided timestamp and
1399 returns the resulting timestamp, or -1 if the frequency could not be
1400 parsed (shouldn't happen). By default, the frequency of this package
1401 will be used; to override this, pass a different frequency as a second
1407 my( $self, $date, $freq ) = @_;
1408 $freq = $self->freq unless $freq;
1410 #change this bit to use Date::Manip? CAREFUL with timezones (see
1411 # mailing list archive)
1412 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1414 if ( $freq =~ /^\d+$/ ) {
1416 until ( $mon < 12 ) { $mon -= 12; $year++; }
1418 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1420 } elsif ( $freq =~ /^(\d+)w$/ ) {
1422 $mday += $weeks * 7;
1423 } elsif ( $freq =~ /^(\d+)d$/ ) {
1426 } elsif ( $freq =~ /^(\d+)h$/ ) {
1433 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1438 For backwards compatibility, returns the plandata field as well as all options
1439 from FS::part_pkg_option.
1445 carp "plandata is deprecated";
1447 $self->SUPER::plandata(@_);
1449 my $plandata = $self->get('plandata');
1450 my %options = $self->options;
1451 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1456 =item part_pkg_vendor
1458 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1459 L<FS::part_pkg_vendor>).
1461 =item vendor_pkg_ids
1463 Returns a list of vendor/external package ids by exportnum
1467 sub vendor_pkg_ids {
1469 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1472 =item part_pkg_option
1474 Returns all options as FS::part_pkg_option objects (see
1475 L<FS::part_pkg_option>).
1479 Returns a list of option names and values suitable for assigning to a hash.
1485 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1488 =item option OPTIONNAME [ QUIET ]
1490 Returns the option value for the given name, or the empty string. If a true
1491 value is passed as the second argument, warnings about missing the option
1497 my( $self, $opt, $ornull ) = @_;
1499 #cache: was pulled up in the original part_pkg query
1500 return $self->hashref->{"_opt_$opt"}
1501 if exists $self->hashref->{"_opt_$opt"};
1503 cluck "$self -> option: searching for $opt" if $DEBUG;
1504 my $part_pkg_option =
1505 qsearchs('part_pkg_option', {
1506 pkgpart => $self->pkgpart,
1509 return $part_pkg_option->optionvalue if $part_pkg_option;
1511 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1512 split("\n", $self->get('plandata') );
1513 return $plandata{$opt} if exists $plandata{$opt};
1515 # check whether the option is defined in plan info (if so, don't warn)
1516 if (exists $plans{ $self->plan }->{fields}->{$opt}) {
1519 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1520 "not found in options or plandata!\n"
1526 =item part_pkg_currency [ CURRENCY ]
1528 Returns all currency options as FS::part_pkg_currency objects (see
1529 L<FS::part_pkg_currency>), or, if a currency is specified, only return the
1530 objects for that currency.
1534 sub part_pkg_currency {
1536 my %hash = ( 'pkgpart' => $self->pkgpart );
1537 $hash{'currency'} = shift if @_;
1538 qsearch('part_pkg_currency', \%hash );
1541 =item part_pkg_currency_options CURRENCY
1543 Returns a list of option names and values from FS::part_pkg_currency for the
1548 sub part_pkg_currency_options {
1550 map { $_->optionname => $_->optionvalue } $self->part_pkg_currency(shift);
1553 =item part_pkg_currency_option CURRENCY OPTIONNAME
1555 Returns the option value for the given name and currency.
1559 sub part_pkg_currency_option {
1560 my( $self, $currency, $optionname ) = @_;
1561 my $part_pkg_currency =
1562 qsearchs('part_pkg_currency', { 'pkgpart' => $self->pkgpart,
1563 'currency' => $currency,
1564 'optionname' => $optionname,
1567 #fatal if not found? that works for our use cases from
1568 #part_pkg/currency_fixed, but isn't how we would typically/expect the method
1569 #to behave. have to catch it there if we change it here...
1570 or die "Unknown price for ". $self->pkg_comment. " in $currency\n";
1572 $part_pkg_currency->optionvalue;
1575 =item fcc_option OPTIONNAME
1577 Returns the FCC 477 report option value for the given name, or the empty
1583 my ($self, $name) = @_;
1584 my $part_pkg_fcc_option =
1585 qsearchs('part_pkg_fcc_option', {
1586 pkgpart => $self->pkgpart,
1587 fccoptionname => $name,
1589 $part_pkg_fcc_option ? $part_pkg_fcc_option->optionvalue : '';
1594 Returns all FCC 477 report options for this package, as a hash-like list.
1600 map { $_->fccoptionname => $_->optionvalue }
1601 qsearch('part_pkg_fcc_option', { pkgpart => $self->pkgpart });
1604 =item bill_part_pkg_link
1606 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1610 sub bill_part_pkg_link {
1611 shift->_part_pkg_link('bill', @_);
1614 =item svc_part_pkg_link
1616 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1620 sub svc_part_pkg_link {
1621 shift->_part_pkg_link('svc', @_);
1624 =item supp_part_pkg_link
1626 Returns the associated part_pkg_link records of type 'supp' (supplemental
1631 sub supp_part_pkg_link {
1632 shift->_part_pkg_link('supp', @_);
1635 sub _part_pkg_link {
1636 my( $self, $type ) = @_;
1638 return @{ $cache_link{$type}->{$self->pkgpart} }
1639 if $cache_enabled && $cache_link{$type}->{$self->pkgpart};
1641 cluck $type.'_part_pkg_link called' if $DEBUG;
1644 qsearch({ table => 'part_pkg_link',
1645 hashref => { src_pkgpart => $self->pkgpart,
1647 #protection against infinite recursive links
1648 dst_pkgpart => { op=>'!=', value=> $self->pkgpart },
1650 order_by => "ORDER BY hidden",
1653 $cache_link{$type}->{$self->pkgpart} = \@ppl if $cache_enabled;
1658 sub self_and_bill_linked {
1659 shift->_self_and_linked('bill', @_);
1662 sub self_and_svc_linked {
1663 shift->_self_and_linked('svc', @_);
1666 sub _self_and_linked {
1667 my( $self, $type, $hidden ) = @_;
1671 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1672 $self->_part_pkg_link($type) ) )
1674 $_->hidden($hidden) if $hidden;
1681 =item part_pkg_taxoverride [ CLASS ]
1683 Returns all associated FS::part_pkg_taxoverride objects (see
1684 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1685 of class CLASS if defined. Class may be one of 'setup', 'recur',
1686 the empty string (default), or a usage class number (see L<FS::usage_class>).
1687 When a class is specified, the empty string class (default) is returned
1688 if no more specific values exist.
1692 sub part_pkg_taxoverride {
1696 my $hashref = { 'pkgpart' => $self->pkgpart };
1697 $hashref->{'usage_class'} = $class if defined($class);
1698 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1700 unless ( scalar(@overrides) || !defined($class) || !$class ){
1701 $hashref->{'usage_class'} = '';
1702 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1708 =item has_taxproduct
1710 Returns true if this package has any taxproduct associated with it.
1714 sub has_taxproduct {
1717 $self->taxproductnum ||
1718 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1719 keys %{ {$self->options} }
1725 =item taxproduct [ CLASS ]
1727 Returns the associated tax product for this package definition (see
1728 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1729 the usage classnum (see L<FS::usage_class>). Returns the default
1730 tax product for this record if the more specific CLASS value does
1739 my $part_pkg_taxproduct;
1741 my $taxproductnum = $self->taxproductnum;
1743 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1744 $taxproductnum = $class_taxproductnum
1745 if $class_taxproductnum
1748 $part_pkg_taxproduct =
1749 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1751 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1752 $taxproductnum = $self->taxproductnum;
1753 $part_pkg_taxproduct =
1754 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1757 $part_pkg_taxproduct;
1760 =item taxproduct_description [ CLASS ]
1762 Returns the description of the associated tax product for this package
1763 definition (see L<FS::part_pkg_taxproduct>).
1767 sub taxproduct_description {
1769 my $part_pkg_taxproduct = $self->taxproduct(@_);
1770 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1774 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1776 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1777 package in the location specified by GEOCODE, for usage class CLASS (one of
1778 'setup', 'recur', null, or a C<usage_class> number).
1784 my ($vendor, $geocode, $class) = @_;
1785 # if this part_pkg is overridden into a specific taxclass, get that class
1786 my @taxclassnums = map { $_->taxclassnum }
1787 $self->part_pkg_taxoverride($class);
1788 # otherwise, get its tax product category
1789 if (!@taxclassnums) {
1790 my $part_pkg_taxproduct = $self->taxproduct($class);
1791 # If this isn't defined, then the class has no taxproduct designation,
1792 # so return no tax rates.
1793 return () if !$part_pkg_taxproduct;
1795 # convert the taxproduct to the tax classes that might apply to it in
1797 @taxclassnums = map { $_->taxclassnum }
1798 grep { $_->taxable eq 'Y' } # why do we need this?
1799 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1801 return unless @taxclassnums;
1803 # then look up the actual tax_rate entries
1804 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1806 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1807 my @taxes = qsearch({ 'table' => 'tax_rate',
1808 'hashref' => { 'geocode' => $geocode,
1809 'data_vendor' => $vendor,
1811 'extra_sql' => $extra_sql,
1813 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1819 =item part_pkg_discount
1821 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1824 =item part_pkg_usage
1826 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1831 Returns the automatic transfer target for this package, or an empty string
1838 my $pkgpart = $self->change_to_pkgpart or return '';
1839 FS::part_pkg->by_key($pkgpart);
1844 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1845 PLAN is the object's I<plan> field. There should be better docs
1846 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1852 my $plan = $self->plan;
1854 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1858 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1859 my $class = ref($self). "::$plan";
1860 warn "reblessing $self into $class" if $DEBUG > 1;
1863 bless($self, $class) unless $@;
1867 =item calc_setup CUST_PKG START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1869 =item calc_recur CUST_PKG START_DATE_SCALARREF DETAILS_ARRAYREF OPTIONS_HASHREF
1871 Calculates and returns the setup or recurring fees, respectively, for this
1872 package. Implementation is in the FS::part_pkg:* module specific to this price
1875 Adds invoicing details to the passed-in DETAILS_ARRAYREF
1877 Options are passed as a hashref. Available options:
1883 Frequency override (for calc_recur)
1887 This option is filled in by the method rather than controlling its operation.
1888 It is an arrayref. Applicable discounts will be added to the arrayref, as
1889 L<FS::cust_bill_pkg_discount> records.
1893 For package add-ons, is the base L<FS::part_pkg> package definition, otherwise
1894 no different than pkgpart.
1896 =item precommit_hooks
1898 This option is filled in by the method rather than controlling its operation.
1899 It is an arrayref. Anonymous coderefs will be added to the arrayref. They
1900 need to be called before completing the billing operation. For calc_recur
1903 =item increment_next_bill
1905 Increment the next bill date (boolean, for calc_recur). Typically true except
1906 for particular situations.
1910 This option is filled in by the method rather than controlling its operation.
1911 It indicates a deferred setup fee that is billed at calc_recur time (see price
1912 plan option prorate_defer_bill).
1916 Note: Don't calculate prices when not actually billing the package. For that,
1917 see the L<FS::cust_pkg/base_setup> and L<FS::cust_pkg/base_recur> methods.
1922 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1923 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1925 =item calc_remain CUST_PKG [ OPTION => VALUE ... ]
1927 Calculates and returns the remaining value to be credited upon package
1928 suspension, change, or cancellation, if enabled.
1930 Options are passed as a list of keys and values. Available options:
1936 Override for the current time
1938 =item cust_credit_source_bill_pkg
1940 This option is filled in by the method rather than controlling its operation.
1942 L<FS::cust_credit_source_bill_pkg|FS::cust_credit_source_bill_pkg> records will
1943 be added to the arrayref indicating the specific line items and amounts which
1944 are the source of this remaining credit.
1948 Note: Don't calculate prices when not actually suspending or cancelling the
1953 #fallback that returns 0 for old legacy packages with no plan
1954 sub calc_remain { 0; }
1956 =item calc_units CUST_PKG
1958 This returns the number of provisioned svc_phone records, or, of the package
1959 count_available_phones option is set, the number available to be provisioned
1965 my($self, $cust_pkg ) = @_;
1967 if ( $self->option('count_available_phones', 1)) {
1968 foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) {
1969 if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx?
1970 $count += $pkg_svc->quantity || 0;
1973 $count *= $cust_pkg->quantity;
1976 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
1981 #fallback for everything not based on flat.pm
1982 sub recur_temporality { 'upcoming'; }
1984 =item calc_cancel START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1986 Runs any necessary billing on cancellation: another recurring cycle for
1987 recur_temporailty 'preceding' pacakges with the bill_recur_on_cancel option
1988 set (calc_recur), or, any outstanding usage for pacakges with the
1989 bill_usage_on_cancel option set (calc_usage).
1993 #fallback for everything not based on flat.pm, doesn't do this yet (which is
1994 #okay, nothing of ours not based on flat.pm does usage-on-cancel billing
1995 sub calc_cancel { 0; }
1997 #fallback for everything except bulk.pm
1998 sub hide_svc_detail { 0; }
2000 #fallback for packages that can't/won't summarize usage
2001 sub sum_usage { 0; }
2003 =item recur_cost_permonth CUST_PKG
2005 recur_cost divided by freq (only supported for monthly and longer frequencies)
2009 sub recur_cost_permonth {
2010 my($self, $cust_pkg) = @_;
2011 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
2012 sprintf('%.2f', ($self->recur_cost || 0) / $self->freq );
2015 =item cust_bill_pkg_recur CUST_PKG
2017 Actual recurring charge for the specified customer package from customer's most
2022 sub cust_bill_pkg_recur {
2023 my($self, $cust_pkg) = @_;
2024 my $cust_bill_pkg = qsearchs({
2025 'table' => 'cust_bill_pkg',
2026 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
2027 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
2028 'recur' => { op=>'>', value=>'0' },
2030 'order_by' => 'ORDER BY cust_bill._date DESC,
2031 cust_bill_pkg.sdate DESC
2034 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
2035 $cust_bill_pkg->recur;
2038 =item unit_setup CUST_PKG
2040 Returns the setup fee for one unit of the package.
2045 my ($self, $cust_pkg) = @_;
2046 $self->option('setup_fee') || 0;
2051 unit_setup minus setup_cost
2057 $self->unit_setup(@_) - ($self->setup_cost || 0);
2060 =item recur_margin_permonth
2062 base_recur_permonth minus recur_cost_permonth
2066 sub recur_margin_permonth {
2068 $self->base_recur_permonth(@_) - $self->recur_cost_permonth(@_);
2071 =item intro_end PACKAGE
2073 Takes an L<FS::cust_pkg> object. If this plan has an introductory rate,
2074 returns the expected date the intro period will end. If there is no intro
2083 =item format OPTION DATA
2085 Returns data formatted according to the function 'format' described
2086 in the plan info. Returns DATA if no such function exists.
2091 my ($self, $option, $data) = (shift, shift, shift);
2092 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
2093 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
2099 =item parse OPTION DATA
2101 Returns data parsed according to the function 'parse' described
2102 in the plan info. Returns DATA if no such function exists.
2107 my ($self, $option, $data) = (shift, shift, shift);
2108 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
2109 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
2119 =head1 CLASS METHODS
2127 # Used by FS::Upgrade to migrate to a new database.
2129 sub _upgrade_data { # class method
2130 my($class, %opts) = @_;
2132 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
2134 my @part_pkg = qsearch({
2135 'table' => 'part_pkg',
2136 'extra_sql' => "WHERE ". join(' OR ',
2137 'plan IS NULL', "plan = '' ",
2141 foreach my $part_pkg (@part_pkg) {
2143 unless ( $part_pkg->plan ) {
2144 $part_pkg->plan('flat');
2151 # Convert RADIUS accounting usage metrics from megabytes to gigabytes
2153 my $upgrade = 'part_pkg_gigabyte_usage';
2154 if (!FS::upgrade_journal->is_done($upgrade)) {
2155 foreach my $part_pkg (qsearch('part_pkg',
2156 { plan => 'sqlradacct_hour' })
2159 my $pkgpart = $part_pkg->pkgpart;
2161 foreach my $opt (qsearch('part_pkg_option',
2162 { 'optionname' => { op => 'LIKE',
2163 value => 'recur_included_%',
2165 pkgpart => $pkgpart,
2168 next if $opt->optionname eq 'recur_included_hours'; # unfortunately named field
2169 next if $opt->optionvalue == 0;
2171 $opt->optionvalue($opt->optionvalue / 1024);
2173 my $error = $opt->replace;
2174 die $error if $error;
2177 foreach my $opt (qsearch('part_pkg_option',
2178 { 'optionname' => { op => 'LIKE',
2179 value => 'recur_%_charge',
2181 pkgpart => $pkgpart,
2183 $opt->optionvalue($opt->optionvalue * 1024);
2185 my $error = $opt->replace;
2186 die $error if $error;
2190 FS::upgrade_journal->set_done($upgrade);
2193 # the rest can be done asynchronously
2196 sub queueable_upgrade {
2197 # now upgrade to the explicit custom flag
2199 my $search = FS::Cursor->new({
2200 'table' => 'part_pkg',
2201 'hashref' => { disabled => 'Y', custom => '' },
2202 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
2206 while (my $part_pkg = $search->fetch) {
2207 my $new = new FS::part_pkg { $part_pkg->hash };
2209 my $comment = $part_pkg->comment;
2210 $comment =~ s/^\(CUSTOM\) //;
2211 $comment = '(none)' unless $comment =~ /\S/;
2212 $new->comment($comment);
2214 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
2215 my $primary = $part_pkg->svcpart;
2216 my $options = { $part_pkg->options };
2218 my $error = $new->replace( $part_pkg,
2219 'pkg_svc' => $pkg_svc,
2220 'primary_svc' => $primary,
2221 'options' => $options,
2224 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2231 # set family_pkgpart on any packages that don't have it
2232 $search = FS::Cursor->new('part_pkg', { 'family_pkgpart' => '' });
2233 while (my $part_pkg = $search->fetch) {
2234 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
2235 my $error = $part_pkg->SUPER::replace;
2237 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2244 my @part_pkg_option = qsearch('part_pkg_option',
2245 { 'optionname' => 'unused_credit',
2248 foreach my $old_opt (@part_pkg_option) {
2249 my $pkgpart = $old_opt->pkgpart;
2250 my $error = $old_opt->delete;
2251 die $error if $error;
2253 foreach (qw(unused_credit_cancel unused_credit_change)) {
2254 my $new_opt = new FS::part_pkg_option {
2255 'pkgpart' => $pkgpart,
2259 $error = $new_opt->insert;
2260 die $error if $error;
2264 # migrate use_disposition_taqua and use_disposition to disposition_in
2265 @part_pkg_option = qsearch('part_pkg_option',
2266 { 'optionname' => { op => 'LIKE',
2267 value => 'use_disposition%',
2271 my %newopts = map { $_->pkgpart => $_ }
2272 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
2273 foreach my $old_opt (@part_pkg_option) {
2274 my $pkgpart = $old_opt->pkgpart;
2275 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
2277 my $error = $old_opt->delete;
2278 die $error if $error;
2280 if ( exists($newopts{$pkgpart}) ) {
2281 my $opt = $newopts{$pkgpart};
2282 $opt->optionvalue($opt->optionvalue.",$newval");
2283 $error = $opt->replace;
2284 die $error if $error;
2286 my $new_opt = new FS::part_pkg_option {
2287 'pkgpart' => $pkgpart,
2288 'optionname' => 'disposition_in',
2289 'optionvalue' => $newval,
2291 $error = $new_opt->insert;
2292 die $error if $error;
2293 $newopts{$pkgpart} = $new_opt;
2297 # set any package with FCC voice lines to the "VoIP with broadband" category
2298 # for backward compatibility
2300 # recover from a bad upgrade bug
2301 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
2302 if (!FS::upgrade_journal->is_done($upgrade)) {
2303 my $bad_upgrade = qsearchs('upgrade_journal',
2304 { upgrade => 'part_pkg_fcc_voip_class' }
2306 if ( $bad_upgrade ) {
2307 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
2308 ' AND history_date > '.($bad_upgrade->_date - 3600);
2309 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
2312 'table' => 'h_part_pkg_option',
2314 'extra_sql' => "$where AND history_action = 'delete'",
2315 'order_by' => 'ORDER BY history_date ASC',
2317 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
2320 'table' => 'h_pkg_svc',
2322 'extra_sql' => "$where AND history_action = 'replace_old'",
2323 'order_by' => 'ORDER BY history_date ASC',
2326 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
2327 my $pkgpart ||= $deleted->pkgpart;
2328 $opt{$pkgpart} ||= {
2334 if ( $deleted->isa('FS::part_pkg_option') ) {
2335 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
2337 my $svcpart = $deleted->svcpart;
2338 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
2339 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
2340 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
2343 foreach my $pkgpart (keys %opt) {
2344 my $part_pkg = FS::part_pkg->by_key($pkgpart);
2345 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
2347 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
2350 } # $bad_upgrade exists
2351 else { # do the original upgrade, but correctly this time
2352 my @part_pkg = qsearch('part_pkg', {
2353 fcc_ds0s => { op => '>', value => 0 },
2354 fcc_voip_class => ''
2356 foreach my $part_pkg (@part_pkg) {
2357 $part_pkg->set(fcc_voip_class => 2);
2358 my @pkg_svc = $part_pkg->pkg_svc;
2359 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
2360 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
2361 my $error = $part_pkg->replace(
2362 $part_pkg->replace_old,
2363 options => { $part_pkg->options },
2364 pkg_svc => \%quantity,
2365 hidden_svc => \%hidden,
2366 primary_svc => ($part_pkg->svcpart || ''),
2368 die $error if $error;
2371 FS::upgrade_journal->set_done($upgrade);
2374 # migrate adjourn_months, expire_months, and contract_end_months to
2376 foreach my $field (qw(adjourn_months expire_months contract_end_months)) {
2377 foreach my $option (qsearch('part_pkg_option', { optionname => $field })) {
2378 my $part_pkg = $option->part_pkg;
2379 my $error = $option->delete;
2380 if ( $option->optionvalue and $part_pkg->get($field) eq '' ) {
2381 $part_pkg->set($field, $option->optionvalue);
2382 $error ||= $part_pkg->replace;
2384 die $error if $error;
2388 # remove custom flag from one-time charge packages that were accidentally
2390 $search = FS::Cursor->new({
2391 'table' => 'part_pkg',
2392 'hashref' => { 'freq' => '0',
2394 'family_pkgpart' => { op => '!=', value => '' },
2396 'addl_from' => ' JOIN
2397 (select pkgpart from cust_pkg group by pkgpart having count(*) = 1)
2398 AS singular_pkg USING (pkgpart)',
2400 my @fields = grep { $_ ne 'pkgpart'
2402 and $_ ne 'disabled' } FS::part_pkg->fields;
2403 PKGPART: while (my $part_pkg = $search->fetch) {
2404 # can't merge the package back into its parent (too late for that)
2405 # but we can remove the custom flag if it's not actually customized,
2406 # i.e. nothing has been changed.
2408 my $family_pkgpart = $part_pkg->family_pkgpart;
2409 next PKGPART if $family_pkgpart == $part_pkg->pkgpart;
2410 my $parent_pkg = FS::part_pkg->by_key($family_pkgpart);
2411 foreach my $field (@fields) {
2412 if ($part_pkg->get($field) ne $parent_pkg->get($field)) {
2416 # options have to be identical too
2417 # but links, FCC options, discount plans, and usage packages can't be
2418 # changed through the "modify charge" UI, so skip them
2419 my %newopt = $part_pkg->options;
2420 my %oldopt = $parent_pkg->options;
2421 OPTION: foreach my $option (keys %newopt) {
2422 if (delete $newopt{$option} ne delete $oldopt{$option}) {
2426 if (keys(%newopt) or keys(%oldopt)) {
2429 # okay, now replace it
2430 warn "Removing custom flag from part_pkg#".$part_pkg->pkgpart."\n";
2431 $part_pkg->set('custom', '');
2432 my $error = $part_pkg->replace;
2433 die $error if $error;
2439 =item curuser_pkgs_sql
2441 Returns an SQL fragment for searching for packages the current user can
2442 use, either via part_pkg.agentnum directly, or via agent type (see
2447 sub curuser_pkgs_sql {
2450 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
2454 =item agent_pkgs_sql AGENT | AGENTNUM, ...
2456 Returns an SQL fragment for searching for packages the provided agent or agents
2457 can use, either via part_pkg.agentnum directly, or via agent type (see
2462 sub agent_pkgs_sql {
2463 my $class = shift; #i'm a class method, not a sub (the question is... why??)
2464 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
2466 $class->_pkgs_sql(@agentnums); #is this why
2471 my( $class, @agentnums ) = @_;
2472 my $agentnums = join(',', @agentnums);
2476 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
2477 OR ( agentnum IS NULL
2478 AND EXISTS ( SELECT 1
2480 LEFT JOIN agent_type USING ( typenum )
2481 LEFT JOIN agent AS typeagent USING ( typenum )
2482 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
2483 AND typeagent.agentnum IN ($agentnums)
2491 =item join_options_sql
2493 Returns an SQL fragment for JOINing the part_pkg_option records for this
2494 package's setup_fee and recur_fee (as setup_option and recur_option,
2495 respectively). Useful for optimization.
2499 sub join_options_sql {
2502 LEFT JOIN part_pkg_option AS setup_option
2503 ON ( part_pkg.pkgpart = setup_option.pkgpart
2504 AND setup_option.optionname = 'setup_fee' )
2505 LEFT JOIN part_pkg_option AS recur_option
2506 ON ( part_pkg.pkgpart = recur_option.pkgpart
2507 AND recur_option.optionname = 'recur_fee' )
2521 #false laziness w/part_export & cdr
2523 foreach my $INC ( @INC ) {
2524 warn "globbing $INC/FS/part_pkg/[a-z]*.pm\n" if $DEBUG;
2525 foreach my $file ( glob("$INC/FS/part_pkg/[a-z]*.pm") ) {
2526 warn "attempting to load plan info from $file\n" if $DEBUG;
2527 $file =~ /\/(\w+)\.pm$/ or do {
2528 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
2532 my $info = eval "use FS::part_pkg::$mod; ".
2533 "\\%FS::part_pkg::$mod\::info;";
2535 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
2538 unless ( keys %$info ) {
2539 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
2542 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
2543 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
2544 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
2547 $info{$mod} = $info;
2548 $info->{'weight'} ||= 0; # quiet warnings
2552 # copy one level deep to allow replacement of fields and fieldorder
2553 tie %plans, 'Tie::IxHash',
2554 map { my %infohash = %{ $info{$_} };
2556 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
2559 # inheritance of plan options
2560 foreach my $name (keys(%info)) {
2561 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
2562 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
2563 delete $plans{$name};
2566 my $parents = $info{$name}->{'inherit_fields'} || [];
2567 my (%fields, %field_exists, @fieldorder);
2568 foreach my $parent ($name, @$parents) {
2569 if ( !exists($info{$parent}) ) {
2570 warn "$name tried to inherit from nonexistent '$parent'\n";
2573 %fields = ( # avoid replacing existing fields
2574 %{ $info{$parent}->{'fields'} || {} },
2577 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
2579 next if $field_exists{$_};
2580 $field_exists{$_} = 1;
2581 # allow inheritors to remove inherited fields from the fieldorder
2582 push @fieldorder, $_ if !exists($fields{$_}) or
2583 !exists($fields{$_}->{'disabled'});
2586 $plans{$name}->{'fields'} = \%fields;
2587 $plans{$name}->{'fieldorder'} = \@fieldorder;
2597 =head1 NEW PLAN CLASSES
2599 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
2600 found in eg/plan_template.pm. Until then, it is suggested that you use the
2601 other modules in FS/FS/part_pkg/ as a guide.
2605 The delete method is unimplemented.
2607 setup and recur semantics are not yet defined (and are implemented in
2608 FS::cust_bill. hmm.). now they're deprecated and need to go.
2612 part_pkg_taxrate is Pg specific
2614 replace should be smarter about managing the related tables (options, pkg_svc)
2618 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2619 schema.html from the base documentation.