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_taxoverride;
20 use FS::part_pkg_taxproduct;
21 use FS::part_pkg_link;
23 @ISA = qw( FS::m2m_Common FS::option_Common );
26 $skip_pkg_svc_hack = 0;
30 FS::part_pkg - Object methods for part_pkg objects
36 $record = new FS::part_pkg \%hash
37 $record = new FS::part_pkg { 'column' => 'value' };
39 $custom_record = $template_record->clone;
41 $error = $record->insert;
43 $error = $new_record->replace($old_record);
45 $error = $record->delete;
47 $error = $record->check;
49 @pkg_svc = $record->pkg_svc;
51 $svcnum = $record->svcpart;
52 $svcnum = $record->svcpart( 'svc_acct' );
56 An FS::part_pkg object represents a package definition. FS::part_pkg
57 inherits from FS::Record. The following fields are currently supported:
61 =item pkgpart - primary key (assigned automatically for new package definitions)
63 =item pkg - Text name of this package definition (customer-viewable)
65 =item comment - Text name of this package definition (non-customer-viewable)
67 =item classnum - Optional package class (see L<FS::pkg_class>)
69 =item promo_code - Promotional code
71 =item setup - Setup fee expression (deprecated)
73 =item freq - Frequency of recurring fee
75 =item recur - Recurring fee expression (deprecated)
77 =item setuptax - Setup fee tax exempt flag, empty or `Y'
79 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
81 =item taxclass - Tax class
83 =item plan - Price plan
85 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
87 =item disabled - Disabled flag, empty or `Y'
89 =item custom - Custom flag, empty or `Y'
91 =item setup_cost - for cost tracking
93 =item recur_cost - for cost tracking
95 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
97 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
99 =item agentnum - Optional agentnum (see L<FS::agent>)
101 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
111 Creates a new package definition. To add the package definition to
112 the database, see L<"insert">.
116 sub table { 'part_pkg'; }
120 An alternate constructor. Creates a new package definition by duplicating
121 an existing definition. A new pkgpart is assigned and the custom flag is
122 set to Y. To add the package definition to the database, see L<"insert">.
128 my $class = ref($self);
129 my %hash = $self->hash;
130 $hash{'pkgpart'} = '';
131 $hash{'custom'} = 'Y';
132 #new FS::part_pkg ( \%hash ); # ?
133 new $class ( \%hash ); # ?
136 =item insert [ , OPTION => VALUE ... ]
138 Adds this package definition to the database. If there is an error,
139 returns the error, otherwise returns false.
141 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
142 I<custnum_ref> and I<options>.
144 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
145 values, appropriate FS::pkg_svc records will be inserted.
147 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
148 FS::pkg_svc record will be updated.
150 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
151 record itself), the object will be updated to point to this package definition.
153 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
154 the scalar will be updated with the custnum value from the cust_pkg record.
156 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
157 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
158 records will be inserted.
160 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
161 records will be inserted.
168 warn "FS::part_pkg::insert called on $self with options ".
169 join(', ', map "$_=>$options{$_}", keys %options)
172 local $SIG{HUP} = 'IGNORE';
173 local $SIG{INT} = 'IGNORE';
174 local $SIG{QUIT} = 'IGNORE';
175 local $SIG{TERM} = 'IGNORE';
176 local $SIG{TSTP} = 'IGNORE';
177 local $SIG{PIPE} = 'IGNORE';
179 my $oldAutoCommit = $FS::UID::AutoCommit;
180 local $FS::UID::AutoCommit = 0;
183 warn " inserting part_pkg record" if $DEBUG;
184 my $error = $self->SUPER::insert( $options{options} );
186 $dbh->rollback if $oldAutoCommit;
190 my $conf = new FS::Conf;
191 if ( $conf->exists('agent_defaultpkg') ) {
192 warn " agent_defaultpkg set; allowing all agents to purchase package"
194 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
195 my $type_pkgs = new FS::type_pkgs({
196 'typenum' => $agent_type->typenum,
197 'pkgpart' => $self->pkgpart,
199 my $error = $type_pkgs->insert;
201 $dbh->rollback if $oldAutoCommit;
207 warn " inserting part_pkg_taxoverride records" if $DEBUG;
208 my %overrides = %{ $options{'tax_overrides'} || {} };
209 foreach my $usage_class ( keys %overrides ) {
211 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
212 ? $overrides{$usage_class}
214 my @overrides = (grep "$_", split(',', $override) );
215 my $error = $self->process_m2m (
216 'link_table' => 'part_pkg_taxoverride',
217 'target_table' => 'tax_class',
218 'hashref' => { 'usage_class' => $usage_class },
219 'params' => \@overrides,
222 $dbh->rollback if $oldAutoCommit;
227 unless ( $skip_pkg_svc_hack ) {
229 warn " inserting pkg_svc records" if $DEBUG;
230 my $pkg_svc = $options{'pkg_svc'} || {};
231 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
232 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
234 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
238 my $pkg_svc = new FS::pkg_svc( {
239 'pkgpart' => $self->pkgpart,
240 'svcpart' => $part_svc->svcpart,
241 'quantity' => $quantity,
242 'primary_svc' => $primary_svc,
244 my $error = $pkg_svc->insert;
246 $dbh->rollback if $oldAutoCommit;
253 if ( $options{'cust_pkg'} ) {
254 warn " updating cust_pkg record " if $DEBUG;
256 ref($options{'cust_pkg'})
257 ? $options{'cust_pkg'}
258 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
259 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
260 if $options{'custnum_ref'};
261 my %hash = $old_cust_pkg->hash;
262 $hash{'pkgpart'} = $self->pkgpart,
263 my $new_cust_pkg = new FS::cust_pkg \%hash;
264 local($FS::cust_pkg::disable_agentcheck) = 1;
265 my $error = $new_cust_pkg->replace($old_cust_pkg);
267 $dbh->rollback if $oldAutoCommit;
268 return "Error modifying cust_pkg record: $error";
272 warn " commiting transaction" if $DEBUG;
273 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
280 Currently unimplemented.
285 return "Can't (yet?) delete package definitions.";
286 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
289 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
291 Replaces OLD_RECORD with this one in the database. If there is an error,
292 returns the error, otherwise returns false.
294 Currently available options are: I<pkg_svc>, I<primary_svc> and I<options>
296 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
297 values, the appropriate FS::pkg_svc records will be replaced.
299 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
300 FS::pkg_svc record will be updated.
302 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
310 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
315 ( ref($_[0]) eq 'HASH' )
319 $options->{options} = {} unless defined($options->{options});
321 warn "FS::part_pkg::replace called on $new to replace $old with options".
322 join(', ', map "$_ => ". $options->{$_}, keys %$options)
325 local $SIG{HUP} = 'IGNORE';
326 local $SIG{INT} = 'IGNORE';
327 local $SIG{QUIT} = 'IGNORE';
328 local $SIG{TERM} = 'IGNORE';
329 local $SIG{TSTP} = 'IGNORE';
330 local $SIG{PIPE} = 'IGNORE';
332 my $oldAutoCommit = $FS::UID::AutoCommit;
333 local $FS::UID::AutoCommit = 0;
336 #plandata shit stays in replace for upgrades until after 2.0 (or edit
338 warn " saving legacy plandata" if $DEBUG;
339 my $plandata = $new->get('plandata');
340 $new->set('plandata', '');
342 warn " deleting old part_pkg_option records" if $DEBUG;
343 foreach my $part_pkg_option ( $old->part_pkg_option ) {
344 my $error = $part_pkg_option->delete;
346 $dbh->rollback if $oldAutoCommit;
351 warn " replacing part_pkg record" if $DEBUG;
352 my $error = $new->SUPER::replace($old, $options->{options} );
354 $dbh->rollback if $oldAutoCommit;
358 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
359 foreach my $part_pkg_option (
360 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
361 return "illegal plandata: $plandata";
363 new FS::part_pkg_option {
364 'pkgpart' => $new->pkgpart,
369 split("\n", $plandata)
371 my $error = $part_pkg_option->insert;
373 $dbh->rollback if $oldAutoCommit;
378 warn " replacing pkg_svc records" if $DEBUG;
379 my $pkg_svc = $options->{'pkg_svc'} || {};
380 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
381 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
383 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
384 && $options->{'primary_svc'} == $part_svc->svcpart
390 my $old_pkg_svc = qsearchs('pkg_svc', {
391 'pkgpart' => $old->pkgpart,
392 'svcpart' => $part_svc->svcpart,
394 my $old_quantity = $old_pkg_svc ? $old_pkg_svc->quantity : 0;
395 my $old_primary_svc =
396 ( $old_pkg_svc && $old_pkg_svc->dbdef_table->column('primary_svc') )
397 ? $old_pkg_svc->primary_svc
399 next unless $old_quantity != $quantity || $old_primary_svc ne $primary_svc;
401 my $new_pkg_svc = new FS::pkg_svc( {
402 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
403 'pkgpart' => $new->pkgpart,
404 'svcpart' => $part_svc->svcpart,
405 'quantity' => $quantity,
406 'primary_svc' => $primary_svc,
408 my $error = $old_pkg_svc
409 ? $new_pkg_svc->replace($old_pkg_svc)
410 : $new_pkg_svc->insert;
412 $dbh->rollback if $oldAutoCommit;
417 warn " commiting transaction" if $DEBUG;
418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
424 Checks all fields to make sure this is a valid package definition. If
425 there is an error, returns the error, otherwise returns false. Called by the
426 insert and replace methods.
432 warn "FS::part_pkg::check called on $self" if $DEBUG;
434 for (qw(setup recur plandata)) {
435 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
436 return "Use of $_ field is deprecated; set a plan and options: ".
438 if length($self->get($_));
442 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
443 my $error = $self->ut_number('freq');
444 return $error if $error;
446 $self->freq =~ /^(\d+[hdw]?)$/
447 or return "Illegal or empty freq: ". $self->freq;
451 my @null_agentnum_right = ( 'Edit global package definitions' );
452 push @null_agentnum_right, 'One-time charge'
453 if $self->freq =~ /^0/;
454 push @null_agentnum_right, 'Customize customer package'
455 if $self->disabled eq 'Y'; #good enough
457 my $error = $self->ut_numbern('pkgpart')
458 || $self->ut_text('pkg')
459 || $self->ut_text('comment')
460 || $self->ut_textn('promo_code')
461 || $self->ut_alphan('plan')
462 || $self->ut_enum('setuptax', [ '', 'Y' ] )
463 || $self->ut_enum('recurtax', [ '', 'Y' ] )
464 || $self->ut_textn('taxclass')
465 || $self->ut_enum('disabled', [ '', 'Y' ] )
466 || $self->ut_enum('custom', [ '', 'Y' ] )
467 #|| $self->ut_moneyn('setup_cost')
468 #|| $self->ut_moneyn('recur_cost')
469 || $self->ut_floatn('setup_cost')
470 || $self->ut_floatn('recur_cost')
471 || $self->ut_floatn('pay_weight')
472 || $self->ut_floatn('credit_weight')
473 || $self->ut_numbern('taxproductnum')
474 || $self->ut_foreign_keyn('taxproductnum',
475 'part_pkg_taxproduct',
479 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
480 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
482 || $self->ut_numbern('fcc_ds0s')
483 || $self->SUPER::check
485 return $error if $error;
487 if ( $self->classnum !~ /^$/ ) {
488 my $error = $self->ut_foreign_key('classnum', 'pkg_class', 'classnum');
489 return $error if $error;
494 return 'Unknown plan '. $self->plan
495 unless exists($plans{$self->plan});
497 my $conf = new FS::Conf;
498 return 'Taxclass is required'
499 if ! $self->taxclass && $conf->exists('require_taxclasses');
504 =item pkg_comment [ OPTION => VALUE... ]
506 Returns an (internal) string representing this package. Currently,
507 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
508 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
511 If the option nopkgpart is true then the "pkgpart: ' is omitted.
519 #$self->pkg. ' - '. $self->comment;
520 #$self->pkg. ' ('. $self->comment. ')';
521 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
522 $pre. $self->pkg. ' - '. $self->custom_comment;
527 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment;
532 Returns the package class, as an FS::pkg_class object, or the empty string
533 if there is no package class.
539 if ( $self->classnum ) {
540 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
548 Returns the package category name, or the empty string if there is no package
555 my $pkg_class = $self->pkg_class;
557 ? $pkg_class->categoryname
563 Returns the package class name, or the empty string if there is no package
570 my $pkg_class = $self->pkg_class;
572 ? $pkg_class->classname
578 Returns the associated agent for this event, if any, as an FS::agent object.
584 qsearchs('agent', { 'agentnum' => $self->agentnum } );
587 =item pkg_svc [ HASHREF | OPTION => VALUE ]
589 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
590 definition (with non-zero quantity).
592 One option is available, I<disable_linked>. If set true it will return the
593 services for this package definition alone, omitting services from any add-on
600 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
607 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
613 # #sort { $b->primary cmp $a->primary }
614 # grep { $_->quantity }
615 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
617 my $opt = ref($_[0]) ? $_[0] : { @_ };
618 my %pkg_svc = map { $_->svcpart => $_ }
619 grep { $_->quantity }
620 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
622 unless ( $opt->{disable_linked} ) {
623 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
624 my @pkg_svc = grep { $_->quantity }
625 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
626 foreach my $pkg_svc ( @pkg_svc ) {
627 if ( $pkg_svc{$pkg_svc->svcpart} ) {
628 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
629 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
631 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
641 =item svcpart [ SVCDB ]
643 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
644 associated with this package definition (see L<FS::pkg_svc>). Returns
645 false if there not a primary service definition or exactly one service
646 definition with quantity 1, or if SVCDB is specified and does not match the
647 svcdb of the service definition. SVCDB can be specified as a scalar table
648 name, such as 'svc_acct', or as an arrayref of possible table names.
653 my $pkg_svc = shift->_primary_pkg_svc(@_);
654 $pkg_svc ? $pkg_svc->svcpart : '';
657 =item part_svc [ SVCDB ]
659 Like the B<svcpart> method, but returns the FS::part_svc object (see
665 my $pkg_svc = shift->_primary_pkg_svc(@_);
666 $pkg_svc ? $pkg_svc->part_svc : '';
669 sub _primary_pkg_svc {
672 my $svcdb = scalar(@_) ? shift : [];
673 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
674 my %svcdb = map { $_=>1 } @$svcdb;
677 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
680 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
681 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
683 return '' if scalar(@pkg_svc) != 1;
687 =item svcpart_unique_svcdb SVCDB
689 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
690 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
691 false if there not a primary service definition for SVCDB or there are multiple
692 service definitions for SVCDB.
696 sub svcpart_unique_svcdb {
697 my( $self, $svcdb ) = @_;
698 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
699 return '' if scalar(@svcdb_pkg_svc) != 1;
700 $svcdb_pkg_svc[0]->svcpart;
705 Returns a list of the acceptable payment types for this package. Eventually
706 this should come out of a database table and be editable, but currently has the
707 following logic instead:
709 If the package is free, the single item B<BILL> is
710 returned, otherwise, the single item B<CARD> is returned.
712 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
718 if ( $self->is_free ) {
727 Returns true if this package is free.
733 unless ( $self->plan ) {
734 $self->setup =~ /^\s*0+(\.0*)?\s*$/
735 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
736 } elsif ( $self->can('is_free_options') ) {
737 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
738 map { $self->option($_) }
739 $self->is_free_options;
741 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
742 "provides neither is_free_options nor is_free method; returning false";
749 # moved to FS::Misc to make this accessible to other packages
751 FS::Misc::pkg_freqs();
756 Returns an english representation of the I<freq> field, such as "monthly",
757 "weekly", "semi-annually", etc.
763 my $freq = $self->freq;
765 #my $freqs_href = $self->freqs_href;
766 my $freqs_href = freqs_href();
768 if ( exists($freqs_href->{$freq}) ) {
769 $freqs_href->{$freq};
771 my $interval = 'month';
772 if ( $freq =~ /^(\d+)([hdw])$/ ) {
773 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
774 $interval = $interval{$2};
779 "every $freq ${interval}s";
784 =item add_freq TIMESTAMP
786 Adds the frequency of this package to the provided timestamp and returns
787 the resulting timestamp, or -1 if the frequency of this package could not be
788 parsed (shouldn't happen).
793 my( $self, $date ) = @_;
794 my $freq = $self->freq;
796 #change this bit to use Date::Manip? CAREFUL with timezones (see
797 # mailing list archive)
798 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
800 if ( $self->freq =~ /^\d+$/ ) {
802 until ( $mon < 12 ) { $mon -= 12; $year++; }
803 } elsif ( $self->freq =~ /^(\d+)w$/ ) {
806 } elsif ( $self->freq =~ /^(\d+)d$/ ) {
809 } elsif ( $self->freq =~ /^(\d+)h$/ ) {
816 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
821 For backwards compatibility, returns the plandata field as well as all options
822 from FS::part_pkg_option.
828 carp "plandata is deprecated";
830 $self->SUPER::plandata(@_);
832 my $plandata = $self->get('plandata');
833 my %options = $self->options;
834 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
839 =item part_pkg_option
841 Returns all options as FS::part_pkg_option objects (see
842 L<FS::part_pkg_option>).
846 sub part_pkg_option {
848 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
853 Returns a list of option names and values suitable for assigning to a hash.
859 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
862 =item option OPTIONNAME
864 Returns the option value for the given name, or the empty string.
869 my( $self, $opt, $ornull ) = @_;
870 my $part_pkg_option =
871 qsearchs('part_pkg_option', {
872 pkgpart => $self->pkgpart,
875 return $part_pkg_option->optionvalue if $part_pkg_option;
876 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
877 split("\n", $self->get('plandata') );
878 return $plandata{$opt} if exists $plandata{$opt};
879 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
880 "not found in options or plandata!\n"
885 =item bill_part_pkg_link
887 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
891 sub bill_part_pkg_link {
892 shift->_part_pkg_link('bill', @_);
895 =item svc_part_pkg_link
897 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
901 sub svc_part_pkg_link {
902 shift->_part_pkg_link('svc', @_);
906 my( $self, $type ) = @_;
907 qsearch({ table => 'part_pkg_link',
908 hashref => { 'src_pkgpart' => $self->pkgpart,
909 'link_type' => $type,
911 order_by => "ORDER BY hidden",
915 sub self_and_bill_linked {
916 shift->_self_and_linked('bill', @_);
919 sub _self_and_linked {
920 my( $self, $type, $hidden ) = @_;
924 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
925 $self->_part_pkg_link($type) ) )
927 $_->hidden($hidden) if $hidden;
934 =item part_pkg_taxoverride [ CLASS ]
936 Returns all associated FS::part_pkg_taxoverride objects (see
937 L<FS::part_pkg_taxoverride>). Limits the returned set to those
938 of class CLASS if defined. Class may be one of 'setup', 'recur',
939 the empty string (default), or a usage class number (see L<FS::usage_class>).
940 When a class is specified, the empty string class (default) is returned
941 if no more specific values exist.
945 sub part_pkg_taxoverride {
949 my $hashref = { 'pkgpart' => $self->pkgpart };
950 $hashref->{'usage_class'} = $class if defined($class);
951 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
953 unless ( scalar(@overrides) || !defined($class) || !$class ){
954 $hashref->{'usage_class'} = '';
955 @overrides = qsearch('part_pkg_taxoverride', $hashref );
963 Returns true if this package has any taxproduct associated with it.
970 $self->taxproductnum ||
971 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
972 keys %{ {$self->options} }
978 =item taxproduct [ CLASS ]
980 Returns the associated tax product for this package definition (see
981 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
982 the usage classnum (see L<FS::usage_class>). Returns the default
983 tax product for this record if the more specific CLASS value does
992 my $part_pkg_taxproduct;
994 my $taxproductnum = $self->taxproductnum;
996 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
997 $taxproductnum = $class_taxproductnum
998 if $class_taxproductnum
1001 $part_pkg_taxproduct =
1002 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1004 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1005 $taxproductnum = $self->taxproductnum;
1006 $part_pkg_taxproduct =
1007 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1010 $part_pkg_taxproduct;
1013 =item taxproduct_description [ CLASS ]
1015 Returns the description of the associated tax product for this package
1016 definition (see L<FS::part_pkg_taxproduct>).
1020 sub taxproduct_description {
1022 my $part_pkg_taxproduct = $self->taxproduct(@_);
1023 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1026 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1028 Returns the package to taxrate m2m records for this package in the location
1029 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1030 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1031 (see L<FS::usage_class>).
1035 sub _expand_cch_taxproductnum {
1038 my $part_pkg_taxproduct = $self->taxproduct($class);
1040 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1041 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1044 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1045 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1046 OR taxproduct = '$a:$b:$c:'
1047 OR taxproduct = '$a:$b:".":$d'
1048 OR taxproduct = '$a:$b:".":' )";
1049 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1050 'hashref' => { 'data_vendor'=>'cch' },
1051 'extra_sql' => $extra_sql,
1056 sub part_pkg_taxrate {
1058 my ($data_vendor, $geocode, $class) = @_;
1061 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1062 dbh->quote($data_vendor);
1064 # CCH oddness in m2m
1065 $extra_sql .= ' AND ('.
1066 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1070 # much more CCH oddness in m2m -- this is kludgy
1071 my @tpnums = $self->_expand_cch_taxproductnum($class);
1072 if (scalar(@tpnums)) {
1073 $extra_sql .= ' AND ('.
1074 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1077 $extra_sql .= ' AND ( 0 = 1 )';
1080 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1081 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1082 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1084 # should qsearch preface columns with the table to facilitate joins?
1085 qsearch( { 'table' => 'part_pkg_taxrate',
1086 'select' => $select,
1087 'hashref' => { # 'data_vendor' => $data_vendor,
1088 # 'taxproductnum' => $self->taxproductnum,
1090 'addl_from' => $addl_from,
1091 'extra_sql' => $extra_sql,
1092 'order_by' => $order_by,
1098 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1099 PLAN is the object's I<plan> field. There should be better docs
1100 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1106 my $plan = $self->plan;
1108 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1112 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1113 my $class = ref($self). "::$plan";
1114 warn "reblessing $self into $class" if $DEBUG;
1117 bless($self, $class) unless $@;
1121 #fallbacks that eval the setup and recur fields, for backwards compat
1125 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1126 $self->_calc_eval('setup', @_);
1131 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1132 $self->_calc_eval('recur', @_);
1135 use vars qw( $sdate @details );
1137 #my( $self, $field, $cust_pkg ) = @_;
1138 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1140 *details = $detailsref;
1141 $self->$field() =~ /^(.*)$/
1142 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1143 $self->$field(). "\n";
1145 return 0 if $prog =~ /^\s*$/;
1146 my $value = eval $prog;
1151 #fallback that return 0 for old legacy packages with no plan
1153 sub calc_remain { 0; }
1154 sub calc_cancel { 0; }
1155 sub calc_units { 0; }
1157 #fallback for everything except bulk.pm
1158 sub hide_svc_detail { 0; }
1160 =item recur_cost_permonth CUST_PKG
1162 recur_cost divided by freq (only supported for monthly and longer frequencies)
1166 sub recur_cost_permonth {
1167 my($self, $cust_pkg) = @_;
1168 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1169 sprintf('%.2f', $self->recur_cost / $self->freq );
1172 =item format OPTION DATA
1174 Returns data formatted according to the function 'format' described
1175 in the plan info. Returns DATA if no such function exists.
1180 my ($self, $option, $data) = (shift, shift, shift);
1181 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1182 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1188 =item parse OPTION DATA
1190 Returns data parsed according to the function 'parse' described
1191 in the plan info. Returns DATA if no such function exists.
1196 my ($self, $option, $data) = (shift, shift, shift);
1197 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1198 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1208 =head1 CLASS METHODS
1216 # Used by FS::Upgrade to migrate to a new database.
1218 sub _upgrade_data { # class method
1219 my($class, %opts) = @_;
1221 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1223 my @part_pkg = qsearch({
1224 'table' => 'part_pkg',
1225 'extra_sql' => "WHERE ". join(' OR ',
1226 ( map "($_ IS NOT NULL AND $_ != '' )",
1227 qw( plandata setup recur ) ),
1228 'plan IS NULL', "plan = '' ",
1232 foreach my $part_pkg (@part_pkg) {
1234 unless ( $part_pkg->plan ) {
1235 $part_pkg->plan('flat');
1238 if ( length($part_pkg->option('setup_fee')) == 0
1239 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1241 my $opt = new FS::part_pkg_option {
1242 'pkgpart' => $part_pkg->pkgpart,
1243 'optionname' => 'setup_fee',
1244 'optionvalue' => $1,
1246 my $error = $opt->insert;
1247 die $error if $error;
1251 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1252 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1254 $part_pkg->setup('');
1256 if ( length($part_pkg->option('recur_fee')) == 0
1257 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1259 my $opt = new FS::part_pkg_option {
1260 'pkgpart' => $part_pkg->pkgpart,
1261 'optionname' => 'recur_fee',
1262 'optionvalue' => $1,
1264 my $error = $opt->insert;
1265 die $error if $error;
1269 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1270 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1272 $part_pkg->recur('');
1274 $part_pkg->replace; #this should take care of plandata, right?
1278 # now upgrade to the explicit custom flag
1280 @part_pkg = qsearch({
1281 'table' => 'part_pkg',
1282 'hashref' => { disabled => 'Y', custom => '' },
1283 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1286 foreach my $part_pkg (@part_pkg) {
1287 my $new = new FS::part_pkg { $part_pkg->hash };
1289 my $comment = $part_pkg->comment;
1290 $comment =~ s/^\(CUSTOM\) //;
1291 $comment = '(none)' unless $comment =~ /\S/;
1292 $new->comment($comment);
1294 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1295 my $primary = $part_pkg->svcpart;
1296 my $options = { $part_pkg->options };
1298 my $error = $new->replace( $part_pkg,
1299 'pkg_svc' => $pkg_svc,
1300 'primary_svc' => $primary,
1301 'options' => $options,
1303 die $error if $error;
1308 =item curuser_pkgs_sql
1310 Returns an SQL fragment for searching for packages the current user can
1311 use, either via part_pkg.agentnum directly, or via agent type (see
1316 sub curuser_pkgs_sql {
1319 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1323 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1325 Returns an SQL fragment for searching for packages the provided agent or agents
1326 can use, either via part_pkg.agentnum directly, or via agent type (see
1331 sub agent_pkgs_sql {
1332 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1333 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1335 $class->_pkgs_sql(@agentnums); #is this why
1340 my( $class, @agentnums ) = @_;
1341 my $agentnums = join(',', @agentnums);
1345 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1346 OR ( agentnum IS NULL
1347 AND EXISTS ( SELECT 1
1349 LEFT JOIN agent_type USING ( typenum )
1350 LEFT JOIN agent AS typeagent USING ( typenum )
1351 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1352 AND typeagent.agentnum IN ($agentnums)
1370 #false laziness w/part_export & cdr
1372 foreach my $INC ( @INC ) {
1373 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1374 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1375 warn "attempting to load plan info from $file\n" if $DEBUG;
1376 $file =~ /\/(\w+)\.pm$/ or do {
1377 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1381 my $info = eval "use FS::part_pkg::$mod; ".
1382 "\\%FS::part_pkg::$mod\::info;";
1384 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1387 unless ( keys %$info ) {
1388 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1391 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1392 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1393 warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1396 $info{$mod} = $info;
1400 tie %plans, 'Tie::IxHash',
1401 map { $_ => $info{$_} }
1402 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1412 =head1 NEW PLAN CLASSES
1414 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1415 found in eg/plan_template.pm. Until then, it is suggested that you use the
1416 other modules in FS/FS/part_pkg/ as a guide.
1420 The delete method is unimplemented.
1422 setup and recur semantics are not yet defined (and are implemented in
1423 FS::cust_bill. hmm.). now they're deprecated and need to go.
1427 part_pkg_taxrate is Pg specific
1429 replace should be smarter about managing the related tables (options, pkg_svc)
1433 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1434 schema.html from the base documentation.