2 use base qw( FS::m2m_Common FS::o2m_Common FS::option_Common );
5 use vars qw( %plans $DEBUG $setup_hack $skip_pkg_svc_hack );
6 use Carp qw(carp cluck confess);
7 use Scalar::Util qw( blessed );
9 use Time::Local qw( timelocal timelocal_nocheck ); # eventually replace with DateTime
12 use FS::Record qw( qsearch qsearchs dbh dbdef );
18 use FS::part_pkg_option;
21 use FS::part_pkg_msgcat;
22 use FS::part_pkg_taxrate;
23 use FS::part_pkg_taxoverride;
24 use FS::part_pkg_taxproduct;
25 use FS::part_pkg_link;
26 use FS::part_pkg_discount;
27 use FS::part_pkg_usage;
28 use FS::part_pkg_vendor;
32 $skip_pkg_svc_hack = 0;
36 FS::part_pkg - Object methods for part_pkg objects
42 $record = new FS::part_pkg \%hash
43 $record = new FS::part_pkg { 'column' => 'value' };
45 $custom_record = $template_record->clone;
47 $error = $record->insert;
49 $error = $new_record->replace($old_record);
51 $error = $record->delete;
53 $error = $record->check;
55 @pkg_svc = $record->pkg_svc;
57 $svcnum = $record->svcpart;
58 $svcnum = $record->svcpart( 'svc_acct' );
62 An FS::part_pkg object represents a package definition. FS::part_pkg
63 inherits from FS::Record. The following fields are currently supported:
67 =item pkgpart - primary key (assigned automatically for new package definitions)
69 =item pkg - Text name of this package definition (customer-viewable)
71 =item comment - Text name of this package definition (non-customer-viewable)
73 =item classnum - Optional package class (see L<FS::pkg_class>)
75 =item promo_code - Promotional code
77 =item setup - Setup fee expression (deprecated)
79 =item freq - Frequency of recurring fee
81 =item recur - Recurring fee expression (deprecated)
83 =item setuptax - Setup fee tax exempt flag, empty or `Y'
85 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
87 =item taxclass - Tax class
89 =item plan - Price plan
91 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
93 =item disabled - Disabled flag, empty or `Y'
95 =item custom - Custom flag, empty or `Y'
97 =item setup_cost - for cost tracking
99 =item recur_cost - for cost tracking
101 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
103 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
105 =item agentnum - Optional agentnum (see L<FS::agent>)
107 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
109 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
112 =item successor - Foreign key for the part_pkg that replaced this record.
113 If this record is not obsolete, will be null.
115 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
116 ancestor of this record. If this record is not a successor to another
117 part_pkg, will be equal to pkgpart.
119 =item delay_start - Number of days to delay package start, by default
129 Creates a new package definition. To add the package definition to
130 the database, see L<"insert">.
134 sub table { 'part_pkg'; }
138 An alternate constructor. Creates a new package definition by duplicating
139 an existing definition. A new pkgpart is assigned and the custom flag is
140 set to Y. To add the package definition to the database, see L<"insert">.
146 my $class = ref($self);
147 my %hash = $self->hash;
148 $hash{'pkgpart'} = '';
149 $hash{'custom'} = 'Y';
150 #new FS::part_pkg ( \%hash ); # ?
151 new $class ( \%hash ); # ?
154 =item insert [ , OPTION => VALUE ... ]
156 Adds this package definition to the database. If there is an error,
157 returns the error, otherwise returns false.
159 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
160 I<custnum_ref> and I<options>.
162 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
163 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
164 be set to a hashref of svcparts and flag values ('Y' or '') to set the
165 'hidden' field in these records.
167 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
168 FS::pkg_svc record will be updated.
170 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
171 record itself), the object will be updated to point to this package definition.
173 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
174 the scalar will be updated with the custnum value from the cust_pkg record.
176 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
177 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
178 records will be inserted.
180 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
181 records will be inserted.
188 warn "FS::part_pkg::insert called on $self with options ".
189 join(', ', map "$_=>$options{$_}", keys %options)
192 local $SIG{HUP} = 'IGNORE';
193 local $SIG{INT} = 'IGNORE';
194 local $SIG{QUIT} = 'IGNORE';
195 local $SIG{TERM} = 'IGNORE';
196 local $SIG{TSTP} = 'IGNORE';
197 local $SIG{PIPE} = 'IGNORE';
199 my $oldAutoCommit = $FS::UID::AutoCommit;
200 local $FS::UID::AutoCommit = 0;
203 warn " inserting part_pkg record" if $DEBUG;
204 my $error = $self->SUPER::insert( $options{options} );
206 $dbh->rollback if $oldAutoCommit;
211 if ( $self->get('family_pkgpart') eq '' ) {
212 $self->set('family_pkgpart' => $self->pkgpart);
213 $error = $self->SUPER::replace;
215 $dbh->rollback if $oldAutoCommit;
220 my $conf = new FS::Conf;
221 if ( $conf->exists('agent_defaultpkg') ) {
222 warn " agent_defaultpkg set; allowing all agents to purchase package"
224 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
225 my $type_pkgs = new FS::type_pkgs({
226 'typenum' => $agent_type->typenum,
227 'pkgpart' => $self->pkgpart,
229 my $error = $type_pkgs->insert;
231 $dbh->rollback if $oldAutoCommit;
237 warn " inserting part_pkg_taxoverride records" if $DEBUG;
238 my %overrides = %{ $options{'tax_overrides'} || {} };
239 foreach my $usage_class ( keys %overrides ) {
241 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
242 ? $overrides{$usage_class}
244 my @overrides = (grep "$_", split(',', $override) );
245 my $error = $self->process_m2m (
246 'link_table' => 'part_pkg_taxoverride',
247 'target_table' => 'tax_class',
248 'hashref' => { 'usage_class' => $usage_class },
249 'params' => \@overrides,
252 $dbh->rollback if $oldAutoCommit;
257 unless ( $skip_pkg_svc_hack ) {
259 warn " inserting pkg_svc records" if $DEBUG;
260 my $pkg_svc = $options{'pkg_svc'} || {};
261 my $hidden_svc = $options{'hidden_svc'} || {};
262 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
263 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
265 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
269 my $pkg_svc = new FS::pkg_svc( {
270 'pkgpart' => $self->pkgpart,
271 'svcpart' => $part_svc->svcpart,
272 'quantity' => $quantity,
273 'primary_svc' => $primary_svc,
274 'hidden' => $hidden_svc->{$part_svc->svcpart},
276 my $error = $pkg_svc->insert;
278 $dbh->rollback if $oldAutoCommit;
285 if ( $options{'cust_pkg'} ) {
286 warn " updating cust_pkg record " if $DEBUG;
288 ref($options{'cust_pkg'})
289 ? $options{'cust_pkg'}
290 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
291 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
292 if $options{'custnum_ref'};
293 my %hash = $old_cust_pkg->hash;
294 $hash{'pkgpart'} = $self->pkgpart,
295 my $new_cust_pkg = new FS::cust_pkg \%hash;
296 local($FS::cust_pkg::disable_agentcheck) = 1;
297 my $error = $new_cust_pkg->replace($old_cust_pkg);
299 $dbh->rollback if $oldAutoCommit;
300 return "Error modifying cust_pkg record: $error";
304 if ( $options{'part_pkg_vendor'} ) {
305 while ( my ($exportnum, $vendor_pkg_id) =
306 each %{ $options{part_pkg_vendor} }
309 my $ppv = new FS::part_pkg_vendor( {
310 'pkgpart' => $self->pkgpart,
311 'exportnum' => $exportnum,
312 'vendor_pkg_id' => $vendor_pkg_id,
314 my $error = $ppv->insert;
316 $dbh->rollback if $oldAutoCommit;
317 return "Error inserting part_pkg_vendor record: $error";
322 warn " committing transaction" if $DEBUG and $oldAutoCommit;
323 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
330 Currently unimplemented.
335 return "Can't (yet?) delete package definitions.";
336 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
339 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
341 Replaces OLD_RECORD with this one in the database. If there is an error,
342 returns the error, otherwise returns false.
344 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
347 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
348 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
349 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
350 'hidden' field in these records.
352 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
353 FS::pkg_svc record will be updated.
355 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
363 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
368 ( ref($_[0]) eq 'HASH' )
372 $options->{options} = { $old->options } unless defined($options->{options});
374 warn "FS::part_pkg::replace called on $new to replace $old with options".
375 join(', ', map "$_ => ". $options->{$_}, keys %$options)
378 local $SIG{HUP} = 'IGNORE';
379 local $SIG{INT} = 'IGNORE';
380 local $SIG{QUIT} = 'IGNORE';
381 local $SIG{TERM} = 'IGNORE';
382 local $SIG{TSTP} = 'IGNORE';
383 local $SIG{PIPE} = 'IGNORE';
385 my $oldAutoCommit = $FS::UID::AutoCommit;
386 local $FS::UID::AutoCommit = 0;
389 my $conf = new FS::Conf;
390 if ( $conf->exists('part_pkg-lineage') ) {
391 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
392 qw(setup_fee recur_fee) #others? config?
395 warn " superseding package" if $DEBUG;
397 my $error = $new->supersede($old, %$options);
399 $dbh->rollback if $oldAutoCommit;
403 warn " committing transaction" if $DEBUG and $oldAutoCommit;
404 $dbh->commit if $oldAutoCommit;
411 #plandata shit stays in replace for upgrades until after 2.0 (or edit
413 warn " saving legacy plandata" if $DEBUG;
414 my $plandata = $new->get('plandata');
415 $new->set('plandata', '');
417 warn " deleting old part_pkg_option records" if $DEBUG;
418 foreach my $part_pkg_option ( $old->part_pkg_option ) {
419 my $error = $part_pkg_option->delete;
421 $dbh->rollback if $oldAutoCommit;
426 warn " replacing part_pkg record" if $DEBUG;
427 my $error = $new->SUPER::replace($old, $options->{options} );
429 $dbh->rollback if $oldAutoCommit;
433 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
434 foreach my $part_pkg_option (
435 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
436 return "illegal plandata: $plandata";
438 new FS::part_pkg_option {
439 'pkgpart' => $new->pkgpart,
444 split("\n", $plandata)
446 my $error = $part_pkg_option->insert;
448 $dbh->rollback if $oldAutoCommit;
453 warn " replacing pkg_svc records" if $DEBUG;
454 my $pkg_svc = $options->{'pkg_svc'};
455 my $hidden_svc = $options->{'hidden_svc'} || {};
456 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
457 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
458 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
459 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
461 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
462 && $options->{'primary_svc'} == $part_svc->svcpart
467 my $old_pkg_svc = qsearchs('pkg_svc', {
468 'pkgpart' => $old->pkgpart,
469 'svcpart' => $part_svc->svcpart,
472 my $old_quantity = 0;
473 my $old_primary_svc = '';
475 if ( $old_pkg_svc ) {
476 $old_quantity = $old_pkg_svc->quantity;
477 $old_primary_svc = $old_pkg_svc->primary_svc
478 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
479 $old_hidden = $old_pkg_svc->hidden;
482 next unless $old_quantity != $quantity ||
483 $old_primary_svc ne $primary_svc ||
484 $old_hidden ne $hidden;
486 my $new_pkg_svc = new FS::pkg_svc( {
487 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
488 'pkgpart' => $new->pkgpart,
489 'svcpart' => $part_svc->svcpart,
490 'quantity' => $quantity,
491 'primary_svc' => $primary_svc,
494 my $error = $old_pkg_svc
495 ? $new_pkg_svc->replace($old_pkg_svc)
496 : $new_pkg_svc->insert;
498 $dbh->rollback if $oldAutoCommit;
502 } #if $options->{pkg_svc}
504 my @part_pkg_vendor = $old->part_pkg_vendor;
505 my @current_exportnum = ();
506 if ( $options->{'part_pkg_vendor'} ) {
507 my($exportnum,$vendor_pkg_id);
508 while ( ($exportnum,$vendor_pkg_id)
509 = each %{$options->{'part_pkg_vendor'}} ) {
511 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
512 if($exportnum == $part_pkg_vendor->exportnum
513 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
514 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
515 my $error = $part_pkg_vendor->replace;
517 $dbh->rollback if $oldAutoCommit;
518 return "Error replacing part_pkg_vendor record: $error";
523 elsif($exportnum == $part_pkg_vendor->exportnum
524 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
529 unless ( $noinsert ) {
530 my $ppv = new FS::part_pkg_vendor( {
531 'pkgpart' => $new->pkgpart,
532 'exportnum' => $exportnum,
533 'vendor_pkg_id' => $vendor_pkg_id,
535 my $error = $ppv->insert;
537 $dbh->rollback if $oldAutoCommit;
538 return "Error inserting part_pkg_vendor record: $error";
541 push @current_exportnum, $exportnum;
544 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
545 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
546 my $error = $part_pkg_vendor->delete;
548 $dbh->rollback if $oldAutoCommit;
549 return "Error deleting part_pkg_vendor record: $error";
554 # propagate changes to certain core fields
555 if ( $conf->exists('part_pkg-lineage') ) {
556 warn " propagating changes to family" if $DEBUG;
557 my $error = $new->propagate($old);
559 $dbh->rollback if $oldAutoCommit;
564 warn " committing transaction" if $DEBUG and $oldAutoCommit;
565 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
571 Checks all fields to make sure this is a valid package definition. If
572 there is an error, returns the error, otherwise returns false. Called by the
573 insert and replace methods.
579 warn "FS::part_pkg::check called on $self" if $DEBUG;
581 for (qw(setup recur plandata)) {
582 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
583 return "Use of $_ field is deprecated; set a plan and options: ".
585 if length($self->get($_));
589 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
590 my $error = $self->ut_number('freq');
591 return $error if $error;
593 $self->freq =~ /^(\d+[hdw]?)$/
594 or return "Illegal or empty freq: ". $self->freq;
598 my @null_agentnum_right = ( 'Edit global package definitions' );
599 push @null_agentnum_right, 'One-time charge'
600 if $self->freq =~ /^0/;
601 push @null_agentnum_right, 'Customize customer package'
602 if $self->disabled eq 'Y'; #good enough
604 my $error = $self->ut_numbern('pkgpart')
605 || $self->ut_text('pkg')
606 || $self->ut_textn('comment')
607 || $self->ut_textn('promo_code')
608 || $self->ut_alphan('plan')
609 || $self->ut_enum('setuptax', [ '', 'Y' ] )
610 || $self->ut_enum('recurtax', [ '', 'Y' ] )
611 || $self->ut_textn('taxclass')
612 || $self->ut_enum('disabled', [ '', 'Y' ] )
613 || $self->ut_enum('custom', [ '', 'Y' ] )
614 || $self->ut_enum('no_auto', [ '', 'Y' ])
615 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
616 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
617 #|| $self->ut_moneyn('setup_cost')
618 #|| $self->ut_moneyn('recur_cost')
619 || $self->ut_floatn('setup_cost')
620 || $self->ut_floatn('recur_cost')
621 || $self->ut_floatn('pay_weight')
622 || $self->ut_floatn('credit_weight')
623 || $self->ut_numbern('taxproductnum')
624 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
625 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
626 || $self->ut_foreign_keyn('taxproductnum',
627 'part_pkg_taxproduct',
631 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
632 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
634 || $self->ut_numbern('fcc_ds0s')
635 || $self->ut_numbern('fcc_voip_class')
636 || $self->ut_numbern('delay_start')
637 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
638 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
639 || $self->ut_alphan('agent_pkgpartid')
640 || $self->SUPER::check
642 return $error if $error;
644 return 'Unknown plan '. $self->plan
645 unless exists($plans{$self->plan});
647 my $conf = new FS::Conf;
648 return 'Taxclass is required'
649 if ! $self->taxclass && $conf->exists('require_taxclasses');
654 =item supersede OLD [, OPTION => VALUE ... ]
656 Inserts this package as a successor to the package OLD. All options are as
657 for C<insert>. After inserting, disables OLD and sets the new package as its
663 my ($new, $old, %options) = @_;
666 $new->set('pkgpart' => '');
667 $new->set('family_pkgpart' => $old->family_pkgpart);
668 warn " inserting successor package\n" if $DEBUG;
669 $error = $new->insert(%options);
670 return $error if $error;
672 warn " disabling superseded package\n" if $DEBUG;
673 $old->set('successor' => $new->pkgpart);
674 $old->set('disabled' => 'Y');
675 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
676 return $error if $error;
678 warn " propagating changes to family" if $DEBUG;
679 $new->propagate($old);
684 If any of certain fields have changed from OLD to this package, then,
685 for all packages in the same lineage as this one, sets those fields
686 to their values in this package.
690 my @propagate_fields = (
691 qw( pkg classnum setup_cost recur_cost taxclass
692 setuptax recurtax pay_weight credit_weight
700 map { $_ => $new->get($_) }
701 grep { $new->get($_) ne $old->get($_) }
705 my @part_pkg = qsearch('part_pkg', {
706 'family_pkgpart' => $new->family_pkgpart
709 foreach my $part_pkg ( @part_pkg ) {
710 my $pkgpart = $part_pkg->pkgpart;
711 next if $pkgpart == $new->pkgpart; # don't modify $new
712 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
713 foreach ( keys %fields ) {
714 $part_pkg->set($_, $fields{$_});
716 # SUPER::replace to avoid changing non-core fields
717 my $error = $part_pkg->SUPER::replace;
718 push @error, "pkgpart $pkgpart: $error"
724 =item pkg_locale LOCALE
726 Returns a customer-viewable string representing this package for the given
727 locale, from the part_pkg_msgcat table. If the given locale is empty or no
728 localized string is found, returns the base pkg field.
733 my( $self, $locale ) = @_;
734 return $self->pkg unless $locale;
735 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
736 $part_pkg_msgcat->pkg;
739 =item part_pkg_msgcat LOCALE
741 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
745 sub part_pkg_msgcat {
746 my( $self, $locale ) = @_;
747 qsearchs( 'part_pkg_msgcat', {
748 pkgpart => $self->pkgpart,
753 =item pkg_comment [ OPTION => VALUE... ]
755 Returns an (internal) string representing this package. Currently,
756 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
757 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
760 If the option nopkgpart is true then the "pkgpart: ' is omitted.
768 #$self->pkg. ' - '. $self->comment;
769 #$self->pkg. ' ('. $self->comment. ')';
770 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
771 my $custom_comment = $self->custom_comment(%opt);
772 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
775 sub price_info { # safety, in case a part_pkg hasn't defined price_info
781 my $price_info = $self->price_info(@_);
782 ( $self->custom ? '(CUSTOM) ' : '' ).
784 ( ( ($self->custom || $self->comment) && $price_info ) ? ' - ' : '' ).
790 $self->pkg. ' - '. ($self->price_info || 'No charge');
795 Returns the package class, as an FS::pkg_class object, or the empty string
796 if there is no package class.
802 if ( $self->classnum ) {
803 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
809 =item addon_pkg_class
811 Returns the add-on package class, as an FS::pkg_class object, or the empty
812 string if there is no add-on package class.
816 sub addon_pkg_class {
818 if ( $self->addon_classnum ) {
819 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
827 Returns the package category name, or the empty string if there is no package
834 my $pkg_class = $self->pkg_class;
836 ? $pkg_class->categoryname
842 Returns the package class name, or the empty string if there is no package
849 my $pkg_class = $self->pkg_class;
851 ? $pkg_class->classname
855 =item addon_classname
857 Returns the add-on package class name, or the empty string if there is no
858 add-on package class.
862 sub addon_classname {
864 my $pkg_class = $self->addon_pkg_class;
866 ? $pkg_class->classname
872 Returns the associated agent for this event, if any, as an FS::agent object.
878 qsearchs('agent', { 'agentnum' => $self->agentnum } );
881 =item pkg_svc [ HASHREF | OPTION => VALUE ]
883 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
884 definition (with non-zero quantity).
886 One option is available, I<disable_linked>. If set true it will return the
887 services for this package definition alone, omitting services from any add-on
894 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
901 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
907 # #sort { $b->primary cmp $a->primary }
908 # grep { $_->quantity }
909 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
911 my $opt = ref($_[0]) ? $_[0] : { @_ };
912 my %pkg_svc = map { $_->svcpart => $_ }
913 grep { $_->quantity }
914 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
916 unless ( $opt->{disable_linked} ) {
917 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
918 my @pkg_svc = grep { $_->quantity }
919 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
920 foreach my $pkg_svc ( @pkg_svc ) {
921 if ( $pkg_svc{$pkg_svc->svcpart} ) {
922 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
923 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
925 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
935 =item svcpart [ SVCDB ]
937 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
938 associated with this package definition (see L<FS::pkg_svc>). Returns
939 false if there not a primary service definition or exactly one service
940 definition with quantity 1, or if SVCDB is specified and does not match the
941 svcdb of the service definition. SVCDB can be specified as a scalar table
942 name, such as 'svc_acct', or as an arrayref of possible table names.
947 my $pkg_svc = shift->_primary_pkg_svc(@_);
948 $pkg_svc ? $pkg_svc->svcpart : '';
951 =item part_svc [ SVCDB ]
953 Like the B<svcpart> method, but returns the FS::part_svc object (see
959 my $pkg_svc = shift->_primary_pkg_svc(@_);
960 $pkg_svc ? $pkg_svc->part_svc : '';
963 sub _primary_pkg_svc {
966 my $svcdb = scalar(@_) ? shift : [];
967 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
968 my %svcdb = map { $_=>1 } @$svcdb;
971 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
974 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
975 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
977 return '' if scalar(@pkg_svc) != 1;
981 =item svcpart_unique_svcdb SVCDB
983 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
984 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
985 false if there not a primary service definition for SVCDB or there are multiple
986 service definitions for SVCDB.
990 sub svcpart_unique_svcdb {
991 my( $self, $svcdb ) = @_;
992 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
993 return '' if scalar(@svcdb_pkg_svc) != 1;
994 $svcdb_pkg_svc[0]->svcpart;
999 Returns a list of the acceptable payment types for this package. Eventually
1000 this should come out of a database table and be editable, but currently has the
1001 following logic instead:
1003 If the package is free, the single item B<BILL> is
1004 returned, otherwise, the single item B<CARD> is returned.
1006 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1012 if ( $self->is_free ) {
1021 Returns true if this package is free.
1027 if ( $self->can('is_free_options') ) {
1028 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1029 map { $self->option($_) }
1030 $self->is_free_options;
1032 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1033 "provides neither is_free_options nor is_free method; returning false";
1038 # whether the plan allows discounts to be applied to this package
1039 sub can_discount { 0; }
1041 # whether the plan allows changing the start date
1042 sub can_start_date { 1; }
1044 # the delay start date if present
1045 sub delay_start_date {
1048 my $delay = $self->delay_start or return '';
1050 # avoid timelocal silliness
1051 my $dt = DateTime->today(time_zone => 'local');
1052 $dt->add(days => $delay);
1057 # moved to FS::Misc to make this accessible to other packages
1059 FS::Misc::pkg_freqs();
1064 Returns an english representation of the I<freq> field, such as "monthly",
1065 "weekly", "semi-annually", etc.
1071 my $freq = $self->freq;
1073 #my $freqs_href = $self->freqs_href;
1074 my $freqs_href = freqs_href();
1076 if ( exists($freqs_href->{$freq}) ) {
1077 $freqs_href->{$freq};
1079 my $interval = 'month';
1080 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1081 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1082 $interval = $interval{$2};
1087 "every $freq ${interval}s";
1092 =item add_freq TIMESTAMP [ FREQ ]
1094 Adds a billing period of some frequency to the provided timestamp and
1095 returns the resulting timestamp, or -1 if the frequency could not be
1096 parsed (shouldn't happen). By default, the frequency of this package
1097 will be used; to override this, pass a different frequency as a second
1103 my( $self, $date, $freq ) = @_;
1104 $freq = $self->freq unless $freq;
1106 #change this bit to use Date::Manip? CAREFUL with timezones (see
1107 # mailing list archive)
1108 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1110 if ( $freq =~ /^\d+$/ ) {
1112 until ( $mon < 12 ) { $mon -= 12; $year++; }
1114 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1116 } elsif ( $freq =~ /^(\d+)w$/ ) {
1118 $mday += $weeks * 7;
1119 } elsif ( $freq =~ /^(\d+)d$/ ) {
1122 } elsif ( $freq =~ /^(\d+)h$/ ) {
1129 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1134 For backwards compatibility, returns the plandata field as well as all options
1135 from FS::part_pkg_option.
1141 carp "plandata is deprecated";
1143 $self->SUPER::plandata(@_);
1145 my $plandata = $self->get('plandata');
1146 my %options = $self->options;
1147 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1152 =item part_pkg_vendor
1154 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1155 L<FS::part_pkg_vendor>).
1159 sub part_pkg_vendor {
1161 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
1164 =item vendor_pkg_ids
1166 Returns a list of vendor/external package ids by exportnum
1170 sub vendor_pkg_ids {
1172 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1175 =item part_pkg_option
1177 Returns all options as FS::part_pkg_option objects (see
1178 L<FS::part_pkg_option>).
1182 sub part_pkg_option {
1184 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
1189 Returns a list of option names and values suitable for assigning to a hash.
1195 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1198 =item option OPTIONNAME [ QUIET ]
1200 Returns the option value for the given name, or the empty string. If a true
1201 value is passed as the second argument, warnings about missing the option
1207 my( $self, $opt, $ornull ) = @_;
1208 my $part_pkg_option =
1209 qsearchs('part_pkg_option', {
1210 pkgpart => $self->pkgpart,
1213 return $part_pkg_option->optionvalue if $part_pkg_option;
1214 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1215 split("\n", $self->get('plandata') );
1216 return $plandata{$opt} if exists $plandata{$opt};
1217 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1218 "not found in options or plandata!\n"
1223 =item bill_part_pkg_link
1225 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1229 sub bill_part_pkg_link {
1230 shift->_part_pkg_link('bill', @_);
1233 =item svc_part_pkg_link
1235 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1239 sub svc_part_pkg_link {
1240 shift->_part_pkg_link('svc', @_);
1243 =item supp_part_pkg_link
1245 Returns the associated part_pkg_link records of type 'supp' (supplemental
1250 sub supp_part_pkg_link {
1251 shift->_part_pkg_link('supp', @_);
1254 sub _part_pkg_link {
1255 my( $self, $type ) = @_;
1256 qsearch({ table => 'part_pkg_link',
1257 hashref => { 'src_pkgpart' => $self->pkgpart,
1258 'link_type' => $type,
1259 #protection against infinite recursive links
1260 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1262 order_by => "ORDER BY hidden",
1266 sub self_and_bill_linked {
1267 shift->_self_and_linked('bill', @_);
1270 sub self_and_svc_linked {
1271 shift->_self_and_linked('svc', @_);
1274 sub _self_and_linked {
1275 my( $self, $type, $hidden ) = @_;
1279 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1280 $self->_part_pkg_link($type) ) )
1282 $_->hidden($hidden) if $hidden;
1289 =item part_pkg_taxoverride [ CLASS ]
1291 Returns all associated FS::part_pkg_taxoverride objects (see
1292 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1293 of class CLASS if defined. Class may be one of 'setup', 'recur',
1294 the empty string (default), or a usage class number (see L<FS::usage_class>).
1295 When a class is specified, the empty string class (default) is returned
1296 if no more specific values exist.
1300 sub part_pkg_taxoverride {
1304 my $hashref = { 'pkgpart' => $self->pkgpart };
1305 $hashref->{'usage_class'} = $class if defined($class);
1306 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1308 unless ( scalar(@overrides) || !defined($class) || !$class ){
1309 $hashref->{'usage_class'} = '';
1310 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1316 =item has_taxproduct
1318 Returns true if this package has any taxproduct associated with it.
1322 sub has_taxproduct {
1325 $self->taxproductnum ||
1326 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1327 keys %{ {$self->options} }
1333 =item taxproduct [ CLASS ]
1335 Returns the associated tax product for this package definition (see
1336 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1337 the usage classnum (see L<FS::usage_class>). Returns the default
1338 tax product for this record if the more specific CLASS value does
1347 my $part_pkg_taxproduct;
1349 my $taxproductnum = $self->taxproductnum;
1351 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1352 $taxproductnum = $class_taxproductnum
1353 if $class_taxproductnum
1356 $part_pkg_taxproduct =
1357 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1359 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1360 $taxproductnum = $self->taxproductnum;
1361 $part_pkg_taxproduct =
1362 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1365 $part_pkg_taxproduct;
1368 =item taxproduct_description [ CLASS ]
1370 Returns the description of the associated tax product for this package
1371 definition (see L<FS::part_pkg_taxproduct>).
1375 sub taxproduct_description {
1377 my $part_pkg_taxproduct = $self->taxproduct(@_);
1378 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1382 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1384 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1385 package in the location specified by GEOCODE, for usage class CLASS (one of
1386 'setup', 'recur', null, or a C<usage_class> number).
1392 my ($vendor, $geocode, $class) = @_;
1393 my @taxclassnums = map { $_->taxclassnum }
1394 $self->part_pkg_taxoverride($class);
1395 if (!@taxclassnums) {
1396 my $part_pkg_taxproduct = $self->taxproduct($class);
1397 @taxclassnums = map { $_->taxclassnum }
1398 grep { $_->taxable eq 'Y' } # why do we need this?
1399 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1401 return unless @taxclassnums;
1403 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1405 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1406 my @taxes = qsearch({ 'table' => 'tax_rate',
1407 'hashref' => { 'geocode' => $geocode,
1408 'data_vendor' => $vendor },
1409 'extra_sql' => $extra_sql,
1411 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1417 =item part_pkg_discount
1419 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1424 sub part_pkg_discount {
1426 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1429 =item part_pkg_usage
1431 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1436 sub part_pkg_usage {
1438 qsearch('part_pkg_usage', { 'pkgpart' => $self->pkgpart });
1443 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1444 PLAN is the object's I<plan> field. There should be better docs
1445 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1451 my $plan = $self->plan;
1453 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1457 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1458 my $class = ref($self). "::$plan";
1459 warn "reblessing $self into $class" if $DEBUG > 1;
1462 bless($self, $class) unless $@;
1467 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1468 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1470 #fallback that return 0 for old legacy packages with no plan
1471 sub calc_remain { 0; }
1472 sub calc_units { 0; }
1474 #fallback for everything not based on flat.pm
1475 sub recur_temporality { 'upcoming'; }
1476 sub calc_cancel { 0; }
1478 #fallback for everything except bulk.pm
1479 sub hide_svc_detail { 0; }
1481 #fallback for packages that can't/won't summarize usage
1482 sub sum_usage { 0; }
1484 =item recur_cost_permonth CUST_PKG
1486 recur_cost divided by freq (only supported for monthly and longer frequencies)
1490 sub recur_cost_permonth {
1491 my($self, $cust_pkg) = @_;
1492 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1493 sprintf('%.2f', $self->recur_cost / $self->freq );
1496 =item cust_bill_pkg_recur CUST_PKG
1498 Actual recurring charge for the specified customer package from customer's most
1503 sub cust_bill_pkg_recur {
1504 my($self, $cust_pkg) = @_;
1505 my $cust_bill_pkg = qsearchs({
1506 'table' => 'cust_bill_pkg',
1507 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1508 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1509 'recur' => { op=>'>', value=>'0' },
1511 'order_by' => 'ORDER BY cust_bill._date DESC,
1512 cust_bill_pkg.sdate DESC
1515 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1516 $cust_bill_pkg->recur;
1519 =item unit_setup CUST_PKG
1521 Returns the setup fee for one unit of the package.
1526 my ($self, $cust_pkg) = @_;
1527 $self->option('setup_fee') || 0;
1530 =item format OPTION DATA
1532 Returns data formatted according to the function 'format' described
1533 in the plan info. Returns DATA if no such function exists.
1538 my ($self, $option, $data) = (shift, shift, shift);
1539 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1540 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1546 =item parse OPTION DATA
1548 Returns data parsed according to the function 'parse' described
1549 in the plan info. Returns DATA if no such function exists.
1554 my ($self, $option, $data) = (shift, shift, shift);
1555 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1556 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1566 =head1 CLASS METHODS
1574 # Used by FS::Upgrade to migrate to a new database.
1576 sub _upgrade_data { # class method
1577 my($class, %opts) = @_;
1579 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1581 my @part_pkg = qsearch({
1582 'table' => 'part_pkg',
1583 'extra_sql' => "WHERE ". join(' OR ',
1584 'plan IS NULL', "plan = '' ",
1588 foreach my $part_pkg (@part_pkg) {
1590 unless ( $part_pkg->plan ) {
1591 $part_pkg->plan('flat');
1598 # now upgrade to the explicit custom flag
1600 @part_pkg = qsearch({
1601 'table' => 'part_pkg',
1602 'hashref' => { disabled => 'Y', custom => '' },
1603 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1606 foreach my $part_pkg (@part_pkg) {
1607 my $new = new FS::part_pkg { $part_pkg->hash };
1609 my $comment = $part_pkg->comment;
1610 $comment =~ s/^\(CUSTOM\) //;
1611 $comment = '(none)' unless $comment =~ /\S/;
1612 $new->comment($comment);
1614 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1615 my $primary = $part_pkg->svcpart;
1616 my $options = { $part_pkg->options };
1618 my $error = $new->replace( $part_pkg,
1619 'pkg_svc' => $pkg_svc,
1620 'primary_svc' => $primary,
1621 'options' => $options,
1623 die $error if $error;
1626 # set family_pkgpart on any packages that don't have it
1627 @part_pkg = qsearch('part_pkg', { 'family_pkgpart' => '' });
1628 foreach my $part_pkg (@part_pkg) {
1629 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1630 my $error = $part_pkg->SUPER::replace;
1631 die $error if $error;
1634 my @part_pkg_option = qsearch('part_pkg_option',
1635 { 'optionname' => 'unused_credit',
1638 foreach my $old_opt (@part_pkg_option) {
1639 my $pkgpart = $old_opt->pkgpart;
1640 my $error = $old_opt->delete;
1641 die $error if $error;
1643 foreach (qw(unused_credit_cancel unused_credit_change)) {
1644 my $new_opt = new FS::part_pkg_option {
1645 'pkgpart' => $pkgpart,
1649 $error = $new_opt->insert;
1650 die $error if $error;
1654 # migrate use_disposition_taqua and use_disposition to disposition_in
1655 @part_pkg_option = qsearch('part_pkg_option',
1656 { 'optionname' => { op => 'LIKE',
1657 value => 'use_disposition%',
1661 my %newopts = map { $_->pkgpart => $_ }
1662 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1663 foreach my $old_opt (@part_pkg_option) {
1664 my $pkgpart = $old_opt->pkgpart;
1665 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1667 my $error = $old_opt->delete;
1668 die $error if $error;
1670 if ( exists($newopts{$pkgpart}) ) {
1671 my $opt = $newopts{$pkgpart};
1672 $opt->optionvalue($opt->optionvalue.",$newval");
1673 $error = $opt->replace;
1674 die $error if $error;
1676 my $new_opt = new FS::part_pkg_option {
1677 'pkgpart' => $pkgpart,
1678 'optionname' => 'disposition_in',
1679 'optionvalue' => $newval,
1681 $error = $new_opt->insert;
1682 die $error if $error;
1683 $newopts{$pkgpart} = $new_opt;
1687 # set any package with FCC voice lines to the "VoIP with broadband" category
1688 # for backward compatibility
1690 # recover from a bad upgrade bug
1691 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1692 if (!FS::upgrade_journal->is_done($upgrade)) {
1693 my $bad_upgrade = qsearchs('upgrade_journal',
1694 { upgrade => 'part_pkg_fcc_voip_class' }
1696 if ( $bad_upgrade ) {
1697 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1698 ' AND history_date > '.($bad_upgrade->_date - 3600);
1699 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1702 'table' => 'h_part_pkg_option',
1704 'extra_sql' => "$where AND history_action = 'delete'",
1705 'order_by' => 'ORDER BY history_date ASC',
1707 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1710 'table' => 'h_pkg_svc',
1712 'extra_sql' => "$where AND history_action = 'replace_old'",
1713 'order_by' => 'ORDER BY history_date ASC',
1716 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1717 my $pkgpart ||= $deleted->pkgpart;
1718 $opt{$pkgpart} ||= {
1724 if ( $deleted->isa('FS::part_pkg_option') ) {
1725 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1727 my $svcpart = $deleted->svcpart;
1728 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1729 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1730 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1733 foreach my $pkgpart (keys %opt) {
1734 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1735 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1737 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1740 } # $bad_upgrade exists
1741 else { # do the original upgrade, but correctly this time
1742 @part_pkg = qsearch('part_pkg', {
1743 fcc_ds0s => { op => '>', value => 0 },
1744 fcc_voip_class => ''
1746 foreach my $part_pkg (@part_pkg) {
1747 $part_pkg->set(fcc_voip_class => 2);
1748 my @pkg_svc = $part_pkg->pkg_svc;
1749 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1750 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1751 my $error = $part_pkg->replace(
1752 $part_pkg->replace_old,
1753 options => { $part_pkg->options },
1754 pkg_svc => \%quantity,
1755 hidden_svc => \%hidden,
1756 primary_svc => ($part_pkg->svcpart || ''),
1758 die $error if $error;
1761 FS::upgrade_journal->set_done($upgrade);
1766 =item curuser_pkgs_sql
1768 Returns an SQL fragment for searching for packages the current user can
1769 use, either via part_pkg.agentnum directly, or via agent type (see
1774 sub curuser_pkgs_sql {
1777 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1781 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1783 Returns an SQL fragment for searching for packages the provided agent or agents
1784 can use, either via part_pkg.agentnum directly, or via agent type (see
1789 sub agent_pkgs_sql {
1790 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1791 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1793 $class->_pkgs_sql(@agentnums); #is this why
1798 my( $class, @agentnums ) = @_;
1799 my $agentnums = join(',', @agentnums);
1803 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1804 OR ( agentnum IS NULL
1805 AND EXISTS ( SELECT 1
1807 LEFT JOIN agent_type USING ( typenum )
1808 LEFT JOIN agent AS typeagent USING ( typenum )
1809 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1810 AND typeagent.agentnum IN ($agentnums)
1828 #false laziness w/part_export & cdr
1830 foreach my $INC ( @INC ) {
1831 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1832 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1833 warn "attempting to load plan info from $file\n" if $DEBUG;
1834 $file =~ /\/(\w+)\.pm$/ or do {
1835 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1839 my $info = eval "use FS::part_pkg::$mod; ".
1840 "\\%FS::part_pkg::$mod\::info;";
1842 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1845 unless ( keys %$info ) {
1846 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1849 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1850 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1851 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1854 $info{$mod} = $info;
1855 $info->{'weight'} ||= 0; # quiet warnings
1859 # copy one level deep to allow replacement of fields and fieldorder
1860 tie %plans, 'Tie::IxHash',
1861 map { my %infohash = %{ $info{$_} };
1863 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1866 # inheritance of plan options
1867 foreach my $name (keys(%info)) {
1868 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1869 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1870 delete $plans{$name};
1873 my $parents = $info{$name}->{'inherit_fields'} || [];
1874 my (%fields, %field_exists, @fieldorder);
1875 foreach my $parent ($name, @$parents) {
1876 if ( !exists($info{$parent}) ) {
1877 warn "$name tried to inherit from nonexistent '$parent'\n";
1880 %fields = ( # avoid replacing existing fields
1881 %{ $info{$parent}->{'fields'} || {} },
1884 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1886 next if $field_exists{$_};
1887 $field_exists{$_} = 1;
1888 # allow inheritors to remove inherited fields from the fieldorder
1889 push @fieldorder, $_ if !exists($fields{$_}) or
1890 !exists($fields{$_}->{'disabled'});
1893 $plans{$name}->{'fields'} = \%fields;
1894 $plans{$name}->{'fieldorder'} = \@fieldorder;
1904 =head1 NEW PLAN CLASSES
1906 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1907 found in eg/plan_template.pm. Until then, it is suggested that you use the
1908 other modules in FS/FS/part_pkg/ as a guide.
1912 The delete method is unimplemented.
1914 setup and recur semantics are not yet defined (and are implemented in
1915 FS::cust_bill. hmm.). now they're deprecated and need to go.
1919 part_pkg_taxrate is Pg specific
1921 replace should be smarter about managing the related tables (options, pkg_svc)
1925 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1926 schema.html from the base documentation.