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 while ( my ($exportnum, $vendor_pkg_id) =
281 each %{ $options{part_pkg_vendor} }
284 my $ppv = new FS::part_pkg_vendor( {
285 'pkgpart' => $self->pkgpart,
286 'exportnum' => $exportnum,
287 'vendor_pkg_id' => $vendor_pkg_id,
289 my $error = $ppv->insert;
291 $dbh->rollback if $oldAutoCommit;
292 return "Error inserting part_pkg_vendor record: $error";
297 warn " commiting transaction" if $DEBUG;
298 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
305 Currently unimplemented.
310 return "Can't (yet?) delete package definitions.";
311 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
314 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
316 Replaces OLD_RECORD with this one in the database. If there is an error,
317 returns the error, otherwise returns false.
319 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
322 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
323 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
324 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
325 'hidden' field in these records.
327 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
328 FS::pkg_svc record will be updated.
330 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
338 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
343 ( ref($_[0]) eq 'HASH' )
347 $options->{options} = {} unless defined($options->{options});
349 warn "FS::part_pkg::replace called on $new to replace $old with options".
350 join(', ', map "$_ => ". $options->{$_}, keys %$options)
353 local $SIG{HUP} = 'IGNORE';
354 local $SIG{INT} = 'IGNORE';
355 local $SIG{QUIT} = 'IGNORE';
356 local $SIG{TERM} = 'IGNORE';
357 local $SIG{TSTP} = 'IGNORE';
358 local $SIG{PIPE} = 'IGNORE';
360 my $oldAutoCommit = $FS::UID::AutoCommit;
361 local $FS::UID::AutoCommit = 0;
364 #plandata shit stays in replace for upgrades until after 2.0 (or edit
366 warn " saving legacy plandata" if $DEBUG;
367 my $plandata = $new->get('plandata');
368 $new->set('plandata', '');
370 warn " deleting old part_pkg_option records" if $DEBUG;
371 foreach my $part_pkg_option ( $old->part_pkg_option ) {
372 my $error = $part_pkg_option->delete;
374 $dbh->rollback if $oldAutoCommit;
379 warn " replacing part_pkg record" if $DEBUG;
380 my $error = $new->SUPER::replace($old, $options->{options} );
382 $dbh->rollback if $oldAutoCommit;
386 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
387 foreach my $part_pkg_option (
388 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
389 return "illegal plandata: $plandata";
391 new FS::part_pkg_option {
392 'pkgpart' => $new->pkgpart,
397 split("\n", $plandata)
399 my $error = $part_pkg_option->insert;
401 $dbh->rollback if $oldAutoCommit;
406 warn " replacing pkg_svc records" if $DEBUG;
407 my $pkg_svc = $options->{'pkg_svc'} || {};
408 my $hidden_svc = $options->{'hidden_svc'} || {};
409 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
410 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
411 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
413 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
414 && $options->{'primary_svc'} == $part_svc->svcpart
419 my $old_pkg_svc = qsearchs('pkg_svc', {
420 'pkgpart' => $old->pkgpart,
421 'svcpart' => $part_svc->svcpart,
424 my $old_quantity = 0;
425 my $old_primary_svc = '';
427 if ( $old_pkg_svc ) {
428 $old_quantity = $old_pkg_svc->quantity;
429 $old_primary_svc = $old_pkg_svc->primary_svc
430 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
431 $old_hidden = $old_pkg_svc->hidden;
434 next unless $old_quantity != $quantity ||
435 $old_primary_svc ne $primary_svc ||
436 $old_hidden ne $hidden;
438 my $new_pkg_svc = new FS::pkg_svc( {
439 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
440 'pkgpart' => $new->pkgpart,
441 'svcpart' => $part_svc->svcpart,
442 'quantity' => $quantity,
443 'primary_svc' => $primary_svc,
446 my $error = $old_pkg_svc
447 ? $new_pkg_svc->replace($old_pkg_svc)
448 : $new_pkg_svc->insert;
450 $dbh->rollback if $oldAutoCommit;
455 my @part_pkg_vendor = $old->part_pkg_vendor;
456 my @current_exportnum = ();
457 if ( $options->{'part_pkg_vendor'} ) {
458 my($exportnum,$vendor_pkg_id);
459 while ( ($exportnum,$vendor_pkg_id)
460 = each %{$options->{'part_pkg_vendor'}} ) {
462 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
463 if($exportnum == $part_pkg_vendor->exportnum
464 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
465 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
466 my $error = $part_pkg_vendor->replace;
468 $dbh->rollback if $oldAutoCommit;
469 return "Error replacing part_pkg_vendor record: $error";
474 elsif($exportnum == $part_pkg_vendor->exportnum
475 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
480 unless ( $noinsert ) {
481 my $ppv = new FS::part_pkg_vendor( {
482 'pkgpart' => $new->pkgpart,
483 'exportnum' => $exportnum,
484 'vendor_pkg_id' => $vendor_pkg_id,
486 my $error = $ppv->insert;
488 $dbh->rollback if $oldAutoCommit;
489 return "Error inserting part_pkg_vendor record: $error";
492 push @current_exportnum, $exportnum;
495 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
496 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
497 my $error = $part_pkg_vendor->delete;
499 $dbh->rollback if $oldAutoCommit;
500 return "Error deleting part_pkg_vendor record: $error";
505 warn " commiting transaction" if $DEBUG;
506 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
512 Checks all fields to make sure this is a valid package definition. If
513 there is an error, returns the error, otherwise returns false. Called by the
514 insert and replace methods.
520 warn "FS::part_pkg::check called on $self" if $DEBUG;
522 for (qw(setup recur plandata)) {
523 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
524 return "Use of $_ field is deprecated; set a plan and options: ".
526 if length($self->get($_));
530 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
531 my $error = $self->ut_number('freq');
532 return $error if $error;
534 $self->freq =~ /^(\d+[hdw]?)$/
535 or return "Illegal or empty freq: ". $self->freq;
539 my @null_agentnum_right = ( 'Edit global package definitions' );
540 push @null_agentnum_right, 'One-time charge'
541 if $self->freq =~ /^0/;
542 push @null_agentnum_right, 'Customize customer package'
543 if $self->disabled eq 'Y'; #good enough
545 my $error = $self->ut_numbern('pkgpart')
546 || $self->ut_text('pkg')
547 || $self->ut_text('comment')
548 || $self->ut_textn('promo_code')
549 || $self->ut_alphan('plan')
550 || $self->ut_enum('setuptax', [ '', 'Y' ] )
551 || $self->ut_enum('recurtax', [ '', 'Y' ] )
552 || $self->ut_textn('taxclass')
553 || $self->ut_enum('disabled', [ '', 'Y' ] )
554 || $self->ut_enum('custom', [ '', 'Y' ] )
555 || $self->ut_enum('no_auto', [ '', 'Y' ])
556 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
557 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
558 #|| $self->ut_moneyn('setup_cost')
559 #|| $self->ut_moneyn('recur_cost')
560 || $self->ut_floatn('setup_cost')
561 || $self->ut_floatn('recur_cost')
562 || $self->ut_floatn('pay_weight')
563 || $self->ut_floatn('credit_weight')
564 || $self->ut_numbern('taxproductnum')
565 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
566 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
567 || $self->ut_foreign_keyn('taxproductnum',
568 'part_pkg_taxproduct',
572 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
573 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
575 || $self->ut_numbern('fcc_ds0s')
576 || $self->SUPER::check
578 return $error if $error;
580 return 'Unknown plan '. $self->plan
581 unless exists($plans{$self->plan});
583 my $conf = new FS::Conf;
584 return 'Taxclass is required'
585 if ! $self->taxclass && $conf->exists('require_taxclasses');
590 =item pkg_comment [ OPTION => VALUE... ]
592 Returns an (internal) string representing this package. Currently,
593 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
594 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
597 If the option nopkgpart is true then the "pkgpart: ' is omitted.
605 #$self->pkg. ' - '. $self->comment;
606 #$self->pkg. ' ('. $self->comment. ')';
607 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
608 $pre. $self->pkg. ' - '. $self->custom_comment;
611 sub price_info { # safety, in case a part_pkg hasn't defined price_info
617 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment . ' ' . $self->price_info;
622 Returns the package class, as an FS::pkg_class object, or the empty string
623 if there is no package class.
629 if ( $self->classnum ) {
630 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
636 =item addon_pkg_class
638 Returns the add-on package class, as an FS::pkg_class object, or the empty
639 string if there is no add-on package class.
643 sub addon_pkg_class {
645 if ( $self->addon_classnum ) {
646 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
654 Returns the package category name, or the empty string if there is no package
661 my $pkg_class = $self->pkg_class;
663 ? $pkg_class->categoryname
669 Returns the package class name, or the empty string if there is no package
676 my $pkg_class = $self->pkg_class;
678 ? $pkg_class->classname
682 =item addon_classname
684 Returns the add-on package class name, or the empty string if there is no
685 add-on package class.
689 sub addon_classname {
691 my $pkg_class = $self->addon_pkg_class;
693 ? $pkg_class->classname
699 Returns the associated agent for this event, if any, as an FS::agent object.
705 qsearchs('agent', { 'agentnum' => $self->agentnum } );
708 =item pkg_svc [ HASHREF | OPTION => VALUE ]
710 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
711 definition (with non-zero quantity).
713 One option is available, I<disable_linked>. If set true it will return the
714 services for this package definition alone, omitting services from any add-on
721 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
728 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
734 # #sort { $b->primary cmp $a->primary }
735 # grep { $_->quantity }
736 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
738 my $opt = ref($_[0]) ? $_[0] : { @_ };
739 my %pkg_svc = map { $_->svcpart => $_ }
740 grep { $_->quantity }
741 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
743 unless ( $opt->{disable_linked} ) {
744 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
745 my @pkg_svc = grep { $_->quantity }
746 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
747 foreach my $pkg_svc ( @pkg_svc ) {
748 if ( $pkg_svc{$pkg_svc->svcpart} ) {
749 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
750 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
752 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
762 =item svcpart [ SVCDB ]
764 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
765 associated with this package definition (see L<FS::pkg_svc>). Returns
766 false if there not a primary service definition or exactly one service
767 definition with quantity 1, or if SVCDB is specified and does not match the
768 svcdb of the service definition. SVCDB can be specified as a scalar table
769 name, such as 'svc_acct', or as an arrayref of possible table names.
774 my $pkg_svc = shift->_primary_pkg_svc(@_);
775 $pkg_svc ? $pkg_svc->svcpart : '';
778 =item part_svc [ SVCDB ]
780 Like the B<svcpart> method, but returns the FS::part_svc object (see
786 my $pkg_svc = shift->_primary_pkg_svc(@_);
787 $pkg_svc ? $pkg_svc->part_svc : '';
790 sub _primary_pkg_svc {
793 my $svcdb = scalar(@_) ? shift : [];
794 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
795 my %svcdb = map { $_=>1 } @$svcdb;
798 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
801 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
802 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
804 return '' if scalar(@pkg_svc) != 1;
808 =item svcpart_unique_svcdb SVCDB
810 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
811 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
812 false if there not a primary service definition for SVCDB or there are multiple
813 service definitions for SVCDB.
817 sub svcpart_unique_svcdb {
818 my( $self, $svcdb ) = @_;
819 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
820 return '' if scalar(@svcdb_pkg_svc) != 1;
821 $svcdb_pkg_svc[0]->svcpart;
826 Returns a list of the acceptable payment types for this package. Eventually
827 this should come out of a database table and be editable, but currently has the
828 following logic instead:
830 If the package is free, the single item B<BILL> is
831 returned, otherwise, the single item B<CARD> is returned.
833 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
839 if ( $self->is_free ) {
848 Returns true if this package is free.
854 unless ( $self->plan ) {
855 $self->setup =~ /^\s*0+(\.0*)?\s*$/
856 && $self->recur =~ /^\s*0+(\.0*)?\s*$/;
857 } elsif ( $self->can('is_free_options') ) {
858 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
859 map { $self->option($_) }
860 $self->is_free_options;
862 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
863 "provides neither is_free_options nor is_free method; returning false";
868 sub can_discount { 0; }
871 # moved to FS::Misc to make this accessible to other packages
873 FS::Misc::pkg_freqs();
878 Returns an english representation of the I<freq> field, such as "monthly",
879 "weekly", "semi-annually", etc.
885 my $freq = $self->freq;
887 #my $freqs_href = $self->freqs_href;
888 my $freqs_href = freqs_href();
890 if ( exists($freqs_href->{$freq}) ) {
891 $freqs_href->{$freq};
893 my $interval = 'month';
894 if ( $freq =~ /^(\d+)([hdw])$/ ) {
895 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
896 $interval = $interval{$2};
901 "every $freq ${interval}s";
906 =item add_freq TIMESTAMP [ FREQ ]
908 Adds a billing period of some frequency to the provided timestamp and
909 returns the resulting timestamp, or -1 if the frequency could not be
910 parsed (shouldn't happen). By default, the frequency of this package
911 will be used; to override this, pass a different frequency as a second
917 my( $self, $date, $freq ) = @_;
918 $freq = $self->freq unless $freq;
920 #change this bit to use Date::Manip? CAREFUL with timezones (see
921 # mailing list archive)
922 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
924 if ( $freq =~ /^\d+$/ ) {
926 until ( $mon < 12 ) { $mon -= 12; $year++; }
927 } elsif ( $freq =~ /^(\d+)w$/ ) {
930 } elsif ( $freq =~ /^(\d+)d$/ ) {
933 } elsif ( $freq =~ /^(\d+)h$/ ) {
940 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
945 For backwards compatibility, returns the plandata field as well as all options
946 from FS::part_pkg_option.
952 carp "plandata is deprecated";
954 $self->SUPER::plandata(@_);
956 my $plandata = $self->get('plandata');
957 my %options = $self->options;
958 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
963 =item part_pkg_vendor
965 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
966 L<FS::part_pkg_vendor>).
970 sub part_pkg_vendor {
972 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
977 Returns a list of vendor/external package ids by exportnum
983 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
986 =item part_pkg_option
988 Returns all options as FS::part_pkg_option objects (see
989 L<FS::part_pkg_option>).
993 sub part_pkg_option {
995 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
1000 Returns a list of option names and values suitable for assigning to a hash.
1006 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1009 =item option OPTIONNAME [ QUIET ]
1011 Returns the option value for the given name, or the empty string. If a true
1012 value is passed as the second argument, warnings about missing the option
1018 my( $self, $opt, $ornull ) = @_;
1019 my $part_pkg_option =
1020 qsearchs('part_pkg_option', {
1021 pkgpart => $self->pkgpart,
1024 return $part_pkg_option->optionvalue if $part_pkg_option;
1025 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1026 split("\n", $self->get('plandata') );
1027 return $plandata{$opt} if exists $plandata{$opt};
1028 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1029 "not found in options or plandata!\n"
1034 =item bill_part_pkg_link
1036 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1040 sub bill_part_pkg_link {
1041 shift->_part_pkg_link('bill', @_);
1044 =item svc_part_pkg_link
1046 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1050 sub svc_part_pkg_link {
1051 shift->_part_pkg_link('svc', @_);
1054 sub _part_pkg_link {
1055 my( $self, $type ) = @_;
1056 qsearch({ table => 'part_pkg_link',
1057 hashref => { 'src_pkgpart' => $self->pkgpart,
1058 'link_type' => $type,
1059 #protection against infinite recursive links
1060 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1062 order_by => "ORDER BY hidden",
1066 sub self_and_bill_linked {
1067 shift->_self_and_linked('bill', @_);
1070 sub _self_and_linked {
1071 my( $self, $type, $hidden ) = @_;
1075 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1076 $self->_part_pkg_link($type) ) )
1078 $_->hidden($hidden) if $hidden;
1085 =item part_pkg_taxoverride [ CLASS ]
1087 Returns all associated FS::part_pkg_taxoverride objects (see
1088 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1089 of class CLASS if defined. Class may be one of 'setup', 'recur',
1090 the empty string (default), or a usage class number (see L<FS::usage_class>).
1091 When a class is specified, the empty string class (default) is returned
1092 if no more specific values exist.
1096 sub part_pkg_taxoverride {
1100 my $hashref = { 'pkgpart' => $self->pkgpart };
1101 $hashref->{'usage_class'} = $class if defined($class);
1102 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1104 unless ( scalar(@overrides) || !defined($class) || !$class ){
1105 $hashref->{'usage_class'} = '';
1106 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1112 =item has_taxproduct
1114 Returns true if this package has any taxproduct associated with it.
1118 sub has_taxproduct {
1121 $self->taxproductnum ||
1122 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1123 keys %{ {$self->options} }
1129 =item taxproduct [ CLASS ]
1131 Returns the associated tax product for this package definition (see
1132 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1133 the usage classnum (see L<FS::usage_class>). Returns the default
1134 tax product for this record if the more specific CLASS value does
1143 my $part_pkg_taxproduct;
1145 my $taxproductnum = $self->taxproductnum;
1147 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1148 $taxproductnum = $class_taxproductnum
1149 if $class_taxproductnum
1152 $part_pkg_taxproduct =
1153 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1155 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1156 $taxproductnum = $self->taxproductnum;
1157 $part_pkg_taxproduct =
1158 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1161 $part_pkg_taxproduct;
1164 =item taxproduct_description [ CLASS ]
1166 Returns the description of the associated tax product for this package
1167 definition (see L<FS::part_pkg_taxproduct>).
1171 sub taxproduct_description {
1173 my $part_pkg_taxproduct = $self->taxproduct(@_);
1174 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1177 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1179 Returns the package to taxrate m2m records for this package in the location
1180 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1181 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1182 (see L<FS::usage_class>).
1186 sub _expand_cch_taxproductnum {
1189 my $part_pkg_taxproduct = $self->taxproduct($class);
1191 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1192 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1195 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1196 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1197 OR taxproduct = '$a:$b:$c:'
1198 OR taxproduct = '$a:$b:".":$d'
1199 OR taxproduct = '$a:$b:".":' )";
1200 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1201 'hashref' => { 'data_vendor'=>'cch' },
1202 'extra_sql' => $extra_sql,
1207 sub part_pkg_taxrate {
1209 my ($data_vendor, $geocode, $class) = @_;
1212 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1213 dbh->quote($data_vendor);
1215 # CCH oddness in m2m
1216 $extra_sql .= ' AND ('.
1217 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1221 # much more CCH oddness in m2m -- this is kludgy
1222 my @tpnums = $self->_expand_cch_taxproductnum($class);
1223 if (scalar(@tpnums)) {
1224 $extra_sql .= ' AND ('.
1225 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1228 $extra_sql .= ' AND ( 0 = 1 )';
1231 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1232 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1233 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1235 # should qsearch preface columns with the table to facilitate joins?
1236 qsearch( { 'table' => 'part_pkg_taxrate',
1237 'select' => $select,
1238 'hashref' => { # 'data_vendor' => $data_vendor,
1239 # 'taxproductnum' => $self->taxproductnum,
1241 'addl_from' => $addl_from,
1242 'extra_sql' => $extra_sql,
1243 'order_by' => $order_by,
1247 =item part_pkg_discount
1249 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1254 sub part_pkg_discount {
1256 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1261 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1262 PLAN is the object's I<plan> field. There should be better docs
1263 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1269 my $plan = $self->plan;
1271 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1275 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1276 my $class = ref($self). "::$plan";
1277 warn "reblessing $self into $class" if $DEBUG;
1280 bless($self, $class) unless $@;
1284 #fallbacks that eval the setup and recur fields, for backwards compat
1288 warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
1289 $self->_calc_eval('setup', @_);
1294 warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
1295 $self->_calc_eval('recur', @_);
1298 use vars qw( $sdate @details );
1300 #my( $self, $field, $cust_pkg ) = @_;
1301 my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
1303 *details = $detailsref;
1304 $self->$field() =~ /^(.*)$/
1305 or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
1306 $self->$field(). "\n";
1308 return 0 if $prog =~ /^\s*$/;
1309 my $value = eval $prog;
1314 #fallback that return 0 for old legacy packages with no plan
1316 sub calc_remain { 0; }
1317 sub calc_cancel { 0; }
1318 sub calc_units { 0; }
1320 #fallback for everything except bulk.pm
1321 sub hide_svc_detail { 0; }
1323 =item recur_cost_permonth CUST_PKG
1325 recur_cost divided by freq (only supported for monthly and longer frequencies)
1329 sub recur_cost_permonth {
1330 my($self, $cust_pkg) = @_;
1331 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1332 sprintf('%.2f', $self->recur_cost / $self->freq );
1335 =item format OPTION DATA
1337 Returns data formatted according to the function 'format' described
1338 in the plan info. Returns DATA if no such function exists.
1343 my ($self, $option, $data) = (shift, shift, shift);
1344 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1345 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1351 =item parse OPTION DATA
1353 Returns data parsed according to the function 'parse' described
1354 in the plan info. Returns DATA if no such function exists.
1359 my ($self, $option, $data) = (shift, shift, shift);
1360 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1361 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1371 =head1 CLASS METHODS
1379 # Used by FS::Upgrade to migrate to a new database.
1381 sub _upgrade_data { # class method
1382 my($class, %opts) = @_;
1384 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1386 my @part_pkg = qsearch({
1387 'table' => 'part_pkg',
1388 'extra_sql' => "WHERE ". join(' OR ',
1389 ( map "($_ IS NOT NULL AND $_ != '' )",
1390 qw( plandata setup recur ) ),
1391 'plan IS NULL', "plan = '' ",
1395 foreach my $part_pkg (@part_pkg) {
1397 unless ( $part_pkg->plan ) {
1398 $part_pkg->plan('flat');
1401 if ( length($part_pkg->option('setup_fee')) == 0
1402 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1404 my $opt = new FS::part_pkg_option {
1405 'pkgpart' => $part_pkg->pkgpart,
1406 'optionname' => 'setup_fee',
1407 'optionvalue' => $1,
1409 my $error = $opt->insert;
1410 die $error if $error;
1414 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1415 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1417 $part_pkg->setup('');
1419 if ( length($part_pkg->option('recur_fee')) == 0
1420 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1422 my $opt = new FS::part_pkg_option {
1423 'pkgpart' => $part_pkg->pkgpart,
1424 'optionname' => 'recur_fee',
1425 'optionvalue' => $1,
1427 my $error = $opt->insert;
1428 die $error if $error;
1432 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1433 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1435 $part_pkg->recur('');
1437 $part_pkg->replace; #this should take care of plandata, right?
1441 # now upgrade to the explicit custom flag
1443 @part_pkg = qsearch({
1444 'table' => 'part_pkg',
1445 'hashref' => { disabled => 'Y', custom => '' },
1446 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1449 foreach my $part_pkg (@part_pkg) {
1450 my $new = new FS::part_pkg { $part_pkg->hash };
1452 my $comment = $part_pkg->comment;
1453 $comment =~ s/^\(CUSTOM\) //;
1454 $comment = '(none)' unless $comment =~ /\S/;
1455 $new->comment($comment);
1457 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1458 my $primary = $part_pkg->svcpart;
1459 my $options = { $part_pkg->options };
1461 my $error = $new->replace( $part_pkg,
1462 'pkg_svc' => $pkg_svc,
1463 'primary_svc' => $primary,
1464 'options' => $options,
1466 die $error if $error;
1469 my @part_pkg_option = qsearch('part_pkg_option',
1470 { 'optionname' => 'unused_credit',
1473 foreach my $old_opt (@part_pkg_option) {
1474 my $pkgpart = $old_opt->pkgpart;
1475 my $error = $old_opt->delete;
1476 die $error if $error;
1478 foreach (qw(unused_credit_cancel unused_credit_change)) {
1479 my $new_opt = new FS::part_pkg_option {
1480 'pkgpart' => $pkgpart,
1484 $error = $new_opt->insert;
1485 die $error if $error;
1489 # migrate use_disposition_taqua and use_disposition to disposition_in
1490 @part_pkg_option = qsearch('part_pkg_option',
1491 { 'optionname' => { op => 'LIKE',
1492 value => 'use_disposition%',
1496 my %newopts = map { $_->pkgpart => $_ }
1497 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1498 foreach my $old_opt (@part_pkg_option) {
1499 my $pkgpart = $old_opt->pkgpart;
1500 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1502 my $error = $old_opt->delete;
1503 die $error if $error;
1505 if ( exists($newopts{$pkgpart}) ) {
1506 my $opt = $newopts{$pkgpart};
1507 $opt->optionvalue($opt->optionvalue.",$newval");
1508 $error = $opt->replace;
1509 die $error if $error;
1511 my $new_opt = new FS::part_pkg_option {
1512 'pkgpart' => $pkgpart,
1513 'optionname' => 'disposition_in',
1514 'optionvalue' => $newval,
1516 $error = $new_opt->insert;
1517 die $error if $error;
1518 $newopts{$pkgpart} = $new_opt;
1524 =item curuser_pkgs_sql
1526 Returns an SQL fragment for searching for packages the current user can
1527 use, either via part_pkg.agentnum directly, or via agent type (see
1532 sub curuser_pkgs_sql {
1535 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1539 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1541 Returns an SQL fragment for searching for packages the provided agent or agents
1542 can use, either via part_pkg.agentnum directly, or via agent type (see
1547 sub agent_pkgs_sql {
1548 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1549 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1551 $class->_pkgs_sql(@agentnums); #is this why
1556 my( $class, @agentnums ) = @_;
1557 my $agentnums = join(',', @agentnums);
1561 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1562 OR ( agentnum IS NULL
1563 AND EXISTS ( SELECT 1
1565 LEFT JOIN agent_type USING ( typenum )
1566 LEFT JOIN agent AS typeagent USING ( typenum )
1567 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1568 AND typeagent.agentnum IN ($agentnums)
1586 #false laziness w/part_export & cdr
1588 foreach my $INC ( @INC ) {
1589 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1590 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1591 warn "attempting to load plan info from $file\n" if $DEBUG;
1592 $file =~ /\/(\w+)\.pm$/ or do {
1593 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1597 my $info = eval "use FS::part_pkg::$mod; ".
1598 "\\%FS::part_pkg::$mod\::info;";
1600 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1603 unless ( keys %$info ) {
1604 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1607 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1608 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1609 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1612 $info{$mod} = $info;
1613 $info->{'weight'} ||= 0; # quiet warnings
1617 # copy one level deep to allow replacement of fields and fieldorder
1618 tie %plans, 'Tie::IxHash',
1619 map { my %infohash = %{ $info{$_} };
1621 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1624 # inheritance of plan options
1625 foreach my $name (keys(%info)) {
1626 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1627 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1628 delete $plans{$name};
1631 my $parents = $info{$name}->{'inherit_fields'} || [];
1632 my (%fields, %field_exists, @fieldorder);
1633 foreach my $parent ($name, @$parents) {
1634 if ( !exists($info{$parent}) ) {
1635 warn "$name tried to inherit from nonexistent '$parent'\n";
1638 %fields = ( # avoid replacing existing fields
1639 %{ $info{$parent}->{'fields'} || {} },
1642 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1644 next if $field_exists{$_};
1645 $field_exists{$_} = 1;
1646 # allow inheritors to remove inherited fields from the fieldorder
1647 push @fieldorder, $_ if !exists($fields{$_}) or
1648 !exists($fields{$_}->{'disabled'});
1651 $plans{$name}->{'fields'} = \%fields;
1652 $plans{$name}->{'fieldorder'} = \@fieldorder;
1662 =head1 NEW PLAN CLASSES
1664 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1665 found in eg/plan_template.pm. Until then, it is suggested that you use the
1666 other modules in FS/FS/part_pkg/ as a guide.
1670 The delete method is unimplemented.
1672 setup and recur semantics are not yet defined (and are implemented in
1673 FS::cust_bill. hmm.). now they're deprecated and need to go.
1677 part_pkg_taxrate is Pg specific
1679 replace should be smarter about managing the related tables (options, pkg_svc)
1683 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1684 schema.html from the base documentation.