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_enum('no_auto', [ '', 'Y' ])
468 #|| $self->ut_moneyn('setup_cost')
469 #|| $self->ut_moneyn('recur_cost')
470 || $self->ut_floatn('setup_cost')
471 || $self->ut_floatn('recur_cost')
472 || $self->ut_floatn('pay_weight')
473 || $self->ut_floatn('credit_weight')
474 || $self->ut_numbern('taxproductnum')
475 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
476 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
477 || $self->ut_foreign_keyn('taxproductnum',
478 'part_pkg_taxproduct',
482 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
483 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
485 || $self->ut_numbern('fcc_ds0s')
486 || $self->SUPER::check
488 return $error if $error;
490 return 'Unknown plan '. $self->plan
491 unless exists($plans{$self->plan});
493 my $conf = new FS::Conf;
494 return 'Taxclass is required'
495 if ! $self->taxclass && $conf->exists('require_taxclasses');
500 =item pkg_comment [ OPTION => VALUE... ]
502 Returns an (internal) string representing this package. Currently,
503 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
504 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
507 If the option nopkgpart is true then the "pkgpart: ' is omitted.
515 #$self->pkg. ' - '. $self->comment;
516 #$self->pkg. ' ('. $self->comment. ')';
517 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
518 $pre. $self->pkg. ' - '. $self->custom_comment;
523 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment;
528 Returns the package class, as an FS::pkg_class object, or the empty string
529 if there is no package class.
535 if ( $self->classnum ) {
536 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
542 =item addon_pkg_class
544 Returns the add-on package class, as an FS::pkg_class object, or the empty
545 string if there is no add-on package class.
549 sub addon_pkg_class {
551 if ( $self->addon_classnum ) {
552 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
560 Returns the package category name, or the empty string if there is no package
567 my $pkg_class = $self->pkg_class;
569 ? $pkg_class->categoryname
575 Returns the package class name, or the empty string if there is no package
582 my $pkg_class = $self->pkg_class;
584 ? $pkg_class->classname
588 =item addon_classname
590 Returns the add-on package class name, or the empty string if there is no
591 add-on package class.
595 sub addon_classname {
597 my $pkg_class = $self->addon_pkg_class;
599 ? $pkg_class->classname
605 Returns the associated agent for this event, if any, as an FS::agent object.
611 qsearchs('agent', { 'agentnum' => $self->agentnum } );
614 =item pkg_svc [ HASHREF | OPTION => VALUE ]
616 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
617 definition (with non-zero quantity).
619 One option is available, I<disable_linked>. If set true it will return the
620 services for this package definition alone, omitting services from any add-on
627 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
634 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
640 # #sort { $b->primary cmp $a->primary }
641 # grep { $_->quantity }
642 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
644 my $opt = ref($_[0]) ? $_[0] : { @_ };
645 my %pkg_svc = map { $_->svcpart => $_ }
646 grep { $_->quantity }
647 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
649 unless ( $opt->{disable_linked} ) {
650 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
651 my @pkg_svc = grep { $_->quantity }
652 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
653 foreach my $pkg_svc ( @pkg_svc ) {
654 if ( $pkg_svc{$pkg_svc->svcpart} ) {
655 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
656 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
658 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
668 =item svcpart [ SVCDB ]
670 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
671 associated with this package definition (see L<FS::pkg_svc>). Returns
672 false if there not a primary service definition or exactly one service
673 definition with quantity 1, or if SVCDB is specified and does not match the
674 svcdb of the service definition. SVCDB can be specified as a scalar table
675 name, such as 'svc_acct', or as an arrayref of possible table names.
680 my $pkg_svc = shift->_primary_pkg_svc(@_);
681 $pkg_svc ? $pkg_svc->svcpart : '';
684 =item part_svc [ SVCDB ]
686 Like the B<svcpart> method, but returns the FS::part_svc object (see
692 my $pkg_svc = shift->_primary_pkg_svc(@_);
693 $pkg_svc ? $pkg_svc->part_svc : '';
696 sub _primary_pkg_svc {
699 my $svcdb = scalar(@_) ? shift : [];
700 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
701 my %svcdb = map { $_=>1 } @$svcdb;
704 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
707 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
708 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
710 return '' if scalar(@pkg_svc) != 1;
714 =item svcpart_unique_svcdb SVCDB
716 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
717 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
718 false if there not a primary service definition for SVCDB or there are multiple
719 service definitions for SVCDB.
723 sub svcpart_unique_svcdb {
724 my( $self, $svcdb ) = @_;
725 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
726 return '' if scalar(@svcdb_pkg_svc) != 1;
727 $svcdb_pkg_svc[0]->svcpart;
732 Returns a list of the acceptable payment types for this package. Eventually
733 this should come out of a database table and be editable, but currently has the
734 following logic instead:
736 If the package is free, the single item B<BILL> is
737 returned, otherwise, the single item B<CARD> is returned.
739 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
745 if ( $self->is_free ) {
754 Returns true if this package is free.
760 unless ( $self->plan ) {
761 $self->setup =~ /^\s*0+(\.0*)?\s*$/
762 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
763 } elsif ( $self->can('is_free_options') ) {
764 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
765 map { $self->option($_) }
766 $self->is_free_options;
768 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
769 "provides neither is_free_options nor is_free method; returning false";
774 sub can_discount { 0; }
777 #method, class method or sub? #my $self = shift;
779 tie my %freq, 'Tie::IxHash',
780 '0' => '(no recurring fee)',
783 '2d' => 'every two days',
784 '3d' => 'every three days',
786 '2w' => 'biweekly (every 2 weeks)',
788 '45d' => 'every 45 days',
789 '2' => 'bimonthly (every 2 months)',
790 '3' => 'quarterly (every 3 months)',
791 '4' => 'every 4 months',
792 '137d' => 'every 4 1/2 months (137 days)',
793 '6' => 'semiannually (every 6 months)',
795 '13' => 'every 13 months (annually +1 month)',
796 '24' => 'biannually (every 2 years)',
797 '36' => 'triannually (every 3 years)',
798 '48' => '(every 4 years)',
799 '60' => '(every 5 years)',
800 '120' => '(every 10 years)',
809 Returns an english representation of the I<freq> field, such as "monthly",
810 "weekly", "semi-annually", etc.
816 my $freq = $self->freq;
818 #my $freqs_href = $self->freqs_href;
819 my $freqs_href = freqs_href();
821 if ( exists($freqs_href->{$freq}) ) {
822 $freqs_href->{$freq};
824 my $interval = 'month';
825 if ( $freq =~ /^(\d+)([hdw])$/ ) {
826 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
827 $interval = $interval{$2};
832 "every $freq ${interval}s";
837 =item add_freq TIMESTAMP
839 Adds the frequency of this package to the provided timestamp and returns
840 the resulting timestamp, or -1 if the frequency of this package could not be
841 parsed (shouldn't happen).
846 my( $self, $date ) = @_;
847 my $freq = $self->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 ( $self->freq =~ /^\d+$/ ) {
855 until ( $mon < 12 ) { $mon -= 12; $year++; }
856 } elsif ( $self->freq =~ /^(\d+)w$/ ) {
859 } elsif ( $self->freq =~ /^(\d+)d$/ ) {
862 } elsif ( $self->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,
966 order_by => "ORDER BY hidden",
970 sub self_and_bill_linked {
971 shift->_self_and_linked('bill', @_);
974 sub _self_and_linked {
975 my( $self, $type, $hidden ) = @_;
979 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
980 $self->_part_pkg_link($type) ) )
982 $_->hidden($hidden) if $hidden;
989 =item part_pkg_taxoverride [ CLASS ]
991 Returns all associated FS::part_pkg_taxoverride objects (see
992 L<FS::part_pkg_taxoverride>). Limits the returned set to those
993 of class CLASS if defined. Class may be one of 'setup', 'recur',
994 the empty string (default), or a usage class number (see L<FS::usage_class>).
995 When a class is specified, the empty string class (default) is returned
996 if no more specific values exist.
1000 sub part_pkg_taxoverride {
1004 my $hashref = { 'pkgpart' => $self->pkgpart };
1005 $hashref->{'usage_class'} = $class if defined($class);
1006 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1008 unless ( scalar(@overrides) || !defined($class) || !$class ){
1009 $hashref->{'usage_class'} = '';
1010 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1016 =item has_taxproduct
1018 Returns true if this package has any taxproduct associated with it.
1022 sub has_taxproduct {
1025 $self->taxproductnum ||
1026 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1027 keys %{ {$self->options} }
1033 =item taxproduct [ CLASS ]
1035 Returns the associated tax product for this package definition (see
1036 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1037 the usage classnum (see L<FS::usage_class>). Returns the default
1038 tax product for this record if the more specific CLASS value does
1047 my $part_pkg_taxproduct;
1049 my $taxproductnum = $self->taxproductnum;
1051 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1052 $taxproductnum = $class_taxproductnum
1053 if $class_taxproductnum
1056 $part_pkg_taxproduct =
1057 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1059 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1060 $taxproductnum = $self->taxproductnum;
1061 $part_pkg_taxproduct =
1062 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1065 $part_pkg_taxproduct;
1068 =item taxproduct_description [ CLASS ]
1070 Returns the description of the associated tax product for this package
1071 definition (see L<FS::part_pkg_taxproduct>).
1075 sub taxproduct_description {
1077 my $part_pkg_taxproduct = $self->taxproduct(@_);
1078 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1081 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1083 Returns the package to taxrate m2m records for this package in the location
1084 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1085 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1086 (see L<FS::usage_class>).
1090 sub _expand_cch_taxproductnum {
1093 my $part_pkg_taxproduct = $self->taxproduct($class);
1095 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1096 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1099 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1100 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1101 OR taxproduct = '$a:$b:$c:'
1102 OR taxproduct = '$a:$b:".":$d'
1103 OR taxproduct = '$a:$b:".":' )";
1104 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1105 'hashref' => { 'data_vendor'=>'cch' },
1106 'extra_sql' => $extra_sql,
1111 sub part_pkg_taxrate {
1113 my ($data_vendor, $geocode, $class) = @_;
1116 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1117 dbh->quote($data_vendor);
1119 # CCH oddness in m2m
1120 $extra_sql .= ' AND ('.
1121 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1125 # much more CCH oddness in m2m -- this is kludgy
1126 my @tpnums = $self->_expand_cch_taxproductnum($class);
1127 if (scalar(@tpnums)) {
1128 $extra_sql .= ' AND ('.
1129 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1132 $extra_sql .= ' AND ( 0 = 1 )';
1135 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1136 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1137 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1139 # should qsearch preface columns with the table to facilitate joins?
1140 qsearch( { 'table' => 'part_pkg_taxrate',
1141 'select' => $select,
1142 'hashref' => { # 'data_vendor' => $data_vendor,
1143 # 'taxproductnum' => $self->taxproductnum,
1145 'addl_from' => $addl_from,
1146 'extra_sql' => $extra_sql,
1147 'order_by' => $order_by,
1153 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1154 PLAN is the object's I<plan> field. There should be better docs
1155 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1161 my $plan = $self->plan;
1163 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1167 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1168 my $class = ref($self). "::$plan";
1169 warn "reblessing $self into $class" if $DEBUG;
1172 bless($self, $class) unless $@;
1176 #fallbacks that eval the setup and recur fields, for backwards compat
1180 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1181 $self->_calc_eval('setup', @_);
1186 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1187 $self->_calc_eval('recur', @_);
1190 use vars qw( $sdate @details );
1192 #my( $self, $field, $cust_pkg ) = @_;
1193 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1195 *details = $detailsref;
1196 $self->$field() =~ /^(.*)$/
1197 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1198 $self->$field(). "\n";
1200 return 0 if $prog =~ /^\s*$/;
1201 my $value = eval $prog;
1206 #fallback that return 0 for old legacy packages with no plan
1208 sub calc_remain { 0; }
1209 sub calc_cancel { 0; }
1210 sub calc_units { 0; }
1212 #fallback for everything except bulk.pm
1213 sub hide_svc_detail { 0; }
1215 =item recur_cost_permonth CUST_PKG
1217 recur_cost divided by freq (only supported for monthly and longer frequencies)
1221 sub recur_cost_permonth {
1222 my($self, $cust_pkg) = @_;
1223 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1224 sprintf('%.2f', $self->recur_cost / $self->freq );
1227 =item format OPTION DATA
1229 Returns data formatted according to the function 'format' described
1230 in the plan info. Returns DATA if no such function exists.
1235 my ($self, $option, $data) = (shift, shift, shift);
1236 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1237 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1243 =item parse OPTION DATA
1245 Returns data parsed according to the function 'parse' described
1246 in the plan info. Returns DATA if no such function exists.
1251 my ($self, $option, $data) = (shift, shift, shift);
1252 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1253 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1263 =head1 CLASS METHODS
1271 # Used by FS::Upgrade to migrate to a new database.
1273 sub _upgrade_data { # class method
1274 my($class, %opts) = @_;
1276 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1278 my @part_pkg = qsearch({
1279 'table' => 'part_pkg',
1280 'extra_sql' => "WHERE ". join(' OR ',
1281 ( map "($_ IS NOT NULL AND $_ != '' )",
1282 qw( plandata setup recur ) ),
1283 'plan IS NULL', "plan = '' ",
1287 foreach my $part_pkg (@part_pkg) {
1289 unless ( $part_pkg->plan ) {
1290 $part_pkg->plan('flat');
1293 if ( length($part_pkg->option('setup_fee')) == 0
1294 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1296 my $opt = new FS::part_pkg_option {
1297 'pkgpart' => $part_pkg->pkgpart,
1298 'optionname' => 'setup_fee',
1299 'optionvalue' => $1,
1301 my $error = $opt->insert;
1302 die $error if $error;
1306 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1307 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1309 $part_pkg->setup('');
1311 if ( length($part_pkg->option('recur_fee')) == 0
1312 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1314 my $opt = new FS::part_pkg_option {
1315 'pkgpart' => $part_pkg->pkgpart,
1316 'optionname' => 'recur_fee',
1317 'optionvalue' => $1,
1319 my $error = $opt->insert;
1320 die $error if $error;
1324 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1325 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1327 $part_pkg->recur('');
1329 $part_pkg->replace; #this should take care of plandata, right?
1333 # now upgrade to the explicit custom flag
1335 @part_pkg = qsearch({
1336 'table' => 'part_pkg',
1337 'hashref' => { disabled => 'Y', custom => '' },
1338 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1341 foreach my $part_pkg (@part_pkg) {
1342 my $new = new FS::part_pkg { $part_pkg->hash };
1344 my $comment = $part_pkg->comment;
1345 $comment =~ s/^\(CUSTOM\) //;
1346 $comment = '(none)' unless $comment =~ /\S/;
1347 $new->comment($comment);
1349 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1350 my $primary = $part_pkg->svcpart;
1351 my $options = { $part_pkg->options };
1353 my $error = $new->replace( $part_pkg,
1354 'pkg_svc' => $pkg_svc,
1355 'primary_svc' => $primary,
1356 'options' => $options,
1358 die $error if $error;
1363 =item curuser_pkgs_sql
1365 Returns an SQL fragment for searching for packages the current user can
1366 use, either via part_pkg.agentnum directly, or via agent type (see
1371 sub curuser_pkgs_sql {
1374 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1378 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1380 Returns an SQL fragment for searching for packages the provided agent or agents
1381 can use, either via part_pkg.agentnum directly, or via agent type (see
1386 sub agent_pkgs_sql {
1387 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1388 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1390 $class->_pkgs_sql(@agentnums); #is this why
1395 my( $class, @agentnums ) = @_;
1396 my $agentnums = join(',', @agentnums);
1400 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1401 OR ( agentnum IS NULL
1402 AND EXISTS ( SELECT 1
1404 LEFT JOIN agent_type USING ( typenum )
1405 LEFT JOIN agent AS typeagent USING ( typenum )
1406 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1407 AND typeagent.agentnum IN ($agentnums)
1425 #false laziness w/part_export & cdr
1427 foreach my $INC ( @INC ) {
1428 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1429 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1430 warn "attempting to load plan info from $file\n" if $DEBUG;
1431 $file =~ /\/(\w+)\.pm$/ or do {
1432 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1436 my $info = eval "use FS::part_pkg::$mod; ".
1437 "\\%FS::part_pkg::$mod\::info;";
1439 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1442 unless ( keys %$info ) {
1443 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1446 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1447 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1448 warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1451 $info{$mod} = $info;
1455 tie %plans, 'Tie::IxHash',
1456 map { $_ => $info{$_} }
1457 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1467 =head1 NEW PLAN CLASSES
1469 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1470 found in eg/plan_template.pm. Until then, it is suggested that you use the
1471 other modules in FS/FS/part_pkg/ as a guide.
1475 The delete method is unimplemented.
1477 setup and recur semantics are not yet defined (and are implemented in
1478 FS::cust_bill. hmm.). now they're deprecated and need to go.
1482 part_pkg_taxrate is Pg specific
1484 replace should be smarter about managing the related tables (options, pkg_svc)
1488 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1489 schema.html from the base documentation.