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
106 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
109 =item successor - Foreign key for the part_pkg that replaced this record.
110 If this record is not obsolete, will be null.
112 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
113 ancestor of this record. If this record is not a successor to another
114 part_pkg, will be equal to pkgpart.
124 Creates a new package definition. To add the package definition to
125 the database, see L<"insert">.
129 sub table { 'part_pkg'; }
133 An alternate constructor. Creates a new package definition by duplicating
134 an existing definition. A new pkgpart is assigned and the custom flag is
135 set to Y. To add the package definition to the database, see L<"insert">.
141 my $class = ref($self);
142 my %hash = $self->hash;
143 $hash{'pkgpart'} = '';
144 $hash{'custom'} = 'Y';
145 #new FS::part_pkg ( \%hash ); # ?
146 new $class ( \%hash ); # ?
149 =item insert [ , OPTION => VALUE ... ]
151 Adds this package definition to the database. If there is an error,
152 returns the error, otherwise returns false.
154 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
155 I<custnum_ref> and I<options>.
157 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
158 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
159 be set to a hashref of svcparts and flag values ('Y' or '') to set the
160 'hidden' field in these records.
162 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
163 FS::pkg_svc record will be updated.
165 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
166 record itself), the object will be updated to point to this package definition.
168 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
169 the scalar will be updated with the custnum value from the cust_pkg record.
171 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
172 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
173 records will be inserted.
175 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
176 records will be inserted.
183 warn "FS::part_pkg::insert called on $self with options ".
184 join(', ', map "$_=>$options{$_}", keys %options)
187 local $SIG{HUP} = 'IGNORE';
188 local $SIG{INT} = 'IGNORE';
189 local $SIG{QUIT} = 'IGNORE';
190 local $SIG{TERM} = 'IGNORE';
191 local $SIG{TSTP} = 'IGNORE';
192 local $SIG{PIPE} = 'IGNORE';
194 my $oldAutoCommit = $FS::UID::AutoCommit;
195 local $FS::UID::AutoCommit = 0;
198 warn " inserting part_pkg record" if $DEBUG;
199 my $error = $self->SUPER::insert( $options{options} );
201 $dbh->rollback if $oldAutoCommit;
206 if ( $self->get('family_pkgpart') eq '' ) {
207 $self->set('family_pkgpart' => $self->pkgpart);
208 $error = $self->SUPER::replace;
210 $dbh->rollback if $oldAutoCommit;
215 my $conf = new FS::Conf;
216 if ( $conf->exists('agent_defaultpkg') ) {
217 warn " agent_defaultpkg set; allowing all agents to purchase package"
219 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
220 my $type_pkgs = new FS::type_pkgs({
221 'typenum' => $agent_type->typenum,
222 'pkgpart' => $self->pkgpart,
224 my $error = $type_pkgs->insert;
226 $dbh->rollback if $oldAutoCommit;
232 warn " inserting part_pkg_taxoverride records" if $DEBUG;
233 my %overrides = %{ $options{'tax_overrides'} || {} };
234 foreach my $usage_class ( keys %overrides ) {
236 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
237 ? $overrides{$usage_class}
239 my @overrides = (grep "$_", split(',', $override) );
240 my $error = $self->process_m2m (
241 'link_table' => 'part_pkg_taxoverride',
242 'target_table' => 'tax_class',
243 'hashref' => { 'usage_class' => $usage_class },
244 'params' => \@overrides,
247 $dbh->rollback if $oldAutoCommit;
252 unless ( $skip_pkg_svc_hack ) {
254 warn " inserting pkg_svc records" if $DEBUG;
255 my $pkg_svc = $options{'pkg_svc'} || {};
256 my $hidden_svc = $options{'hidden_svc'} || {};
257 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
258 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
260 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
264 my $pkg_svc = new FS::pkg_svc( {
265 'pkgpart' => $self->pkgpart,
266 'svcpart' => $part_svc->svcpart,
267 'quantity' => $quantity,
268 'primary_svc' => $primary_svc,
269 'hidden' => $hidden_svc->{$part_svc->svcpart},
271 my $error = $pkg_svc->insert;
273 $dbh->rollback if $oldAutoCommit;
280 if ( $options{'cust_pkg'} ) {
281 warn " updating cust_pkg record " if $DEBUG;
283 ref($options{'cust_pkg'})
284 ? $options{'cust_pkg'}
285 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
286 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
287 if $options{'custnum_ref'};
288 my %hash = $old_cust_pkg->hash;
289 $hash{'pkgpart'} = $self->pkgpart,
290 my $new_cust_pkg = new FS::cust_pkg \%hash;
291 local($FS::cust_pkg::disable_agentcheck) = 1;
292 my $error = $new_cust_pkg->replace($old_cust_pkg);
294 $dbh->rollback if $oldAutoCommit;
295 return "Error modifying cust_pkg record: $error";
299 if ( $options{'part_pkg_vendor'} ) {
300 while ( my ($exportnum, $vendor_pkg_id) =
301 each %{ $options{part_pkg_vendor} }
304 my $ppv = new FS::part_pkg_vendor( {
305 'pkgpart' => $self->pkgpart,
306 'exportnum' => $exportnum,
307 'vendor_pkg_id' => $vendor_pkg_id,
309 my $error = $ppv->insert;
311 $dbh->rollback if $oldAutoCommit;
312 return "Error inserting part_pkg_vendor record: $error";
317 warn " committing transaction" if $DEBUG and $oldAutoCommit;
318 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
325 Currently unimplemented.
330 return "Can't (yet?) delete package definitions.";
331 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
334 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
336 Replaces OLD_RECORD with this one in the database. If there is an error,
337 returns the error, otherwise returns false.
339 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
342 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
343 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
344 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
345 'hidden' field in these records.
347 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
348 FS::pkg_svc record will be updated.
350 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
358 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
363 ( ref($_[0]) eq 'HASH' )
367 $options->{options} = {} unless defined($options->{options});
369 warn "FS::part_pkg::replace called on $new to replace $old with options".
370 join(', ', map "$_ => ". $options->{$_}, keys %$options)
373 local $SIG{HUP} = 'IGNORE';
374 local $SIG{INT} = 'IGNORE';
375 local $SIG{QUIT} = 'IGNORE';
376 local $SIG{TERM} = 'IGNORE';
377 local $SIG{TSTP} = 'IGNORE';
378 local $SIG{PIPE} = 'IGNORE';
380 my $oldAutoCommit = $FS::UID::AutoCommit;
381 local $FS::UID::AutoCommit = 0;
384 my $conf = new FS::Conf;
385 if ( $conf->exists('part_pkg-lineage') ) {
386 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
387 qw(setup_fee recur_fee) #others? config?
390 warn " superseding package" if $DEBUG;
392 my $error = $new->supersede($old, %$options);
394 $dbh->rollback if $oldAutoCommit;
398 warn " committing transaction" if $DEBUG and $oldAutoCommit;
399 $dbh->commit if $oldAutoCommit;
406 #plandata shit stays in replace for upgrades until after 2.0 (or edit
408 warn " saving legacy plandata" if $DEBUG;
409 my $plandata = $new->get('plandata');
410 $new->set('plandata', '');
412 warn " deleting old part_pkg_option records" if $DEBUG;
413 foreach my $part_pkg_option ( $old->part_pkg_option ) {
414 my $error = $part_pkg_option->delete;
416 $dbh->rollback if $oldAutoCommit;
421 warn " replacing part_pkg record" if $DEBUG;
422 my $error = $new->SUPER::replace($old, $options->{options} );
424 $dbh->rollback if $oldAutoCommit;
428 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
429 foreach my $part_pkg_option (
430 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
431 return "illegal plandata: $plandata";
433 new FS::part_pkg_option {
434 'pkgpart' => $new->pkgpart,
439 split("\n", $plandata)
441 my $error = $part_pkg_option->insert;
443 $dbh->rollback if $oldAutoCommit;
448 warn " replacing pkg_svc records" if $DEBUG;
449 my $pkg_svc = $options->{'pkg_svc'} || {};
450 my $hidden_svc = $options->{'hidden_svc'} || {};
451 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
452 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
453 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
455 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
456 && $options->{'primary_svc'} == $part_svc->svcpart
461 my $old_pkg_svc = qsearchs('pkg_svc', {
462 'pkgpart' => $old->pkgpart,
463 'svcpart' => $part_svc->svcpart,
466 my $old_quantity = 0;
467 my $old_primary_svc = '';
469 if ( $old_pkg_svc ) {
470 $old_quantity = $old_pkg_svc->quantity;
471 $old_primary_svc = $old_pkg_svc->primary_svc
472 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
473 $old_hidden = $old_pkg_svc->hidden;
476 next unless $old_quantity != $quantity ||
477 $old_primary_svc ne $primary_svc ||
478 $old_hidden ne $hidden;
480 my $new_pkg_svc = new FS::pkg_svc( {
481 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
482 'pkgpart' => $new->pkgpart,
483 'svcpart' => $part_svc->svcpart,
484 'quantity' => $quantity,
485 'primary_svc' => $primary_svc,
488 my $error = $old_pkg_svc
489 ? $new_pkg_svc->replace($old_pkg_svc)
490 : $new_pkg_svc->insert;
492 $dbh->rollback if $oldAutoCommit;
497 my @part_pkg_vendor = $old->part_pkg_vendor;
498 my @current_exportnum = ();
499 if ( $options->{'part_pkg_vendor'} ) {
500 my($exportnum,$vendor_pkg_id);
501 while ( ($exportnum,$vendor_pkg_id)
502 = each %{$options->{'part_pkg_vendor'}} ) {
504 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
505 if($exportnum == $part_pkg_vendor->exportnum
506 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
507 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
508 my $error = $part_pkg_vendor->replace;
510 $dbh->rollback if $oldAutoCommit;
511 return "Error replacing part_pkg_vendor record: $error";
516 elsif($exportnum == $part_pkg_vendor->exportnum
517 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
522 unless ( $noinsert ) {
523 my $ppv = new FS::part_pkg_vendor( {
524 'pkgpart' => $new->pkgpart,
525 'exportnum' => $exportnum,
526 'vendor_pkg_id' => $vendor_pkg_id,
528 my $error = $ppv->insert;
530 $dbh->rollback if $oldAutoCommit;
531 return "Error inserting part_pkg_vendor record: $error";
534 push @current_exportnum, $exportnum;
537 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
538 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
539 my $error = $part_pkg_vendor->delete;
541 $dbh->rollback if $oldAutoCommit;
542 return "Error deleting part_pkg_vendor record: $error";
547 # propagate changes to certain core fields
548 if ( $conf->exists('part_pkg-lineage') ) {
549 warn " propagating changes to family" if $DEBUG;
550 my $error = $new->propagate($old);
552 $dbh->rollback if $oldAutoCommit;
557 warn " committing transaction" if $DEBUG and $oldAutoCommit;
558 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
564 Checks all fields to make sure this is a valid package definition. If
565 there is an error, returns the error, otherwise returns false. Called by the
566 insert and replace methods.
572 warn "FS::part_pkg::check called on $self" if $DEBUG;
574 for (qw(setup recur plandata)) {
575 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
576 return "Use of $_ field is deprecated; set a plan and options: ".
578 if length($self->get($_));
582 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
583 my $error = $self->ut_number('freq');
584 return $error if $error;
586 $self->freq =~ /^(\d+[hdw]?)$/
587 or return "Illegal or empty freq: ". $self->freq;
591 my @null_agentnum_right = ( 'Edit global package definitions' );
592 push @null_agentnum_right, 'One-time charge'
593 if $self->freq =~ /^0/;
594 push @null_agentnum_right, 'Customize customer package'
595 if $self->disabled eq 'Y'; #good enough
597 my $error = $self->ut_numbern('pkgpart')
598 || $self->ut_text('pkg')
599 || $self->ut_text('comment')
600 || $self->ut_textn('promo_code')
601 || $self->ut_alphan('plan')
602 || $self->ut_enum('setuptax', [ '', 'Y' ] )
603 || $self->ut_enum('recurtax', [ '', 'Y' ] )
604 || $self->ut_textn('taxclass')
605 || $self->ut_enum('disabled', [ '', 'Y' ] )
606 || $self->ut_enum('custom', [ '', 'Y' ] )
607 || $self->ut_enum('no_auto', [ '', 'Y' ])
608 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
609 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
610 #|| $self->ut_moneyn('setup_cost')
611 #|| $self->ut_moneyn('recur_cost')
612 || $self->ut_floatn('setup_cost')
613 || $self->ut_floatn('recur_cost')
614 || $self->ut_floatn('pay_weight')
615 || $self->ut_floatn('credit_weight')
616 || $self->ut_numbern('taxproductnum')
617 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
618 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
619 || $self->ut_foreign_keyn('taxproductnum',
620 'part_pkg_taxproduct',
624 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
625 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
627 || $self->ut_numbern('fcc_ds0s')
628 || $self->ut_numbern('fcc_voip_class')
629 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
630 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
631 || $self->SUPER::check
633 return $error if $error;
635 return 'Unknown plan '. $self->plan
636 unless exists($plans{$self->plan});
638 my $conf = new FS::Conf;
639 return 'Taxclass is required'
640 if ! $self->taxclass && $conf->exists('require_taxclasses');
645 =item supersede OLD [, OPTION => VALUE ... ]
647 Inserts this package as a successor to the package OLD. All options are as
648 for C<insert>. After inserting, disables OLD and sets the new package as its
654 my ($new, $old, %options) = @_;
657 $new->set('pkgpart' => '');
658 $new->set('family_pkgpart' => $old->family_pkgpart);
659 warn " inserting successor package\n" if $DEBUG;
660 $error = $new->insert(%options);
661 return $error if $error;
663 warn " disabling superseded package\n" if $DEBUG;
664 $old->set('successor' => $new->pkgpart);
665 $old->set('disabled' => 'Y');
666 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
667 return $error if $error;
669 warn " propagating changes to family" if $DEBUG;
670 $new->propagate($old);
675 If any of certain fields have changed from OLD to this package, then,
676 for all packages in the same lineage as this one, sets those fields
677 to their values in this package.
681 my @propagate_fields = (
682 qw( pkg classnum setup_cost recur_cost taxclass
683 setuptax recurtax pay_weight credit_weight
691 map { $_ => $new->get($_) }
692 grep { $new->get($_) ne $old->get($_) }
696 my @part_pkg = qsearch('part_pkg', {
697 'family_pkgpart' => $new->family_pkgpart
700 foreach my $part_pkg ( @part_pkg ) {
701 my $pkgpart = $part_pkg->pkgpart;
702 next if $pkgpart == $new->pkgpart; # don't modify $new
703 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
704 foreach ( keys %fields ) {
705 $part_pkg->set($_, $fields{$_});
707 # SUPER::replace to avoid changing non-core fields
708 my $error = $part_pkg->SUPER::replace;
709 push @error, "pkgpart $pkgpart: $error"
715 =item pkg_comment [ OPTION => VALUE... ]
717 Returns an (internal) string representing this package. Currently,
718 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
719 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
722 If the option nopkgpart is true then the "pkgpart: ' is omitted.
730 #$self->pkg. ' - '. $self->comment;
731 #$self->pkg. ' ('. $self->comment. ')';
732 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
733 $pre. $self->pkg. ' - '. $self->custom_comment;
736 sub price_info { # safety, in case a part_pkg hasn't defined price_info
742 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment . ' ' . $self->price_info;
747 Returns the package class, as an FS::pkg_class object, or the empty string
748 if there is no package class.
754 if ( $self->classnum ) {
755 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
761 =item addon_pkg_class
763 Returns the add-on package class, as an FS::pkg_class object, or the empty
764 string if there is no add-on package class.
768 sub addon_pkg_class {
770 if ( $self->addon_classnum ) {
771 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
779 Returns the package category name, or the empty string if there is no package
786 my $pkg_class = $self->pkg_class;
788 ? $pkg_class->categoryname
794 Returns the package class name, or the empty string if there is no package
801 my $pkg_class = $self->pkg_class;
803 ? $pkg_class->classname
807 =item addon_classname
809 Returns the add-on package class name, or the empty string if there is no
810 add-on package class.
814 sub addon_classname {
816 my $pkg_class = $self->addon_pkg_class;
818 ? $pkg_class->classname
824 Returns the associated agent for this event, if any, as an FS::agent object.
830 qsearchs('agent', { 'agentnum' => $self->agentnum } );
833 =item pkg_svc [ HASHREF | OPTION => VALUE ]
835 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
836 definition (with non-zero quantity).
838 One option is available, I<disable_linked>. If set true it will return the
839 services for this package definition alone, omitting services from any add-on
846 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
853 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
859 # #sort { $b->primary cmp $a->primary }
860 # grep { $_->quantity }
861 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
863 my $opt = ref($_[0]) ? $_[0] : { @_ };
864 my %pkg_svc = map { $_->svcpart => $_ }
865 grep { $_->quantity }
866 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
868 unless ( $opt->{disable_linked} ) {
869 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
870 my @pkg_svc = grep { $_->quantity }
871 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
872 foreach my $pkg_svc ( @pkg_svc ) {
873 if ( $pkg_svc{$pkg_svc->svcpart} ) {
874 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
875 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
877 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
887 =item svcpart [ SVCDB ]
889 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
890 associated with this package definition (see L<FS::pkg_svc>). Returns
891 false if there not a primary service definition or exactly one service
892 definition with quantity 1, or if SVCDB is specified and does not match the
893 svcdb of the service definition. SVCDB can be specified as a scalar table
894 name, such as 'svc_acct', or as an arrayref of possible table names.
899 my $pkg_svc = shift->_primary_pkg_svc(@_);
900 $pkg_svc ? $pkg_svc->svcpart : '';
903 =item part_svc [ SVCDB ]
905 Like the B<svcpart> method, but returns the FS::part_svc object (see
911 my $pkg_svc = shift->_primary_pkg_svc(@_);
912 $pkg_svc ? $pkg_svc->part_svc : '';
915 sub _primary_pkg_svc {
918 my $svcdb = scalar(@_) ? shift : [];
919 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
920 my %svcdb = map { $_=>1 } @$svcdb;
923 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
926 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
927 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
929 return '' if scalar(@pkg_svc) != 1;
933 =item svcpart_unique_svcdb SVCDB
935 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
936 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
937 false if there not a primary service definition for SVCDB or there are multiple
938 service definitions for SVCDB.
942 sub svcpart_unique_svcdb {
943 my( $self, $svcdb ) = @_;
944 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
945 return '' if scalar(@svcdb_pkg_svc) != 1;
946 $svcdb_pkg_svc[0]->svcpart;
951 Returns a list of the acceptable payment types for this package. Eventually
952 this should come out of a database table and be editable, but currently has the
953 following logic instead:
955 If the package is free, the single item B<BILL> is
956 returned, otherwise, the single item B<CARD> is returned.
958 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
964 if ( $self->is_free ) {
973 Returns true if this package is free.
979 if ( $self->can('is_free_options') ) {
980 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
981 map { $self->option($_) }
982 $self->is_free_options;
984 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
985 "provides neither is_free_options nor is_free method; returning false";
990 sub can_discount { 0; }
992 sub can_start_date { 1; }
995 # moved to FS::Misc to make this accessible to other packages
997 FS::Misc::pkg_freqs();
1002 Returns an english representation of the I<freq> field, such as "monthly",
1003 "weekly", "semi-annually", etc.
1009 my $freq = $self->freq;
1011 #my $freqs_href = $self->freqs_href;
1012 my $freqs_href = freqs_href();
1014 if ( exists($freqs_href->{$freq}) ) {
1015 $freqs_href->{$freq};
1017 my $interval = 'month';
1018 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1019 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1020 $interval = $interval{$2};
1025 "every $freq ${interval}s";
1030 =item add_freq TIMESTAMP [ FREQ ]
1032 Adds a billing period of some frequency to the provided timestamp and
1033 returns the resulting timestamp, or -1 if the frequency could not be
1034 parsed (shouldn't happen). By default, the frequency of this package
1035 will be used; to override this, pass a different frequency as a second
1041 my( $self, $date, $freq ) = @_;
1042 $freq = $self->freq unless $freq;
1044 #change this bit to use Date::Manip? CAREFUL with timezones (see
1045 # mailing list archive)
1046 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1048 if ( $freq =~ /^\d+$/ ) {
1050 until ( $mon < 12 ) { $mon -= 12; $year++; }
1051 } elsif ( $freq =~ /^(\d+)w$/ ) {
1053 $mday += $weeks * 7;
1054 } elsif ( $freq =~ /^(\d+)d$/ ) {
1057 } elsif ( $freq =~ /^(\d+)h$/ ) {
1064 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1069 For backwards compatibility, returns the plandata field as well as all options
1070 from FS::part_pkg_option.
1076 carp "plandata is deprecated";
1078 $self->SUPER::plandata(@_);
1080 my $plandata = $self->get('plandata');
1081 my %options = $self->options;
1082 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1087 =item part_pkg_vendor
1089 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1090 L<FS::part_pkg_vendor>).
1094 sub part_pkg_vendor {
1096 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
1099 =item vendor_pkg_ids
1101 Returns a list of vendor/external package ids by exportnum
1105 sub vendor_pkg_ids {
1107 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1110 =item part_pkg_option
1112 Returns all options as FS::part_pkg_option objects (see
1113 L<FS::part_pkg_option>).
1117 sub part_pkg_option {
1119 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
1124 Returns a list of option names and values suitable for assigning to a hash.
1130 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1133 =item option OPTIONNAME [ QUIET ]
1135 Returns the option value for the given name, or the empty string. If a true
1136 value is passed as the second argument, warnings about missing the option
1142 my( $self, $opt, $ornull ) = @_;
1143 my $part_pkg_option =
1144 qsearchs('part_pkg_option', {
1145 pkgpart => $self->pkgpart,
1148 return $part_pkg_option->optionvalue if $part_pkg_option;
1149 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1150 split("\n", $self->get('plandata') );
1151 return $plandata{$opt} if exists $plandata{$opt};
1152 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1153 "not found in options or plandata!\n"
1158 =item bill_part_pkg_link
1160 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1164 sub bill_part_pkg_link {
1165 shift->_part_pkg_link('bill', @_);
1168 =item svc_part_pkg_link
1170 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1174 sub svc_part_pkg_link {
1175 shift->_part_pkg_link('svc', @_);
1178 =item supp_part_pkg_link
1180 Returns the associated part_pkg_link records of type 'supp' (supplemental
1185 sub supp_part_pkg_link {
1186 shift->_part_pkg_link('supp', @_);
1189 sub _part_pkg_link {
1190 my( $self, $type ) = @_;
1191 qsearch({ table => 'part_pkg_link',
1192 hashref => { 'src_pkgpart' => $self->pkgpart,
1193 'link_type' => $type,
1194 #protection against infinite recursive links
1195 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1197 order_by => "ORDER BY hidden",
1201 sub self_and_bill_linked {
1202 shift->_self_and_linked('bill', @_);
1205 sub self_and_svc_linked {
1206 shift->_self_and_linked('svc', @_);
1209 sub _self_and_linked {
1210 my( $self, $type, $hidden ) = @_;
1214 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1215 $self->_part_pkg_link($type) ) )
1217 $_->hidden($hidden) if $hidden;
1224 =item part_pkg_taxoverride [ CLASS ]
1226 Returns all associated FS::part_pkg_taxoverride objects (see
1227 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1228 of class CLASS if defined. Class may be one of 'setup', 'recur',
1229 the empty string (default), or a usage class number (see L<FS::usage_class>).
1230 When a class is specified, the empty string class (default) is returned
1231 if no more specific values exist.
1235 sub part_pkg_taxoverride {
1239 my $hashref = { 'pkgpart' => $self->pkgpart };
1240 $hashref->{'usage_class'} = $class if defined($class);
1241 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1243 unless ( scalar(@overrides) || !defined($class) || !$class ){
1244 $hashref->{'usage_class'} = '';
1245 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1251 =item has_taxproduct
1253 Returns true if this package has any taxproduct associated with it.
1257 sub has_taxproduct {
1260 $self->taxproductnum ||
1261 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1262 keys %{ {$self->options} }
1268 =item taxproduct [ CLASS ]
1270 Returns the associated tax product for this package definition (see
1271 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1272 the usage classnum (see L<FS::usage_class>). Returns the default
1273 tax product for this record if the more specific CLASS value does
1282 my $part_pkg_taxproduct;
1284 my $taxproductnum = $self->taxproductnum;
1286 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1287 $taxproductnum = $class_taxproductnum
1288 if $class_taxproductnum
1291 $part_pkg_taxproduct =
1292 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1294 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1295 $taxproductnum = $self->taxproductnum;
1296 $part_pkg_taxproduct =
1297 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1300 $part_pkg_taxproduct;
1303 =item taxproduct_description [ CLASS ]
1305 Returns the description of the associated tax product for this package
1306 definition (see L<FS::part_pkg_taxproduct>).
1310 sub taxproduct_description {
1312 my $part_pkg_taxproduct = $self->taxproduct(@_);
1313 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1316 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1318 Returns the package to taxrate m2m records for this package in the location
1319 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1320 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1321 (see L<FS::usage_class>).
1325 sub _expand_cch_taxproductnum {
1328 my $part_pkg_taxproduct = $self->taxproduct($class);
1330 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1331 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1334 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1335 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1336 OR taxproduct = '$a:$b:$c:'
1337 OR taxproduct = '$a:$b:".":$d'
1338 OR taxproduct = '$a:$b:".":' )";
1339 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1340 'hashref' => { 'data_vendor'=>'cch' },
1341 'extra_sql' => $extra_sql,
1346 sub part_pkg_taxrate {
1348 my ($data_vendor, $geocode, $class) = @_;
1351 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1352 dbh->quote($data_vendor);
1354 # CCH oddness in m2m
1355 $extra_sql .= ' AND ('.
1356 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1360 # much more CCH oddness in m2m -- this is kludgy
1361 my @tpnums = $self->_expand_cch_taxproductnum($class);
1362 if (scalar(@tpnums)) {
1363 $extra_sql .= ' AND ('.
1364 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1367 $extra_sql .= ' AND ( 0 = 1 )';
1370 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1371 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1372 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1374 # should qsearch preface columns with the table to facilitate joins?
1375 qsearch( { 'table' => 'part_pkg_taxrate',
1376 'select' => $select,
1377 'hashref' => { # 'data_vendor' => $data_vendor,
1378 # 'taxproductnum' => $self->taxproductnum,
1380 'addl_from' => $addl_from,
1381 'extra_sql' => $extra_sql,
1382 'order_by' => $order_by,
1386 =item part_pkg_discount
1388 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1393 sub part_pkg_discount {
1395 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1400 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1401 PLAN is the object's I<plan> field. There should be better docs
1402 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1408 my $plan = $self->plan;
1410 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1414 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1415 my $class = ref($self). "::$plan";
1416 warn "reblessing $self into $class" if $DEBUG > 1;
1419 bless($self, $class) unless $@;
1424 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1425 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1427 #fallback that return 0 for old legacy packages with no plan
1428 sub calc_remain { 0; }
1429 sub calc_units { 0; }
1431 #fallback for everything not based on flat.pm
1432 sub recur_temporality { 'upcoming'; }
1433 sub calc_cancel { 0; }
1435 #fallback for everything except bulk.pm
1436 sub hide_svc_detail { 0; }
1438 #fallback for packages that can't/won't summarize usage
1439 sub sum_usage { 0; }
1441 =item recur_cost_permonth CUST_PKG
1443 recur_cost divided by freq (only supported for monthly and longer frequencies)
1447 sub recur_cost_permonth {
1448 my($self, $cust_pkg) = @_;
1449 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1450 sprintf('%.2f', $self->recur_cost / $self->freq );
1453 =item cust_bill_pkg_recur CUST_PKG
1455 Actual recurring charge for the specified customer package from customer's most
1460 sub cust_bill_pkg_recur {
1461 my($self, $cust_pkg) = @_;
1462 my $cust_bill_pkg = qsearchs({
1463 'table' => 'cust_bill_pkg',
1464 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1465 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1466 'recur' => { op=>'>', value=>'0' },
1468 'order_by' => 'ORDER BY cust_bill._date DESC,
1469 cust_bill_pkg.sdate DESC
1472 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1473 $cust_bill_pkg->recur;
1476 =item format OPTION DATA
1478 Returns data formatted according to the function 'format' described
1479 in the plan info. Returns DATA if no such function exists.
1484 my ($self, $option, $data) = (shift, shift, shift);
1485 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1486 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1492 =item parse OPTION DATA
1494 Returns data parsed according to the function 'parse' described
1495 in the plan info. Returns DATA if no such function exists.
1500 my ($self, $option, $data) = (shift, shift, shift);
1501 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1502 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1512 =head1 CLASS METHODS
1520 # Used by FS::Upgrade to migrate to a new database.
1522 sub _upgrade_data { # class method
1523 my($class, %opts) = @_;
1525 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1527 my @part_pkg = qsearch({
1528 'table' => 'part_pkg',
1529 'extra_sql' => "WHERE ". join(' OR ',
1530 'plan IS NULL', "plan = '' ",
1534 foreach my $part_pkg (@part_pkg) {
1536 unless ( $part_pkg->plan ) {
1537 $part_pkg->plan('flat');
1544 # now upgrade to the explicit custom flag
1546 @part_pkg = qsearch({
1547 'table' => 'part_pkg',
1548 'hashref' => { disabled => 'Y', custom => '' },
1549 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1552 foreach my $part_pkg (@part_pkg) {
1553 my $new = new FS::part_pkg { $part_pkg->hash };
1555 my $comment = $part_pkg->comment;
1556 $comment =~ s/^\(CUSTOM\) //;
1557 $comment = '(none)' unless $comment =~ /\S/;
1558 $new->comment($comment);
1560 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1561 my $primary = $part_pkg->svcpart;
1562 my $options = { $part_pkg->options };
1564 my $error = $new->replace( $part_pkg,
1565 'pkg_svc' => $pkg_svc,
1566 'primary_svc' => $primary,
1567 'options' => $options,
1569 die $error if $error;
1572 # set family_pkgpart on any packages that don't have it
1573 @part_pkg = qsearch('part_pkg', { 'family_pkgpart' => '' });
1574 foreach my $part_pkg (@part_pkg) {
1575 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1576 my $error = $part_pkg->SUPER::replace;
1577 die $error if $error;
1580 my @part_pkg_option = qsearch('part_pkg_option',
1581 { 'optionname' => 'unused_credit',
1584 foreach my $old_opt (@part_pkg_option) {
1585 my $pkgpart = $old_opt->pkgpart;
1586 my $error = $old_opt->delete;
1587 die $error if $error;
1589 foreach (qw(unused_credit_cancel unused_credit_change)) {
1590 my $new_opt = new FS::part_pkg_option {
1591 'pkgpart' => $pkgpart,
1595 $error = $new_opt->insert;
1596 die $error if $error;
1600 # migrate use_disposition_taqua and use_disposition to disposition_in
1601 @part_pkg_option = qsearch('part_pkg_option',
1602 { 'optionname' => { op => 'LIKE',
1603 value => 'use_disposition%',
1607 my %newopts = map { $_->pkgpart => $_ }
1608 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1609 foreach my $old_opt (@part_pkg_option) {
1610 my $pkgpart = $old_opt->pkgpart;
1611 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1613 my $error = $old_opt->delete;
1614 die $error if $error;
1616 if ( exists($newopts{$pkgpart}) ) {
1617 my $opt = $newopts{$pkgpart};
1618 $opt->optionvalue($opt->optionvalue.",$newval");
1619 $error = $opt->replace;
1620 die $error if $error;
1622 my $new_opt = new FS::part_pkg_option {
1623 'pkgpart' => $pkgpart,
1624 'optionname' => 'disposition_in',
1625 'optionvalue' => $newval,
1627 $error = $new_opt->insert;
1628 die $error if $error;
1629 $newopts{$pkgpart} = $new_opt;
1633 # set any package with FCC voice lines to the "VoIP with broadband" category
1634 # for backward compatibility
1636 # recover from a bad upgrade bug
1637 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1638 if (!FS::upgrade_journal->is_done($upgrade)) {
1639 my $bad_upgrade = qsearchs('upgrade_journal',
1640 { upgrade => 'part_pkg_fcc_voip_class' }
1642 if ( $bad_upgrade ) {
1643 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1644 ' AND history_date > '.($bad_upgrade->_date - 3600);
1645 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1648 'table' => 'h_part_pkg_option',
1650 'extra_sql' => "$where AND history_action = 'delete'",
1651 'order_by' => 'ORDER BY history_date ASC',
1653 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1656 'table' => 'h_pkg_svc',
1658 'extra_sql' => "$where AND history_action = 'replace_old'",
1659 'order_by' => 'ORDER BY history_date ASC',
1662 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1663 my $pkgpart ||= $deleted->pkgpart;
1664 $opt{$pkgpart} ||= {
1670 if ( $deleted->isa('FS::part_pkg_option') ) {
1671 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1673 my $svcpart = $deleted->svcpart;
1674 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1675 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1676 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1679 foreach my $pkgpart (keys %opt) {
1680 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1681 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1683 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1686 } # $bad_upgrade exists
1687 else { # do the original upgrade, but correctly this time
1688 @part_pkg = qsearch('part_pkg', {
1689 fcc_ds0s => { op => '>', value => 0 },
1690 fcc_voip_class => ''
1692 foreach my $part_pkg (@part_pkg) {
1693 $part_pkg->set(fcc_voip_class => 2);
1694 my @pkg_svc = $part_pkg->pkg_svc;
1695 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1696 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1697 my $error = $part_pkg->replace(
1698 $part_pkg->replace_old,
1699 options => { $part_pkg->options },
1700 pkg_svc => \%quantity,
1701 hidden_svc => \%hidden,
1702 primary_svc => ($part_pkg->svcpart || ''),
1704 die $error if $error;
1707 FS::upgrade_journal->set_done($upgrade);
1712 =item curuser_pkgs_sql
1714 Returns an SQL fragment for searching for packages the current user can
1715 use, either via part_pkg.agentnum directly, or via agent type (see
1720 sub curuser_pkgs_sql {
1723 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1727 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1729 Returns an SQL fragment for searching for packages the provided agent or agents
1730 can use, either via part_pkg.agentnum directly, or via agent type (see
1735 sub agent_pkgs_sql {
1736 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1737 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1739 $class->_pkgs_sql(@agentnums); #is this why
1744 my( $class, @agentnums ) = @_;
1745 my $agentnums = join(',', @agentnums);
1749 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1750 OR ( agentnum IS NULL
1751 AND EXISTS ( SELECT 1
1753 LEFT JOIN agent_type USING ( typenum )
1754 LEFT JOIN agent AS typeagent USING ( typenum )
1755 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1756 AND typeagent.agentnum IN ($agentnums)
1774 #false laziness w/part_export & cdr
1776 foreach my $INC ( @INC ) {
1777 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1778 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1779 warn "attempting to load plan info from $file\n" if $DEBUG;
1780 $file =~ /\/(\w+)\.pm$/ or do {
1781 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1785 my $info = eval "use FS::part_pkg::$mod; ".
1786 "\\%FS::part_pkg::$mod\::info;";
1788 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1791 unless ( keys %$info ) {
1792 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1795 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1796 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1797 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1800 $info{$mod} = $info;
1801 $info->{'weight'} ||= 0; # quiet warnings
1805 # copy one level deep to allow replacement of fields and fieldorder
1806 tie %plans, 'Tie::IxHash',
1807 map { my %infohash = %{ $info{$_} };
1809 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1812 # inheritance of plan options
1813 foreach my $name (keys(%info)) {
1814 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1815 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1816 delete $plans{$name};
1819 my $parents = $info{$name}->{'inherit_fields'} || [];
1820 my (%fields, %field_exists, @fieldorder);
1821 foreach my $parent ($name, @$parents) {
1822 if ( !exists($info{$parent}) ) {
1823 warn "$name tried to inherit from nonexistent '$parent'\n";
1826 %fields = ( # avoid replacing existing fields
1827 %{ $info{$parent}->{'fields'} || {} },
1830 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1832 next if $field_exists{$_};
1833 $field_exists{$_} = 1;
1834 # allow inheritors to remove inherited fields from the fieldorder
1835 push @fieldorder, $_ if !exists($fields{$_}) or
1836 !exists($fields{$_}->{'disabled'});
1839 $plans{$name}->{'fields'} = \%fields;
1840 $plans{$name}->{'fieldorder'} = \@fieldorder;
1850 =head1 NEW PLAN CLASSES
1852 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1853 found in eg/plan_template.pm. Until then, it is suggested that you use the
1854 other modules in FS/FS/part_pkg/ as a guide.
1858 The delete method is unimplemented.
1860 setup and recur semantics are not yet defined (and are implemented in
1861 FS::cust_bill. hmm.). now they're deprecated and need to go.
1865 part_pkg_taxrate is Pg specific
1867 replace should be smarter about managing the related tables (options, pkg_svc)
1871 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1872 schema.html from the base documentation.