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 if ( $self->can('is_free_options') ) {
855 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
856 map { $self->option($_) }
857 $self->is_free_options;
859 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
860 "provides neither is_free_options nor is_free method; returning false";
865 sub can_discount { 0; }
867 sub can_start_date { 1; }
870 # moved to FS::Misc to make this accessible to other packages
872 FS::Misc::pkg_freqs();
877 Returns an english representation of the I<freq> field, such as "monthly",
878 "weekly", "semi-annually", etc.
884 my $freq = $self->freq;
886 #my $freqs_href = $self->freqs_href;
887 my $freqs_href = freqs_href();
889 if ( exists($freqs_href->{$freq}) ) {
890 $freqs_href->{$freq};
892 my $interval = 'month';
893 if ( $freq =~ /^(\d+)([hdw])$/ ) {
894 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
895 $interval = $interval{$2};
900 "every $freq ${interval}s";
905 =item add_freq TIMESTAMP [ FREQ ]
907 Adds a billing period of some frequency to the provided timestamp and
908 returns the resulting timestamp, or -1 if the frequency could not be
909 parsed (shouldn't happen). By default, the frequency of this package
910 will be used; to override this, pass a different frequency as a second
916 my( $self, $date, $freq ) = @_;
917 $freq = $self->freq unless $freq;
919 #change this bit to use Date::Manip? CAREFUL with timezones (see
920 # mailing list archive)
921 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
923 if ( $freq =~ /^\d+$/ ) {
925 until ( $mon < 12 ) { $mon -= 12; $year++; }
926 } elsif ( $freq =~ /^(\d+)w$/ ) {
929 } elsif ( $freq =~ /^(\d+)d$/ ) {
932 } elsif ( $freq =~ /^(\d+)h$/ ) {
939 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
944 For backwards compatibility, returns the plandata field as well as all options
945 from FS::part_pkg_option.
951 carp "plandata is deprecated";
953 $self->SUPER::plandata(@_);
955 my $plandata = $self->get('plandata');
956 my %options = $self->options;
957 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
962 =item part_pkg_vendor
964 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
965 L<FS::part_pkg_vendor>).
969 sub part_pkg_vendor {
971 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
976 Returns a list of vendor/external package ids by exportnum
982 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
985 =item part_pkg_option
987 Returns all options as FS::part_pkg_option objects (see
988 L<FS::part_pkg_option>).
992 sub part_pkg_option {
994 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
999 Returns a list of option names and values suitable for assigning to a hash.
1005 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1008 =item option OPTIONNAME [ QUIET ]
1010 Returns the option value for the given name, or the empty string. If a true
1011 value is passed as the second argument, warnings about missing the option
1017 my( $self, $opt, $ornull ) = @_;
1018 my $part_pkg_option =
1019 qsearchs('part_pkg_option', {
1020 pkgpart => $self->pkgpart,
1023 return $part_pkg_option->optionvalue if $part_pkg_option;
1024 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1025 split("\n", $self->get('plandata') );
1026 return $plandata{$opt} if exists $plandata{$opt};
1027 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1028 "not found in options or plandata!\n"
1033 =item bill_part_pkg_link
1035 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1039 sub bill_part_pkg_link {
1040 shift->_part_pkg_link('bill', @_);
1043 =item svc_part_pkg_link
1045 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1049 sub svc_part_pkg_link {
1050 shift->_part_pkg_link('svc', @_);
1053 sub _part_pkg_link {
1054 my( $self, $type ) = @_;
1055 qsearch({ table => 'part_pkg_link',
1056 hashref => { 'src_pkgpart' => $self->pkgpart,
1057 'link_type' => $type,
1058 #protection against infinite recursive links
1059 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1061 order_by => "ORDER BY hidden",
1065 sub self_and_bill_linked {
1066 shift->_self_and_linked('bill', @_);
1069 sub self_and_svc_linked {
1070 shift->_self_and_linked('svc', @_);
1073 sub _self_and_linked {
1074 my( $self, $type, $hidden ) = @_;
1078 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1079 $self->_part_pkg_link($type) ) )
1081 $_->hidden($hidden) if $hidden;
1088 =item part_pkg_taxoverride [ CLASS ]
1090 Returns all associated FS::part_pkg_taxoverride objects (see
1091 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1092 of class CLASS if defined. Class may be one of 'setup', 'recur',
1093 the empty string (default), or a usage class number (see L<FS::usage_class>).
1094 When a class is specified, the empty string class (default) is returned
1095 if no more specific values exist.
1099 sub part_pkg_taxoverride {
1103 my $hashref = { 'pkgpart' => $self->pkgpart };
1104 $hashref->{'usage_class'} = $class if defined($class);
1105 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1107 unless ( scalar(@overrides) || !defined($class) || !$class ){
1108 $hashref->{'usage_class'} = '';
1109 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1115 =item has_taxproduct
1117 Returns true if this package has any taxproduct associated with it.
1121 sub has_taxproduct {
1124 $self->taxproductnum ||
1125 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1126 keys %{ {$self->options} }
1132 =item taxproduct [ CLASS ]
1134 Returns the associated tax product for this package definition (see
1135 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1136 the usage classnum (see L<FS::usage_class>). Returns the default
1137 tax product for this record if the more specific CLASS value does
1146 my $part_pkg_taxproduct;
1148 my $taxproductnum = $self->taxproductnum;
1150 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1151 $taxproductnum = $class_taxproductnum
1152 if $class_taxproductnum
1155 $part_pkg_taxproduct =
1156 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1158 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1159 $taxproductnum = $self->taxproductnum;
1160 $part_pkg_taxproduct =
1161 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1164 $part_pkg_taxproduct;
1167 =item taxproduct_description [ CLASS ]
1169 Returns the description of the associated tax product for this package
1170 definition (see L<FS::part_pkg_taxproduct>).
1174 sub taxproduct_description {
1176 my $part_pkg_taxproduct = $self->taxproduct(@_);
1177 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1180 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1182 Returns the package to taxrate m2m records for this package in the location
1183 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1184 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1185 (see L<FS::usage_class>).
1189 sub _expand_cch_taxproductnum {
1192 my $part_pkg_taxproduct = $self->taxproduct($class);
1194 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1195 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1198 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1199 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1200 OR taxproduct = '$a:$b:$c:'
1201 OR taxproduct = '$a:$b:".":$d'
1202 OR taxproduct = '$a:$b:".":' )";
1203 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1204 'hashref' => { 'data_vendor'=>'cch' },
1205 'extra_sql' => $extra_sql,
1210 sub part_pkg_taxrate {
1212 my ($data_vendor, $geocode, $class) = @_;
1215 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1216 dbh->quote($data_vendor);
1218 # CCH oddness in m2m
1219 $extra_sql .= ' AND ('.
1220 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1224 # much more CCH oddness in m2m -- this is kludgy
1225 my @tpnums = $self->_expand_cch_taxproductnum($class);
1226 if (scalar(@tpnums)) {
1227 $extra_sql .= ' AND ('.
1228 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1231 $extra_sql .= ' AND ( 0 = 1 )';
1234 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1235 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1236 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1238 # should qsearch preface columns with the table to facilitate joins?
1239 qsearch( { 'table' => 'part_pkg_taxrate',
1240 'select' => $select,
1241 'hashref' => { # 'data_vendor' => $data_vendor,
1242 # 'taxproductnum' => $self->taxproductnum,
1244 'addl_from' => $addl_from,
1245 'extra_sql' => $extra_sql,
1246 'order_by' => $order_by,
1250 =item part_pkg_discount
1252 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1257 sub part_pkg_discount {
1259 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1264 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1265 PLAN is the object's I<plan> field. There should be better docs
1266 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1272 my $plan = $self->plan;
1274 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1278 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1279 my $class = ref($self). "::$plan";
1280 warn "reblessing $self into $class" if $DEBUG;
1283 bless($self, $class) unless $@;
1288 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1289 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1291 #fallback that return 0 for old legacy packages with no plan
1292 sub calc_remain { 0; }
1293 sub calc_units { 0; }
1295 #fallback for everything not based on flat.pm
1296 sub recur_temporality { 'upcoming'; }
1297 sub calc_cancel { 0; }
1299 #fallback for everything except bulk.pm
1300 sub hide_svc_detail { 0; }
1302 #fallback for packages that can't/won't summarize usage
1303 sub sum_usage { 0; }
1305 =item recur_cost_permonth CUST_PKG
1307 recur_cost divided by freq (only supported for monthly and longer frequencies)
1311 sub recur_cost_permonth {
1312 my($self, $cust_pkg) = @_;
1313 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1314 sprintf('%.2f', $self->recur_cost / $self->freq );
1317 =item format OPTION DATA
1319 Returns data formatted according to the function 'format' described
1320 in the plan info. Returns DATA if no such function exists.
1325 my ($self, $option, $data) = (shift, shift, shift);
1326 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1327 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1333 =item parse OPTION DATA
1335 Returns data parsed according to the function 'parse' described
1336 in the plan info. Returns DATA if no such function exists.
1341 my ($self, $option, $data) = (shift, shift, shift);
1342 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1343 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1353 =head1 CLASS METHODS
1361 # Used by FS::Upgrade to migrate to a new database.
1363 sub _upgrade_data { # class method
1364 my($class, %opts) = @_;
1366 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1368 my @part_pkg = qsearch({
1369 'table' => 'part_pkg',
1370 'extra_sql' => "WHERE ". join(' OR ',
1371 ( map "($_ IS NOT NULL AND $_ != '' )",
1372 qw( plandata setup recur ) ),
1373 'plan IS NULL', "plan = '' ",
1377 foreach my $part_pkg (@part_pkg) {
1379 unless ( $part_pkg->plan ) {
1380 $part_pkg->plan('flat');
1383 if ( length($part_pkg->option('setup_fee')) == 0
1384 && $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) {
1386 my $opt = new FS::part_pkg_option {
1387 'pkgpart' => $part_pkg->pkgpart,
1388 'optionname' => 'setup_fee',
1389 'optionvalue' => $1,
1391 my $error = $opt->insert;
1392 die $error if $error;
1396 # die "Can't parse part_pkg.setup for fee; convert pkgnum ".
1397 # $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n";
1399 $part_pkg->setup('');
1401 if ( length($part_pkg->option('recur_fee')) == 0
1402 && $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) {
1404 my $opt = new FS::part_pkg_option {
1405 'pkgpart' => $part_pkg->pkgpart,
1406 'optionname' => 'recur_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->recur('');
1419 $part_pkg->replace; #this should take care of plandata, right?
1423 # now upgrade to the explicit custom flag
1425 @part_pkg = qsearch({
1426 'table' => 'part_pkg',
1427 'hashref' => { disabled => 'Y', custom => '' },
1428 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1431 foreach my $part_pkg (@part_pkg) {
1432 my $new = new FS::part_pkg { $part_pkg->hash };
1434 my $comment = $part_pkg->comment;
1435 $comment =~ s/^\(CUSTOM\) //;
1436 $comment = '(none)' unless $comment =~ /\S/;
1437 $new->comment($comment);
1439 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1440 my $primary = $part_pkg->svcpart;
1441 my $options = { $part_pkg->options };
1443 my $error = $new->replace( $part_pkg,
1444 'pkg_svc' => $pkg_svc,
1445 'primary_svc' => $primary,
1446 'options' => $options,
1448 die $error if $error;
1451 my @part_pkg_option = qsearch('part_pkg_option',
1452 { 'optionname' => 'unused_credit',
1455 foreach my $old_opt (@part_pkg_option) {
1456 my $pkgpart = $old_opt->pkgpart;
1457 my $error = $old_opt->delete;
1458 die $error if $error;
1460 foreach (qw(unused_credit_cancel unused_credit_change)) {
1461 my $new_opt = new FS::part_pkg_option {
1462 'pkgpart' => $pkgpart,
1466 $error = $new_opt->insert;
1467 die $error if $error;
1471 # migrate use_disposition_taqua and use_disposition to disposition_in
1472 @part_pkg_option = qsearch('part_pkg_option',
1473 { 'optionname' => { op => 'LIKE',
1474 value => 'use_disposition%',
1478 my %newopts = map { $_->pkgpart => $_ }
1479 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1480 foreach my $old_opt (@part_pkg_option) {
1481 my $pkgpart = $old_opt->pkgpart;
1482 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1484 my $error = $old_opt->delete;
1485 die $error if $error;
1487 if ( exists($newopts{$pkgpart}) ) {
1488 my $opt = $newopts{$pkgpart};
1489 $opt->optionvalue($opt->optionvalue.",$newval");
1490 $error = $opt->replace;
1491 die $error if $error;
1493 my $new_opt = new FS::part_pkg_option {
1494 'pkgpart' => $pkgpart,
1495 'optionname' => 'disposition_in',
1496 'optionvalue' => $newval,
1498 $error = $new_opt->insert;
1499 die $error if $error;
1500 $newopts{$pkgpart} = $new_opt;
1506 =item curuser_pkgs_sql
1508 Returns an SQL fragment for searching for packages the current user can
1509 use, either via part_pkg.agentnum directly, or via agent type (see
1514 sub curuser_pkgs_sql {
1517 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1521 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1523 Returns an SQL fragment for searching for packages the provided agent or agents
1524 can use, either via part_pkg.agentnum directly, or via agent type (see
1529 sub agent_pkgs_sql {
1530 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1531 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1533 $class->_pkgs_sql(@agentnums); #is this why
1538 my( $class, @agentnums ) = @_;
1539 my $agentnums = join(',', @agentnums);
1543 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1544 OR ( agentnum IS NULL
1545 AND EXISTS ( SELECT 1
1547 LEFT JOIN agent_type USING ( typenum )
1548 LEFT JOIN agent AS typeagent USING ( typenum )
1549 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1550 AND typeagent.agentnum IN ($agentnums)
1568 #false laziness w/part_export & cdr
1570 foreach my $INC ( @INC ) {
1571 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1572 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1573 warn "attempting to load plan info from $file\n" if $DEBUG;
1574 $file =~ /\/(\w+)\.pm$/ or do {
1575 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1579 my $info = eval "use FS::part_pkg::$mod; ".
1580 "\\%FS::part_pkg::$mod\::info;";
1582 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1585 unless ( keys %$info ) {
1586 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1589 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1590 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1591 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1594 $info{$mod} = $info;
1595 $info->{'weight'} ||= 0; # quiet warnings
1599 # copy one level deep to allow replacement of fields and fieldorder
1600 tie %plans, 'Tie::IxHash',
1601 map { my %infohash = %{ $info{$_} };
1603 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1606 # inheritance of plan options
1607 foreach my $name (keys(%info)) {
1608 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1609 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1610 delete $plans{$name};
1613 my $parents = $info{$name}->{'inherit_fields'} || [];
1614 my (%fields, %field_exists, @fieldorder);
1615 foreach my $parent ($name, @$parents) {
1616 if ( !exists($info{$parent}) ) {
1617 warn "$name tried to inherit from nonexistent '$parent'\n";
1620 %fields = ( # avoid replacing existing fields
1621 %{ $info{$parent}->{'fields'} || {} },
1624 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1626 next if $field_exists{$_};
1627 $field_exists{$_} = 1;
1628 # allow inheritors to remove inherited fields from the fieldorder
1629 push @fieldorder, $_ if !exists($fields{$_}) or
1630 !exists($fields{$_}->{'disabled'});
1633 $plans{$name}->{'fields'} = \%fields;
1634 $plans{$name}->{'fieldorder'} = \@fieldorder;
1644 =head1 NEW PLAN CLASSES
1646 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1647 found in eg/plan_template.pm. Until then, it is suggested that you use the
1648 other modules in FS/FS/part_pkg/ as a guide.
1652 The delete method is unimplemented.
1654 setup and recur semantics are not yet defined (and are implemented in
1655 FS::cust_bill. hmm.). now they're deprecated and need to go.
1659 part_pkg_taxrate is Pg specific
1661 replace should be smarter about managing the related tables (options, pkg_svc)
1665 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1666 schema.html from the base documentation.