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;
540 sub price_info { # safety, in case a part_pkg hasn't defined price_info
546 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment . ' ' . $self->price_info;
551 Returns the package class, as an FS::pkg_class object, or the empty string
552 if there is no package class.
558 if ( $self->classnum ) {
559 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
565 =item addon_pkg_class
567 Returns the add-on package class, as an FS::pkg_class object, or the empty
568 string if there is no add-on package class.
572 sub addon_pkg_class {
574 if ( $self->addon_classnum ) {
575 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
583 Returns the package category name, or the empty string if there is no package
590 my $pkg_class = $self->pkg_class;
592 ? $pkg_class->categoryname
598 Returns the package class name, or the empty string if there is no package
605 my $pkg_class = $self->pkg_class;
607 ? $pkg_class->classname
611 =item addon_classname
613 Returns the add-on package class name, or the empty string if there is no
614 add-on package class.
618 sub addon_classname {
620 my $pkg_class = $self->addon_pkg_class;
622 ? $pkg_class->classname
628 Returns the associated agent for this event, if any, as an FS::agent object.
634 qsearchs('agent', { 'agentnum' => $self->agentnum } );
637 =item pkg_svc [ HASHREF | OPTION => VALUE ]
639 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
640 definition (with non-zero quantity).
642 One option is available, I<disable_linked>. If set true it will return the
643 services for this package definition alone, omitting services from any add-on
650 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
657 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
663 # #sort { $b->primary cmp $a->primary }
664 # grep { $_->quantity }
665 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
667 my $opt = ref($_[0]) ? $_[0] : { @_ };
668 my %pkg_svc = map { $_->svcpart => $_ }
669 grep { $_->quantity }
670 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
672 unless ( $opt->{disable_linked} ) {
673 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
674 my @pkg_svc = grep { $_->quantity }
675 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
676 foreach my $pkg_svc ( @pkg_svc ) {
677 if ( $pkg_svc{$pkg_svc->svcpart} ) {
678 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
679 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
681 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
691 =item svcpart [ SVCDB ]
693 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
694 associated with this package definition (see L<FS::pkg_svc>). Returns
695 false if there not a primary service definition or exactly one service
696 definition with quantity 1, or if SVCDB is specified and does not match the
697 svcdb of the service definition. SVCDB can be specified as a scalar table
698 name, such as 'svc_acct', or as an arrayref of possible table names.
703 my $pkg_svc = shift->_primary_pkg_svc(@_);
704 $pkg_svc ? $pkg_svc->svcpart : '';
707 =item part_svc [ SVCDB ]
709 Like the B<svcpart> method, but returns the FS::part_svc object (see
715 my $pkg_svc = shift->_primary_pkg_svc(@_);
716 $pkg_svc ? $pkg_svc->part_svc : '';
719 sub _primary_pkg_svc {
722 my $svcdb = scalar(@_) ? shift : [];
723 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
724 my %svcdb = map { $_=>1 } @$svcdb;
727 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
730 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
731 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
733 return '' if scalar(@pkg_svc) != 1;
737 =item svcpart_unique_svcdb SVCDB
739 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
740 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
741 false if there not a primary service definition for SVCDB or there are multiple
742 service definitions for SVCDB.
746 sub svcpart_unique_svcdb {
747 my( $self, $svcdb ) = @_;
748 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
749 return '' if scalar(@svcdb_pkg_svc) != 1;
750 $svcdb_pkg_svc[0]->svcpart;
755 Returns a list of the acceptable payment types for this package. Eventually
756 this should come out of a database table and be editable, but currently has the
757 following logic instead:
759 If the package is free, the single item B<BILL> is
760 returned, otherwise, the single item B<CARD> is returned.
762 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
768 if ( $self->is_free ) {
777 Returns true if this package is free.
783 unless ( $self->plan ) {
784 $self->setup =~ /^\s*0+(\.0*)?\s*$/
785 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
786 } elsif ( $self->can('is_free_options') ) {
787 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
788 map { $self->option($_) }
789 $self->is_free_options;
791 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
792 "provides neither is_free_options nor is_free method; returning false";
797 sub can_discount { 0; }
800 # moved to FS::Misc to make this accessible to other packages
802 FS::Misc::pkg_freqs();
807 Returns an english representation of the I<freq> field, such as "monthly",
808 "weekly", "semi-annually", etc.
814 my $freq = $self->freq;
816 #my $freqs_href = $self->freqs_href;
817 my $freqs_href = freqs_href();
819 if ( exists($freqs_href->{$freq}) ) {
820 $freqs_href->{$freq};
822 my $interval = 'month';
823 if ( $freq =~ /^(\d+)([hdw])$/ ) {
824 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
825 $interval = $interval{$2};
830 "every $freq ${interval}s";
835 =item add_freq TIMESTAMP [ FREQ ]
837 Adds a billing period of some frequency to the provided timestamp and
838 returns the resulting timestamp, or -1 if the frequency could not be
839 parsed (shouldn't happen). By default, the frequency of this package
840 will be used; to override this, pass a different frequency as a second
846 my( $self, $date, $freq ) = @_;
847 $freq = $self->freq unless $freq;
849 #change this bit to use Date::Manip? CAREFUL with timezones (see
850 # mailing list archive)
851 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
853 if ( $freq =~ /^\d+$/ ) {
855 until ( $mon < 12 ) { $mon -= 12; $year++; }
856 } elsif ( $freq =~ /^(\d+)w$/ ) {
859 } elsif ( $freq =~ /^(\d+)d$/ ) {
862 } elsif ( $freq =~ /^(\d+)h$/ ) {
869 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
874 For backwards compatibility, returns the plandata field as well as all options
875 from FS::part_pkg_option.
881 carp "plandata is deprecated";
883 $self->SUPER::plandata(@_);
885 my $plandata = $self->get('plandata');
886 my %options = $self->options;
887 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
892 =item part_pkg_option
894 Returns all options as FS::part_pkg_option objects (see
895 L<FS::part_pkg_option>).
899 sub part_pkg_option {
901 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
906 Returns a list of option names and values suitable for assigning to a hash.
912 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
915 =item option OPTIONNAME [ QUIET ]
917 Returns the option value for the given name, or the empty string. If a true
918 value is passed as the second argument, warnings about missing the option
924 my( $self, $opt, $ornull ) = @_;
925 my $part_pkg_option =
926 qsearchs('part_pkg_option', {
927 pkgpart => $self->pkgpart,
930 return $part_pkg_option->optionvalue if $part_pkg_option;
931 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
932 split("\n", $self->get('plandata') );
933 return $plandata{$opt} if exists $plandata{$opt};
934 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
935 "not found in options or plandata!\n"
940 =item bill_part_pkg_link
942 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
946 sub bill_part_pkg_link {
947 shift->_part_pkg_link('bill', @_);
950 =item svc_part_pkg_link
952 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
956 sub svc_part_pkg_link {
957 shift->_part_pkg_link('svc', @_);
961 my( $self, $type ) = @_;
962 qsearch({ table => 'part_pkg_link',
963 hashref => { 'src_pkgpart' => $self->pkgpart,
964 'link_type' => $type,
965 #protection against infinite recursive links
966 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
968 order_by => "ORDER BY hidden",
972 sub self_and_bill_linked {
973 shift->_self_and_linked('bill', @_);
976 sub _self_and_linked {
977 my( $self, $type, $hidden ) = @_;
981 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
982 $self->_part_pkg_link($type) ) )
984 $_->hidden($hidden) if $hidden;
991 =item part_pkg_taxoverride [ CLASS ]
993 Returns all associated FS::part_pkg_taxoverride objects (see
994 L<FS::part_pkg_taxoverride>). Limits the returned set to those
995 of class CLASS if defined. Class may be one of 'setup', 'recur',
996 the empty string (default), or a usage class number (see L<FS::usage_class>).
997 When a class is specified, the empty string class (default) is returned
998 if no more specific values exist.
1002 sub part_pkg_taxoverride {
1006 my $hashref = { 'pkgpart' => $self->pkgpart };
1007 $hashref->{'usage_class'} = $class if defined($class);
1008 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1010 unless ( scalar(@overrides) || !defined($class) || !$class ){
1011 $hashref->{'usage_class'} = '';
1012 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1018 =item has_taxproduct
1020 Returns true if this package has any taxproduct associated with it.
1024 sub has_taxproduct {
1027 $self->taxproductnum ||
1028 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1029 keys %{ {$self->options} }
1035 =item taxproduct [ CLASS ]
1037 Returns the associated tax product for this package definition (see
1038 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1039 the usage classnum (see L<FS::usage_class>). Returns the default
1040 tax product for this record if the more specific CLASS value does
1049 my $part_pkg_taxproduct;
1051 my $taxproductnum = $self->taxproductnum;
1053 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1054 $taxproductnum = $class_taxproductnum
1055 if $class_taxproductnum
1058 $part_pkg_taxproduct =
1059 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1061 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1062 $taxproductnum = $self->taxproductnum;
1063 $part_pkg_taxproduct =
1064 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1067 $part_pkg_taxproduct;
1070 =item taxproduct_description [ CLASS ]
1072 Returns the description of the associated tax product for this package
1073 definition (see L<FS::part_pkg_taxproduct>).
1077 sub taxproduct_description {
1079 my $part_pkg_taxproduct = $self->taxproduct(@_);
1080 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1083 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1085 Returns the package to taxrate m2m records for this package in the location
1086 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1087 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1088 (see L<FS::usage_class>).
1092 sub _expand_cch_taxproductnum {
1095 my $part_pkg_taxproduct = $self->taxproduct($class);
1097 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1098 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1101 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1102 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1103 OR taxproduct = '$a:$b:$c:'
1104 OR taxproduct = '$a:$b:".":$d'
1105 OR taxproduct = '$a:$b:".":' )";
1106 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1107 'hashref' => { 'data_vendor'=>'cch' },
1108 'extra_sql' => $extra_sql,
1113 sub part_pkg_taxrate {
1115 my ($data_vendor, $geocode, $class) = @_;
1118 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1119 dbh->quote($data_vendor);
1121 # CCH oddness in m2m
1122 $extra_sql .= ' AND ('.
1123 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1127 # much more CCH oddness in m2m -- this is kludgy
1128 my @tpnums = $self->_expand_cch_taxproductnum($class);
1129 if (scalar(@tpnums)) {
1130 $extra_sql .= ' AND ('.
1131 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1134 $extra_sql .= ' AND ( 0 = 1 )';
1137 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1138 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1139 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1141 # should qsearch preface columns with the table to facilitate joins?
1142 qsearch( { 'table' => 'part_pkg_taxrate',
1143 'select' => $select,
1144 'hashref' => { # 'data_vendor' => $data_vendor,
1145 # 'taxproductnum' => $self->taxproductnum,
1147 'addl_from' => $addl_from,
1148 'extra_sql' => $extra_sql,
1149 'order_by' => $order_by,
1153 =item part_pkg_discount
1155 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1160 sub part_pkg_discount {
1162 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1167 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1168 PLAN is the object's I<plan> field. There should be better docs
1169 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1175 my $plan = $self->plan;
1177 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1181 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1182 my $class = ref($self). "::$plan";
1183 warn "reblessing $self into $class" if $DEBUG;
1186 bless($self, $class) unless $@;
1190 #fallbacks that eval the setup and recur fields, for backwards compat
1194 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1195 $self->_calc_eval('setup', @_);
1200 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1201 $self->_calc_eval('recur', @_);
1204 use vars qw( $sdate @details );
1206 #my( $self, $field, $cust_pkg ) = @_;
1207 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1209 *details = $detailsref;
1210 $self->$field() =~ /^(.*)$/
1211 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1212 $self->$field(). "\n";
1214 return 0 if $prog =~ /^\s*$/;
1215 my $value = eval $prog;
1220 #fallback that return 0 for old legacy packages with no plan
1222 sub calc_remain { 0; }
1223 sub calc_cancel { 0; }
1224 sub calc_units { 0; }
1226 #fallback for everything except bulk.pm
1227 sub hide_svc_detail { 0; }
1229 =item recur_cost_permonth CUST_PKG
1231 recur_cost divided by freq (only supported for monthly and longer frequencies)
1235 sub recur_cost_permonth {
1236 my($self, $cust_pkg) = @_;
1237 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1238 sprintf('%.2f', $self->recur_cost / $self->freq );
1241 =item format OPTION DATA
1243 Returns data formatted according to the function 'format' described
1244 in the plan info. Returns DATA if no such function exists.
1249 my ($self, $option, $data) = (shift, shift, shift);
1250 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1251 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1257 =item parse OPTION DATA
1259 Returns data parsed according to the function 'parse' described
1260 in the plan info. Returns DATA if no such function exists.
1265 my ($self, $option, $data) = (shift, shift, shift);
1266 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1267 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1277 =head1 CLASS METHODS
1285 # Used by FS::Upgrade to migrate to a new database.
1287 sub _upgrade_data { # class method
1288 my($class, %opts) = @_;
1290 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1292 my @part_pkg = qsearch({
1293 'table' => 'part_pkg',
1294 'extra_sql' => "WHERE ". join(' OR ',
1295 ( map "($_ IS NOT NULL AND $_ != '' )",
1296 qw( plandata setup recur ) ),
1297 'plan IS NULL', "plan = '' ",
1301 foreach my $part_pkg (@part_pkg) {
1303 unless ( $part_pkg->plan ) {
1304 $part_pkg->plan('flat');
1307 if ( length($part_pkg->option('setup_fee')) == 0
1308 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1310 my $opt = new FS::part_pkg_option {
1311 'pkgpart' => $part_pkg->pkgpart,
1312 'optionname' => 'setup_fee',
1313 'optionvalue' => $1,
1315 my $error = $opt->insert;
1316 die $error if $error;
1320 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1321 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1323 $part_pkg->setup('');
1325 if ( length($part_pkg->option('recur_fee')) == 0
1326 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1328 my $opt = new FS::part_pkg_option {
1329 'pkgpart' => $part_pkg->pkgpart,
1330 'optionname' => 'recur_fee',
1331 'optionvalue' => $1,
1333 my $error = $opt->insert;
1334 die $error if $error;
1338 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1339 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1341 $part_pkg->recur('');
1343 $part_pkg->replace; #this should take care of plandata, right?
1347 # now upgrade to the explicit custom flag
1349 @part_pkg = qsearch({
1350 'table' => 'part_pkg',
1351 'hashref' => { disabled => 'Y', custom => '' },
1352 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1355 foreach my $part_pkg (@part_pkg) {
1356 my $new = new FS::part_pkg { $part_pkg->hash };
1358 my $comment = $part_pkg->comment;
1359 $comment =~ s/^\(CUSTOM\) //;
1360 $comment = '(none)' unless $comment =~ /\S/;
1361 $new->comment($comment);
1363 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1364 my $primary = $part_pkg->svcpart;
1365 my $options = { $part_pkg->options };
1367 my $error = $new->replace( $part_pkg,
1368 'pkg_svc' => $pkg_svc,
1369 'primary_svc' => $primary,
1370 'options' => $options,
1372 die $error if $error;
1375 my @part_pkg_option = qsearch('part_pkg_option',
1376 { 'optionname' => 'unused_credit',
1379 foreach my $old_opt (@part_pkg_option) {
1380 my $pkgpart = $old_opt->pkgpart;
1381 my $error = $old_opt->delete;
1382 die $error if $error;
1384 foreach (qw(unused_credit_cancel unused_credit_change)) {
1385 my $new_opt = new FS::part_pkg_option {
1386 'pkgpart' => $pkgpart,
1390 $error = $new_opt->insert;
1391 die $error if $error;
1396 =item curuser_pkgs_sql
1398 Returns an SQL fragment for searching for packages the current user can
1399 use, either via part_pkg.agentnum directly, or via agent type (see
1404 sub curuser_pkgs_sql {
1407 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1411 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1413 Returns an SQL fragment for searching for packages the provided agent or agents
1414 can use, either via part_pkg.agentnum directly, or via agent type (see
1419 sub agent_pkgs_sql {
1420 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1421 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1423 $class->_pkgs_sql(@agentnums); #is this why
1428 my( $class, @agentnums ) = @_;
1429 my $agentnums = join(',', @agentnums);
1433 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1434 OR ( agentnum IS NULL
1435 AND EXISTS ( SELECT 1
1437 LEFT JOIN agent_type USING ( typenum )
1438 LEFT JOIN agent AS typeagent USING ( typenum )
1439 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1440 AND typeagent.agentnum IN ($agentnums)
1458 #false laziness w/part_export & cdr
1460 foreach my $INC ( @INC ) {
1461 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1462 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1463 warn "attempting to load plan info from $file\n" if $DEBUG;
1464 $file =~ /\/(\w+)\.pm$/ or do {
1465 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1469 my $info = eval "use FS::part_pkg::$mod; ".
1470 "\\%FS::part_pkg::$mod\::info;";
1472 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1475 unless ( keys %$info ) {
1476 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1479 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1480 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1481 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1484 $info{$mod} = $info;
1485 $info->{'weight'} ||= 0; # quiet warnings
1489 # copy one level deep to allow replacement of fields and fieldorder
1490 tie %plans, 'Tie::IxHash',
1491 map { my %infohash = %{ $info{$_} };
1493 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1496 # inheritance of plan options
1497 foreach my $name (keys(%info)) {
1498 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1499 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1500 delete $plans{$name};
1503 my $parents = $info{$name}->{'inherit_fields'} || [];
1504 my (%fields, %field_exists, @fieldorder);
1505 foreach my $parent ($name, @$parents) {
1506 %fields = ( # avoid replacing existing fields
1507 %{ $info{$parent}->{'fields'} || {} },
1510 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1512 next if $field_exists{$_};
1513 $field_exists{$_} = 1;
1514 # allow inheritors to remove inherited fields from the fieldorder
1515 push @fieldorder, $_ if !exists($fields{$_}->{'disabled'});
1518 $plans{$name}->{'fields'} = \%fields;
1519 $plans{$name}->{'fieldorder'} = \@fieldorder;
1529 =head1 NEW PLAN CLASSES
1531 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1532 found in eg/plan_template.pm. Until then, it is suggested that you use the
1533 other modules in FS/FS/part_pkg/ as a guide.
1537 The delete method is unimplemented.
1539 setup and recur semantics are not yet defined (and are implemented in
1540 FS::cust_bill. hmm.). now they're deprecated and need to go.
1544 part_pkg_taxrate is Pg specific
1546 replace should be smarter about managing the related tables (options, pkg_svc)
1550 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1551 schema.html from the base documentation.