2 use base qw( FS::part_pkg::API
3 FS::m2m_Common FS::o2m_Common FS::option_Common
7 use vars qw( %plans $DEBUG $setup_hack $skip_pkg_svc_hack
8 $cache_enabled %cache_link %cache_pkg_svc
10 use Carp qw(carp cluck confess);
11 use Scalar::Util qw( blessed );
13 use Time::Local qw( timelocal timelocal_nocheck ); # eventually replace with DateTime
16 use FS::Record qw( qsearch qsearchs dbh dbdef );
17 use FS::Cursor; # for upgrade
23 use FS::part_pkg_option;
24 use FS::part_pkg_fcc_option;
27 use FS::part_pkg_msgcat;
28 use FS::part_pkg_taxrate;
29 use FS::part_pkg_taxoverride;
30 use FS::part_pkg_taxproduct;
31 use FS::part_pkg_link;
32 use FS::part_pkg_discount;
33 use FS::part_pkg_vendor;
34 use FS::part_pkg_currency;
35 use FS::part_svc_link;
40 $skip_pkg_svc_hack = 0;
48 FS::part_pkg - Object methods for part_pkg objects
54 $record = new FS::part_pkg \%hash
55 $record = new FS::part_pkg { 'column' => 'value' };
57 $custom_record = $template_record->clone;
59 $error = $record->insert;
61 $error = $new_record->replace($old_record);
63 $error = $record->delete;
65 $error = $record->check;
67 @pkg_svc = $record->pkg_svc;
69 $svcnum = $record->svcpart;
70 $svcnum = $record->svcpart( 'svc_acct' );
74 An FS::part_pkg object represents a package definition. FS::part_pkg
75 inherits from FS::Record. The following fields are currently supported:
79 =item pkgpart - primary key (assigned automatically for new package definitions)
81 =item pkg - Text name of this package definition (customer-viewable)
83 =item comment - Text name of this package definition (non-customer-viewable)
85 =item classnum - Optional package class (see L<FS::pkg_class>)
87 =item promo_code - Promotional code
89 =item setup - Setup fee expression (deprecated)
91 =item freq - Frequency of recurring fee
93 =item recur - Recurring fee expression (deprecated)
95 =item setuptax - Setup fee tax exempt flag, empty or `Y'
97 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
99 =item taxclass - Tax class
101 =item plan - Price plan
103 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
105 =item disabled - Disabled flag, empty or `Y'
107 =item custom - Custom flag, empty or `Y'
109 =item setup_cost - for cost tracking
111 =item recur_cost - for cost tracking
113 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
115 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
117 =item agentnum - Optional agentnum (see L<FS::agent>)
119 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
121 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
124 =item successor - Foreign key for the part_pkg that replaced this record.
125 If this record is not obsolete, will be null.
127 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
128 ancestor of this record. If this record is not a successor to another
129 part_pkg, will be equal to pkgpart.
131 =item delay_start - Number of days to delay package start, by default
133 =item start_on_hold - 'Y' to suspend this package immediately when it is
134 ordered. The package will not start billing or have a setup fee charged
135 until it is manually unsuspended.
137 =item change_to_pkgpart - When this package is ordered, schedule a future
138 package change. The 'expire_months' field will determine when the package
141 =item expire_months - Number of months until this package expires (or changes
144 =item adjourn_months - Number of months until this package becomes suspended.
146 =item contract_end_months - Number of months until the package's contract
157 Creates a new package definition. To add the package definition to
158 the database, see L<"insert">.
162 sub table { 'part_pkg'; }
166 An alternate constructor. Creates a new package definition by duplicating
167 an existing definition. A new pkgpart is assigned and the custom flag is
168 set to Y. To add the package definition to the database, see L<"insert">.
174 my $class = ref($self);
175 my %hash = $self->hash;
176 $hash{'pkgpart'} = '';
177 $hash{'custom'} = 'Y';
178 #new FS::part_pkg ( \%hash ); # ?
179 new $class ( \%hash ); # ?
182 =item insert [ , OPTION => VALUE ... ]
184 Adds this package definition to the database. If there is an error,
185 returns the error, otherwise returns false.
187 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
188 I<custnum_ref> and I<options>.
190 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
191 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
192 be set to a hashref of svcparts and flag values ('Y' or '') to set the
193 'hidden' field in these records, and I<provision_hold> can be set similarly
194 for the 'provision_hold' field in these records.
196 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
197 FS::pkg_svc record will be updated.
199 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
200 record itself), the object will be updated to point to this package definition.
202 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
203 the scalar will be updated with the custnum value from the cust_pkg record.
205 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
206 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
207 records will be inserted.
209 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
210 records will be inserted.
212 If I<part_pkg_currency> is set to a hashref of options (with the keys as
213 option_CURRENCY), appropriate FS::part_pkg::currency records will be inserted.
220 warn "FS::part_pkg::insert called on $self with options ".
221 join(', ', map "$_=>$options{$_}", keys %options)
224 local $SIG{HUP} = 'IGNORE';
225 local $SIG{INT} = 'IGNORE';
226 local $SIG{QUIT} = 'IGNORE';
227 local $SIG{TERM} = 'IGNORE';
228 local $SIG{TSTP} = 'IGNORE';
229 local $SIG{PIPE} = 'IGNORE';
231 my $oldAutoCommit = $FS::UID::AutoCommit;
232 local $FS::UID::AutoCommit = 0;
235 warn " inserting part_pkg record" if $DEBUG;
236 my $error = $self->SUPER::insert( $options{options} );
238 $dbh->rollback if $oldAutoCommit;
243 if ( $self->get('family_pkgpart') eq '' ) {
244 $self->set('family_pkgpart' => $self->pkgpart);
245 $error = $self->SUPER::replace;
247 $dbh->rollback if $oldAutoCommit;
252 warn " inserting part_pkg_taxoverride records" if $DEBUG;
253 my %overrides = %{ $options{'tax_overrides'} || {} };
254 foreach my $usage_class ( keys %overrides ) {
256 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
257 ? $overrides{$usage_class}
259 my @overrides = (grep "$_", split(',', $override) );
260 my $error = $self->process_m2m (
261 'link_table' => 'part_pkg_taxoverride',
262 'target_table' => 'tax_class',
263 'hashref' => { 'usage_class' => $usage_class },
264 'params' => \@overrides,
267 $dbh->rollback if $oldAutoCommit;
272 warn " inserting part_pkg_currency records" if $DEBUG;
273 my %part_pkg_currency = %{ $options{'part_pkg_currency'} || {} };
274 foreach my $key ( keys %part_pkg_currency ) {
275 $key =~ /^(.+)_([A-Z]{3})$/ or next;
276 my( $optionname, $currency ) = ( $1, $2 );
277 if ( $part_pkg_currency{$key} =~ /^\s*$/ ) {
278 if ( $self->option($optionname) == 0 ) {
279 $part_pkg_currency{$key} = '0';
281 $dbh->rollback if $oldAutoCommit;
282 ( my $thing = $optionname ) =~ s/_/ /g;
283 return ucfirst($thing). " $currency is required";
286 my $part_pkg_currency = new FS::part_pkg_currency {
287 'pkgpart' => $self->pkgpart,
288 'optionname' => $optionname,
289 'currency' => $currency,
290 'optionvalue' => $part_pkg_currency{$key},
292 my $error = $part_pkg_currency->insert;
294 $dbh->rollback if $oldAutoCommit;
299 unless ( $skip_pkg_svc_hack ) {
301 warn " inserting pkg_svc records" if $DEBUG;
302 my $pkg_svc = $options{'pkg_svc'} || {};
303 my $hidden_svc = $options{'hidden_svc'} || {};
304 my $provision_hold = $options{'provision_hold'} || {};
305 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
306 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
308 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
312 my $pkg_svc = new FS::pkg_svc( {
313 'pkgpart' => $self->pkgpart,
314 'svcpart' => $part_svc->svcpart,
315 'quantity' => $quantity,
316 'primary_svc' => $primary_svc,
317 'hidden' => $hidden_svc->{$part_svc->svcpart},
318 'provision_hold' => $provision_hold->{$part_svc->svcpart},
320 my $error = $pkg_svc->insert;
322 $dbh->rollback if $oldAutoCommit;
327 my $error = $self->check_pkg_svc(%options);
329 $dbh->rollback if $oldAutoCommit;
335 if ( $options{'cust_pkg'} ) {
336 warn " updating cust_pkg record " if $DEBUG;
338 ref($options{'cust_pkg'})
339 ? $options{'cust_pkg'}
340 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
341 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
342 if $options{'custnum_ref'};
343 my %hash = $old_cust_pkg->hash;
344 $hash{'pkgpart'} = $self->pkgpart,
345 my $new_cust_pkg = new FS::cust_pkg \%hash;
346 local($FS::cust_pkg::disable_agentcheck) = 1;
347 my $error = $new_cust_pkg->replace($old_cust_pkg);
349 $dbh->rollback if $oldAutoCommit;
350 return "Error modifying cust_pkg record: $error";
354 if ( $options{'part_pkg_vendor'} ) {
355 while ( my ($exportnum, $vendor_pkg_id) =
356 each %{ $options{part_pkg_vendor} }
359 my $ppv = new FS::part_pkg_vendor( {
360 'pkgpart' => $self->pkgpart,
361 'exportnum' => $exportnum,
362 'vendor_pkg_id' => $vendor_pkg_id,
364 my $error = $ppv->insert;
366 $dbh->rollback if $oldAutoCommit;
367 return "Error inserting part_pkg_vendor record: $error";
372 if ( $options{fcc_options} ) {
373 warn " updating fcc options " if $DEBUG;
374 $self->set_fcc_options( $options{fcc_options} );
377 warn " committing transaction" if $DEBUG and $oldAutoCommit;
378 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
385 Currently unimplemented.
390 return "Can't (yet?) delete package definitions.";
391 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
394 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
396 Replaces OLD_RECORD with this one in the database. If there is an error,
397 returns the error, otherwise returns false.
399 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>,
400 I<bulk_skip>, I<provision_hold> and I<options>
402 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
403 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
404 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
405 'hidden' field in these records. I<bulk_skip> and I<provision_hold> can be set
406 to a hashref of svcparts and flag values ('Y' or '') to set the respective field
409 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
410 FS::pkg_svc record will be updated.
412 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
415 If I<part_pkg_currency> is set to a hashref of options (with the keys as
416 option_CURRENCY), appropriate FS::part_pkg::currency records will be replaced.
423 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
428 ( ref($_[0]) eq 'HASH' )
432 $options->{options} = { $old->options } unless defined($options->{options});
434 warn "FS::part_pkg::replace called on $new to replace $old with options".
435 join(', ', map "$_ => ". $options->{$_}, keys %$options)
438 local $SIG{HUP} = 'IGNORE';
439 local $SIG{INT} = 'IGNORE';
440 local $SIG{QUIT} = 'IGNORE';
441 local $SIG{TERM} = 'IGNORE';
442 local $SIG{TSTP} = 'IGNORE';
443 local $SIG{PIPE} = 'IGNORE';
445 my $oldAutoCommit = $FS::UID::AutoCommit;
446 local $FS::UID::AutoCommit = 0;
449 my $conf = new FS::Conf;
450 if ( $conf->exists('part_pkg-lineage') ) {
451 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
452 qw(setup_fee recur_fee) #others? config?
455 warn " superseding package" if $DEBUG;
457 my $error = $new->supersede($old, %$options);
459 $dbh->rollback if $oldAutoCommit;
463 warn " committing transaction" if $DEBUG and $oldAutoCommit;
464 $dbh->commit if $oldAutoCommit;
471 #plandata shit stays in replace for upgrades until after 2.0 (or edit
473 warn " saving legacy plandata" if $DEBUG;
474 my $plandata = $new->get('plandata');
475 $new->set('plandata', '');
477 warn " deleting old part_pkg_option records" if $DEBUG;
478 foreach my $part_pkg_option ( $old->part_pkg_option ) {
479 my $error = $part_pkg_option->delete;
481 $dbh->rollback if $oldAutoCommit;
486 warn " replacing part_pkg record" if $DEBUG;
487 my $error = $new->SUPER::replace($old, $options->{options} );
489 $dbh->rollback if $oldAutoCommit;
493 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
494 foreach my $part_pkg_option (
495 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
496 return "illegal plandata: $plandata";
498 new FS::part_pkg_option {
499 'pkgpart' => $new->pkgpart,
504 split("\n", $plandata)
506 my $error = $part_pkg_option->insert;
508 $dbh->rollback if $oldAutoCommit;
513 #trivial nit: not the most efficient to delete and reinsert
514 warn " deleting old part_pkg_currency records" if $DEBUG;
515 foreach my $part_pkg_currency ( $old->part_pkg_currency ) {
516 my $error = $part_pkg_currency->delete;
518 $dbh->rollback if $oldAutoCommit;
519 return "error deleting part_pkg_currency record: $error";
523 warn " inserting new part_pkg_currency records" if $DEBUG;
524 my %part_pkg_currency = %{ $options->{'part_pkg_currency'} || {} };
525 foreach my $key ( keys %part_pkg_currency ) {
526 $key =~ /^(.+)_([A-Z]{3})$/ or next;
527 my $part_pkg_currency = new FS::part_pkg_currency {
528 'pkgpart' => $new->pkgpart,
531 'optionvalue' => $part_pkg_currency{$key},
533 my $error = $part_pkg_currency->insert;
535 $dbh->rollback if $oldAutoCommit;
536 return "error inserting part_pkg_currency record: $error";
541 warn " replacing pkg_svc records" if $DEBUG;
542 my $pkg_svc = $options->{'pkg_svc'};
543 my $hidden_svc = $options->{'hidden_svc'} || {};
544 my $bulk_skip = $options->{'bulk_skip'} || {};
545 my $provision_hold = $options->{'provision_hold'} || {};
546 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
548 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
549 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
550 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
551 my $bulk_skip = $bulk_skip->{$part_svc->svcpart} || '';
552 my $provision_hold = $provision_hold->{$part_svc->svcpart} || '';
554 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
555 && $options->{'primary_svc'} == $part_svc->svcpart
560 my $old_pkg_svc = qsearchs('pkg_svc', {
561 'pkgpart' => $old->pkgpart,
562 'svcpart' => $part_svc->svcpart,
565 my $old_quantity = 0;
566 my $old_primary_svc = '';
568 my $old_bulk_skip = '';
569 my $old_provision_hold = '';
570 if ( $old_pkg_svc ) {
571 $old_quantity = $old_pkg_svc->quantity;
572 $old_primary_svc = $old_pkg_svc->primary_svc
573 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
574 $old_hidden = $old_pkg_svc->hidden;
575 $old_bulk_skip = $old_pkg_svc->old_bulk_skip; # should this just be bulk_skip?
576 $old_provision_hold = $old_pkg_svc->provision_hold;
579 next unless $old_quantity != $quantity
580 || $old_primary_svc ne $primary_svc
581 || $old_hidden ne $hidden
582 || $old_bulk_skip ne $bulk_skip
583 || $old_provision_hold ne $provision_hold;
585 my $new_pkg_svc = new FS::pkg_svc( {
586 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
587 'pkgpart' => $new->pkgpart,
588 'svcpart' => $part_svc->svcpart,
589 'quantity' => $quantity,
590 'primary_svc' => $primary_svc,
592 'bulk_skip' => $bulk_skip,
593 'provision_hold' => $provision_hold,
595 my $error = $old_pkg_svc
596 ? $new_pkg_svc->replace($old_pkg_svc)
597 : $new_pkg_svc->insert;
599 $dbh->rollback if $oldAutoCommit;
604 my $error = $new->check_pkg_svc(%$options);
606 $dbh->rollback if $oldAutoCommit;
610 } #if $options->{pkg_svc}
612 my @part_pkg_vendor = $old->part_pkg_vendor;
613 my @current_exportnum = ();
614 if ( $options->{'part_pkg_vendor'} ) {
615 my($exportnum,$vendor_pkg_id);
616 while ( ($exportnum,$vendor_pkg_id)
617 = each %{$options->{'part_pkg_vendor'}} ) {
619 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
620 if($exportnum == $part_pkg_vendor->exportnum
621 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
622 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
623 my $error = $part_pkg_vendor->replace;
625 $dbh->rollback if $oldAutoCommit;
626 return "Error replacing part_pkg_vendor record: $error";
631 elsif($exportnum == $part_pkg_vendor->exportnum
632 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
637 unless ( $noinsert ) {
638 my $ppv = new FS::part_pkg_vendor( {
639 'pkgpart' => $new->pkgpart,
640 'exportnum' => $exportnum,
641 'vendor_pkg_id' => $vendor_pkg_id,
643 my $error = $ppv->insert;
645 $dbh->rollback if $oldAutoCommit;
646 return "Error inserting part_pkg_vendor record: $error";
649 push @current_exportnum, $exportnum;
652 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
653 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
654 my $error = $part_pkg_vendor->delete;
656 $dbh->rollback if $oldAutoCommit;
657 return "Error deleting part_pkg_vendor record: $error";
662 # propagate changes to certain core fields
663 if ( $conf->exists('part_pkg-lineage') ) {
664 warn " propagating changes to family" if $DEBUG;
665 my $error = $new->propagate($old);
667 $dbh->rollback if $oldAutoCommit;
672 if ( $options->{fcc_options} ) {
673 warn " updating fcc options " if $DEBUG;
674 $new->set_fcc_options( $options->{fcc_options} );
677 warn " committing transaction" if $DEBUG and $oldAutoCommit;
678 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
684 Checks all fields to make sure this is a valid package definition. If
685 there is an error, returns the error, otherwise returns false. Called by the
686 insert and replace methods.
692 warn "FS::part_pkg::check called on $self" if $DEBUG;
694 for (qw(setup recur plandata)) {
695 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
696 return "Use of $_ field is deprecated; set a plan and options: ".
698 if length($self->get($_));
702 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
703 my $error = $self->ut_number('freq');
704 return $error if $error;
706 $self->freq =~ /^(\d+[hdw]?)$/
707 or return "Illegal or empty freq: ". $self->freq;
711 my @null_agentnum_right = ( 'Edit global package definitions' );
712 push @null_agentnum_right, 'One-time charge'
713 if $self->freq =~ /^0/;
714 push @null_agentnum_right, 'Customize customer package'
715 if $self->disabled eq 'Y'; #good enough
717 my $error = $self->ut_numbern('pkgpart')
718 || $self->ut_text('pkg')
719 || $self->ut_textn('comment')
720 || $self->ut_textn('promo_code')
721 || $self->ut_alphan('plan')
722 || $self->ut_flag('setuptax')
723 || $self->ut_flag('recurtax')
724 || $self->ut_textn('taxclass')
725 || $self->ut_flag('disabled')
726 || $self->ut_flag('custom')
727 || $self->ut_flag('no_auto')
728 || $self->ut_flag('recur_show_zero')
729 || $self->ut_flag('setup_show_zero')
730 || $self->ut_flag('start_on_hold')
731 #|| $self->ut_moneyn('setup_cost')
732 #|| $self->ut_moneyn('recur_cost')
733 || $self->ut_floatn('setup_cost')
734 || $self->ut_floatn('recur_cost')
735 || $self->ut_floatn('pay_weight')
736 || $self->ut_floatn('credit_weight')
737 || $self->ut_numbern('taxproductnum')
738 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
739 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
740 || $self->ut_foreign_keyn('taxproductnum',
741 'part_pkg_taxproduct',
745 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
746 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
748 || $self->ut_numbern('fcc_ds0s')
749 || $self->ut_numbern('fcc_voip_class')
750 || $self->ut_numbern('delay_start')
751 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
752 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
753 || $self->ut_numbern('expire_months')
754 || $self->ut_numbern('adjourn_months')
755 || $self->ut_numbern('contract_end_months')
756 || $self->ut_numbern('change_to_pkgpart')
757 || $self->ut_foreign_keyn('change_to_pkgpart', 'part_pkg', 'pkgpart')
758 || $self->ut_alphan('agent_pkgpartid')
759 || $self->SUPER::check
761 return $error if $error;
763 return 'Unknown plan '. $self->plan
764 unless exists($plans{$self->plan});
766 my $conf = new FS::Conf;
767 return 'Taxclass is required'
768 if ! $self->taxclass && $conf->exists('require_taxclasses');
775 Checks pkg_svc records as a whole (for part_svc_link dependencies).
777 If there is an error, returns the error, otherwise returns false.
782 my( $self, %opt ) = @_;
784 my $agentnum = $self->agentnum;
786 my %pkg_svc = map { $_->svcpart => $_ } $self->pkg_svc;
788 foreach my $svcpart ( keys %pkg_svc ) {
790 foreach my $part_svc_link ( $self->part_svc_link(
791 'src_svcpart' => $svcpart,
792 'link_type' => 'part_pkg_restrict',
796 return $part_svc_link->dst_svc. ' must be included with '.
797 $part_svc_link->src_svc
798 unless $pkg_svc{ $part_svc_link->dst_svcpart };
803 return '' if $opt{part_pkg_restrict_soft_override};
805 foreach my $svcpart ( keys %pkg_svc ) {
807 foreach my $part_svc_link ( $self->part_svc_link(
808 'src_svcpart' => $svcpart,
809 'link_type' => 'part_pkg_restrict_soft',
812 return $part_svc_link->dst_svc. ' is suggested with '.
813 $part_svc_link->src_svc
814 unless $pkg_svc{ $part_svc_link->dst_svcpart };
822 =item part_svc_link OPTION => VALUE ...
824 Returns the service dependencies (see L<FS::part_svc_link>) for the given
825 search options, taking into account this package definition's agent.
827 Available options are any field in part_svc_link. Typically used options are
828 src_svcpart and link_type.
833 FS::part_svc_link->by_agentnum( shift->agentnum, @_ );
836 =item supersede OLD [, OPTION => VALUE ... ]
838 Inserts this package as a successor to the package OLD. All options are as
839 for C<insert>. After inserting, disables OLD and sets the new package as its
845 my ($new, $old, %options) = @_;
848 $new->set('pkgpart' => '');
849 $new->set('family_pkgpart' => $old->family_pkgpart);
850 warn " inserting successor package\n" if $DEBUG;
851 $error = $new->insert(%options);
852 return $error if $error;
854 warn " disabling superseded package\n" if $DEBUG;
855 $old->set('successor' => $new->pkgpart);
856 $old->set('disabled' => 'Y');
857 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
858 return $error if $error;
860 warn " propagating changes to family" if $DEBUG;
861 $new->propagate($old);
866 If any of certain fields have changed from OLD to this package, then,
867 for all packages in the same lineage as this one, sets those fields
868 to their values in this package.
872 my @propagate_fields = (
873 qw( pkg classnum setup_cost recur_cost taxclass
874 setuptax recurtax pay_weight credit_weight
882 map { $_ => $new->get($_) }
883 grep { $new->get($_) ne $old->get($_) }
887 my @part_pkg = qsearch('part_pkg', {
888 'family_pkgpart' => $new->family_pkgpart
891 foreach my $part_pkg ( @part_pkg ) {
892 my $pkgpart = $part_pkg->pkgpart;
893 next if $pkgpart == $new->pkgpart; # don't modify $new
894 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
895 foreach ( keys %fields ) {
896 $part_pkg->set($_, $fields{$_});
898 # SUPER::replace to avoid changing non-core fields
899 my $error = $part_pkg->SUPER::replace;
900 push @error, "pkgpart $pkgpart: $error"
906 =item set_fcc_options HASHREF
908 Sets the FCC options on this package definition to the values specified
913 sub set_fcc_options {
915 my $pkgpart = $self->pkgpart;
923 my %existing_num = map { $_->fccoptionname => $_->num }
924 qsearch('part_pkg_fcc_option', { pkgpart => $pkgpart });
926 local $FS::Record::nowarn_identical = 1;
927 # set up params for process_o2m
930 foreach my $name (keys %$options ) {
931 $params->{ "num$i" } = $existing_num{$name} || '';
932 $params->{ "num$i".'_fccoptionname' } = $name;
933 $params->{ "num$i".'_optionvalue' } = $options->{$name};
938 table => 'part_pkg_fcc_option',
939 fields => [qw( fccoptionname optionvalue )],
944 =item pkg_locale LOCALE
946 Returns a customer-viewable string representing this package for the given
947 locale, from the part_pkg_msgcat table. If the given locale is empty or no
948 localized string is found, returns the base pkg field.
953 my( $self, $locale ) = @_;
954 return $self->pkg unless $locale;
955 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
956 $part_pkg_msgcat->pkg;
959 =item part_pkg_msgcat LOCALE
961 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
965 sub part_pkg_msgcat {
966 my( $self, $locale ) = @_;
967 qsearchs( 'part_pkg_msgcat', {
968 pkgpart => $self->pkgpart,
973 =item pkg_comment [ OPTION => VALUE... ]
975 Returns an (internal) string representing this package. Currently,
976 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
977 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
980 If the option nopkgpart is true then the "pkgpart: ' is omitted.
988 #$self->pkg. ' - '. $self->comment;
989 #$self->pkg. ' ('. $self->comment. ')';
990 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
991 my $custom_comment = $self->custom_comment(%opt);
992 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
995 #without price info (so without hitting the DB again)
996 sub pkg_comment_only {
1000 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
1001 my $comment = $self->comment;
1002 $pre. $self->pkg. ( $comment ? " - $comment" : '' );
1005 sub price_info { # safety, in case a part_pkg hasn't defined price_info
1009 sub custom_comment {
1011 my $price_info = $self->price_info(@_);
1012 ( $self->custom ? '(CUSTOM) ' : '' ).
1014 ( ($self->custom || $self->comment) ? ' - ' : '' ).
1015 ($price_info || 'No charge');
1018 sub pkg_price_info {
1020 $self->pkg. ' - '. ($self->price_info || 'No charge');
1025 Returns the package class, as an FS::pkg_class object, or the empty string
1026 if there is no package class.
1028 =item addon_pkg_class
1030 Returns the add-on package class, as an FS::pkg_class object, or the empty
1031 string if there is no add-on package class.
1035 sub addon_pkg_class {
1037 if ( $self->addon_classnum ) {
1038 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
1046 Returns the package category name, or the empty string if there is no package
1053 my $pkg_class = $self->pkg_class;
1055 ? $pkg_class->categoryname
1061 Returns the package class name, or the empty string if there is no package
1068 my $pkg_class = $self->pkg_class;
1070 ? $pkg_class->classname
1074 =item addon_classname
1076 Returns the add-on package class name, or the empty string if there is no
1077 add-on package class.
1081 sub addon_classname {
1083 my $pkg_class = $self->addon_pkg_class;
1085 ? $pkg_class->classname
1091 Returns the associated agent for this event, if any, as an FS::agent object.
1093 =item pkg_svc [ HASHREF | OPTION => VALUE ]
1095 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
1096 definition (with non-zero quantity).
1098 One option is available, I<disable_linked>. If set true it will return the
1099 services for this package definition alone, omitting services from any add-on
1106 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
1114 return @{ $cache_pkg_svc{$self->pkgpart} }
1115 if $cache_enabled && $cache_pkg_svc{$self->pkgpart};
1117 # #sort { $b->primary cmp $a->primary }
1118 # grep { $_->quantity }
1119 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
1121 my $opt = ref($_[0]) ? $_[0] : { @_ };
1122 my %pkg_svc = map { $_->svcpart => $_ }
1123 grep { $_->quantity }
1124 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
1126 unless ( $opt->{disable_linked} ) {
1127 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
1128 my @pkg_svc = grep { $_->quantity }
1129 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
1130 foreach my $pkg_svc ( @pkg_svc ) {
1131 if ( $pkg_svc{$pkg_svc->svcpart} ) {
1132 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
1133 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
1135 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
1141 my @pkg_svc = values(%pkg_svc);
1143 $cache_pkg_svc{$self->pkgpart} = \@pkg_svc if $cache_enabled;
1149 =item svcpart [ SVCDB ]
1151 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
1152 associated with this package definition (see L<FS::pkg_svc>). Returns
1153 false if there not a primary service definition or exactly one service
1154 definition with quantity 1, or if SVCDB is specified and does not match the
1155 svcdb of the service definition. SVCDB can be specified as a scalar table
1156 name, such as 'svc_acct', or as an arrayref of possible table names.
1161 my $pkg_svc = shift->_primary_pkg_svc(@_);
1162 $pkg_svc ? $pkg_svc->svcpart : '';
1165 =item part_svc [ SVCDB ]
1167 Like the B<svcpart> method, but returns the FS::part_svc object (see
1173 my $pkg_svc = shift->_primary_pkg_svc(@_);
1174 $pkg_svc ? $pkg_svc->part_svc : '';
1177 sub _primary_pkg_svc {
1180 my $svcdb = scalar(@_) ? shift : [];
1181 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1182 my %svcdb = map { $_=>1 } @$svcdb;
1185 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1188 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1189 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1191 return '' if scalar(@pkg_svc) != 1;
1195 =item svcpart_unique_svcdb SVCDB
1197 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1198 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1199 false if there not a primary service definition for SVCDB or there are multiple
1200 service definitions for SVCDB.
1204 sub svcpart_unique_svcdb {
1205 my( $self, $svcdb ) = @_;
1206 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1207 return '' if scalar(@svcdb_pkg_svc) != 1;
1208 $svcdb_pkg_svc[0]->svcpart;
1213 Returns a list of the acceptable payment types for this package. Eventually
1214 this should come out of a database table and be editable, but currently has the
1215 following logic instead:
1217 If the package is free, the single item B<BILL> is
1218 returned, otherwise, the single item B<CARD> is returned.
1220 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1226 if ( $self->is_free ) {
1235 Returns true if this package is free.
1241 if ( $self->can('is_free_options') ) {
1242 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1243 map { $self->option($_) }
1244 $self->is_free_options;
1246 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1247 "provides neither is_free_options nor is_free method; returning false";
1252 # whether the plan allows discounts to be applied to this package
1253 sub can_discount { 0; }
1255 # whether the plan allows changing the start date
1256 sub can_start_date {
1258 $self->start_on_hold ? 0 : 1;
1261 # whether the plan supports part_pkg_usageprice add-ons (a specific kind of
1262 # pre-selectable usage pricing, there's others this doesn't refer to)
1263 sub can_usageprice { 0; }
1265 # the delay start date if present
1266 sub delay_start_date {
1269 my $delay = $self->delay_start or return '';
1271 # avoid timelocal silliness
1272 my $dt = DateTime->today(time_zone => 'local');
1273 $dt->add(days => $delay);
1277 sub can_currency_exchange { 0; }
1280 # moved to FS::Misc to make this accessible to other packages
1282 FS::Misc::pkg_freqs();
1287 Returns an english representation of the I<freq> field, such as "monthly",
1288 "weekly", "semi-annually", etc.
1294 my $freq = $self->freq;
1296 #my $freqs_href = $self->freqs_href;
1297 my $freqs_href = freqs_href();
1299 if ( exists($freqs_href->{$freq}) ) {
1300 $freqs_href->{$freq};
1302 my $interval = 'month';
1303 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1304 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1305 $interval = $interval{$2};
1310 "every $freq ${interval}s";
1315 =item add_freq TIMESTAMP [ FREQ ]
1317 Adds a billing period of some frequency to the provided timestamp and
1318 returns the resulting timestamp, or -1 if the frequency could not be
1319 parsed (shouldn't happen). By default, the frequency of this package
1320 will be used; to override this, pass a different frequency as a second
1326 my( $self, $date, $freq ) = @_;
1327 $freq = $self->freq unless $freq;
1329 #change this bit to use Date::Manip? CAREFUL with timezones (see
1330 # mailing list archive)
1331 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1333 if ( $freq =~ /^\d+$/ ) {
1335 until ( $mon < 12 ) { $mon -= 12; $year++; }
1337 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1339 } elsif ( $freq =~ /^(\d+)w$/ ) {
1341 $mday += $weeks * 7;
1342 } elsif ( $freq =~ /^(\d+)d$/ ) {
1345 } elsif ( $freq =~ /^(\d+)h$/ ) {
1352 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1357 For backwards compatibility, returns the plandata field as well as all options
1358 from FS::part_pkg_option.
1364 carp "plandata is deprecated";
1366 $self->SUPER::plandata(@_);
1368 my $plandata = $self->get('plandata');
1369 my %options = $self->options;
1370 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1375 =item part_pkg_vendor
1377 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1378 L<FS::part_pkg_vendor>).
1380 =item vendor_pkg_ids
1382 Returns a list of vendor/external package ids by exportnum
1386 sub vendor_pkg_ids {
1388 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1391 =item part_pkg_option
1393 Returns all options as FS::part_pkg_option objects (see
1394 L<FS::part_pkg_option>).
1398 Returns a list of option names and values suitable for assigning to a hash.
1404 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1407 =item option OPTIONNAME [ QUIET ]
1409 Returns the option value for the given name, or the empty string. If a true
1410 value is passed as the second argument, warnings about missing the option
1416 my( $self, $opt, $ornull ) = @_;
1418 #cache: was pulled up in the original part_pkg query
1419 if ( $opt =~ /^(setup|recur)_fee$/ && defined($self->hashref->{"_$opt"}) ) {
1420 return $self->hashref->{"_$opt"};
1423 cluck "$self -> option: searching for $opt" if $DEBUG;
1424 my $part_pkg_option =
1425 qsearchs('part_pkg_option', {
1426 pkgpart => $self->pkgpart,
1429 return $part_pkg_option->optionvalue if $part_pkg_option;
1431 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1432 split("\n", $self->get('plandata') );
1433 return $plandata{$opt} if exists $plandata{$opt};
1435 # check whether the option is defined in plan info (if so, don't warn)
1436 if (exists $plans{ $self->plan }->{fields}->{$opt}) {
1439 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1440 "not found in options or plandata!\n"
1446 =item part_pkg_currency [ CURRENCY ]
1448 Returns all currency options as FS::part_pkg_currency objects (see
1449 L<FS::part_pkg_currency>), or, if a currency is specified, only return the
1450 objects for that currency.
1454 sub part_pkg_currency {
1456 my %hash = ( 'pkgpart' => $self->pkgpart );
1457 $hash{'currency'} = shift if @_;
1458 qsearch('part_pkg_currency', \%hash );
1461 =item part_pkg_currency_options CURRENCY
1463 Returns a list of option names and values from FS::part_pkg_currency for the
1468 sub part_pkg_currency_options {
1470 map { $_->optionname => $_->optionvalue } $self->part_pkg_currency(shift);
1473 =item part_pkg_currency_option CURRENCY OPTIONNAME
1475 Returns the option value for the given name and currency.
1479 sub part_pkg_currency_option {
1480 my( $self, $currency, $optionname ) = @_;
1481 my $part_pkg_currency =
1482 qsearchs('part_pkg_currency', { 'pkgpart' => $self->pkgpart,
1483 'currency' => $currency,
1484 'optionname' => $optionname,
1487 #fatal if not found? that works for our use cases from
1488 #part_pkg/currency_fixed, but isn't how we would typically/expect the method
1489 #to behave. have to catch it there if we change it here...
1490 or die "Unknown price for ". $self->pkg_comment. " in $currency\n";
1492 $part_pkg_currency->optionvalue;
1495 =item fcc_option OPTIONNAME
1497 Returns the FCC 477 report option value for the given name, or the empty
1503 my ($self, $name) = @_;
1504 my $part_pkg_fcc_option =
1505 qsearchs('part_pkg_fcc_option', {
1506 pkgpart => $self->pkgpart,
1507 fccoptionname => $name,
1509 $part_pkg_fcc_option ? $part_pkg_fcc_option->optionvalue : '';
1514 Returns all FCC 477 report options for this package, as a hash-like list.
1520 map { $_->fccoptionname => $_->optionvalue }
1521 qsearch('part_pkg_fcc_option', { pkgpart => $self->pkgpart });
1524 =item bill_part_pkg_link
1526 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1530 sub bill_part_pkg_link {
1531 shift->_part_pkg_link('bill', @_);
1534 =item svc_part_pkg_link
1536 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1540 sub svc_part_pkg_link {
1541 shift->_part_pkg_link('svc', @_);
1544 =item supp_part_pkg_link
1546 Returns the associated part_pkg_link records of type 'supp' (supplemental
1551 sub supp_part_pkg_link {
1552 shift->_part_pkg_link('supp', @_);
1555 sub _part_pkg_link {
1556 my( $self, $type ) = @_;
1558 return @{ $cache_link{$type}->{$self->pkgpart} }
1559 if $cache_enabled && $cache_link{$type}->{$self->pkgpart};
1561 cluck $type.'_part_pkg_link called' if $DEBUG;
1564 qsearch({ table => 'part_pkg_link',
1565 hashref => { src_pkgpart => $self->pkgpart,
1567 #protection against infinite recursive links
1568 dst_pkgpart => { op=>'!=', value=> $self->pkgpart },
1570 order_by => "ORDER BY hidden",
1573 $cache_link{$type}->{$self->pkgpart} = \@ppl if $cache_enabled;
1578 sub self_and_bill_linked {
1579 shift->_self_and_linked('bill', @_);
1582 sub self_and_svc_linked {
1583 shift->_self_and_linked('svc', @_);
1586 sub _self_and_linked {
1587 my( $self, $type, $hidden ) = @_;
1591 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1592 $self->_part_pkg_link($type) ) )
1594 $_->hidden($hidden) if $hidden;
1601 =item part_pkg_taxoverride [ CLASS ]
1603 Returns all associated FS::part_pkg_taxoverride objects (see
1604 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1605 of class CLASS if defined. Class may be one of 'setup', 'recur',
1606 the empty string (default), or a usage class number (see L<FS::usage_class>).
1607 When a class is specified, the empty string class (default) is returned
1608 if no more specific values exist.
1612 sub part_pkg_taxoverride {
1616 my $hashref = { 'pkgpart' => $self->pkgpart };
1617 $hashref->{'usage_class'} = $class if defined($class);
1618 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1620 unless ( scalar(@overrides) || !defined($class) || !$class ){
1621 $hashref->{'usage_class'} = '';
1622 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1628 =item has_taxproduct
1630 Returns true if this package has any taxproduct associated with it.
1634 sub has_taxproduct {
1637 $self->taxproductnum ||
1638 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1639 keys %{ {$self->options} }
1645 =item taxproduct [ CLASS ]
1647 Returns the associated tax product for this package definition (see
1648 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1649 the usage classnum (see L<FS::usage_class>). Returns the default
1650 tax product for this record if the more specific CLASS value does
1659 my $part_pkg_taxproduct;
1661 my $taxproductnum = $self->taxproductnum;
1663 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1664 $taxproductnum = $class_taxproductnum
1665 if $class_taxproductnum
1668 $part_pkg_taxproduct =
1669 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1671 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1672 $taxproductnum = $self->taxproductnum;
1673 $part_pkg_taxproduct =
1674 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1677 $part_pkg_taxproduct;
1680 =item taxproduct_description [ CLASS ]
1682 Returns the description of the associated tax product for this package
1683 definition (see L<FS::part_pkg_taxproduct>).
1687 sub taxproduct_description {
1689 my $part_pkg_taxproduct = $self->taxproduct(@_);
1690 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1694 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1696 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1697 package in the location specified by GEOCODE, for usage class CLASS (one of
1698 'setup', 'recur', null, or a C<usage_class> number).
1704 my ($vendor, $geocode, $class) = @_;
1705 # if this part_pkg is overridden into a specific taxclass, get that class
1706 my @taxclassnums = map { $_->taxclassnum }
1707 $self->part_pkg_taxoverride($class);
1708 # otherwise, get its tax product category
1709 if (!@taxclassnums) {
1710 my $part_pkg_taxproduct = $self->taxproduct($class);
1711 # If this isn't defined, then the class has no taxproduct designation,
1712 # so return no tax rates.
1713 return () if !$part_pkg_taxproduct;
1715 # convert the taxproduct to the tax classes that might apply to it in
1717 @taxclassnums = map { $_->taxclassnum }
1718 grep { $_->taxable eq 'Y' } # why do we need this?
1719 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1721 return unless @taxclassnums;
1723 # then look up the actual tax_rate entries
1724 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1726 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1727 my @taxes = qsearch({ 'table' => 'tax_rate',
1728 'hashref' => { 'geocode' => $geocode,
1729 'data_vendor' => $vendor,
1731 'extra_sql' => $extra_sql,
1733 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1739 =item part_pkg_discount
1741 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1744 =item part_pkg_usage
1746 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1751 Returns the automatic transfer target for this package, or an empty string
1758 my $pkgpart = $self->change_to_pkgpart or return '';
1759 FS::part_pkg->by_key($pkgpart);
1764 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1765 PLAN is the object's I<plan> field. There should be better docs
1766 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1772 my $plan = $self->plan;
1774 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1778 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1779 my $class = ref($self). "::$plan";
1780 warn "reblessing $self into $class" if $DEBUG > 1;
1783 bless($self, $class) unless $@;
1787 =item calc_setup CUST_PKG START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1789 =item calc_recur CUST_PKG START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1791 Calculates and returns the setup or recurring fees, respectively, for this
1792 package. Implementation is in the FS::part_pkg:* module specific to this price
1795 Adds invoicing details to the passed-in DETAILS_ARRAYREF
1797 Options are passed as a hashref. Available options:
1803 Frequency override (for calc_recur)
1807 This option is filled in by the method rather than controlling its operation.
1808 It is an arrayref. Applicable discounts will be added to the arrayref, as
1809 L<FS::cust_bill_pkg_discount|FS::cust_bill_pkg_discount records>.
1813 For package add-ons, is the base L<FS::part_pkg|package definition>, otherwise
1814 no different than pkgpart.
1816 =item precommit_hooks
1818 This option is filled in by the method rather than controlling its operation.
1819 It is an arrayref. Anonymous coderefs will be added to the arrayref. They
1820 need to be called before completing the billing operation. For calc_recur
1823 =item increment_next_bill
1825 Increment the next bill date (boolean, for calc_recur). Typically true except
1826 for particular situations.
1830 This option is filled in by the method rather than controlling its operation.
1831 It indicates a deferred setup fee that is billed at calc_recur time (see price
1832 plan option prorate_defer_bill).
1836 Note: Don't calculate prices when not actually billing the package. For that,
1837 see the L</base_setup|base_setup> and L</base_recur|base_recur> methods.
1842 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1843 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1845 =item calc_remain CUST_PKG [ OPTION => VALUE ... ]
1847 Calculates and returns the remaining value to be credited upon package
1848 suspension, change, or cancellation, if enabled.
1850 Options are passed as a list of keys and values. Available options:
1856 Override for the current time
1858 =item cust_credit_source_bill_pkg
1860 This option is filled in by the method rather than controlling its operation.
1862 L<FS::cust_credit_source_bill_pkg|FS::cust_credit_source_bill_pkg> records will
1863 be added to the arrayref indicating the specific line items and amounts which
1864 are the source of this remaining credit.
1868 Note: Don't calculate prices when not actually suspending or cancelling the
1873 #fallback that returns 0 for old legacy packages with no plan
1874 sub calc_remain { 0; }
1876 =item calc_units CUST_PKG
1878 This returns the number of provisioned svc_phone records, or, of the package
1879 count_available_phones option is set, the number available to be provisoined
1884 #fallback that returns 0 for old legacy packages with no plan
1885 sub calc_units { 0; }
1887 #fallback for everything not based on flat.pm
1888 sub recur_temporality { 'upcoming'; }
1890 =item calc_cancel START_DATE DETAILS_ARRAYREF OPTIONS_HASHREF
1892 Runs any necessary billing on cancellation: another recurring cycle for
1893 recur_temporailty 'preceding' pacakges with the bill_recur_on_cancel option
1894 set (calc_recur), or, any outstanding usage for pacakges with the
1895 bill_usage_on_cancel option set (calc_usage).
1899 #fallback for everything not based on flat.pm, doesn't do this yet (which is
1900 #okay, nothing of ours not based on flat.pm does usage-on-cancel billing
1901 sub calc_cancel { 0; }
1903 #fallback for everything except bulk.pm
1904 sub hide_svc_detail { 0; }
1906 #fallback for packages that can't/won't summarize usage
1907 sub sum_usage { 0; }
1909 =item recur_cost_permonth CUST_PKG
1911 recur_cost divided by freq (only supported for monthly and longer frequencies)
1915 sub recur_cost_permonth {
1916 my($self, $cust_pkg) = @_;
1917 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1918 sprintf('%.2f', ($self->recur_cost || 0) / $self->freq );
1921 =item cust_bill_pkg_recur CUST_PKG
1923 Actual recurring charge for the specified customer package from customer's most
1928 sub cust_bill_pkg_recur {
1929 my($self, $cust_pkg) = @_;
1930 my $cust_bill_pkg = qsearchs({
1931 'table' => 'cust_bill_pkg',
1932 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1933 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1934 'recur' => { op=>'>', value=>'0' },
1936 'order_by' => 'ORDER BY cust_bill._date DESC,
1937 cust_bill_pkg.sdate DESC
1940 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1941 $cust_bill_pkg->recur;
1944 =item unit_setup CUST_PKG
1946 Returns the setup fee for one unit of the package.
1951 my ($self, $cust_pkg) = @_;
1952 $self->option('setup_fee') || 0;
1957 unit_setup minus setup_cost
1963 $self->unit_setup(@_) - ($self->setup_cost || 0);
1966 =item recur_margin_permonth
1968 base_recur_permonth minus recur_cost_permonth
1972 sub recur_margin_permonth {
1974 $self->base_recur_permonth(@_) - $self->recur_cost_permonth(@_);
1977 =item format OPTION DATA
1979 Returns data formatted according to the function 'format' described
1980 in the plan info. Returns DATA if no such function exists.
1985 my ($self, $option, $data) = (shift, shift, shift);
1986 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1987 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1993 =item parse OPTION DATA
1995 Returns data parsed according to the function 'parse' described
1996 in the plan info. Returns DATA if no such function exists.
2001 my ($self, $option, $data) = (shift, shift, shift);
2002 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
2003 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
2013 =head1 CLASS METHODS
2021 # Used by FS::Upgrade to migrate to a new database.
2023 sub _upgrade_data { # class method
2024 my($class, %opts) = @_;
2026 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
2028 my @part_pkg = qsearch({
2029 'table' => 'part_pkg',
2030 'extra_sql' => "WHERE ". join(' OR ',
2031 'plan IS NULL', "plan = '' ",
2035 foreach my $part_pkg (@part_pkg) {
2037 unless ( $part_pkg->plan ) {
2038 $part_pkg->plan('flat');
2045 # Convert RADIUS accounting usage metrics from megabytes to gigabytes
2047 my $upgrade = 'part_pkg_gigabyte_usage';
2048 if (!FS::upgrade_journal->is_done($upgrade)) {
2049 foreach my $part_pkg (qsearch('part_pkg',
2050 { plan => 'sqlradacct_hour' })
2053 my $pkgpart = $part_pkg->pkgpart;
2055 foreach my $opt (qsearch('part_pkg_option',
2056 { 'optionname' => { op => 'LIKE',
2057 value => 'recur_included_%',
2059 pkgpart => $pkgpart,
2062 next if $opt->optionname eq 'recur_included_hours'; # unfortunately named field
2063 next if $opt->optionvalue == 0;
2065 $opt->optionvalue($opt->optionvalue / 1024);
2067 my $error = $opt->replace;
2068 die $error if $error;
2071 foreach my $opt (qsearch('part_pkg_option',
2072 { 'optionname' => { op => 'LIKE',
2073 value => 'recur_%_charge',
2075 pkgpart => $pkgpart,
2077 $opt->optionvalue($opt->optionvalue * 1024);
2079 my $error = $opt->replace;
2080 die $error if $error;
2084 FS::upgrade_journal->set_done($upgrade);
2087 # the rest can be done asynchronously
2090 sub queueable_upgrade {
2091 # now upgrade to the explicit custom flag
2093 my $search = FS::Cursor->new({
2094 'table' => 'part_pkg',
2095 'hashref' => { disabled => 'Y', custom => '' },
2096 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
2100 while (my $part_pkg = $search->fetch) {
2101 my $new = new FS::part_pkg { $part_pkg->hash };
2103 my $comment = $part_pkg->comment;
2104 $comment =~ s/^\(CUSTOM\) //;
2105 $comment = '(none)' unless $comment =~ /\S/;
2106 $new->comment($comment);
2108 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
2109 my $primary = $part_pkg->svcpart;
2110 my $options = { $part_pkg->options };
2112 my $error = $new->replace( $part_pkg,
2113 'pkg_svc' => $pkg_svc,
2114 'primary_svc' => $primary,
2115 'options' => $options,
2118 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2125 # set family_pkgpart on any packages that don't have it
2126 $search = FS::Cursor->new('part_pkg', { 'family_pkgpart' => '' });
2127 while (my $part_pkg = $search->fetch) {
2128 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
2129 my $error = $part_pkg->SUPER::replace;
2131 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
2138 my @part_pkg_option = qsearch('part_pkg_option',
2139 { 'optionname' => 'unused_credit',
2142 foreach my $old_opt (@part_pkg_option) {
2143 my $pkgpart = $old_opt->pkgpart;
2144 my $error = $old_opt->delete;
2145 die $error if $error;
2147 foreach (qw(unused_credit_cancel unused_credit_change)) {
2148 my $new_opt = new FS::part_pkg_option {
2149 'pkgpart' => $pkgpart,
2153 $error = $new_opt->insert;
2154 die $error if $error;
2158 # migrate use_disposition_taqua and use_disposition to disposition_in
2159 @part_pkg_option = qsearch('part_pkg_option',
2160 { 'optionname' => { op => 'LIKE',
2161 value => 'use_disposition%',
2165 my %newopts = map { $_->pkgpart => $_ }
2166 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
2167 foreach my $old_opt (@part_pkg_option) {
2168 my $pkgpart = $old_opt->pkgpart;
2169 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
2171 my $error = $old_opt->delete;
2172 die $error if $error;
2174 if ( exists($newopts{$pkgpart}) ) {
2175 my $opt = $newopts{$pkgpart};
2176 $opt->optionvalue($opt->optionvalue.",$newval");
2177 $error = $opt->replace;
2178 die $error if $error;
2180 my $new_opt = new FS::part_pkg_option {
2181 'pkgpart' => $pkgpart,
2182 'optionname' => 'disposition_in',
2183 'optionvalue' => $newval,
2185 $error = $new_opt->insert;
2186 die $error if $error;
2187 $newopts{$pkgpart} = $new_opt;
2191 # set any package with FCC voice lines to the "VoIP with broadband" category
2192 # for backward compatibility
2194 # recover from a bad upgrade bug
2195 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
2196 if (!FS::upgrade_journal->is_done($upgrade)) {
2197 my $bad_upgrade = qsearchs('upgrade_journal',
2198 { upgrade => 'part_pkg_fcc_voip_class' }
2200 if ( $bad_upgrade ) {
2201 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
2202 ' AND history_date > '.($bad_upgrade->_date - 3600);
2203 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
2206 'table' => 'h_part_pkg_option',
2208 'extra_sql' => "$where AND history_action = 'delete'",
2209 'order_by' => 'ORDER BY history_date ASC',
2211 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
2214 'table' => 'h_pkg_svc',
2216 'extra_sql' => "$where AND history_action = 'replace_old'",
2217 'order_by' => 'ORDER BY history_date ASC',
2220 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
2221 my $pkgpart ||= $deleted->pkgpart;
2222 $opt{$pkgpart} ||= {
2228 if ( $deleted->isa('FS::part_pkg_option') ) {
2229 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
2231 my $svcpart = $deleted->svcpart;
2232 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
2233 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
2234 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
2237 foreach my $pkgpart (keys %opt) {
2238 my $part_pkg = FS::part_pkg->by_key($pkgpart);
2239 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
2241 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
2244 } # $bad_upgrade exists
2245 else { # do the original upgrade, but correctly this time
2246 my @part_pkg = qsearch('part_pkg', {
2247 fcc_ds0s => { op => '>', value => 0 },
2248 fcc_voip_class => ''
2250 foreach my $part_pkg (@part_pkg) {
2251 $part_pkg->set(fcc_voip_class => 2);
2252 my @pkg_svc = $part_pkg->pkg_svc;
2253 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
2254 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
2255 my $error = $part_pkg->replace(
2256 $part_pkg->replace_old,
2257 options => { $part_pkg->options },
2258 pkg_svc => \%quantity,
2259 hidden_svc => \%hidden,
2260 primary_svc => ($part_pkg->svcpart || ''),
2262 die $error if $error;
2265 FS::upgrade_journal->set_done($upgrade);
2268 # migrate adjourn_months, expire_months, and contract_end_months to
2270 foreach my $field (qw(adjourn_months expire_months contract_end_months)) {
2271 foreach my $option (qsearch('part_pkg_option', { optionname => $field })) {
2272 my $part_pkg = $option->part_pkg;
2273 my $error = $option->delete;
2274 if ( $option->optionvalue and $part_pkg->get($field) eq '' ) {
2275 $part_pkg->set($field, $option->optionvalue);
2276 $error ||= $part_pkg->replace;
2278 die $error if $error;
2283 =item curuser_pkgs_sql
2285 Returns an SQL fragment for searching for packages the current user can
2286 use, either via part_pkg.agentnum directly, or via agent type (see
2291 sub curuser_pkgs_sql {
2294 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
2298 =item agent_pkgs_sql AGENT | AGENTNUM, ...
2300 Returns an SQL fragment for searching for packages the provided agent or agents
2301 can use, either via part_pkg.agentnum directly, or via agent type (see
2306 sub agent_pkgs_sql {
2307 my $class = shift; #i'm a class method, not a sub (the question is... why??)
2308 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
2310 $class->_pkgs_sql(@agentnums); #is this why
2315 my( $class, @agentnums ) = @_;
2316 my $agentnums = join(',', @agentnums);
2320 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
2321 OR ( agentnum IS NULL
2322 AND EXISTS ( SELECT 1
2324 LEFT JOIN agent_type USING ( typenum )
2325 LEFT JOIN agent AS typeagent USING ( typenum )
2326 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
2327 AND typeagent.agentnum IN ($agentnums)
2335 =item join_options_sql
2337 Returns an SQL fragment for JOINing the part_pkg_option records for this
2338 package's setup_fee and recur_fee (as setup_option and recur_option,
2339 respectively). Useful for optimization.
2343 sub join_options_sql {
2346 LEFT JOIN part_pkg_option AS setup_option
2347 ON ( part_pkg.pkgpart = setup_option.pkgpart
2348 AND setup_option.optionname = 'setup_fee' )
2349 LEFT JOIN part_pkg_option AS recur_option
2350 ON ( part_pkg.pkgpart = recur_option.pkgpart
2351 AND recur_option.optionname = 'recur_fee' )
2365 #false laziness w/part_export & cdr
2367 foreach my $INC ( @INC ) {
2368 warn "globbing $INC/FS/part_pkg/[a-z]*.pm\n" if $DEBUG;
2369 foreach my $file ( glob("$INC/FS/part_pkg/[a-z]*.pm") ) {
2370 warn "attempting to load plan info from $file\n" if $DEBUG;
2371 $file =~ /\/(\w+)\.pm$/ or do {
2372 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
2376 my $info = eval "use FS::part_pkg::$mod; ".
2377 "\\%FS::part_pkg::$mod\::info;";
2379 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
2382 unless ( keys %$info ) {
2383 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
2386 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
2387 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
2388 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
2391 $info{$mod} = $info;
2392 $info->{'weight'} ||= 0; # quiet warnings
2396 # copy one level deep to allow replacement of fields and fieldorder
2397 tie %plans, 'Tie::IxHash',
2398 map { my %infohash = %{ $info{$_} };
2400 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
2403 # inheritance of plan options
2404 foreach my $name (keys(%info)) {
2405 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
2406 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
2407 delete $plans{$name};
2410 my $parents = $info{$name}->{'inherit_fields'} || [];
2411 my (%fields, %field_exists, @fieldorder);
2412 foreach my $parent ($name, @$parents) {
2413 if ( !exists($info{$parent}) ) {
2414 warn "$name tried to inherit from nonexistent '$parent'\n";
2417 %fields = ( # avoid replacing existing fields
2418 %{ $info{$parent}->{'fields'} || {} },
2421 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
2423 next if $field_exists{$_};
2424 $field_exists{$_} = 1;
2425 # allow inheritors to remove inherited fields from the fieldorder
2426 push @fieldorder, $_ if !exists($fields{$_}) or
2427 !exists($fields{$_}->{'disabled'});
2430 $plans{$name}->{'fields'} = \%fields;
2431 $plans{$name}->{'fieldorder'} = \@fieldorder;
2441 =head1 NEW PLAN CLASSES
2443 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
2444 found in eg/plan_template.pm. Until then, it is suggested that you use the
2445 other modules in FS/FS/part_pkg/ as a guide.
2449 The delete method is unimplemented.
2451 setup and recur semantics are not yet defined (and are implemented in
2452 FS::cust_bill. hmm.). now they're deprecated and need to go.
2456 part_pkg_taxrate is Pg specific
2458 replace should be smarter about managing the related tables (options, pkg_svc)
2462 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2463 schema.html from the base documentation.