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_moneyn('setup_cost')
488 #|| $self->ut_moneyn('recur_cost')
489 || $self->ut_floatn('setup_cost')
490 || $self->ut_floatn('recur_cost')
491 || $self->ut_floatn('pay_weight')
492 || $self->ut_floatn('credit_weight')
493 || $self->ut_numbern('taxproductnum')
494 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
495 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
496 || $self->ut_foreign_keyn('taxproductnum',
497 'part_pkg_taxproduct',
501 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
502 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
504 || $self->ut_numbern('fcc_ds0s')
505 || $self->SUPER::check
507 return $error if $error;
509 return 'Unknown plan '. $self->plan
510 unless exists($plans{$self->plan});
512 my $conf = new FS::Conf;
513 return 'Taxclass is required'
514 if ! $self->taxclass && $conf->exists('require_taxclasses');
519 =item pkg_comment [ OPTION => VALUE... ]
521 Returns an (internal) string representing this package. Currently,
522 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
523 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
526 If the option nopkgpart is true then the "pkgpart: ' is omitted.
534 #$self->pkg. ' - '. $self->comment;
535 #$self->pkg. ' ('. $self->comment. ')';
536 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
537 $pre. $self->pkg. ' - '. $self->custom_comment;
542 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment;
547 Returns the package class, as an FS::pkg_class object, or the empty string
548 if there is no package class.
554 if ( $self->classnum ) {
555 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
561 =item addon_pkg_class
563 Returns the add-on package class, as an FS::pkg_class object, or the empty
564 string if there is no add-on package class.
568 sub addon_pkg_class {
570 if ( $self->addon_classnum ) {
571 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
579 Returns the package category name, or the empty string if there is no package
586 my $pkg_class = $self->pkg_class;
588 ? $pkg_class->categoryname
594 Returns the package class name, or the empty string if there is no package
601 my $pkg_class = $self->pkg_class;
603 ? $pkg_class->classname
607 =item addon_classname
609 Returns the add-on package class name, or the empty string if there is no
610 add-on package class.
614 sub addon_classname {
616 my $pkg_class = $self->addon_pkg_class;
618 ? $pkg_class->classname
624 Returns the associated agent for this event, if any, as an FS::agent object.
630 qsearchs('agent', { 'agentnum' => $self->agentnum } );
633 =item pkg_svc [ HASHREF | OPTION => VALUE ]
635 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
636 definition (with non-zero quantity).
638 One option is available, I<disable_linked>. If set true it will return the
639 services for this package definition alone, omitting services from any add-on
646 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
653 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
659 # #sort { $b->primary cmp $a->primary }
660 # grep { $_->quantity }
661 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
663 my $opt = ref($_[0]) ? $_[0] : { @_ };
664 my %pkg_svc = map { $_->svcpart => $_ }
665 grep { $_->quantity }
666 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
668 unless ( $opt->{disable_linked} ) {
669 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
670 my @pkg_svc = grep { $_->quantity }
671 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
672 foreach my $pkg_svc ( @pkg_svc ) {
673 if ( $pkg_svc{$pkg_svc->svcpart} ) {
674 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
675 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
677 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
687 =item svcpart [ SVCDB ]
689 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
690 associated with this package definition (see L<FS::pkg_svc>). Returns
691 false if there not a primary service definition or exactly one service
692 definition with quantity 1, or if SVCDB is specified and does not match the
693 svcdb of the service definition. SVCDB can be specified as a scalar table
694 name, such as 'svc_acct', or as an arrayref of possible table names.
699 my $pkg_svc = shift->_primary_pkg_svc(@_);
700 $pkg_svc ? $pkg_svc->svcpart : '';
703 =item part_svc [ SVCDB ]
705 Like the B<svcpart> method, but returns the FS::part_svc object (see
711 my $pkg_svc = shift->_primary_pkg_svc(@_);
712 $pkg_svc ? $pkg_svc->part_svc : '';
715 sub _primary_pkg_svc {
718 my $svcdb = scalar(@_) ? shift : [];
719 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
720 my %svcdb = map { $_=>1 } @$svcdb;
723 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
726 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
727 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
729 return '' if scalar(@pkg_svc) != 1;
733 =item svcpart_unique_svcdb SVCDB
735 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
736 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
737 false if there not a primary service definition for SVCDB or there are multiple
738 service definitions for SVCDB.
742 sub svcpart_unique_svcdb {
743 my( $self, $svcdb ) = @_;
744 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
745 return '' if scalar(@svcdb_pkg_svc) != 1;
746 $svcdb_pkg_svc[0]->svcpart;
751 Returns a list of the acceptable payment types for this package. Eventually
752 this should come out of a database table and be editable, but currently has the
753 following logic instead:
755 If the package is free, the single item B<BILL> is
756 returned, otherwise, the single item B<CARD> is returned.
758 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
764 if ( $self->is_free ) {
773 Returns true if this package is free.
779 unless ( $self->plan ) {
780 $self->setup =~ /^\s*0+(\.0*)?\s*$/
781 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
782 } elsif ( $self->can('is_free_options') ) {
783 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
784 map { $self->option($_) }
785 $self->is_free_options;
787 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
788 "provides neither is_free_options nor is_free method; returning false";
793 sub can_discount { 0; }
796 # moved to FS::Misc to make this accessible to other packages
798 FS::Misc::pkg_freqs();
803 Returns an english representation of the I<freq> field, such as "monthly",
804 "weekly", "semi-annually", etc.
810 my $freq = $self->freq;
812 #my $freqs_href = $self->freqs_href;
813 my $freqs_href = freqs_href();
815 if ( exists($freqs_href->{$freq}) ) {
816 $freqs_href->{$freq};
818 my $interval = 'month';
819 if ( $freq =~ /^(\d+)([hdw])$/ ) {
820 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
821 $interval = $interval{$2};
826 "every $freq ${interval}s";
831 =item add_freq TIMESTAMP [ FREQ ]
833 Adds a billing period of some frequency to the provided timestamp and
834 returns the resulting timestamp, or -1 if the frequency could not be
835 parsed (shouldn't happen). By default, the frequency of this package
836 will be used; to override this, pass a different frequency as a second
842 my( $self, $date, $freq ) = @_;
843 $freq = $self->freq unless $freq;
845 #change this bit to use Date::Manip? CAREFUL with timezones (see
846 # mailing list archive)
847 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
849 if ( $freq =~ /^\d+$/ ) {
851 until ( $mon < 12 ) { $mon -= 12; $year++; }
852 } elsif ( $freq =~ /^(\d+)w$/ ) {
855 } elsif ( $freq =~ /^(\d+)d$/ ) {
858 } elsif ( $freq =~ /^(\d+)h$/ ) {
865 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
870 For backwards compatibility, returns the plandata field as well as all options
871 from FS::part_pkg_option.
877 carp "plandata is deprecated";
879 $self->SUPER::plandata(@_);
881 my $plandata = $self->get('plandata');
882 my %options = $self->options;
883 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
888 =item part_pkg_option
890 Returns all options as FS::part_pkg_option objects (see
891 L<FS::part_pkg_option>).
895 sub part_pkg_option {
897 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
902 Returns a list of option names and values suitable for assigning to a hash.
908 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
911 =item option OPTIONNAME [ QUIET ]
913 Returns the option value for the given name, or the empty string. If a true
914 value is passed as the second argument, warnings about missing the option
920 my( $self, $opt, $ornull ) = @_;
921 my $part_pkg_option =
922 qsearchs('part_pkg_option', {
923 pkgpart => $self->pkgpart,
926 return $part_pkg_option->optionvalue if $part_pkg_option;
927 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
928 split("\n", $self->get('plandata') );
929 return $plandata{$opt} if exists $plandata{$opt};
930 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
931 "not found in options or plandata!\n"
936 =item bill_part_pkg_link
938 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
942 sub bill_part_pkg_link {
943 shift->_part_pkg_link('bill', @_);
946 =item svc_part_pkg_link
948 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
952 sub svc_part_pkg_link {
953 shift->_part_pkg_link('svc', @_);
957 my( $self, $type ) = @_;
958 qsearch({ table => 'part_pkg_link',
959 hashref => { 'src_pkgpart' => $self->pkgpart,
960 'link_type' => $type,
961 #protection against infinite recursive links
962 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
964 order_by => "ORDER BY hidden",
968 sub self_and_bill_linked {
969 shift->_self_and_linked('bill', @_);
972 sub _self_and_linked {
973 my( $self, $type, $hidden ) = @_;
977 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
978 $self->_part_pkg_link($type) ) )
980 $_->hidden($hidden) if $hidden;
987 =item part_pkg_taxoverride [ CLASS ]
989 Returns all associated FS::part_pkg_taxoverride objects (see
990 L<FS::part_pkg_taxoverride>). Limits the returned set to those
991 of class CLASS if defined. Class may be one of 'setup', 'recur',
992 the empty string (default), or a usage class number (see L<FS::usage_class>).
993 When a class is specified, the empty string class (default) is returned
994 if no more specific values exist.
998 sub part_pkg_taxoverride {
1002 my $hashref = { 'pkgpart' => $self->pkgpart };
1003 $hashref->{'usage_class'} = $class if defined($class);
1004 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1006 unless ( scalar(@overrides) || !defined($class) || !$class ){
1007 $hashref->{'usage_class'} = '';
1008 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1014 =item has_taxproduct
1016 Returns true if this package has any taxproduct associated with it.
1020 sub has_taxproduct {
1023 $self->taxproductnum ||
1024 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1025 keys %{ {$self->options} }
1031 =item taxproduct [ CLASS ]
1033 Returns the associated tax product for this package definition (see
1034 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1035 the usage classnum (see L<FS::usage_class>). Returns the default
1036 tax product for this record if the more specific CLASS value does
1045 my $part_pkg_taxproduct;
1047 my $taxproductnum = $self->taxproductnum;
1049 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1050 $taxproductnum = $class_taxproductnum
1051 if $class_taxproductnum
1054 $part_pkg_taxproduct =
1055 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1057 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1058 $taxproductnum = $self->taxproductnum;
1059 $part_pkg_taxproduct =
1060 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1063 $part_pkg_taxproduct;
1066 =item taxproduct_description [ CLASS ]
1068 Returns the description of the associated tax product for this package
1069 definition (see L<FS::part_pkg_taxproduct>).
1073 sub taxproduct_description {
1075 my $part_pkg_taxproduct = $self->taxproduct(@_);
1076 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1079 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1081 Returns the package to taxrate m2m records for this package in the location
1082 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1083 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1084 (see L<FS::usage_class>).
1088 sub _expand_cch_taxproductnum {
1091 my $part_pkg_taxproduct = $self->taxproduct($class);
1093 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1094 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1097 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1098 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1099 OR taxproduct = '$a:$b:$c:'
1100 OR taxproduct = '$a:$b:".":$d'
1101 OR taxproduct = '$a:$b:".":' )";
1102 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1103 'hashref' => { 'data_vendor'=>'cch' },
1104 'extra_sql' => $extra_sql,
1109 sub part_pkg_taxrate {
1111 my ($data_vendor, $geocode, $class) = @_;
1114 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1115 dbh->quote($data_vendor);
1117 # CCH oddness in m2m
1118 $extra_sql .= ' AND ('.
1119 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1123 # much more CCH oddness in m2m -- this is kludgy
1124 my @tpnums = $self->_expand_cch_taxproductnum($class);
1125 if (scalar(@tpnums)) {
1126 $extra_sql .= ' AND ('.
1127 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1130 $extra_sql .= ' AND ( 0 = 1 )';
1133 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1134 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1135 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1137 # should qsearch preface columns with the table to facilitate joins?
1138 qsearch( { 'table' => 'part_pkg_taxrate',
1139 'select' => $select,
1140 'hashref' => { # 'data_vendor' => $data_vendor,
1141 # 'taxproductnum' => $self->taxproductnum,
1143 'addl_from' => $addl_from,
1144 'extra_sql' => $extra_sql,
1145 'order_by' => $order_by,
1149 =item part_pkg_discount
1151 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1156 sub part_pkg_discount {
1158 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1163 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1164 PLAN is the object's I<plan> field. There should be better docs
1165 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1171 my $plan = $self->plan;
1173 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1177 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1178 my $class = ref($self). "::$plan";
1179 warn "reblessing $self into $class" if $DEBUG;
1182 bless($self, $class) unless $@;
1186 #fallbacks that eval the setup and recur fields, for backwards compat
1190 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1191 $self->_calc_eval('setup', @_);
1196 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1197 $self->_calc_eval('recur', @_);
1200 use vars qw( $sdate @details );
1202 #my( $self, $field, $cust_pkg ) = @_;
1203 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1205 *details = $detailsref;
1206 $self->$field() =~ /^(.*)$/
1207 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1208 $self->$field(). "\n";
1210 return 0 if $prog =~ /^\s*$/;
1211 my $value = eval $prog;
1216 #fallback that return 0 for old legacy packages with no plan
1218 sub calc_remain { 0; }
1219 sub calc_cancel { 0; }
1220 sub calc_units { 0; }
1222 #fallback for everything except bulk.pm
1223 sub hide_svc_detail { 0; }
1225 =item recur_cost_permonth CUST_PKG
1227 recur_cost divided by freq (only supported for monthly and longer frequencies)
1231 sub recur_cost_permonth {
1232 my($self, $cust_pkg) = @_;
1233 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1234 sprintf('%.2f', $self->recur_cost / $self->freq );
1237 =item format OPTION DATA
1239 Returns data formatted according to the function 'format' described
1240 in the plan info. Returns DATA if no such function exists.
1245 my ($self, $option, $data) = (shift, shift, shift);
1246 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1247 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1253 =item parse OPTION DATA
1255 Returns data parsed according to the function 'parse' described
1256 in the plan info. Returns DATA if no such function exists.
1261 my ($self, $option, $data) = (shift, shift, shift);
1262 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1263 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1273 =head1 CLASS METHODS
1281 # Used by FS::Upgrade to migrate to a new database.
1283 sub _upgrade_data { # class method
1284 my($class, %opts) = @_;
1286 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1288 my @part_pkg = qsearch({
1289 'table' => 'part_pkg',
1290 'extra_sql' => "WHERE ". join(' OR ',
1291 ( map "($_ IS NOT NULL AND $_ != '' )",
1292 qw( plandata setup recur ) ),
1293 'plan IS NULL', "plan = '' ",
1297 foreach my $part_pkg (@part_pkg) {
1299 unless ( $part_pkg->plan ) {
1300 $part_pkg->plan('flat');
1303 if ( length($part_pkg->option('setup_fee')) == 0
1304 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1306 my $opt = new FS::part_pkg_option {
1307 'pkgpart' => $part_pkg->pkgpart,
1308 'optionname' => 'setup_fee',
1309 'optionvalue' => $1,
1311 my $error = $opt->insert;
1312 die $error if $error;
1316 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1317 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1319 $part_pkg->setup('');
1321 if ( length($part_pkg->option('recur_fee')) == 0
1322 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1324 my $opt = new FS::part_pkg_option {
1325 'pkgpart' => $part_pkg->pkgpart,
1326 'optionname' => 'recur_fee',
1327 'optionvalue' => $1,
1329 my $error = $opt->insert;
1330 die $error if $error;
1334 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1335 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1337 $part_pkg->recur('');
1339 $part_pkg->replace; #this should take care of plandata, right?
1343 # now upgrade to the explicit custom flag
1345 @part_pkg = qsearch({
1346 'table' => 'part_pkg',
1347 'hashref' => { disabled => 'Y', custom => '' },
1348 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1351 foreach my $part_pkg (@part_pkg) {
1352 my $new = new FS::part_pkg { $part_pkg->hash };
1354 my $comment = $part_pkg->comment;
1355 $comment =~ s/^\(CUSTOM\) //;
1356 $comment = '(none)' unless $comment =~ /\S/;
1357 $new->comment($comment);
1359 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1360 my $primary = $part_pkg->svcpart;
1361 my $options = { $part_pkg->options };
1363 my $error = $new->replace( $part_pkg,
1364 'pkg_svc' => $pkg_svc,
1365 'primary_svc' => $primary,
1366 'options' => $options,
1368 die $error if $error;
1373 =item curuser_pkgs_sql
1375 Returns an SQL fragment for searching for packages the current user can
1376 use, either via part_pkg.agentnum directly, or via agent type (see
1381 sub curuser_pkgs_sql {
1384 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1388 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1390 Returns an SQL fragment for searching for packages the provided agent or agents
1391 can use, either via part_pkg.agentnum directly, or via agent type (see
1396 sub agent_pkgs_sql {
1397 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1398 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1400 $class->_pkgs_sql(@agentnums); #is this why
1405 my( $class, @agentnums ) = @_;
1406 my $agentnums = join(',', @agentnums);
1410 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1411 OR ( agentnum IS NULL
1412 AND EXISTS ( SELECT 1
1414 LEFT JOIN agent_type USING ( typenum )
1415 LEFT JOIN agent AS typeagent USING ( typenum )
1416 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1417 AND typeagent.agentnum IN ($agentnums)
1435 #false laziness w/part_export & cdr
1437 foreach my $INC ( @INC ) {
1438 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1439 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1440 warn "attempting to load plan info from $file\n" if $DEBUG;
1441 $file =~ /\/(\w+)\.pm$/ or do {
1442 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1446 my $info = eval "use FS::part_pkg::$mod; ".
1447 "\\%FS::part_pkg::$mod\::info;";
1449 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1452 unless ( keys %$info ) {
1453 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1456 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1457 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1458 warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1461 $info{$mod} = $info;
1465 tie %plans, 'Tie::IxHash',
1466 map { $_ => $info{$_} }
1467 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1477 =head1 NEW PLAN CLASSES
1479 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1480 found in eg/plan_template.pm. Until then, it is suggested that you use the
1481 other modules in FS/FS/part_pkg/ as a guide.
1485 The delete method is unimplemented.
1487 setup and recur semantics are not yet defined (and are implemented in
1488 FS::cust_bill. hmm.). now they're deprecated and need to go.
1492 part_pkg_taxrate is Pg specific
1494 replace should be smarter about managing the related tables (options, pkg_svc)
1498 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1499 schema.html from the base documentation.