4 use vars qw( @ISA %plans $DEBUG $setup_hack $skip_pkg_svc_hack );
5 use Carp qw(carp cluck confess);
6 use Scalar::Util qw( blessed );
7 use Time::Local qw( timelocal_nocheck );
10 use FS::Record qw( qsearch qsearchs dbh dbdef );
16 use FS::part_pkg_option;
19 use FS::part_pkg_taxrate;
20 use FS::part_pkg_taxoverride;
21 use FS::part_pkg_taxproduct;
22 use FS::part_pkg_link;
23 use FS::part_pkg_discount;
25 @ISA = qw( FS::m2m_Common FS::option_Common );
28 $skip_pkg_svc_hack = 0;
32 FS::part_pkg - Object methods for part_pkg objects
38 $record = new FS::part_pkg \%hash
39 $record = new FS::part_pkg { 'column' => 'value' };
41 $custom_record = $template_record->clone;
43 $error = $record->insert;
45 $error = $new_record->replace($old_record);
47 $error = $record->delete;
49 $error = $record->check;
51 @pkg_svc = $record->pkg_svc;
53 $svcnum = $record->svcpart;
54 $svcnum = $record->svcpart( 'svc_acct' );
58 An FS::part_pkg object represents a package definition. FS::part_pkg
59 inherits from FS::Record. The following fields are currently supported:
63 =item pkgpart - primary key (assigned automatically for new package definitions)
65 =item pkg - Text name of this package definition (customer-viewable)
67 =item comment - Text name of this package definition (non-customer-viewable)
69 =item classnum - Optional package class (see L<FS::pkg_class>)
71 =item promo_code - Promotional code
73 =item setup - Setup fee expression (deprecated)
75 =item freq - Frequency of recurring fee
77 =item recur - Recurring fee expression (deprecated)
79 =item setuptax - Setup fee tax exempt flag, empty or `Y'
81 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
83 =item taxclass - Tax class
85 =item plan - Price plan
87 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
89 =item disabled - Disabled flag, empty or `Y'
91 =item custom - Custom flag, empty or `Y'
93 =item setup_cost - for cost tracking
95 =item recur_cost - for cost tracking
97 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
99 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
101 =item agentnum - Optional agentnum (see L<FS::agent>)
103 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
113 Creates a new package definition. To add the package definition to
114 the database, see L<"insert">.
118 sub table { 'part_pkg'; }
122 An alternate constructor. Creates a new package definition by duplicating
123 an existing definition. A new pkgpart is assigned and the custom flag is
124 set to Y. To add the package definition to the database, see L<"insert">.
130 my $class = ref($self);
131 my %hash = $self->hash;
132 $hash{'pkgpart'} = '';
133 $hash{'custom'} = 'Y';
134 #new FS::part_pkg ( \%hash ); # ?
135 new $class ( \%hash ); # ?
138 =item insert [ , OPTION => VALUE ... ]
140 Adds this package definition to the database. If there is an error,
141 returns the error, otherwise returns false.
143 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
144 I<custnum_ref> and I<options>.
146 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
147 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
148 be set to a hashref of svcparts and flag values ('Y' or '') to set the
149 'hidden' field in these records.
151 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
152 FS::pkg_svc record will be updated.
154 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
155 record itself), the object will be updated to point to this package definition.
157 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
158 the scalar will be updated with the custnum value from the cust_pkg record.
160 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
161 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
162 records will be inserted.
164 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
165 records will be inserted.
172 warn "FS::part_pkg::insert called on $self with options ".
173 join(', ', map "$_=>$options{$_}", keys %options)
176 local $SIG{HUP} = 'IGNORE';
177 local $SIG{INT} = 'IGNORE';
178 local $SIG{QUIT} = 'IGNORE';
179 local $SIG{TERM} = 'IGNORE';
180 local $SIG{TSTP} = 'IGNORE';
181 local $SIG{PIPE} = 'IGNORE';
183 my $oldAutoCommit = $FS::UID::AutoCommit;
184 local $FS::UID::AutoCommit = 0;
187 warn " inserting part_pkg record" if $DEBUG;
188 my $error = $self->SUPER::insert( $options{options} );
190 $dbh->rollback if $oldAutoCommit;
194 my $conf = new FS::Conf;
195 if ( $conf->exists('agent_defaultpkg') ) {
196 warn " agent_defaultpkg set; allowing all agents to purchase package"
198 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
199 my $type_pkgs = new FS::type_pkgs({
200 'typenum' => $agent_type->typenum,
201 'pkgpart' => $self->pkgpart,
203 my $error = $type_pkgs->insert;
205 $dbh->rollback if $oldAutoCommit;
211 warn " inserting part_pkg_taxoverride records" if $DEBUG;
212 my %overrides = %{ $options{'tax_overrides'} || {} };
213 foreach my $usage_class ( keys %overrides ) {
215 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
216 ? $overrides{$usage_class}
218 my @overrides = (grep "$_", split(',', $override) );
219 my $error = $self->process_m2m (
220 'link_table' => 'part_pkg_taxoverride',
221 'target_table' => 'tax_class',
222 'hashref' => { 'usage_class' => $usage_class },
223 'params' => \@overrides,
226 $dbh->rollback if $oldAutoCommit;
231 unless ( $skip_pkg_svc_hack ) {
233 warn " inserting pkg_svc records" if $DEBUG;
234 my $pkg_svc = $options{'pkg_svc'} || {};
235 my $hidden_svc = $options{'hidden_svc'} || {};
236 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
237 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
239 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
243 my $pkg_svc = new FS::pkg_svc( {
244 'pkgpart' => $self->pkgpart,
245 'svcpart' => $part_svc->svcpart,
246 'quantity' => $quantity,
247 'primary_svc' => $primary_svc,
248 'hidden' => $hidden_svc->{$part_svc->svcpart},
250 my $error = $pkg_svc->insert;
252 $dbh->rollback if $oldAutoCommit;
259 if ( $options{'cust_pkg'} ) {
260 warn " updating cust_pkg record " if $DEBUG;
262 ref($options{'cust_pkg'})
263 ? $options{'cust_pkg'}
264 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
265 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
266 if $options{'custnum_ref'};
267 my %hash = $old_cust_pkg->hash;
268 $hash{'pkgpart'} = $self->pkgpart,
269 my $new_cust_pkg = new FS::cust_pkg \%hash;
270 local($FS::cust_pkg::disable_agentcheck) = 1;
271 my $error = $new_cust_pkg->replace($old_cust_pkg);
273 $dbh->rollback if $oldAutoCommit;
274 return "Error modifying cust_pkg record: $error";
278 warn " commiting transaction" if $DEBUG;
279 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
286 Currently unimplemented.
291 return "Can't (yet?) delete package definitions.";
292 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
295 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
297 Replaces OLD_RECORD with this one in the database. If there is an error,
298 returns the error, otherwise returns false.
300 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
303 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
304 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
305 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
306 'hidden' field in these records.
308 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
309 FS::pkg_svc record will be updated.
311 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
319 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
324 ( ref($_[0]) eq 'HASH' )
328 $options->{options} = {} unless defined($options->{options});
330 warn "FS::part_pkg::replace called on $new to replace $old with options".
331 join(', ', map "$_ => ". $options->{$_}, keys %$options)
334 local $SIG{HUP} = 'IGNORE';
335 local $SIG{INT} = 'IGNORE';
336 local $SIG{QUIT} = 'IGNORE';
337 local $SIG{TERM} = 'IGNORE';
338 local $SIG{TSTP} = 'IGNORE';
339 local $SIG{PIPE} = 'IGNORE';
341 my $oldAutoCommit = $FS::UID::AutoCommit;
342 local $FS::UID::AutoCommit = 0;
345 #plandata shit stays in replace for upgrades until after 2.0 (or edit
347 warn " saving legacy plandata" if $DEBUG;
348 my $plandata = $new->get('plandata');
349 $new->set('plandata', '');
351 warn " deleting old part_pkg_option records" if $DEBUG;
352 foreach my $part_pkg_option ( $old->part_pkg_option ) {
353 my $error = $part_pkg_option->delete;
355 $dbh->rollback if $oldAutoCommit;
360 warn " replacing part_pkg record" if $DEBUG;
361 my $error = $new->SUPER::replace($old, $options->{options} );
363 $dbh->rollback if $oldAutoCommit;
367 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
368 foreach my $part_pkg_option (
369 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
370 return "illegal plandata: $plandata";
372 new FS::part_pkg_option {
373 'pkgpart' => $new->pkgpart,
378 split("\n", $plandata)
380 my $error = $part_pkg_option->insert;
382 $dbh->rollback if $oldAutoCommit;
387 warn " replacing pkg_svc records" if $DEBUG;
388 my $pkg_svc = $options->{'pkg_svc'} || {};
389 my $hidden_svc = $options->{'hidden_svc'} || {};
390 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
391 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
392 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
394 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
395 && $options->{'primary_svc'} == $part_svc->svcpart
400 my $old_pkg_svc = qsearchs('pkg_svc', {
401 'pkgpart' => $old->pkgpart,
402 'svcpart' => $part_svc->svcpart,
405 my $old_quantity = 0;
406 my $old_primary_svc = '';
408 if ( $old_pkg_svc ) {
409 $old_quantity = $old_pkg_svc->quantity;
410 $old_primary_svc = $old_pkg_svc->primary_svc
411 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
412 $old_hidden = $old_pkg_svc->hidden;
415 next unless $old_quantity != $quantity ||
416 $old_primary_svc ne $primary_svc ||
417 $old_hidden ne $hidden;
419 my $new_pkg_svc = new FS::pkg_svc( {
420 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
421 'pkgpart' => $new->pkgpart,
422 'svcpart' => $part_svc->svcpart,
423 'quantity' => $quantity,
424 'primary_svc' => $primary_svc,
427 my $error = $old_pkg_svc
428 ? $new_pkg_svc->replace($old_pkg_svc)
429 : $new_pkg_svc->insert;
431 $dbh->rollback if $oldAutoCommit;
436 warn " commiting transaction" if $DEBUG;
437 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
443 Checks all fields to make sure this is a valid package definition. If
444 there is an error, returns the error, otherwise returns false. Called by the
445 insert and replace methods.
451 warn "FS::part_pkg::check called on $self" if $DEBUG;
453 for (qw(setup recur plandata)) {
454 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
455 return "Use of $_ field is deprecated; set a plan and options: ".
457 if length($self->get($_));
461 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
462 my $error = $self->ut_number('freq');
463 return $error if $error;
465 $self->freq =~ /^(\d+[hdw]?)$/
466 or return "Illegal or empty freq: ". $self->freq;
470 my @null_agentnum_right = ( 'Edit global package definitions' );
471 push @null_agentnum_right, 'One-time charge'
472 if $self->freq =~ /^0/;
473 push @null_agentnum_right, 'Customize customer package'
474 if $self->disabled eq 'Y'; #good enough
476 my $error = $self->ut_numbern('pkgpart')
477 || $self->ut_text('pkg')
478 || $self->ut_text('comment')
479 || $self->ut_textn('promo_code')
480 || $self->ut_alphan('plan')
481 || $self->ut_enum('setuptax', [ '', 'Y' ] )
482 || $self->ut_enum('recurtax', [ '', 'Y' ] )
483 || $self->ut_textn('taxclass')
484 || $self->ut_enum('disabled', [ '', 'Y' ] )
485 || $self->ut_enum('custom', [ '', 'Y' ] )
486 || $self->ut_enum('no_auto', [ '', 'Y' ])
487 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
488 #|| $self->ut_moneyn('setup_cost')
489 #|| $self->ut_moneyn('recur_cost')
490 || $self->ut_floatn('setup_cost')
491 || $self->ut_floatn('recur_cost')
492 || $self->ut_floatn('pay_weight')
493 || $self->ut_floatn('credit_weight')
494 || $self->ut_numbern('taxproductnum')
495 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
496 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
497 || $self->ut_foreign_keyn('taxproductnum',
498 'part_pkg_taxproduct',
502 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
503 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
505 || $self->ut_numbern('fcc_ds0s')
506 || $self->SUPER::check
508 return $error if $error;
510 return 'Unknown plan '. $self->plan
511 unless exists($plans{$self->plan});
513 my $conf = new FS::Conf;
514 return 'Taxclass is required'
515 if ! $self->taxclass && $conf->exists('require_taxclasses');
520 =item pkg_comment [ OPTION => VALUE... ]
522 Returns an (internal) string representing this package. Currently,
523 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
524 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
527 If the option nopkgpart is true then the "pkgpart: ' is omitted.
535 #$self->pkg. ' - '. $self->comment;
536 #$self->pkg. ' ('. $self->comment. ')';
537 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
538 $pre. $self->pkg. ' - '. $self->custom_comment;
541 sub price_info { # safety, in case a part_pkg hasn't defined price_info
547 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment . ' ' . $self->price_info;
552 Returns the package class, as an FS::pkg_class object, or the empty string
553 if there is no package class.
559 if ( $self->classnum ) {
560 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
566 =item addon_pkg_class
568 Returns the add-on package class, as an FS::pkg_class object, or the empty
569 string if there is no add-on package class.
573 sub addon_pkg_class {
575 if ( $self->addon_classnum ) {
576 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
584 Returns the package category name, or the empty string if there is no package
591 my $pkg_class = $self->pkg_class;
593 ? $pkg_class->categoryname
599 Returns the package class name, or the empty string if there is no package
606 my $pkg_class = $self->pkg_class;
608 ? $pkg_class->classname
612 =item addon_classname
614 Returns the add-on package class name, or the empty string if there is no
615 add-on package class.
619 sub addon_classname {
621 my $pkg_class = $self->addon_pkg_class;
623 ? $pkg_class->classname
629 Returns the associated agent for this event, if any, as an FS::agent object.
635 qsearchs('agent', { 'agentnum' => $self->agentnum } );
638 =item pkg_svc [ HASHREF | OPTION => VALUE ]
640 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
641 definition (with non-zero quantity).
643 One option is available, I<disable_linked>. If set true it will return the
644 services for this package definition alone, omitting services from any add-on
651 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
658 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
664 # #sort { $b->primary cmp $a->primary }
665 # grep { $_->quantity }
666 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
668 my $opt = ref($_[0]) ? $_[0] : { @_ };
669 my %pkg_svc = map { $_->svcpart => $_ }
670 grep { $_->quantity }
671 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
673 unless ( $opt->{disable_linked} ) {
674 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
675 my @pkg_svc = grep { $_->quantity }
676 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
677 foreach my $pkg_svc ( @pkg_svc ) {
678 if ( $pkg_svc{$pkg_svc->svcpart} ) {
679 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
680 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
682 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
692 =item svcpart [ SVCDB ]
694 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
695 associated with this package definition (see L<FS::pkg_svc>). Returns
696 false if there not a primary service definition or exactly one service
697 definition with quantity 1, or if SVCDB is specified and does not match the
698 svcdb of the service definition. SVCDB can be specified as a scalar table
699 name, such as 'svc_acct', or as an arrayref of possible table names.
704 my $pkg_svc = shift->_primary_pkg_svc(@_);
705 $pkg_svc ? $pkg_svc->svcpart : '';
708 =item part_svc [ SVCDB ]
710 Like the B<svcpart> method, but returns the FS::part_svc object (see
716 my $pkg_svc = shift->_primary_pkg_svc(@_);
717 $pkg_svc ? $pkg_svc->part_svc : '';
720 sub _primary_pkg_svc {
723 my $svcdb = scalar(@_) ? shift : [];
724 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
725 my %svcdb = map { $_=>1 } @$svcdb;
728 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
731 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
732 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
734 return '' if scalar(@pkg_svc) != 1;
738 =item svcpart_unique_svcdb SVCDB
740 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
741 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
742 false if there not a primary service definition for SVCDB or there are multiple
743 service definitions for SVCDB.
747 sub svcpart_unique_svcdb {
748 my( $self, $svcdb ) = @_;
749 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
750 return '' if scalar(@svcdb_pkg_svc) != 1;
751 $svcdb_pkg_svc[0]->svcpart;
756 Returns a list of the acceptable payment types for this package. Eventually
757 this should come out of a database table and be editable, but currently has the
758 following logic instead:
760 If the package is free, the single item B<BILL> is
761 returned, otherwise, the single item B<CARD> is returned.
763 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
769 if ( $self->is_free ) {
778 Returns true if this package is free.
784 unless ( $self->plan ) {
785 $self->setup =~ /^\s*0+(\.0*)?\s*$/
786 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
787 } elsif ( $self->can('is_free_options') ) {
788 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
789 map { $self->option($_) }
790 $self->is_free_options;
792 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
793 "provides neither is_free_options nor is_free method; returning false";
798 sub can_discount { 0; }
801 # moved to FS::Misc to make this accessible to other packages
803 FS::Misc::pkg_freqs();
808 Returns an english representation of the I<freq> field, such as "monthly",
809 "weekly", "semi-annually", etc.
815 my $freq = $self->freq;
817 #my $freqs_href = $self->freqs_href;
818 my $freqs_href = freqs_href();
820 if ( exists($freqs_href->{$freq}) ) {
821 $freqs_href->{$freq};
823 my $interval = 'month';
824 if ( $freq =~ /^(\d+)([hdw])$/ ) {
825 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
826 $interval = $interval{$2};
831 "every $freq ${interval}s";
836 =item add_freq TIMESTAMP [ FREQ ]
838 Adds a billing period of some frequency to the provided timestamp and
839 returns the resulting timestamp, or -1 if the frequency could not be
840 parsed (shouldn't happen). By default, the frequency of this package
841 will be used; to override this, pass a different frequency as a second
847 my( $self, $date, $freq ) = @_;
848 $freq = $self->freq unless $freq;
850 #change this bit to use Date::Manip? CAREFUL with timezones (see
851 # mailing list archive)
852 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
854 if ( $freq =~ /^\d+$/ ) {
856 until ( $mon < 12 ) { $mon -= 12; $year++; }
857 } elsif ( $freq =~ /^(\d+)w$/ ) {
860 } elsif ( $freq =~ /^(\d+)d$/ ) {
863 } elsif ( $freq =~ /^(\d+)h$/ ) {
870 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
875 For backwards compatibility, returns the plandata field as well as all options
876 from FS::part_pkg_option.
882 carp "plandata is deprecated";
884 $self->SUPER::plandata(@_);
886 my $plandata = $self->get('plandata');
887 my %options = $self->options;
888 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
893 =item part_pkg_option
895 Returns all options as FS::part_pkg_option objects (see
896 L<FS::part_pkg_option>).
900 sub part_pkg_option {
902 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
907 Returns a list of option names and values suitable for assigning to a hash.
913 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
916 =item option OPTIONNAME [ QUIET ]
918 Returns the option value for the given name, or the empty string. If a true
919 value is passed as the second argument, warnings about missing the option
925 my( $self, $opt, $ornull ) = @_;
926 my $part_pkg_option =
927 qsearchs('part_pkg_option', {
928 pkgpart => $self->pkgpart,
931 return $part_pkg_option->optionvalue if $part_pkg_option;
932 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
933 split("\n", $self->get('plandata') );
934 return $plandata{$opt} if exists $plandata{$opt};
935 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
936 "not found in options or plandata!\n"
941 =item bill_part_pkg_link
943 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
947 sub bill_part_pkg_link {
948 shift->_part_pkg_link('bill', @_);
951 =item svc_part_pkg_link
953 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
957 sub svc_part_pkg_link {
958 shift->_part_pkg_link('svc', @_);
962 my( $self, $type ) = @_;
963 qsearch({ table => 'part_pkg_link',
964 hashref => { 'src_pkgpart' => $self->pkgpart,
965 'link_type' => $type,
966 #protection against infinite recursive links
967 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
969 order_by => "ORDER BY hidden",
973 sub self_and_bill_linked {
974 shift->_self_and_linked('bill', @_);
977 sub _self_and_linked {
978 my( $self, $type, $hidden ) = @_;
982 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
983 $self->_part_pkg_link($type) ) )
985 $_->hidden($hidden) if $hidden;
992 =item part_pkg_taxoverride [ CLASS ]
994 Returns all associated FS::part_pkg_taxoverride objects (see
995 L<FS::part_pkg_taxoverride>). Limits the returned set to those
996 of class CLASS if defined. Class may be one of 'setup', 'recur',
997 the empty string (default), or a usage class number (see L<FS::usage_class>).
998 When a class is specified, the empty string class (default) is returned
999 if no more specific values exist.
1003 sub part_pkg_taxoverride {
1007 my $hashref = { 'pkgpart' => $self->pkgpart };
1008 $hashref->{'usage_class'} = $class if defined($class);
1009 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1011 unless ( scalar(@overrides) || !defined($class) || !$class ){
1012 $hashref->{'usage_class'} = '';
1013 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1019 =item has_taxproduct
1021 Returns true if this package has any taxproduct associated with it.
1025 sub has_taxproduct {
1028 $self->taxproductnum ||
1029 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1030 keys %{ {$self->options} }
1036 =item taxproduct [ CLASS ]
1038 Returns the associated tax product for this package definition (see
1039 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1040 the usage classnum (see L<FS::usage_class>). Returns the default
1041 tax product for this record if the more specific CLASS value does
1050 my $part_pkg_taxproduct;
1052 my $taxproductnum = $self->taxproductnum;
1054 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1055 $taxproductnum = $class_taxproductnum
1056 if $class_taxproductnum
1059 $part_pkg_taxproduct =
1060 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1062 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1063 $taxproductnum = $self->taxproductnum;
1064 $part_pkg_taxproduct =
1065 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1068 $part_pkg_taxproduct;
1071 =item taxproduct_description [ CLASS ]
1073 Returns the description of the associated tax product for this package
1074 definition (see L<FS::part_pkg_taxproduct>).
1078 sub taxproduct_description {
1080 my $part_pkg_taxproduct = $self->taxproduct(@_);
1081 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1084 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1086 Returns the package to taxrate m2m records for this package in the location
1087 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1088 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1089 (see L<FS::usage_class>).
1093 sub _expand_cch_taxproductnum {
1096 my $part_pkg_taxproduct = $self->taxproduct($class);
1098 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1099 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1102 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1103 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1104 OR taxproduct = '$a:$b:$c:'
1105 OR taxproduct = '$a:$b:".":$d'
1106 OR taxproduct = '$a:$b:".":' )";
1107 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1108 'hashref' => { 'data_vendor'=>'cch' },
1109 'extra_sql' => $extra_sql,
1114 sub part_pkg_taxrate {
1116 my ($data_vendor, $geocode, $class) = @_;
1119 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1120 dbh->quote($data_vendor);
1122 # CCH oddness in m2m
1123 $extra_sql .= ' AND ('.
1124 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1128 # much more CCH oddness in m2m -- this is kludgy
1129 my @tpnums = $self->_expand_cch_taxproductnum($class);
1130 if (scalar(@tpnums)) {
1131 $extra_sql .= ' AND ('.
1132 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1135 $extra_sql .= ' AND ( 0 = 1 )';
1138 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1139 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1140 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1142 # should qsearch preface columns with the table to facilitate joins?
1143 qsearch( { 'table' => 'part_pkg_taxrate',
1144 'select' => $select,
1145 'hashref' => { # 'data_vendor' => $data_vendor,
1146 # 'taxproductnum' => $self->taxproductnum,
1148 'addl_from' => $addl_from,
1149 'extra_sql' => $extra_sql,
1150 'order_by' => $order_by,
1154 =item part_pkg_discount
1156 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1161 sub part_pkg_discount {
1163 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1168 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1169 PLAN is the object's I<plan> field. There should be better docs
1170 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1176 my $plan = $self->plan;
1178 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1182 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1183 my $class = ref($self). "::$plan";
1184 warn "reblessing $self into $class" if $DEBUG;
1187 bless($self, $class) unless $@;
1191 #fallbacks that eval the setup and recur fields, for backwards compat
1195 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1196 $self->_calc_eval('setup', @_);
1201 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1202 $self->_calc_eval('recur', @_);
1205 use vars qw( $sdate @details );
1207 #my( $self, $field, $cust_pkg ) = @_;
1208 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1210 *details = $detailsref;
1211 $self->$field() =~ /^(.*)$/
1212 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1213 $self->$field(). "\n";
1215 return 0 if $prog =~ /^\s*$/;
1216 my $value = eval $prog;
1221 #fallback that return 0 for old legacy packages with no plan
1223 sub calc_remain { 0; }
1224 sub calc_cancel { 0; }
1225 sub calc_units { 0; }
1227 #fallback for everything except bulk.pm
1228 sub hide_svc_detail { 0; }
1230 =item recur_cost_permonth CUST_PKG
1232 recur_cost divided by freq (only supported for monthly and longer frequencies)
1236 sub recur_cost_permonth {
1237 my($self, $cust_pkg) = @_;
1238 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1239 sprintf('%.2f', $self->recur_cost / $self->freq );
1242 =item format OPTION DATA
1244 Returns data formatted according to the function 'format' described
1245 in the plan info. Returns DATA if no such function exists.
1250 my ($self, $option, $data) = (shift, shift, shift);
1251 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1252 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1258 =item parse OPTION DATA
1260 Returns data parsed according to the function 'parse' described
1261 in the plan info. Returns DATA if no such function exists.
1266 my ($self, $option, $data) = (shift, shift, shift);
1267 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1268 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1278 =head1 CLASS METHODS
1286 # Used by FS::Upgrade to migrate to a new database.
1288 sub _upgrade_data { # class method
1289 my($class, %opts) = @_;
1291 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1293 my @part_pkg = qsearch({
1294 'table' => 'part_pkg',
1295 'extra_sql' => "WHERE ". join(' OR ',
1296 ( map "($_ IS NOT NULL AND $_ != '' )",
1297 qw( plandata setup recur ) ),
1298 'plan IS NULL', "plan = '' ",
1302 foreach my $part_pkg (@part_pkg) {
1304 unless ( $part_pkg->plan ) {
1305 $part_pkg->plan('flat');
1308 if ( length($part_pkg->option('setup_fee')) == 0
1309 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1311 my $opt = new FS::part_pkg_option {
1312 'pkgpart' => $part_pkg->pkgpart,
1313 'optionname' => 'setup_fee',
1314 'optionvalue' => $1,
1316 my $error = $opt->insert;
1317 die $error if $error;
1321 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1322 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1324 $part_pkg->setup('');
1326 if ( length($part_pkg->option('recur_fee')) == 0
1327 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1329 my $opt = new FS::part_pkg_option {
1330 'pkgpart' => $part_pkg->pkgpart,
1331 'optionname' => 'recur_fee',
1332 'optionvalue' => $1,
1334 my $error = $opt->insert;
1335 die $error if $error;
1339 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1340 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1342 $part_pkg->recur('');
1344 $part_pkg->replace; #this should take care of plandata, right?
1348 # now upgrade to the explicit custom flag
1350 @part_pkg = qsearch({
1351 'table' => 'part_pkg',
1352 'hashref' => { disabled => 'Y', custom => '' },
1353 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1356 foreach my $part_pkg (@part_pkg) {
1357 my $new = new FS::part_pkg { $part_pkg->hash };
1359 my $comment = $part_pkg->comment;
1360 $comment =~ s/^\(CUSTOM\) //;
1361 $comment = '(none)' unless $comment =~ /\S/;
1362 $new->comment($comment);
1364 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1365 my $primary = $part_pkg->svcpart;
1366 my $options = { $part_pkg->options };
1368 my $error = $new->replace( $part_pkg,
1369 'pkg_svc' => $pkg_svc,
1370 'primary_svc' => $primary,
1371 'options' => $options,
1373 die $error if $error;
1376 my @part_pkg_option = qsearch('part_pkg_option',
1377 { 'optionname' => 'unused_credit',
1380 foreach my $old_opt (@part_pkg_option) {
1381 my $pkgpart = $old_opt->pkgpart;
1382 my $error = $old_opt->delete;
1383 die $error if $error;
1385 foreach (qw(unused_credit_cancel unused_credit_change)) {
1386 my $new_opt = new FS::part_pkg_option {
1387 'pkgpart' => $pkgpart,
1391 $error = $new_opt->insert;
1392 die $error if $error;
1397 =item curuser_pkgs_sql
1399 Returns an SQL fragment for searching for packages the current user can
1400 use, either via part_pkg.agentnum directly, or via agent type (see
1405 sub curuser_pkgs_sql {
1408 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1412 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1414 Returns an SQL fragment for searching for packages the provided agent or agents
1415 can use, either via part_pkg.agentnum directly, or via agent type (see
1420 sub agent_pkgs_sql {
1421 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1422 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1424 $class->_pkgs_sql(@agentnums); #is this why
1429 my( $class, @agentnums ) = @_;
1430 my $agentnums = join(',', @agentnums);
1434 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1435 OR ( agentnum IS NULL
1436 AND EXISTS ( SELECT 1
1438 LEFT JOIN agent_type USING ( typenum )
1439 LEFT JOIN agent AS typeagent USING ( typenum )
1440 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1441 AND typeagent.agentnum IN ($agentnums)
1459 #false laziness w/part_export & cdr
1461 foreach my $INC ( @INC ) {
1462 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1463 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1464 warn "attempting to load plan info from $file\n" if $DEBUG;
1465 $file =~ /\/(\w+)\.pm$/ or do {
1466 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1470 my $info = eval "use FS::part_pkg::$mod; ".
1471 "\\%FS::part_pkg::$mod\::info;";
1473 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1476 unless ( keys %$info ) {
1477 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1480 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1481 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1482 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1485 $info{$mod} = $info;
1486 $info->{'weight'} ||= 0; # quiet warnings
1490 # copy one level deep to allow replacement of fields and fieldorder
1491 tie %plans, 'Tie::IxHash',
1492 map { my %infohash = %{ $info{$_} };
1494 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1497 # inheritance of plan options
1498 foreach my $name (keys(%info)) {
1499 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1500 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1501 delete $plans{$name};
1504 my $parents = $info{$name}->{'inherit_fields'} || [];
1505 my (%fields, %field_exists, @fieldorder);
1506 foreach my $parent ($name, @$parents) {
1507 %fields = ( # avoid replacing existing fields
1508 %{ $info{$parent}->{'fields'} || {} },
1511 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1513 next if $field_exists{$_};
1514 $field_exists{$_} = 1;
1515 # allow inheritors to remove inherited fields from the fieldorder
1516 push @fieldorder, $_ if !exists($fields{$_}->{'disabled'});
1519 $plans{$name}->{'fields'} = \%fields;
1520 $plans{$name}->{'fieldorder'} = \@fieldorder;
1530 =head1 NEW PLAN CLASSES
1532 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1533 found in eg/plan_template.pm. Until then, it is suggested that you use the
1534 other modules in FS/FS/part_pkg/ as a guide.
1538 The delete method is unimplemented.
1540 setup and recur semantics are not yet defined (and are implemented in
1541 FS::cust_bill. hmm.). now they're deprecated and need to go.
1545 part_pkg_taxrate is Pg specific
1547 replace should be smarter about managing the related tables (options, pkg_svc)
1551 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1552 schema.html from the base documentation.