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} = { $old->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 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
452 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
453 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
454 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
456 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
457 && $options->{'primary_svc'} == $part_svc->svcpart
462 my $old_pkg_svc = qsearchs('pkg_svc', {
463 'pkgpart' => $old->pkgpart,
464 'svcpart' => $part_svc->svcpart,
467 my $old_quantity = 0;
468 my $old_primary_svc = '';
470 if ( $old_pkg_svc ) {
471 $old_quantity = $old_pkg_svc->quantity;
472 $old_primary_svc = $old_pkg_svc->primary_svc
473 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
474 $old_hidden = $old_pkg_svc->hidden;
477 next unless $old_quantity != $quantity ||
478 $old_primary_svc ne $primary_svc ||
479 $old_hidden ne $hidden;
481 my $new_pkg_svc = new FS::pkg_svc( {
482 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
483 'pkgpart' => $new->pkgpart,
484 'svcpart' => $part_svc->svcpart,
485 'quantity' => $quantity,
486 'primary_svc' => $primary_svc,
489 my $error = $old_pkg_svc
490 ? $new_pkg_svc->replace($old_pkg_svc)
491 : $new_pkg_svc->insert;
493 $dbh->rollback if $oldAutoCommit;
497 } #if $options->{pkg_svc}
499 my @part_pkg_vendor = $old->part_pkg_vendor;
500 my @current_exportnum = ();
501 if ( $options->{'part_pkg_vendor'} ) {
502 my($exportnum,$vendor_pkg_id);
503 while ( ($exportnum,$vendor_pkg_id)
504 = each %{$options->{'part_pkg_vendor'}} ) {
506 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
507 if($exportnum == $part_pkg_vendor->exportnum
508 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
509 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
510 my $error = $part_pkg_vendor->replace;
512 $dbh->rollback if $oldAutoCommit;
513 return "Error replacing part_pkg_vendor record: $error";
518 elsif($exportnum == $part_pkg_vendor->exportnum
519 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
524 unless ( $noinsert ) {
525 my $ppv = new FS::part_pkg_vendor( {
526 'pkgpart' => $new->pkgpart,
527 'exportnum' => $exportnum,
528 'vendor_pkg_id' => $vendor_pkg_id,
530 my $error = $ppv->insert;
532 $dbh->rollback if $oldAutoCommit;
533 return "Error inserting part_pkg_vendor record: $error";
536 push @current_exportnum, $exportnum;
539 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
540 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
541 my $error = $part_pkg_vendor->delete;
543 $dbh->rollback if $oldAutoCommit;
544 return "Error deleting part_pkg_vendor record: $error";
549 # propagate changes to certain core fields
550 if ( $conf->exists('part_pkg-lineage') ) {
551 warn " propagating changes to family" if $DEBUG;
552 my $error = $new->propagate($old);
554 $dbh->rollback if $oldAutoCommit;
559 warn " committing transaction" if $DEBUG and $oldAutoCommit;
560 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
566 Checks all fields to make sure this is a valid package definition. If
567 there is an error, returns the error, otherwise returns false. Called by the
568 insert and replace methods.
574 warn "FS::part_pkg::check called on $self" if $DEBUG;
576 for (qw(setup recur plandata)) {
577 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
578 return "Use of $_ field is deprecated; set a plan and options: ".
580 if length($self->get($_));
584 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
585 my $error = $self->ut_number('freq');
586 return $error if $error;
588 $self->freq =~ /^(\d+[hdw]?)$/
589 or return "Illegal or empty freq: ". $self->freq;
593 my @null_agentnum_right = ( 'Edit global package definitions' );
594 push @null_agentnum_right, 'One-time charge'
595 if $self->freq =~ /^0/;
596 push @null_agentnum_right, 'Customize customer package'
597 if $self->disabled eq 'Y'; #good enough
599 my $error = $self->ut_numbern('pkgpart')
600 || $self->ut_text('pkg')
601 || $self->ut_text('comment')
602 || $self->ut_textn('promo_code')
603 || $self->ut_alphan('plan')
604 || $self->ut_enum('setuptax', [ '', 'Y' ] )
605 || $self->ut_enum('recurtax', [ '', 'Y' ] )
606 || $self->ut_textn('taxclass')
607 || $self->ut_enum('disabled', [ '', 'Y' ] )
608 || $self->ut_enum('custom', [ '', 'Y' ] )
609 || $self->ut_enum('no_auto', [ '', 'Y' ])
610 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
611 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
612 #|| $self->ut_moneyn('setup_cost')
613 #|| $self->ut_moneyn('recur_cost')
614 || $self->ut_floatn('setup_cost')
615 || $self->ut_floatn('recur_cost')
616 || $self->ut_floatn('pay_weight')
617 || $self->ut_floatn('credit_weight')
618 || $self->ut_numbern('taxproductnum')
619 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
620 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
621 || $self->ut_foreign_keyn('taxproductnum',
622 'part_pkg_taxproduct',
626 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
627 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
629 || $self->ut_numbern('fcc_ds0s')
630 || $self->ut_numbern('fcc_voip_class')
631 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
632 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
633 || $self->SUPER::check
635 return $error if $error;
637 return 'Unknown plan '. $self->plan
638 unless exists($plans{$self->plan});
640 my $conf = new FS::Conf;
641 return 'Taxclass is required'
642 if ! $self->taxclass && $conf->exists('require_taxclasses');
647 =item supersede OLD [, OPTION => VALUE ... ]
649 Inserts this package as a successor to the package OLD. All options are as
650 for C<insert>. After inserting, disables OLD and sets the new package as its
656 my ($new, $old, %options) = @_;
659 $new->set('pkgpart' => '');
660 $new->set('family_pkgpart' => $old->family_pkgpart);
661 warn " inserting successor package\n" if $DEBUG;
662 $error = $new->insert(%options);
663 return $error if $error;
665 warn " disabling superseded package\n" if $DEBUG;
666 $old->set('successor' => $new->pkgpart);
667 $old->set('disabled' => 'Y');
668 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
669 return $error if $error;
671 warn " propagating changes to family" if $DEBUG;
672 $new->propagate($old);
677 If any of certain fields have changed from OLD to this package, then,
678 for all packages in the same lineage as this one, sets those fields
679 to their values in this package.
683 my @propagate_fields = (
684 qw( pkg classnum setup_cost recur_cost taxclass
685 setuptax recurtax pay_weight credit_weight
693 map { $_ => $new->get($_) }
694 grep { $new->get($_) ne $old->get($_) }
698 my @part_pkg = qsearch('part_pkg', {
699 'family_pkgpart' => $new->family_pkgpart
702 foreach my $part_pkg ( @part_pkg ) {
703 my $pkgpart = $part_pkg->pkgpart;
704 next if $pkgpart == $new->pkgpart; # don't modify $new
705 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
706 foreach ( keys %fields ) {
707 $part_pkg->set($_, $fields{$_});
709 # SUPER::replace to avoid changing non-core fields
710 my $error = $part_pkg->SUPER::replace;
711 push @error, "pkgpart $pkgpart: $error"
717 =item pkg_comment [ OPTION => VALUE... ]
719 Returns an (internal) string representing this package. Currently,
720 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
721 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
724 If the option nopkgpart is true then the "pkgpart: ' is omitted.
732 #$self->pkg. ' - '. $self->comment;
733 #$self->pkg. ' ('. $self->comment. ')';
734 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
735 $pre. $self->pkg. ' - '. $self->custom_comment;
738 sub price_info { # safety, in case a part_pkg hasn't defined price_info
744 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment . ' ' . $self->price_info;
749 Returns the package class, as an FS::pkg_class object, or the empty string
750 if there is no package class.
756 if ( $self->classnum ) {
757 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
763 =item addon_pkg_class
765 Returns the add-on package class, as an FS::pkg_class object, or the empty
766 string if there is no add-on package class.
770 sub addon_pkg_class {
772 if ( $self->addon_classnum ) {
773 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
781 Returns the package category name, or the empty string if there is no package
788 my $pkg_class = $self->pkg_class;
790 ? $pkg_class->categoryname
796 Returns the package class name, or the empty string if there is no package
803 my $pkg_class = $self->pkg_class;
805 ? $pkg_class->classname
809 =item addon_classname
811 Returns the add-on package class name, or the empty string if there is no
812 add-on package class.
816 sub addon_classname {
818 my $pkg_class = $self->addon_pkg_class;
820 ? $pkg_class->classname
826 Returns the associated agent for this event, if any, as an FS::agent object.
832 qsearchs('agent', { 'agentnum' => $self->agentnum } );
835 =item pkg_svc [ HASHREF | OPTION => VALUE ]
837 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
838 definition (with non-zero quantity).
840 One option is available, I<disable_linked>. If set true it will return the
841 services for this package definition alone, omitting services from any add-on
848 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
855 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
861 # #sort { $b->primary cmp $a->primary }
862 # grep { $_->quantity }
863 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
865 my $opt = ref($_[0]) ? $_[0] : { @_ };
866 my %pkg_svc = map { $_->svcpart => $_ }
867 grep { $_->quantity }
868 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
870 unless ( $opt->{disable_linked} ) {
871 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
872 my @pkg_svc = grep { $_->quantity }
873 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
874 foreach my $pkg_svc ( @pkg_svc ) {
875 if ( $pkg_svc{$pkg_svc->svcpart} ) {
876 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
877 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
879 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
889 =item svcpart [ SVCDB ]
891 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
892 associated with this package definition (see L<FS::pkg_svc>). Returns
893 false if there not a primary service definition or exactly one service
894 definition with quantity 1, or if SVCDB is specified and does not match the
895 svcdb of the service definition. SVCDB can be specified as a scalar table
896 name, such as 'svc_acct', or as an arrayref of possible table names.
901 my $pkg_svc = shift->_primary_pkg_svc(@_);
902 $pkg_svc ? $pkg_svc->svcpart : '';
905 =item part_svc [ SVCDB ]
907 Like the B<svcpart> method, but returns the FS::part_svc object (see
913 my $pkg_svc = shift->_primary_pkg_svc(@_);
914 $pkg_svc ? $pkg_svc->part_svc : '';
917 sub _primary_pkg_svc {
920 my $svcdb = scalar(@_) ? shift : [];
921 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
922 my %svcdb = map { $_=>1 } @$svcdb;
925 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
928 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
929 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
931 return '' if scalar(@pkg_svc) != 1;
935 =item svcpart_unique_svcdb SVCDB
937 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
938 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
939 false if there not a primary service definition for SVCDB or there are multiple
940 service definitions for SVCDB.
944 sub svcpart_unique_svcdb {
945 my( $self, $svcdb ) = @_;
946 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
947 return '' if scalar(@svcdb_pkg_svc) != 1;
948 $svcdb_pkg_svc[0]->svcpart;
953 Returns a list of the acceptable payment types for this package. Eventually
954 this should come out of a database table and be editable, but currently has the
955 following logic instead:
957 If the package is free, the single item B<BILL> is
958 returned, otherwise, the single item B<CARD> is returned.
960 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
966 if ( $self->is_free ) {
975 Returns true if this package is free.
981 if ( $self->can('is_free_options') ) {
982 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
983 map { $self->option($_) }
984 $self->is_free_options;
986 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
987 "provides neither is_free_options nor is_free method; returning false";
992 sub can_discount { 0; }
994 sub can_start_date { 1; }
997 # moved to FS::Misc to make this accessible to other packages
999 FS::Misc::pkg_freqs();
1004 Returns an english representation of the I<freq> field, such as "monthly",
1005 "weekly", "semi-annually", etc.
1011 my $freq = $self->freq;
1013 #my $freqs_href = $self->freqs_href;
1014 my $freqs_href = freqs_href();
1016 if ( exists($freqs_href->{$freq}) ) {
1017 $freqs_href->{$freq};
1019 my $interval = 'month';
1020 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1021 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1022 $interval = $interval{$2};
1027 "every $freq ${interval}s";
1032 =item add_freq TIMESTAMP [ FREQ ]
1034 Adds a billing period of some frequency to the provided timestamp and
1035 returns the resulting timestamp, or -1 if the frequency could not be
1036 parsed (shouldn't happen). By default, the frequency of this package
1037 will be used; to override this, pass a different frequency as a second
1043 my( $self, $date, $freq ) = @_;
1044 $freq = $self->freq unless $freq;
1046 #change this bit to use Date::Manip? CAREFUL with timezones (see
1047 # mailing list archive)
1048 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1050 if ( $freq =~ /^\d+$/ ) {
1052 until ( $mon < 12 ) { $mon -= 12; $year++; }
1053 } elsif ( $freq =~ /^(\d+)w$/ ) {
1055 $mday += $weeks * 7;
1056 } elsif ( $freq =~ /^(\d+)d$/ ) {
1059 } elsif ( $freq =~ /^(\d+)h$/ ) {
1066 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1071 For backwards compatibility, returns the plandata field as well as all options
1072 from FS::part_pkg_option.
1078 carp "plandata is deprecated";
1080 $self->SUPER::plandata(@_);
1082 my $plandata = $self->get('plandata');
1083 my %options = $self->options;
1084 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1089 =item part_pkg_vendor
1091 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1092 L<FS::part_pkg_vendor>).
1096 sub part_pkg_vendor {
1098 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
1101 =item vendor_pkg_ids
1103 Returns a list of vendor/external package ids by exportnum
1107 sub vendor_pkg_ids {
1109 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1112 =item part_pkg_option
1114 Returns all options as FS::part_pkg_option objects (see
1115 L<FS::part_pkg_option>).
1119 sub part_pkg_option {
1121 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
1126 Returns a list of option names and values suitable for assigning to a hash.
1132 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1135 =item option OPTIONNAME [ QUIET ]
1137 Returns the option value for the given name, or the empty string. If a true
1138 value is passed as the second argument, warnings about missing the option
1144 my( $self, $opt, $ornull ) = @_;
1145 my $part_pkg_option =
1146 qsearchs('part_pkg_option', {
1147 pkgpart => $self->pkgpart,
1150 return $part_pkg_option->optionvalue if $part_pkg_option;
1151 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1152 split("\n", $self->get('plandata') );
1153 return $plandata{$opt} if exists $plandata{$opt};
1154 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1155 "not found in options or plandata!\n"
1160 =item bill_part_pkg_link
1162 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1166 sub bill_part_pkg_link {
1167 shift->_part_pkg_link('bill', @_);
1170 =item svc_part_pkg_link
1172 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1176 sub svc_part_pkg_link {
1177 shift->_part_pkg_link('svc', @_);
1180 =item supp_part_pkg_link
1182 Returns the associated part_pkg_link records of type 'supp' (supplemental
1187 sub supp_part_pkg_link {
1188 shift->_part_pkg_link('supp', @_);
1191 sub _part_pkg_link {
1192 my( $self, $type ) = @_;
1193 qsearch({ table => 'part_pkg_link',
1194 hashref => { 'src_pkgpart' => $self->pkgpart,
1195 'link_type' => $type,
1196 #protection against infinite recursive links
1197 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1199 order_by => "ORDER BY hidden",
1203 sub self_and_bill_linked {
1204 shift->_self_and_linked('bill', @_);
1207 sub self_and_svc_linked {
1208 shift->_self_and_linked('svc', @_);
1211 sub _self_and_linked {
1212 my( $self, $type, $hidden ) = @_;
1216 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1217 $self->_part_pkg_link($type) ) )
1219 $_->hidden($hidden) if $hidden;
1226 =item part_pkg_taxoverride [ CLASS ]
1228 Returns all associated FS::part_pkg_taxoverride objects (see
1229 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1230 of class CLASS if defined. Class may be one of 'setup', 'recur',
1231 the empty string (default), or a usage class number (see L<FS::usage_class>).
1232 When a class is specified, the empty string class (default) is returned
1233 if no more specific values exist.
1237 sub part_pkg_taxoverride {
1241 my $hashref = { 'pkgpart' => $self->pkgpart };
1242 $hashref->{'usage_class'} = $class if defined($class);
1243 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1245 unless ( scalar(@overrides) || !defined($class) || !$class ){
1246 $hashref->{'usage_class'} = '';
1247 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1253 =item has_taxproduct
1255 Returns true if this package has any taxproduct associated with it.
1259 sub has_taxproduct {
1262 $self->taxproductnum ||
1263 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1264 keys %{ {$self->options} }
1270 =item taxproduct [ CLASS ]
1272 Returns the associated tax product for this package definition (see
1273 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1274 the usage classnum (see L<FS::usage_class>). Returns the default
1275 tax product for this record if the more specific CLASS value does
1284 my $part_pkg_taxproduct;
1286 my $taxproductnum = $self->taxproductnum;
1288 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1289 $taxproductnum = $class_taxproductnum
1290 if $class_taxproductnum
1293 $part_pkg_taxproduct =
1294 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1296 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1297 $taxproductnum = $self->taxproductnum;
1298 $part_pkg_taxproduct =
1299 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1302 $part_pkg_taxproduct;
1305 =item taxproduct_description [ CLASS ]
1307 Returns the description of the associated tax product for this package
1308 definition (see L<FS::part_pkg_taxproduct>).
1312 sub taxproduct_description {
1314 my $part_pkg_taxproduct = $self->taxproduct(@_);
1315 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1318 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1320 Returns the package to taxrate m2m records for this package in the location
1321 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1322 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1323 (see L<FS::usage_class>).
1327 sub _expand_cch_taxproductnum {
1330 my $part_pkg_taxproduct = $self->taxproduct($class);
1332 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1333 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1336 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1337 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1338 OR taxproduct = '$a:$b:$c:'
1339 OR taxproduct = '$a:$b:".":$d'
1340 OR taxproduct = '$a:$b:".":' )";
1341 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1342 'hashref' => { 'data_vendor'=>'cch' },
1343 'extra_sql' => $extra_sql,
1348 sub part_pkg_taxrate {
1350 my ($data_vendor, $geocode, $class) = @_;
1353 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1354 dbh->quote($data_vendor);
1356 # CCH oddness in m2m
1357 $extra_sql .= ' AND ('.
1358 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1362 # much more CCH oddness in m2m -- this is kludgy
1363 my @tpnums = $self->_expand_cch_taxproductnum($class);
1364 if (scalar(@tpnums)) {
1365 $extra_sql .= ' AND ('.
1366 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1369 $extra_sql .= ' AND ( 0 = 1 )';
1372 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1373 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1374 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1376 # should qsearch preface columns with the table to facilitate joins?
1377 qsearch( { 'table' => 'part_pkg_taxrate',
1378 'select' => $select,
1379 'hashref' => { # 'data_vendor' => $data_vendor,
1380 # 'taxproductnum' => $self->taxproductnum,
1382 'addl_from' => $addl_from,
1383 'extra_sql' => $extra_sql,
1384 'order_by' => $order_by,
1388 =item part_pkg_discount
1390 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1395 sub part_pkg_discount {
1397 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1402 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1403 PLAN is the object's I<plan> field. There should be better docs
1404 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1410 my $plan = $self->plan;
1412 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1416 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1417 my $class = ref($self). "::$plan";
1418 warn "reblessing $self into $class" if $DEBUG > 1;
1421 bless($self, $class) unless $@;
1426 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1427 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1429 #fallback that return 0 for old legacy packages with no plan
1430 sub calc_remain { 0; }
1431 sub calc_units { 0; }
1433 #fallback for everything not based on flat.pm
1434 sub recur_temporality { 'upcoming'; }
1435 sub calc_cancel { 0; }
1437 #fallback for everything except bulk.pm
1438 sub hide_svc_detail { 0; }
1440 #fallback for packages that can't/won't summarize usage
1441 sub sum_usage { 0; }
1443 =item recur_cost_permonth CUST_PKG
1445 recur_cost divided by freq (only supported for monthly and longer frequencies)
1449 sub recur_cost_permonth {
1450 my($self, $cust_pkg) = @_;
1451 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1452 sprintf('%.2f', $self->recur_cost / $self->freq );
1455 =item cust_bill_pkg_recur CUST_PKG
1457 Actual recurring charge for the specified customer package from customer's most
1462 sub cust_bill_pkg_recur {
1463 my($self, $cust_pkg) = @_;
1464 my $cust_bill_pkg = qsearchs({
1465 'table' => 'cust_bill_pkg',
1466 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1467 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1468 'recur' => { op=>'>', value=>'0' },
1470 'order_by' => 'ORDER BY cust_bill._date DESC,
1471 cust_bill_pkg.sdate DESC
1474 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1475 $cust_bill_pkg->recur;
1478 =item format OPTION DATA
1480 Returns data formatted according to the function 'format' described
1481 in the plan info. Returns DATA if no such function exists.
1486 my ($self, $option, $data) = (shift, shift, shift);
1487 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1488 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1494 =item parse OPTION DATA
1496 Returns data parsed according to the function 'parse' described
1497 in the plan info. Returns DATA if no such function exists.
1502 my ($self, $option, $data) = (shift, shift, shift);
1503 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1504 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1514 =head1 CLASS METHODS
1522 # Used by FS::Upgrade to migrate to a new database.
1524 sub _upgrade_data { # class method
1525 my($class, %opts) = @_;
1527 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1529 my @part_pkg = qsearch({
1530 'table' => 'part_pkg',
1531 'extra_sql' => "WHERE ". join(' OR ',
1532 'plan IS NULL', "plan = '' ",
1536 foreach my $part_pkg (@part_pkg) {
1538 unless ( $part_pkg->plan ) {
1539 $part_pkg->plan('flat');
1546 # now upgrade to the explicit custom flag
1548 @part_pkg = qsearch({
1549 'table' => 'part_pkg',
1550 'hashref' => { disabled => 'Y', custom => '' },
1551 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1554 foreach my $part_pkg (@part_pkg) {
1555 my $new = new FS::part_pkg { $part_pkg->hash };
1557 my $comment = $part_pkg->comment;
1558 $comment =~ s/^\(CUSTOM\) //;
1559 $comment = '(none)' unless $comment =~ /\S/;
1560 $new->comment($comment);
1562 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1563 my $primary = $part_pkg->svcpart;
1564 my $options = { $part_pkg->options };
1566 my $error = $new->replace( $part_pkg,
1567 'pkg_svc' => $pkg_svc,
1568 'primary_svc' => $primary,
1569 'options' => $options,
1571 die $error if $error;
1574 # set family_pkgpart on any packages that don't have it
1575 @part_pkg = qsearch('part_pkg', { 'family_pkgpart' => '' });
1576 foreach my $part_pkg (@part_pkg) {
1577 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1578 my $error = $part_pkg->SUPER::replace;
1579 die $error if $error;
1582 my @part_pkg_option = qsearch('part_pkg_option',
1583 { 'optionname' => 'unused_credit',
1586 foreach my $old_opt (@part_pkg_option) {
1587 my $pkgpart = $old_opt->pkgpart;
1588 my $error = $old_opt->delete;
1589 die $error if $error;
1591 foreach (qw(unused_credit_cancel unused_credit_change)) {
1592 my $new_opt = new FS::part_pkg_option {
1593 'pkgpart' => $pkgpart,
1597 $error = $new_opt->insert;
1598 die $error if $error;
1602 # migrate use_disposition_taqua and use_disposition to disposition_in
1603 @part_pkg_option = qsearch('part_pkg_option',
1604 { 'optionname' => { op => 'LIKE',
1605 value => 'use_disposition%',
1609 my %newopts = map { $_->pkgpart => $_ }
1610 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1611 foreach my $old_opt (@part_pkg_option) {
1612 my $pkgpart = $old_opt->pkgpart;
1613 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1615 my $error = $old_opt->delete;
1616 die $error if $error;
1618 if ( exists($newopts{$pkgpart}) ) {
1619 my $opt = $newopts{$pkgpart};
1620 $opt->optionvalue($opt->optionvalue.",$newval");
1621 $error = $opt->replace;
1622 die $error if $error;
1624 my $new_opt = new FS::part_pkg_option {
1625 'pkgpart' => $pkgpart,
1626 'optionname' => 'disposition_in',
1627 'optionvalue' => $newval,
1629 $error = $new_opt->insert;
1630 die $error if $error;
1631 $newopts{$pkgpart} = $new_opt;
1635 # set any package with FCC voice lines to the "VoIP with broadband" category
1636 # for backward compatibility
1638 # recover from a bad upgrade bug
1639 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1640 if (!FS::upgrade_journal->is_done($upgrade)) {
1641 my $bad_upgrade = qsearchs('upgrade_journal',
1642 { upgrade => 'part_pkg_fcc_voip_class' }
1644 if ( $bad_upgrade ) {
1645 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1646 ' AND history_date > '.($bad_upgrade->_date - 3600);
1647 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1650 'table' => 'h_part_pkg_option',
1652 'extra_sql' => "$where AND history_action = 'delete'",
1653 'order_by' => 'ORDER BY history_date ASC',
1655 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1658 'table' => 'h_pkg_svc',
1660 'extra_sql' => "$where AND history_action = 'replace_old'",
1661 'order_by' => 'ORDER BY history_date ASC',
1664 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1665 my $pkgpart ||= $deleted->pkgpart;
1666 $opt{$pkgpart} ||= {
1672 if ( $deleted->isa('FS::part_pkg_option') ) {
1673 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1675 my $svcpart = $deleted->svcpart;
1676 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1677 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1678 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1681 foreach my $pkgpart (keys %opt) {
1682 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1683 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1685 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1688 } # $bad_upgrade exists
1689 else { # do the original upgrade, but correctly this time
1690 @part_pkg = qsearch('part_pkg', {
1691 fcc_ds0s => { op => '>', value => 0 },
1692 fcc_voip_class => ''
1694 foreach my $part_pkg (@part_pkg) {
1695 $part_pkg->set(fcc_voip_class => 2);
1696 my @pkg_svc = $part_pkg->pkg_svc;
1697 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1698 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1699 my $error = $part_pkg->replace(
1700 $part_pkg->replace_old,
1701 options => { $part_pkg->options },
1702 pkg_svc => \%quantity,
1703 hidden_svc => \%hidden,
1704 primary_svc => ($part_pkg->svcpart || ''),
1706 die $error if $error;
1709 FS::upgrade_journal->set_done($upgrade);
1714 =item curuser_pkgs_sql
1716 Returns an SQL fragment for searching for packages the current user can
1717 use, either via part_pkg.agentnum directly, or via agent type (see
1722 sub curuser_pkgs_sql {
1725 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1729 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1731 Returns an SQL fragment for searching for packages the provided agent or agents
1732 can use, either via part_pkg.agentnum directly, or via agent type (see
1737 sub agent_pkgs_sql {
1738 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1739 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1741 $class->_pkgs_sql(@agentnums); #is this why
1746 my( $class, @agentnums ) = @_;
1747 my $agentnums = join(',', @agentnums);
1751 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1752 OR ( agentnum IS NULL
1753 AND EXISTS ( SELECT 1
1755 LEFT JOIN agent_type USING ( typenum )
1756 LEFT JOIN agent AS typeagent USING ( typenum )
1757 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1758 AND typeagent.agentnum IN ($agentnums)
1776 #false laziness w/part_export & cdr
1778 foreach my $INC ( @INC ) {
1779 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1780 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1781 warn "attempting to load plan info from $file\n" if $DEBUG;
1782 $file =~ /\/(\w+)\.pm$/ or do {
1783 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1787 my $info = eval "use FS::part_pkg::$mod; ".
1788 "\\%FS::part_pkg::$mod\::info;";
1790 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1793 unless ( keys %$info ) {
1794 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1797 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1798 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1799 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1802 $info{$mod} = $info;
1803 $info->{'weight'} ||= 0; # quiet warnings
1807 # copy one level deep to allow replacement of fields and fieldorder
1808 tie %plans, 'Tie::IxHash',
1809 map { my %infohash = %{ $info{$_} };
1811 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1814 # inheritance of plan options
1815 foreach my $name (keys(%info)) {
1816 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1817 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1818 delete $plans{$name};
1821 my $parents = $info{$name}->{'inherit_fields'} || [];
1822 my (%fields, %field_exists, @fieldorder);
1823 foreach my $parent ($name, @$parents) {
1824 if ( !exists($info{$parent}) ) {
1825 warn "$name tried to inherit from nonexistent '$parent'\n";
1828 %fields = ( # avoid replacing existing fields
1829 %{ $info{$parent}->{'fields'} || {} },
1832 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1834 next if $field_exists{$_};
1835 $field_exists{$_} = 1;
1836 # allow inheritors to remove inherited fields from the fieldorder
1837 push @fieldorder, $_ if !exists($fields{$_}) or
1838 !exists($fields{$_}->{'disabled'});
1841 $plans{$name}->{'fields'} = \%fields;
1842 $plans{$name}->{'fieldorder'} = \@fieldorder;
1852 =head1 NEW PLAN CLASSES
1854 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1855 found in eg/plan_template.pm. Until then, it is suggested that you use the
1856 other modules in FS/FS/part_pkg/ as a guide.
1860 The delete method is unimplemented.
1862 setup and recur semantics are not yet defined (and are implemented in
1863 FS::cust_bill. hmm.). now they're deprecated and need to go.
1867 part_pkg_taxrate is Pg specific
1869 replace should be smarter about managing the related tables (options, pkg_svc)
1873 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1874 schema.html from the base documentation.