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;
24 use FS::part_pkg_vendor;
26 @ISA = qw( FS::m2m_Common FS::option_Common );
29 $skip_pkg_svc_hack = 0;
33 FS::part_pkg - Object methods for part_pkg objects
39 $record = new FS::part_pkg \%hash
40 $record = new FS::part_pkg { 'column' => 'value' };
42 $custom_record = $template_record->clone;
44 $error = $record->insert;
46 $error = $new_record->replace($old_record);
48 $error = $record->delete;
50 $error = $record->check;
52 @pkg_svc = $record->pkg_svc;
54 $svcnum = $record->svcpart;
55 $svcnum = $record->svcpart( 'svc_acct' );
59 An FS::part_pkg object represents a package definition. FS::part_pkg
60 inherits from FS::Record. The following fields are currently supported:
64 =item pkgpart - primary key (assigned automatically for new package definitions)
66 =item pkg - Text name of this package definition (customer-viewable)
68 =item comment - Text name of this package definition (non-customer-viewable)
70 =item classnum - Optional package class (see L<FS::pkg_class>)
72 =item promo_code - Promotional code
74 =item setup - Setup fee expression (deprecated)
76 =item freq - Frequency of recurring fee
78 =item recur - Recurring fee expression (deprecated)
80 =item setuptax - Setup fee tax exempt flag, empty or `Y'
82 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
84 =item taxclass - Tax class
86 =item plan - Price plan
88 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
90 =item disabled - Disabled flag, empty or `Y'
92 =item custom - Custom flag, empty or `Y'
94 =item setup_cost - for cost tracking
96 =item recur_cost - for cost tracking
98 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
100 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
102 =item agentnum - Optional agentnum (see L<FS::agent>)
104 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
114 Creates a new package definition. To add the package definition to
115 the database, see L<"insert">.
119 sub table { 'part_pkg'; }
123 An alternate constructor. Creates a new package definition by duplicating
124 an existing definition. A new pkgpart is assigned and the custom flag is
125 set to Y. To add the package definition to the database, see L<"insert">.
131 my $class = ref($self);
132 my %hash = $self->hash;
133 $hash{'pkgpart'} = '';
134 $hash{'custom'} = 'Y';
135 #new FS::part_pkg ( \%hash ); # ?
136 new $class ( \%hash ); # ?
139 =item insert [ , OPTION => VALUE ... ]
141 Adds this package definition to the database. If there is an error,
142 returns the error, otherwise returns false.
144 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
145 I<custnum_ref> and I<options>.
147 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
148 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
149 be set to a hashref of svcparts and flag values ('Y' or '') to set the
150 'hidden' field in these records.
152 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
153 FS::pkg_svc record will be updated.
155 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
156 record itself), the object will be updated to point to this package definition.
158 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
159 the scalar will be updated with the custnum value from the cust_pkg record.
161 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
162 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
163 records will be inserted.
165 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
166 records will be inserted.
173 warn "FS::part_pkg::insert called on $self with options ".
174 join(', ', map "$_=>$options{$_}", keys %options)
177 local $SIG{HUP} = 'IGNORE';
178 local $SIG{INT} = 'IGNORE';
179 local $SIG{QUIT} = 'IGNORE';
180 local $SIG{TERM} = 'IGNORE';
181 local $SIG{TSTP} = 'IGNORE';
182 local $SIG{PIPE} = 'IGNORE';
184 my $oldAutoCommit = $FS::UID::AutoCommit;
185 local $FS::UID::AutoCommit = 0;
188 warn " inserting part_pkg record" if $DEBUG;
189 my $error = $self->SUPER::insert( $options{options} );
191 $dbh->rollback if $oldAutoCommit;
195 my $conf = new FS::Conf;
196 if ( $conf->exists('agent_defaultpkg') ) {
197 warn " agent_defaultpkg set; allowing all agents to purchase package"
199 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
200 my $type_pkgs = new FS::type_pkgs({
201 'typenum' => $agent_type->typenum,
202 'pkgpart' => $self->pkgpart,
204 my $error = $type_pkgs->insert;
206 $dbh->rollback if $oldAutoCommit;
212 warn " inserting part_pkg_taxoverride records" if $DEBUG;
213 my %overrides = %{ $options{'tax_overrides'} || {} };
214 foreach my $usage_class ( keys %overrides ) {
216 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
217 ? $overrides{$usage_class}
219 my @overrides = (grep "$_", split(',', $override) );
220 my $error = $self->process_m2m (
221 'link_table' => 'part_pkg_taxoverride',
222 'target_table' => 'tax_class',
223 'hashref' => { 'usage_class' => $usage_class },
224 'params' => \@overrides,
227 $dbh->rollback if $oldAutoCommit;
232 unless ( $skip_pkg_svc_hack ) {
234 warn " inserting pkg_svc records" if $DEBUG;
235 my $pkg_svc = $options{'pkg_svc'} || {};
236 my $hidden_svc = $options{'hidden_svc'} || {};
237 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
238 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
240 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
244 my $pkg_svc = new FS::pkg_svc( {
245 'pkgpart' => $self->pkgpart,
246 'svcpart' => $part_svc->svcpart,
247 'quantity' => $quantity,
248 'primary_svc' => $primary_svc,
249 'hidden' => $hidden_svc->{$part_svc->svcpart},
251 my $error = $pkg_svc->insert;
253 $dbh->rollback if $oldAutoCommit;
260 if ( $options{'cust_pkg'} ) {
261 warn " updating cust_pkg record " if $DEBUG;
263 ref($options{'cust_pkg'})
264 ? $options{'cust_pkg'}
265 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
266 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
267 if $options{'custnum_ref'};
268 my %hash = $old_cust_pkg->hash;
269 $hash{'pkgpart'} = $self->pkgpart,
270 my $new_cust_pkg = new FS::cust_pkg \%hash;
271 local($FS::cust_pkg::disable_agentcheck) = 1;
272 my $error = $new_cust_pkg->replace($old_cust_pkg);
274 $dbh->rollback if $oldAutoCommit;
275 return "Error modifying cust_pkg record: $error";
279 if ( $options{'part_pkg_vendor'} ) {
280 my($exportnum,$vendor_pkg_id);
281 my %options_part_pkg_vendor = $options{'part_pkg_vendor'};
282 while(($exportnum,$vendor_pkg_id) = each %options_part_pkg_vendor){
283 my $ppv = new FS::part_pkg_vendor( {
284 'pkgpart' => $self->pkgpart,
285 'exportnum' => $exportnum,
286 'vendor_pkg_id' => $vendor_pkg_id,
288 my $error = $ppv->insert;
290 $dbh->rollback if $oldAutoCommit;
291 return "Error inserting part_pkg_vendor record: $error";
296 warn " commiting transaction" if $DEBUG;
297 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
304 Currently unimplemented.
309 return "Can't (yet?) delete package definitions.";
310 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
313 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
315 Replaces OLD_RECORD with this one in the database. If there is an error,
316 returns the error, otherwise returns false.
318 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
321 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
322 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
323 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
324 'hidden' field in these records.
326 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
327 FS::pkg_svc record will be updated.
329 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
337 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
342 ( ref($_[0]) eq 'HASH' )
346 $options->{options} = {} unless defined($options->{options});
348 warn "FS::part_pkg::replace called on $new to replace $old with options".
349 join(', ', map "$_ => ". $options->{$_}, keys %$options)
352 local $SIG{HUP} = 'IGNORE';
353 local $SIG{INT} = 'IGNORE';
354 local $SIG{QUIT} = 'IGNORE';
355 local $SIG{TERM} = 'IGNORE';
356 local $SIG{TSTP} = 'IGNORE';
357 local $SIG{PIPE} = 'IGNORE';
359 my $oldAutoCommit = $FS::UID::AutoCommit;
360 local $FS::UID::AutoCommit = 0;
363 #plandata shit stays in replace for upgrades until after 2.0 (or edit
365 warn " saving legacy plandata" if $DEBUG;
366 my $plandata = $new->get('plandata');
367 $new->set('plandata', '');
369 warn " deleting old part_pkg_option records" if $DEBUG;
370 foreach my $part_pkg_option ( $old->part_pkg_option ) {
371 my $error = $part_pkg_option->delete;
373 $dbh->rollback if $oldAutoCommit;
378 warn " replacing part_pkg record" if $DEBUG;
379 my $error = $new->SUPER::replace($old, $options->{options} );
381 $dbh->rollback if $oldAutoCommit;
385 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
386 foreach my $part_pkg_option (
387 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
388 return "illegal plandata: $plandata";
390 new FS::part_pkg_option {
391 'pkgpart' => $new->pkgpart,
396 split("\n", $plandata)
398 my $error = $part_pkg_option->insert;
400 $dbh->rollback if $oldAutoCommit;
405 warn " replacing pkg_svc records" if $DEBUG;
406 my $pkg_svc = $options->{'pkg_svc'} || {};
407 my $hidden_svc = $options->{'hidden_svc'} || {};
408 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
409 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
410 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
412 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
413 && $options->{'primary_svc'} == $part_svc->svcpart
418 my $old_pkg_svc = qsearchs('pkg_svc', {
419 'pkgpart' => $old->pkgpart,
420 'svcpart' => $part_svc->svcpart,
423 my $old_quantity = 0;
424 my $old_primary_svc = '';
426 if ( $old_pkg_svc ) {
427 $old_quantity = $old_pkg_svc->quantity;
428 $old_primary_svc = $old_pkg_svc->primary_svc
429 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
430 $old_hidden = $old_pkg_svc->hidden;
433 next unless $old_quantity != $quantity ||
434 $old_primary_svc ne $primary_svc ||
435 $old_hidden ne $hidden;
437 my $new_pkg_svc = new FS::pkg_svc( {
438 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
439 'pkgpart' => $new->pkgpart,
440 'svcpart' => $part_svc->svcpart,
441 'quantity' => $quantity,
442 'primary_svc' => $primary_svc,
445 my $error = $old_pkg_svc
446 ? $new_pkg_svc->replace($old_pkg_svc)
447 : $new_pkg_svc->insert;
449 $dbh->rollback if $oldAutoCommit;
454 my @part_pkg_vendor = $old->part_pkg_vendor;
455 my @current_exportnum = ();
456 if ( $options->{'part_pkg_vendor'} ) {
457 my($exportnum,$vendor_pkg_id);
458 while ( ($exportnum,$vendor_pkg_id)
459 = each %{$options->{'part_pkg_vendor'}} ) {
461 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
462 if($exportnum == $part_pkg_vendor->exportnum
463 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
464 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
465 my $error = $part_pkg_vendor->replace;
467 $dbh->rollback if $oldAutoCommit;
468 return "Error replacing part_pkg_vendor record: $error";
473 elsif($exportnum == $part_pkg_vendor->exportnum
474 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
479 unless ( $noinsert ) {
480 my $ppv = new FS::part_pkg_vendor( {
481 'pkgpart' => $new->pkgpart,
482 'exportnum' => $exportnum,
483 'vendor_pkg_id' => $vendor_pkg_id,
485 my $error = $ppv->insert;
487 $dbh->rollback if $oldAutoCommit;
488 return "Error inserting part_pkg_vendor record: $error";
491 push @current_exportnum, $exportnum;
494 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
495 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
496 my $error = $part_pkg_vendor->delete;
498 $dbh->rollback if $oldAutoCommit;
499 return "Error deleting part_pkg_vendor record: $error";
504 warn " commiting transaction" if $DEBUG;
505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
511 Checks all fields to make sure this is a valid package definition. If
512 there is an error, returns the error, otherwise returns false. Called by the
513 insert and replace methods.
519 warn "FS::part_pkg::check called on $self" if $DEBUG;
521 for (qw(setup recur plandata)) {
522 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
523 return "Use of $_ field is deprecated; set a plan and options: ".
525 if length($self->get($_));
529 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
530 my $error = $self->ut_number('freq');
531 return $error if $error;
533 $self->freq =~ /^(\d+[hdw]?)$/
534 or return "Illegal or empty freq: ". $self->freq;
538 my @null_agentnum_right = ( 'Edit global package definitions' );
539 push @null_agentnum_right, 'One-time charge'
540 if $self->freq =~ /^0/;
541 push @null_agentnum_right, 'Customize customer package'
542 if $self->disabled eq 'Y'; #good enough
544 my $error = $self->ut_numbern('pkgpart')
545 || $self->ut_text('pkg')
546 || $self->ut_text('comment')
547 || $self->ut_textn('promo_code')
548 || $self->ut_alphan('plan')
549 || $self->ut_enum('setuptax', [ '', 'Y' ] )
550 || $self->ut_enum('recurtax', [ '', 'Y' ] )
551 || $self->ut_textn('taxclass')
552 || $self->ut_enum('disabled', [ '', 'Y' ] )
553 || $self->ut_enum('custom', [ '', 'Y' ] )
554 || $self->ut_enum('no_auto', [ '', 'Y' ])
555 #|| $self->ut_moneyn('setup_cost')
556 #|| $self->ut_moneyn('recur_cost')
557 || $self->ut_floatn('setup_cost')
558 || $self->ut_floatn('recur_cost')
559 || $self->ut_floatn('pay_weight')
560 || $self->ut_floatn('credit_weight')
561 || $self->ut_numbern('taxproductnum')
562 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
563 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
564 || $self->ut_foreign_keyn('taxproductnum',
565 'part_pkg_taxproduct',
569 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
570 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
572 || $self->ut_numbern('fcc_ds0s')
573 || $self->SUPER::check
575 return $error if $error;
577 return 'Unknown plan '. $self->plan
578 unless exists($plans{$self->plan});
580 my $conf = new FS::Conf;
581 return 'Taxclass is required'
582 if ! $self->taxclass && $conf->exists('require_taxclasses');
587 =item pkg_comment [ OPTION => VALUE... ]
589 Returns an (internal) string representing this package. Currently,
590 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
591 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
594 If the option nopkgpart is true then the "pkgpart: ' is omitted.
602 #$self->pkg. ' - '. $self->comment;
603 #$self->pkg. ' ('. $self->comment. ')';
604 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
605 $pre. $self->pkg. ' - '. $self->custom_comment;
610 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment;
615 Returns the package class, as an FS::pkg_class object, or the empty string
616 if there is no package class.
622 if ( $self->classnum ) {
623 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
629 =item addon_pkg_class
631 Returns the add-on package class, as an FS::pkg_class object, or the empty
632 string if there is no add-on package class.
636 sub addon_pkg_class {
638 if ( $self->addon_classnum ) {
639 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
647 Returns the package category name, or the empty string if there is no package
654 my $pkg_class = $self->pkg_class;
656 ? $pkg_class->categoryname
662 Returns the package class name, or the empty string if there is no package
669 my $pkg_class = $self->pkg_class;
671 ? $pkg_class->classname
675 =item addon_classname
677 Returns the add-on package class name, or the empty string if there is no
678 add-on package class.
682 sub addon_classname {
684 my $pkg_class = $self->addon_pkg_class;
686 ? $pkg_class->classname
692 Returns the associated agent for this event, if any, as an FS::agent object.
698 qsearchs('agent', { 'agentnum' => $self->agentnum } );
701 =item pkg_svc [ HASHREF | OPTION => VALUE ]
703 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
704 definition (with non-zero quantity).
706 One option is available, I<disable_linked>. If set true it will return the
707 services for this package definition alone, omitting services from any add-on
714 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
721 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
727 # #sort { $b->primary cmp $a->primary }
728 # grep { $_->quantity }
729 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
731 my $opt = ref($_[0]) ? $_[0] : { @_ };
732 my %pkg_svc = map { $_->svcpart => $_ }
733 grep { $_->quantity }
734 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
736 unless ( $opt->{disable_linked} ) {
737 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
738 my @pkg_svc = grep { $_->quantity }
739 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
740 foreach my $pkg_svc ( @pkg_svc ) {
741 if ( $pkg_svc{$pkg_svc->svcpart} ) {
742 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
743 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
745 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
755 =item svcpart [ SVCDB ]
757 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
758 associated with this package definition (see L<FS::pkg_svc>). Returns
759 false if there not a primary service definition or exactly one service
760 definition with quantity 1, or if SVCDB is specified and does not match the
761 svcdb of the service definition. SVCDB can be specified as a scalar table
762 name, such as 'svc_acct', or as an arrayref of possible table names.
767 my $pkg_svc = shift->_primary_pkg_svc(@_);
768 $pkg_svc ? $pkg_svc->svcpart : '';
771 =item part_svc [ SVCDB ]
773 Like the B<svcpart> method, but returns the FS::part_svc object (see
779 my $pkg_svc = shift->_primary_pkg_svc(@_);
780 $pkg_svc ? $pkg_svc->part_svc : '';
783 sub _primary_pkg_svc {
786 my $svcdb = scalar(@_) ? shift : [];
787 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
788 my %svcdb = map { $_=>1 } @$svcdb;
791 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
794 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
795 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
797 return '' if scalar(@pkg_svc) != 1;
801 =item svcpart_unique_svcdb SVCDB
803 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
804 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
805 false if there not a primary service definition for SVCDB or there are multiple
806 service definitions for SVCDB.
810 sub svcpart_unique_svcdb {
811 my( $self, $svcdb ) = @_;
812 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
813 return '' if scalar(@svcdb_pkg_svc) != 1;
814 $svcdb_pkg_svc[0]->svcpart;
819 Returns a list of the acceptable payment types for this package. Eventually
820 this should come out of a database table and be editable, but currently has the
821 following logic instead:
823 If the package is free, the single item B<BILL> is
824 returned, otherwise, the single item B<CARD> is returned.
826 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
832 if ( $self->is_free ) {
841 Returns true if this package is free.
847 unless ( $self->plan ) {
848 $self->setup =~ /^\s*0+(\.0*)?\s*$/
849 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
850 } elsif ( $self->can('is_free_options') ) {
851 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
852 map { $self->option($_) }
853 $self->is_free_options;
855 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
856 "provides neither is_free_options nor is_free method; returning false";
861 sub can_discount { 0; }
864 # moved to FS::Misc to make this accessible to other packages
866 FS::Misc::pkg_freqs();
871 Returns an english representation of the I<freq> field, such as "monthly",
872 "weekly", "semi-annually", etc.
878 my $freq = $self->freq;
880 #my $freqs_href = $self->freqs_href;
881 my $freqs_href = freqs_href();
883 if ( exists($freqs_href->{$freq}) ) {
884 $freqs_href->{$freq};
886 my $interval = 'month';
887 if ( $freq =~ /^(\d+)([hdw])$/ ) {
888 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
889 $interval = $interval{$2};
894 "every $freq ${interval}s";
899 =item add_freq TIMESTAMP [ FREQ ]
901 Adds a billing period of some frequency to the provided timestamp and
902 returns the resulting timestamp, or -1 if the frequency could not be
903 parsed (shouldn't happen). By default, the frequency of this package
904 will be used; to override this, pass a different frequency as a second
910 my( $self, $date, $freq ) = @_;
911 $freq = $self->freq unless $freq;
913 #change this bit to use Date::Manip? CAREFUL with timezones (see
914 # mailing list archive)
915 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
917 if ( $freq =~ /^\d+$/ ) {
919 until ( $mon < 12 ) { $mon -= 12; $year++; }
920 } elsif ( $freq =~ /^(\d+)w$/ ) {
923 } elsif ( $freq =~ /^(\d+)d$/ ) {
926 } elsif ( $freq =~ /^(\d+)h$/ ) {
933 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
938 For backwards compatibility, returns the plandata field as well as all options
939 from FS::part_pkg_option.
945 carp "plandata is deprecated";
947 $self->SUPER::plandata(@_);
949 my $plandata = $self->get('plandata');
950 my %options = $self->options;
951 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
956 =item part_pkg_vendor
958 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
959 L<FS::part_pkg_vendor>).
963 sub part_pkg_vendor {
965 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
970 Returns a list of vendor/external package ids by exportnum
976 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
979 =item part_pkg_option
981 Returns all options as FS::part_pkg_option objects (see
982 L<FS::part_pkg_option>).
986 sub part_pkg_option {
988 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
993 Returns a list of option names and values suitable for assigning to a hash.
999 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1002 =item option OPTIONNAME [ QUIET ]
1004 Returns the option value for the given name, or the empty string. If a true
1005 value is passed as the second argument, warnings about missing the option
1011 my( $self, $opt, $ornull ) = @_;
1012 my $part_pkg_option =
1013 qsearchs('part_pkg_option', {
1014 pkgpart => $self->pkgpart,
1017 return $part_pkg_option->optionvalue if $part_pkg_option;
1018 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1019 split("\n", $self->get('plandata') );
1020 return $plandata{$opt} if exists $plandata{$opt};
1021 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1022 "not found in options or plandata!\n"
1027 =item bill_part_pkg_link
1029 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1033 sub bill_part_pkg_link {
1034 shift->_part_pkg_link('bill', @_);
1037 =item svc_part_pkg_link
1039 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1043 sub svc_part_pkg_link {
1044 shift->_part_pkg_link('svc', @_);
1047 sub _part_pkg_link {
1048 my( $self, $type ) = @_;
1049 qsearch({ table => 'part_pkg_link',
1050 hashref => { 'src_pkgpart' => $self->pkgpart,
1051 'link_type' => $type,
1052 #protection against infinite recursive links
1053 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1055 order_by => "ORDER BY hidden",
1059 sub self_and_bill_linked {
1060 shift->_self_and_linked('bill', @_);
1063 sub _self_and_linked {
1064 my( $self, $type, $hidden ) = @_;
1068 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1069 $self->_part_pkg_link($type) ) )
1071 $_->hidden($hidden) if $hidden;
1078 =item part_pkg_taxoverride [ CLASS ]
1080 Returns all associated FS::part_pkg_taxoverride objects (see
1081 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1082 of class CLASS if defined. Class may be one of 'setup', 'recur',
1083 the empty string (default), or a usage class number (see L<FS::usage_class>).
1084 When a class is specified, the empty string class (default) is returned
1085 if no more specific values exist.
1089 sub part_pkg_taxoverride {
1093 my $hashref = { 'pkgpart' => $self->pkgpart };
1094 $hashref->{'usage_class'} = $class if defined($class);
1095 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1097 unless ( scalar(@overrides) || !defined($class) || !$class ){
1098 $hashref->{'usage_class'} = '';
1099 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1105 =item has_taxproduct
1107 Returns true if this package has any taxproduct associated with it.
1111 sub has_taxproduct {
1114 $self->taxproductnum ||
1115 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1116 keys %{ {$self->options} }
1122 =item taxproduct [ CLASS ]
1124 Returns the associated tax product for this package definition (see
1125 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1126 the usage classnum (see L<FS::usage_class>). Returns the default
1127 tax product for this record if the more specific CLASS value does
1136 my $part_pkg_taxproduct;
1138 my $taxproductnum = $self->taxproductnum;
1140 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1141 $taxproductnum = $class_taxproductnum
1142 if $class_taxproductnum
1145 $part_pkg_taxproduct =
1146 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1148 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1149 $taxproductnum = $self->taxproductnum;
1150 $part_pkg_taxproduct =
1151 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1154 $part_pkg_taxproduct;
1157 =item taxproduct_description [ CLASS ]
1159 Returns the description of the associated tax product for this package
1160 definition (see L<FS::part_pkg_taxproduct>).
1164 sub taxproduct_description {
1166 my $part_pkg_taxproduct = $self->taxproduct(@_);
1167 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1170 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1172 Returns the package to taxrate m2m records for this package in the location
1173 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1174 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1175 (see L<FS::usage_class>).
1179 sub _expand_cch_taxproductnum {
1182 my $part_pkg_taxproduct = $self->taxproduct($class);
1184 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1185 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1188 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1189 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1190 OR taxproduct = '$a:$b:$c:'
1191 OR taxproduct = '$a:$b:".":$d'
1192 OR taxproduct = '$a:$b:".":' )";
1193 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1194 'hashref' => { 'data_vendor'=>'cch' },
1195 'extra_sql' => $extra_sql,
1200 sub part_pkg_taxrate {
1202 my ($data_vendor, $geocode, $class) = @_;
1205 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1206 dbh->quote($data_vendor);
1208 # CCH oddness in m2m
1209 $extra_sql .= ' AND ('.
1210 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1214 # much more CCH oddness in m2m -- this is kludgy
1215 my @tpnums = $self->_expand_cch_taxproductnum($class);
1216 if (scalar(@tpnums)) {
1217 $extra_sql .= ' AND ('.
1218 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1221 $extra_sql .= ' AND ( 0 = 1 )';
1224 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1225 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1226 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1228 # should qsearch preface columns with the table to facilitate joins?
1229 qsearch( { 'table' => 'part_pkg_taxrate',
1230 'select' => $select,
1231 'hashref' => { # 'data_vendor' => $data_vendor,
1232 # 'taxproductnum' => $self->taxproductnum,
1234 'addl_from' => $addl_from,
1235 'extra_sql' => $extra_sql,
1236 'order_by' => $order_by,
1240 =item part_pkg_discount
1242 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1247 sub part_pkg_discount {
1249 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1254 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1255 PLAN is the object's I<plan> field. There should be better docs
1256 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1262 my $plan = $self->plan;
1264 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1268 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1269 my $class = ref($self). "::$plan";
1270 warn "reblessing $self into $class" if $DEBUG;
1273 bless($self, $class) unless $@;
1277 #fallbacks that eval the setup and recur fields, for backwards compat
1281 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1282 $self->_calc_eval('setup', @_);
1287 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1288 $self->_calc_eval('recur', @_);
1291 use vars qw( $sdate @details );
1293 #my( $self, $field, $cust_pkg ) = @_;
1294 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1296 *details = $detailsref;
1297 $self->$field() =~ /^(.*)$/
1298 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1299 $self->$field(). "\n";
1301 return 0 if $prog =~ /^\s*$/;
1302 my $value = eval $prog;
1307 #fallback that return 0 for old legacy packages with no plan
1309 sub calc_remain { 0; }
1310 sub calc_cancel { 0; }
1311 sub calc_units { 0; }
1313 #fallback for everything except bulk.pm
1314 sub hide_svc_detail { 0; }
1316 =item recur_cost_permonth CUST_PKG
1318 recur_cost divided by freq (only supported for monthly and longer frequencies)
1322 sub recur_cost_permonth {
1323 my($self, $cust_pkg) = @_;
1324 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1325 sprintf('%.2f', $self->recur_cost / $self->freq );
1328 =item format OPTION DATA
1330 Returns data formatted according to the function 'format' described
1331 in the plan info. Returns DATA if no such function exists.
1336 my ($self, $option, $data) = (shift, shift, shift);
1337 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1338 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1344 =item parse OPTION DATA
1346 Returns data parsed according to the function 'parse' described
1347 in the plan info. Returns DATA if no such function exists.
1352 my ($self, $option, $data) = (shift, shift, shift);
1353 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1354 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1364 =head1 CLASS METHODS
1372 # Used by FS::Upgrade to migrate to a new database.
1374 sub _upgrade_data { # class method
1375 my($class, %opts) = @_;
1377 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1379 my @part_pkg = qsearch({
1380 'table' => 'part_pkg',
1381 'extra_sql' => "WHERE ". join(' OR ',
1382 ( map "($_ IS NOT NULL AND $_ != '' )",
1383 qw( plandata setup recur ) ),
1384 'plan IS NULL', "plan = '' ",
1388 foreach my $part_pkg (@part_pkg) {
1390 unless ( $part_pkg->plan ) {
1391 $part_pkg->plan('flat');
1394 if ( length($part_pkg->option('setup_fee')) == 0
1395 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1397 my $opt = new FS::part_pkg_option {
1398 'pkgpart' => $part_pkg->pkgpart,
1399 'optionname' => 'setup_fee',
1400 'optionvalue' => $1,
1402 my $error = $opt->insert;
1403 die $error if $error;
1407 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1408 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1410 $part_pkg->setup('');
1412 if ( length($part_pkg->option('recur_fee')) == 0
1413 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1415 my $opt = new FS::part_pkg_option {
1416 'pkgpart' => $part_pkg->pkgpart,
1417 'optionname' => 'recur_fee',
1418 'optionvalue' => $1,
1420 my $error = $opt->insert;
1421 die $error if $error;
1425 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1426 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1428 $part_pkg->recur('');
1430 $part_pkg->replace; #this should take care of plandata, right?
1434 # now upgrade to the explicit custom flag
1436 @part_pkg = qsearch({
1437 'table' => 'part_pkg',
1438 'hashref' => { disabled => 'Y', custom => '' },
1439 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1442 foreach my $part_pkg (@part_pkg) {
1443 my $new = new FS::part_pkg { $part_pkg->hash };
1445 my $comment = $part_pkg->comment;
1446 $comment =~ s/^\(CUSTOM\) //;
1447 $comment = '(none)' unless $comment =~ /\S/;
1448 $new->comment($comment);
1450 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1451 my $primary = $part_pkg->svcpart;
1452 my $options = { $part_pkg->options };
1454 my $error = $new->replace( $part_pkg,
1455 'pkg_svc' => $pkg_svc,
1456 'primary_svc' => $primary,
1457 'options' => $options,
1459 die $error if $error;
1464 =item curuser_pkgs_sql
1466 Returns an SQL fragment for searching for packages the current user can
1467 use, either via part_pkg.agentnum directly, or via agent type (see
1472 sub curuser_pkgs_sql {
1475 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1479 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1481 Returns an SQL fragment for searching for packages the provided agent or agents
1482 can use, either via part_pkg.agentnum directly, or via agent type (see
1487 sub agent_pkgs_sql {
1488 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1489 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1491 $class->_pkgs_sql(@agentnums); #is this why
1496 my( $class, @agentnums ) = @_;
1497 my $agentnums = join(',', @agentnums);
1501 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1502 OR ( agentnum IS NULL
1503 AND EXISTS ( SELECT 1
1505 LEFT JOIN agent_type USING ( typenum )
1506 LEFT JOIN agent AS typeagent USING ( typenum )
1507 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1508 AND typeagent.agentnum IN ($agentnums)
1526 #false laziness w/part_export & cdr
1528 foreach my $INC ( @INC ) {
1529 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1530 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1531 warn "attempting to load plan info from $file\n" if $DEBUG;
1532 $file =~ /\/(\w+)\.pm$/ or do {
1533 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1537 my $info = eval "use FS::part_pkg::$mod; ".
1538 "\\%FS::part_pkg::$mod\::info;";
1540 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1543 unless ( keys %$info ) {
1544 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1547 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1548 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1549 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1552 $info{$mod} = $info;
1553 $info->{'weight'} ||= 0; # quiet warnings
1557 # copy one level deep to allow replacement of fields and fieldorder
1558 tie %plans, 'Tie::IxHash',
1559 map { my %infohash = %{ $info{$_} };
1561 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1564 # inheritance of plan options
1565 foreach my $name (keys(%info)) {
1566 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1567 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1568 delete $plans{$name};
1571 my $parents = $info{$name}->{'inherit_fields'} || [];
1572 my (%fields, %field_exists, @fieldorder);
1573 foreach my $parent ($name, @$parents) {
1574 %fields = ( # avoid replacing existing fields
1575 %{ $info{$parent}->{'fields'} || {} },
1578 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1580 next if $field_exists{$_};
1581 $field_exists{$_} = 1;
1582 # allow inheritors to remove inherited fields from the fieldorder
1583 push @fieldorder, $_ if !exists($fields{$_}->{'disabled'});
1586 $plans{$name}->{'fields'} = \%fields;
1587 $plans{$name}->{'fieldorder'} = \@fieldorder;
1597 =head1 NEW PLAN CLASSES
1599 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1600 found in eg/plan_template.pm. Until then, it is suggested that you use the
1601 other modules in FS/FS/part_pkg/ as a guide.
1605 The delete method is unimplemented.
1607 setup and recur semantics are not yet defined (and are implemented in
1608 FS::cust_bill. hmm.). now they're deprecated and need to go.
1612 part_pkg_taxrate is Pg specific
1614 replace should be smarter about managing the related tables (options, pkg_svc)
1618 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1619 schema.html from the base documentation.