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>)
109 Creates a new package definition. To add the package definition to
110 the database, see L<"insert">.
114 sub table { 'part_pkg'; }
118 An alternate constructor. Creates a new package definition by duplicating
119 an existing definition. A new pkgpart is assigned and the custom flag is
120 set to Y. To add the package definition to the database, see L<"insert">.
126 my $class = ref($self);
127 my %hash = $self->hash;
128 $hash{'pkgpart'} = '';
129 $hash{'custom'} = 'Y';
130 #new FS::part_pkg ( \%hash ); # ?
131 new $class ( \%hash ); # ?
134 =item insert [ , OPTION => VALUE ... ]
136 Adds this package definition to the database. If there is an error,
137 returns the error, otherwise returns false.
139 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
140 I<custnum_ref> and I<options>.
142 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
143 values, appropriate FS::pkg_svc records will be inserted.
145 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
146 FS::pkg_svc record will be updated.
148 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
149 record itself), the object will be updated to point to this package definition.
151 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
152 the scalar will be updated with the custnum value from the cust_pkg record.
154 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
155 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
156 records will be inserted.
158 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
159 records will be inserted.
166 warn "FS::part_pkg::insert called on $self with options ".
167 join(', ', map "$_=>$options{$_}", keys %options)
170 local $SIG{HUP} = 'IGNORE';
171 local $SIG{INT} = 'IGNORE';
172 local $SIG{QUIT} = 'IGNORE';
173 local $SIG{TERM} = 'IGNORE';
174 local $SIG{TSTP} = 'IGNORE';
175 local $SIG{PIPE} = 'IGNORE';
177 my $oldAutoCommit = $FS::UID::AutoCommit;
178 local $FS::UID::AutoCommit = 0;
181 warn " inserting part_pkg record" if $DEBUG;
182 my $error = $self->SUPER::insert( $options{options} );
184 $dbh->rollback if $oldAutoCommit;
188 my $conf = new FS::Conf;
189 if ( $conf->exists('agent_defaultpkg') ) {
190 warn " agent_defaultpkg set; allowing all agents to purchase package"
192 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
193 my $type_pkgs = new FS::type_pkgs({
194 'typenum' => $agent_type->typenum,
195 'pkgpart' => $self->pkgpart,
197 my $error = $type_pkgs->insert;
199 $dbh->rollback if $oldAutoCommit;
205 warn " inserting part_pkg_taxoverride records" if $DEBUG;
206 my %overrides = %{ $options{'tax_overrides'} || {} };
207 foreach my $usage_class ( keys %overrides ) {
209 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
210 ? $overrides{$usage_class}
212 my @overrides = (grep "$_", split(',', $override) );
213 my $error = $self->process_m2m (
214 'link_table' => 'part_pkg_taxoverride',
215 'target_table' => 'tax_class',
216 'hashref' => { 'usage_class' => $usage_class },
217 'params' => \@overrides,
220 $dbh->rollback if $oldAutoCommit;
225 unless ( $skip_pkg_svc_hack ) {
227 warn " inserting pkg_svc records" if $DEBUG;
228 my $pkg_svc = $options{'pkg_svc'} || {};
229 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
230 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
232 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
236 my $pkg_svc = new FS::pkg_svc( {
237 'pkgpart' => $self->pkgpart,
238 'svcpart' => $part_svc->svcpart,
239 'quantity' => $quantity,
240 'primary_svc' => $primary_svc,
242 my $error = $pkg_svc->insert;
244 $dbh->rollback if $oldAutoCommit;
251 if ( $options{'cust_pkg'} ) {
252 warn " updating cust_pkg record " if $DEBUG;
254 ref($options{'cust_pkg'})
255 ? $options{'cust_pkg'}
256 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
257 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
258 if $options{'custnum_ref'};
259 my %hash = $old_cust_pkg->hash;
260 $hash{'pkgpart'} = $self->pkgpart,
261 my $new_cust_pkg = new FS::cust_pkg \%hash;
262 local($FS::cust_pkg::disable_agentcheck) = 1;
263 my $error = $new_cust_pkg->replace($old_cust_pkg);
265 $dbh->rollback if $oldAutoCommit;
266 return "Error modifying cust_pkg record: $error";
270 warn " commiting transaction" if $DEBUG;
271 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
278 Currently unimplemented.
283 return "Can't (yet?) delete package definitions.";
284 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
287 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
289 Replaces OLD_RECORD with this one in the database. If there is an error,
290 returns the error, otherwise returns false.
292 Currently available options are: I<pkg_svc>, I<primary_svc> and I<options>
294 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
295 values, the appropriate FS::pkg_svc records will be replaced.
297 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
298 FS::pkg_svc record will be updated.
300 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
308 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
313 ( ref($_[0]) eq 'HASH' )
317 $options->{options} = {} unless defined($options->{options});
319 warn "FS::part_pkg::replace called on $new to replace $old with options".
320 join(', ', map "$_ => ". $options->{$_}, keys %$options)
323 local $SIG{HUP} = 'IGNORE';
324 local $SIG{INT} = 'IGNORE';
325 local $SIG{QUIT} = 'IGNORE';
326 local $SIG{TERM} = 'IGNORE';
327 local $SIG{TSTP} = 'IGNORE';
328 local $SIG{PIPE} = 'IGNORE';
330 my $oldAutoCommit = $FS::UID::AutoCommit;
331 local $FS::UID::AutoCommit = 0;
334 #plandata shit stays in replace for upgrades until after 2.0 (or edit
336 warn " saving legacy plandata" if $DEBUG;
337 my $plandata = $new->get('plandata');
338 $new->set('plandata', '');
340 warn " deleting old part_pkg_option records" if $DEBUG;
341 foreach my $part_pkg_option ( $old->part_pkg_option ) {
342 my $error = $part_pkg_option->delete;
344 $dbh->rollback if $oldAutoCommit;
349 warn " replacing part_pkg record" if $DEBUG;
350 my $error = $new->SUPER::replace($old, $options->{options} );
352 $dbh->rollback if $oldAutoCommit;
356 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
357 foreach my $part_pkg_option (
358 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
359 return "illegal plandata: $plandata";
361 new FS::part_pkg_option {
362 'pkgpart' => $new->pkgpart,
367 split("\n", $plandata)
369 my $error = $part_pkg_option->insert;
371 $dbh->rollback if $oldAutoCommit;
376 warn " replacing pkg_svc records" if $DEBUG;
377 my $pkg_svc = $options->{'pkg_svc'} || {};
378 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
379 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
381 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
382 && $options->{'primary_svc'} == $part_svc->svcpart
388 my $old_pkg_svc = qsearchs('pkg_svc', {
389 'pkgpart' => $old->pkgpart,
390 'svcpart' => $part_svc->svcpart,
392 my $old_quantity = $old_pkg_svc ? $old_pkg_svc->quantity : 0;
393 my $old_primary_svc =
394 ( $old_pkg_svc && $old_pkg_svc->dbdef_table->column('primary_svc') )
395 ? $old_pkg_svc->primary_svc
397 next unless $old_quantity != $quantity || $old_primary_svc ne $primary_svc;
399 my $new_pkg_svc = new FS::pkg_svc( {
400 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
401 'pkgpart' => $new->pkgpart,
402 'svcpart' => $part_svc->svcpart,
403 'quantity' => $quantity,
404 'primary_svc' => $primary_svc,
406 my $error = $old_pkg_svc
407 ? $new_pkg_svc->replace($old_pkg_svc)
408 : $new_pkg_svc->insert;
410 $dbh->rollback if $oldAutoCommit;
415 warn " commiting transaction" if $DEBUG;
416 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
422 Checks all fields to make sure this is a valid package definition. If
423 there is an error, returns the error, otherwise returns false. Called by the
424 insert and replace methods.
430 warn "FS::part_pkg::check called on $self" if $DEBUG;
432 for (qw(setup recur plandata)) {
433 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
434 return "Use of $_ field is deprecated; set a plan and options: ".
436 if length($self->get($_));
440 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
441 my $error = $self->ut_number('freq');
442 return $error if $error;
444 $self->freq =~ /^(\d+[hdw]?)$/
445 or return "Illegal or empty freq: ". $self->freq;
449 my @null_agentnum_right = ( 'Edit global package definitions' );
450 push @null_agentnum_right, 'One-time charge'
451 if $self->freq =~ /^0/;
452 push @null_agentnum_right, 'Customize customer package'
453 if $self->disabled eq 'Y'; #good enough
455 my $error = $self->ut_numbern('pkgpart')
456 || $self->ut_text('pkg')
457 || $self->ut_text('comment')
458 || $self->ut_textn('promo_code')
459 || $self->ut_alphan('plan')
460 || $self->ut_enum('setuptax', [ '', 'Y' ] )
461 || $self->ut_enum('recurtax', [ '', 'Y' ] )
462 || $self->ut_textn('taxclass')
463 || $self->ut_enum('disabled', [ '', 'Y' ] )
464 || $self->ut_enum('custom', [ '', 'Y' ] )
465 #|| $self->ut_moneyn('setup_cost')
466 #|| $self->ut_moneyn('recur_cost')
467 || $self->ut_floatn('setup_cost')
468 || $self->ut_floatn('recur_cost')
469 || $self->ut_floatn('pay_weight')
470 || $self->ut_floatn('credit_weight')
471 || $self->ut_numbern('taxproductnum')
472 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
473 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
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->SUPER::check
484 return $error if $error;
486 return 'Unknown plan '. $self->plan
487 unless exists($plans{$self->plan});
489 my $conf = new FS::Conf;
490 return 'Taxclass is required'
491 if ! $self->taxclass && $conf->exists('require_taxclasses');
496 =item pkg_comment [ OPTION => VALUE... ]
498 Returns an (internal) string representing this package. Currently,
499 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
500 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
503 If the option nopkgpart is true then the "pkgpart: ' is omitted.
511 #$self->pkg. ' - '. $self->comment;
512 #$self->pkg. ' ('. $self->comment. ')';
513 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
514 $pre. $self->pkg. ' - '. $self->custom_comment;
519 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment;
524 Returns the package class, as an FS::pkg_class object, or the empty string
525 if there is no package class.
531 if ( $self->classnum ) {
532 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
538 =item addon_pkg_class
540 Returns the add-on package class, as an FS::pkg_class object, or the empty
541 string if there is no add-on package class.
545 sub addon_pkg_class {
547 if ( $self->addon_classnum ) {
548 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
556 Returns the package category name, or the empty string if there is no package
563 my $pkg_class = $self->pkg_class;
565 ? $pkg_class->categoryname
571 Returns the package class name, or the empty string if there is no package
578 my $pkg_class = $self->pkg_class;
580 ? $pkg_class->classname
584 =item addon_classname
586 Returns the add-on package class name, or the empty string if there is no
587 add-on package class.
591 sub addon_classname {
593 my $pkg_class = $self->addon_pkg_class;
595 ? $pkg_class->classname
601 Returns the associated agent for this event, if any, as an FS::agent object.
607 qsearchs('agent', { 'agentnum' => $self->agentnum } );
610 =item pkg_svc [ HASHREF | OPTION => VALUE ]
612 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
613 definition (with non-zero quantity).
615 One option is available, I<disable_linked>. If set true it will return the
616 services for this package definition alone, omitting services from any add-on
623 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
630 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
636 # #sort { $b->primary cmp $a->primary }
637 # grep { $_->quantity }
638 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
640 my $opt = ref($_[0]) ? $_[0] : { @_ };
641 my %pkg_svc = map { $_->svcpart => $_ }
642 grep { $_->quantity }
643 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
645 unless ( $opt->{disable_linked} ) {
646 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
647 my @pkg_svc = grep { $_->quantity }
648 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
649 foreach my $pkg_svc ( @pkg_svc ) {
650 if ( $pkg_svc{$pkg_svc->svcpart} ) {
651 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
652 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
654 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
664 =item svcpart [ SVCDB ]
666 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
667 associated with this package definition (see L<FS::pkg_svc>). Returns
668 false if there not a primary service definition or exactly one service
669 definition with quantity 1, or if SVCDB is specified and does not match the
670 svcdb of the service definition. SVCDB can be specified as a scalar table
671 name, such as 'svc_acct', or as an arrayref of possible table names.
676 my $pkg_svc = shift->_primary_pkg_svc(@_);
677 $pkg_svc ? $pkg_svc->svcpart : '';
680 =item part_svc [ SVCDB ]
682 Like the B<svcpart> method, but returns the FS::part_svc object (see
688 my $pkg_svc = shift->_primary_pkg_svc(@_);
689 $pkg_svc ? $pkg_svc->part_svc : '';
692 sub _primary_pkg_svc {
695 my $svcdb = scalar(@_) ? shift : [];
696 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
697 my %svcdb = map { $_=>1 } @$svcdb;
700 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
703 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
704 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
706 return '' if scalar(@pkg_svc) != 1;
710 =item svcpart_unique_svcdb SVCDB
712 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
713 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
714 false if there not a primary service definition for SVCDB or there are multiple
715 service definitions for SVCDB.
719 sub svcpart_unique_svcdb {
720 my( $self, $svcdb ) = @_;
721 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
722 return '' if scalar(@svcdb_pkg_svc) != 1;
723 $svcdb_pkg_svc[0]->svcpart;
728 Returns a list of the acceptable payment types for this package. Eventually
729 this should come out of a database table and be editable, but currently has the
730 following logic instead:
732 If the package is free, the single item B<BILL> is
733 returned, otherwise, the single item B<CARD> is returned.
735 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
741 if ( $self->is_free ) {
750 Returns true if this package is free.
756 unless ( $self->plan ) {
757 $self->setup =~ /^\s*0+(\.0*)?\s*$/
758 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
759 } elsif ( $self->can('is_free_options') ) {
760 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
761 map { $self->option($_) }
762 $self->is_free_options;
764 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
765 "provides neither is_free_options nor is_free method; returning false";
772 #method, class method or sub? #my $self = shift;
774 tie my %freq, 'Tie::IxHash',
775 '0' => '(no recurring fee)',
778 '2d' => 'every two days',
779 '3d' => 'every three days',
781 '2w' => 'biweekly (every 2 weeks)',
783 '45d' => 'every 45 days',
784 '2' => 'bimonthly (every 2 months)',
785 '3' => 'quarterly (every 3 months)',
786 '4' => 'every 4 months',
787 '137d' => 'every 4 1/2 months (137 days)',
788 '6' => 'semiannually (every 6 months)',
790 '13' => 'every 13 months (annually +1 month)',
791 '24' => 'biannually (every 2 years)',
792 '36' => 'triannually (every 3 years)',
793 '48' => '(every 4 years)',
794 '60' => '(every 5 years)',
795 '120' => '(every 10 years)',
804 Returns an english representation of the I<freq> field, such as "monthly",
805 "weekly", "semi-annually", etc.
811 my $freq = $self->freq;
813 #my $freqs_href = $self->freqs_href;
814 my $freqs_href = freqs_href();
816 if ( exists($freqs_href->{$freq}) ) {
817 $freqs_href->{$freq};
819 my $interval = 'month';
820 if ( $freq =~ /^(\d+)([hdw])$/ ) {
821 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
822 $interval = $interval{$2};
827 "every $freq ${interval}s";
832 =item add_freq TIMESTAMP
834 Adds the frequency of this package to the provided timestamp and returns
835 the resulting timestamp, or -1 if the frequency of this package could not be
836 parsed (shouldn't happen).
841 my( $self, $date ) = @_;
842 my $freq = $self->freq;
844 #change this bit to use Date::Manip? CAREFUL with timezones (see
845 # mailing list archive)
846 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
848 if ( $self->freq =~ /^\d+$/ ) {
850 until ( $mon < 12 ) { $mon -= 12; $year++; }
851 } elsif ( $self->freq =~ /^(\d+)w$/ ) {
854 } elsif ( $self->freq =~ /^(\d+)d$/ ) {
857 } elsif ( $self->freq =~ /^(\d+)h$/ ) {
864 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
869 For backwards compatibility, returns the plandata field as well as all options
870 from FS::part_pkg_option.
876 carp "plandata is deprecated";
878 $self->SUPER::plandata(@_);
880 my $plandata = $self->get('plandata');
881 my %options = $self->options;
882 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
887 =item part_pkg_option
889 Returns all options as FS::part_pkg_option objects (see
890 L<FS::part_pkg_option>).
894 sub part_pkg_option {
896 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
901 Returns a list of option names and values suitable for assigning to a hash.
907 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
910 =item option OPTIONNAME
912 Returns the option value for the given name, or the empty string.
917 my( $self, $opt, $ornull ) = @_;
918 my $part_pkg_option =
919 qsearchs('part_pkg_option', {
920 pkgpart => $self->pkgpart,
923 return $part_pkg_option->optionvalue if $part_pkg_option;
924 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
925 split("\n", $self->get('plandata') );
926 return $plandata{$opt} if exists $plandata{$opt};
927 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
928 "not found in options or plandata!\n"
933 =item bill_part_pkg_link
935 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
939 sub bill_part_pkg_link {
940 shift->_part_pkg_link('bill', @_);
943 =item svc_part_pkg_link
945 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
949 sub svc_part_pkg_link {
950 shift->_part_pkg_link('svc', @_);
954 my( $self, $type ) = @_;
955 qsearch({ table => 'part_pkg_link',
956 hashref => { 'src_pkgpart' => $self->pkgpart,
957 'link_type' => $type,
959 order_by => "ORDER BY hidden",
963 sub self_and_bill_linked {
964 shift->_self_and_linked('bill', @_);
967 sub _self_and_linked {
968 my( $self, $type, $hidden ) = @_;
972 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
973 $self->_part_pkg_link($type) ) )
975 $_->hidden($hidden) if $hidden;
982 =item part_pkg_taxoverride [ CLASS ]
984 Returns all associated FS::part_pkg_taxoverride objects (see
985 L<FS::part_pkg_taxoverride>). Limits the returned set to those
986 of class CLASS if defined. Class may be one of 'setup', 'recur',
987 the empty string (default), or a usage class number (see L<FS::usage_class>).
988 When a class is specified, the empty string class (default) is returned
989 if no more specific values exist.
993 sub part_pkg_taxoverride {
997 my $hashref = { 'pkgpart' => $self->pkgpart };
998 $hashref->{'usage_class'} = $class if defined($class);
999 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1001 unless ( scalar(@overrides) || !defined($class) || !$class ){
1002 $hashref->{'usage_class'} = '';
1003 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1009 =item has_taxproduct
1011 Returns true if this package has any taxproduct associated with it.
1015 sub has_taxproduct {
1018 $self->taxproductnum ||
1019 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1020 keys %{ {$self->options} }
1026 =item taxproduct [ CLASS ]
1028 Returns the associated tax product for this package definition (see
1029 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1030 the usage classnum (see L<FS::usage_class>). Returns the default
1031 tax product for this record if the more specific CLASS value does
1040 my $part_pkg_taxproduct;
1042 my $taxproductnum = $self->taxproductnum;
1044 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1045 $taxproductnum = $class_taxproductnum
1046 if $class_taxproductnum
1049 $part_pkg_taxproduct =
1050 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1052 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1053 $taxproductnum = $self->taxproductnum;
1054 $part_pkg_taxproduct =
1055 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1058 $part_pkg_taxproduct;
1061 =item taxproduct_description [ CLASS ]
1063 Returns the description of the associated tax product for this package
1064 definition (see L<FS::part_pkg_taxproduct>).
1068 sub taxproduct_description {
1070 my $part_pkg_taxproduct = $self->taxproduct(@_);
1071 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1074 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1076 Returns the package to taxrate m2m records for this package in the location
1077 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1078 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1079 (see L<FS::usage_class>).
1083 sub _expand_cch_taxproductnum {
1086 my $part_pkg_taxproduct = $self->taxproduct($class);
1088 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1089 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1092 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1093 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1094 OR taxproduct = '$a:$b:$c:'
1095 OR taxproduct = '$a:$b:".":$d'
1096 OR taxproduct = '$a:$b:".":' )";
1097 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1098 'hashref' => { 'data_vendor'=>'cch' },
1099 'extra_sql' => $extra_sql,
1104 sub part_pkg_taxrate {
1106 my ($data_vendor, $geocode, $class) = @_;
1109 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1110 dbh->quote($data_vendor);
1112 # CCH oddness in m2m
1113 $extra_sql .= ' AND ('.
1114 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1118 # much more CCH oddness in m2m -- this is kludgy
1119 my @tpnums = $self->_expand_cch_taxproductnum($class);
1120 if (scalar(@tpnums)) {
1121 $extra_sql .= ' AND ('.
1122 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1125 $extra_sql .= ' AND ( 0 = 1 )';
1128 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1129 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1130 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1132 # should qsearch preface columns with the table to facilitate joins?
1133 qsearch( { 'table' => 'part_pkg_taxrate',
1134 'select' => $select,
1135 'hashref' => { # 'data_vendor' => $data_vendor,
1136 # 'taxproductnum' => $self->taxproductnum,
1138 'addl_from' => $addl_from,
1139 'extra_sql' => $extra_sql,
1140 'order_by' => $order_by,
1146 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1147 PLAN is the object's I<plan> field. There should be better docs
1148 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1154 my $plan = $self->plan;
1156 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1160 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1161 my $class = ref($self). "::$plan";
1162 warn "reblessing $self into $class" if $DEBUG;
1165 bless($self, $class) unless $@;
1169 #fallbacks that eval the setup and recur fields, for backwards compat
1173 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1174 $self->_calc_eval('setup', @_);
1179 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1180 $self->_calc_eval('recur', @_);
1183 use vars qw( $sdate @details );
1185 #my( $self, $field, $cust_pkg ) = @_;
1186 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1188 *details = $detailsref;
1189 $self->$field() =~ /^(.*)$/
1190 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1191 $self->$field(). "\n";
1193 return 0 if $prog =~ /^\s*$/;
1194 my $value = eval $prog;
1199 #fallback that return 0 for old legacy packages with no plan
1201 sub calc_remain { 0; }
1202 sub calc_cancel { 0; }
1203 sub calc_units { 0; }
1205 #fallback for everything except bulk.pm
1206 sub hide_svc_detail { 0; }
1208 =item format OPTION DATA
1210 Returns data formatted according to the function 'format' described
1211 in the plan info. Returns DATA if no such function exists.
1216 my ($self, $option, $data) = (shift, shift, shift);
1217 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1218 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1224 =item parse OPTION DATA
1226 Returns data parsed according to the function 'parse' described
1227 in the plan info. Returns DATA if no such function exists.
1232 my ($self, $option, $data) = (shift, shift, shift);
1233 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1234 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1244 =head1 CLASS METHODS
1252 # Used by FS::Upgrade to migrate to a new database.
1254 sub _upgrade_data { # class method
1255 my($class, %opts) = @_;
1257 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1259 my @part_pkg = qsearch({
1260 'table' => 'part_pkg',
1261 'extra_sql' => "WHERE ". join(' OR ',
1262 ( map "($_ IS NOT NULL AND $_ != '' )",
1263 qw( plandata setup recur ) ),
1264 'plan IS NULL', "plan = '' ",
1268 foreach my $part_pkg (@part_pkg) {
1270 unless ( $part_pkg->plan ) {
1271 $part_pkg->plan('flat');
1274 if ( length($part_pkg->option('setup_fee')) == 0
1275 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1277 my $opt = new FS::part_pkg_option {
1278 'pkgpart' => $part_pkg->pkgpart,
1279 'optionname' => 'setup_fee',
1280 'optionvalue' => $1,
1282 my $error = $opt->insert;
1283 die $error if $error;
1287 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1288 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1290 $part_pkg->setup('');
1292 if ( length($part_pkg->option('recur_fee')) == 0
1293 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1295 my $opt = new FS::part_pkg_option {
1296 'pkgpart' => $part_pkg->pkgpart,
1297 'optionname' => 'recur_fee',
1298 'optionvalue' => $1,
1300 my $error = $opt->insert;
1301 die $error if $error;
1305 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1306 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1308 $part_pkg->recur('');
1310 $part_pkg->replace; #this should take care of plandata, right?
1314 # now upgrade to the explicit custom flag
1316 @part_pkg = qsearch({
1317 'table' => 'part_pkg',
1318 'hashref' => { disabled => 'Y', custom => '' },
1319 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1322 foreach my $part_pkg (@part_pkg) {
1323 my $new = new FS::part_pkg { $part_pkg->hash };
1325 my $comment = $part_pkg->comment;
1326 $comment =~ s/^\(CUSTOM\) //;
1327 $comment = '(none)' unless $comment =~ /\S/;
1328 $new->comment($comment);
1330 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1331 my $primary = $part_pkg->svcpart;
1332 my $options = { $part_pkg->options };
1334 my $error = $new->replace( $part_pkg,
1335 'pkg_svc' => $pkg_svc,
1336 'primary_svc' => $primary,
1337 'options' => $options,
1339 die $error if $error;
1344 =item curuser_pkgs_sql
1346 Returns an SQL fragment for searching for packages the current user can
1347 use, either via part_pkg.agentnum directly, or via agent type (see
1352 sub curuser_pkgs_sql {
1355 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1359 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1361 Returns an SQL fragment for searching for packages the provided agent or agents
1362 can use, either via part_pkg.agentnum directly, or via agent type (see
1367 sub agent_pkgs_sql {
1368 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1369 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1371 $class->_pkgs_sql(@agentnums); #is this why
1376 my( $class, @agentnums ) = @_;
1377 my $agentnums = join(',', @agentnums);
1381 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1382 OR ( agentnum IS NULL
1383 AND EXISTS ( SELECT 1
1385 LEFT JOIN agent_type USING ( typenum )
1386 LEFT JOIN agent AS typeagent USING ( typenum )
1387 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1388 AND typeagent.agentnum IN ($agentnums)
1406 #false laziness w/part_export & cdr
1408 foreach my $INC ( @INC ) {
1409 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1410 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1411 warn "attempting to load plan info from $file\n" if $DEBUG;
1412 $file =~ /\/(\w+)\.pm$/ or do {
1413 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1417 my $info = eval "use FS::part_pkg::$mod; ".
1418 "\\%FS::part_pkg::$mod\::info;";
1420 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1423 unless ( keys %$info ) {
1424 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1427 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1428 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1429 warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1432 $info{$mod} = $info;
1436 tie %plans, 'Tie::IxHash',
1437 map { $_ => $info{$_} }
1438 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1448 =head1 NEW PLAN CLASSES
1450 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1451 found in eg/plan_template.pm. Until then, it is suggested that you use the
1452 other modules in FS/FS/part_pkg/ as a guide.
1456 The delete method is unimplemented.
1458 setup and recur semantics are not yet defined (and are implemented in
1459 FS::cust_bill. hmm.). now they're deprecated and need to go.
1463 part_pkg_taxrate is Pg specific
1465 replace should be smarter about managing the related tables (options, pkg_svc)
1469 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1470 schema.html from the base documentation.