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->SUPER::check
641 return $error if $error;
643 return 'Unknown plan '. $self->plan
644 unless exists($plans{$self->plan});
646 my $conf = new FS::Conf;
647 return 'Taxclass is required'
648 if ! $self->taxclass && $conf->exists('require_taxclasses');
653 =item supersede OLD [, OPTION => VALUE ... ]
655 Inserts this package as a successor to the package OLD. All options are as
656 for C<insert>. After inserting, disables OLD and sets the new package as its
662 my ($new, $old, %options) = @_;
665 $new->set('pkgpart' => '');
666 $new->set('family_pkgpart' => $old->family_pkgpart);
667 warn " inserting successor package\n" if $DEBUG;
668 $error = $new->insert(%options);
669 return $error if $error;
671 warn " disabling superseded package\n" if $DEBUG;
672 $old->set('successor' => $new->pkgpart);
673 $old->set('disabled' => 'Y');
674 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
675 return $error if $error;
677 warn " propagating changes to family" if $DEBUG;
678 $new->propagate($old);
683 If any of certain fields have changed from OLD to this package, then,
684 for all packages in the same lineage as this one, sets those fields
685 to their values in this package.
689 my @propagate_fields = (
690 qw( pkg classnum setup_cost recur_cost taxclass
691 setuptax recurtax pay_weight credit_weight
699 map { $_ => $new->get($_) }
700 grep { $new->get($_) ne $old->get($_) }
704 my @part_pkg = qsearch('part_pkg', {
705 'family_pkgpart' => $new->family_pkgpart
708 foreach my $part_pkg ( @part_pkg ) {
709 my $pkgpart = $part_pkg->pkgpart;
710 next if $pkgpart == $new->pkgpart; # don't modify $new
711 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
712 foreach ( keys %fields ) {
713 $part_pkg->set($_, $fields{$_});
715 # SUPER::replace to avoid changing non-core fields
716 my $error = $part_pkg->SUPER::replace;
717 push @error, "pkgpart $pkgpart: $error"
723 =item pkg_locale LOCALE
725 Returns a customer-viewable string representing this package for the given
726 locale, from the part_pkg_msgcat table. If the given locale is empty or no
727 localized string is found, returns the base pkg field.
732 my( $self, $locale ) = @_;
733 return $self->pkg unless $locale;
734 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
735 $part_pkg_msgcat->pkg;
738 =item part_pkg_msgcat LOCALE
740 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
744 sub part_pkg_msgcat {
745 my( $self, $locale ) = @_;
746 qsearchs( 'part_pkg_msgcat', {
747 pkgpart => $self->pkgpart,
752 =item pkg_comment [ OPTION => VALUE... ]
754 Returns an (internal) string representing this package. Currently,
755 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
756 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
759 If the option nopkgpart is true then the "pkgpart: ' is omitted.
767 #$self->pkg. ' - '. $self->comment;
768 #$self->pkg. ' ('. $self->comment. ')';
769 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
770 my $custom_comment = $self->custom_comment(%opt);
771 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
774 sub price_info { # safety, in case a part_pkg hasn't defined price_info
780 my $price_info = $self->price_info(@_);
781 ( $self->custom ? '(CUSTOM) ' : '' ).
783 ( ( ($self->custom || $self->comment) && $price_info ) ? ' - ' : '' ).
789 Returns the package class, as an FS::pkg_class object, or the empty string
790 if there is no package class.
796 if ( $self->classnum ) {
797 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
803 =item addon_pkg_class
805 Returns the add-on package class, as an FS::pkg_class object, or the empty
806 string if there is no add-on package class.
810 sub addon_pkg_class {
812 if ( $self->addon_classnum ) {
813 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
821 Returns the package category name, or the empty string if there is no package
828 my $pkg_class = $self->pkg_class;
830 ? $pkg_class->categoryname
836 Returns the package class name, or the empty string if there is no package
843 my $pkg_class = $self->pkg_class;
845 ? $pkg_class->classname
849 =item addon_classname
851 Returns the add-on package class name, or the empty string if there is no
852 add-on package class.
856 sub addon_classname {
858 my $pkg_class = $self->addon_pkg_class;
860 ? $pkg_class->classname
866 Returns the associated agent for this event, if any, as an FS::agent object.
872 qsearchs('agent', { 'agentnum' => $self->agentnum } );
875 =item pkg_svc [ HASHREF | OPTION => VALUE ]
877 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
878 definition (with non-zero quantity).
880 One option is available, I<disable_linked>. If set true it will return the
881 services for this package definition alone, omitting services from any add-on
888 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
895 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
901 # #sort { $b->primary cmp $a->primary }
902 # grep { $_->quantity }
903 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
905 my $opt = ref($_[0]) ? $_[0] : { @_ };
906 my %pkg_svc = map { $_->svcpart => $_ }
907 grep { $_->quantity }
908 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
910 unless ( $opt->{disable_linked} ) {
911 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
912 my @pkg_svc = grep { $_->quantity }
913 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
914 foreach my $pkg_svc ( @pkg_svc ) {
915 if ( $pkg_svc{$pkg_svc->svcpart} ) {
916 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
917 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
919 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
929 =item svcpart [ SVCDB ]
931 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
932 associated with this package definition (see L<FS::pkg_svc>). Returns
933 false if there not a primary service definition or exactly one service
934 definition with quantity 1, or if SVCDB is specified and does not match the
935 svcdb of the service definition. SVCDB can be specified as a scalar table
936 name, such as 'svc_acct', or as an arrayref of possible table names.
941 my $pkg_svc = shift->_primary_pkg_svc(@_);
942 $pkg_svc ? $pkg_svc->svcpart : '';
945 =item part_svc [ SVCDB ]
947 Like the B<svcpart> method, but returns the FS::part_svc object (see
953 my $pkg_svc = shift->_primary_pkg_svc(@_);
954 $pkg_svc ? $pkg_svc->part_svc : '';
957 sub _primary_pkg_svc {
960 my $svcdb = scalar(@_) ? shift : [];
961 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
962 my %svcdb = map { $_=>1 } @$svcdb;
965 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
968 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
969 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
971 return '' if scalar(@pkg_svc) != 1;
975 =item svcpart_unique_svcdb SVCDB
977 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
978 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
979 false if there not a primary service definition for SVCDB or there are multiple
980 service definitions for SVCDB.
984 sub svcpart_unique_svcdb {
985 my( $self, $svcdb ) = @_;
986 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
987 return '' if scalar(@svcdb_pkg_svc) != 1;
988 $svcdb_pkg_svc[0]->svcpart;
993 Returns a list of the acceptable payment types for this package. Eventually
994 this should come out of a database table and be editable, but currently has the
995 following logic instead:
997 If the package is free, the single item B<BILL> is
998 returned, otherwise, the single item B<CARD> is returned.
1000 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1006 if ( $self->is_free ) {
1015 Returns true if this package is free.
1021 if ( $self->can('is_free_options') ) {
1022 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1023 map { $self->option($_) }
1024 $self->is_free_options;
1026 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1027 "provides neither is_free_options nor is_free method; returning false";
1032 # whether the plan allows discounts to be applied to this package
1033 sub can_discount { 0; }
1035 # whether the plan allows changing the start date
1036 sub can_start_date { 1; }
1038 # the delay start date if present
1039 sub delay_start_date {
1042 my $delay = $self->delay_start or return '';
1044 # avoid timelocal silliness
1045 my $dt = DateTime->today(time_zone => 'local');
1046 $dt->add(days => $delay);
1051 # moved to FS::Misc to make this accessible to other packages
1053 FS::Misc::pkg_freqs();
1058 Returns an english representation of the I<freq> field, such as "monthly",
1059 "weekly", "semi-annually", etc.
1065 my $freq = $self->freq;
1067 #my $freqs_href = $self->freqs_href;
1068 my $freqs_href = freqs_href();
1070 if ( exists($freqs_href->{$freq}) ) {
1071 $freqs_href->{$freq};
1073 my $interval = 'month';
1074 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1075 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1076 $interval = $interval{$2};
1081 "every $freq ${interval}s";
1086 =item add_freq TIMESTAMP [ FREQ ]
1088 Adds a billing period of some frequency to the provided timestamp and
1089 returns the resulting timestamp, or -1 if the frequency could not be
1090 parsed (shouldn't happen). By default, the frequency of this package
1091 will be used; to override this, pass a different frequency as a second
1097 my( $self, $date, $freq ) = @_;
1098 $freq = $self->freq unless $freq;
1100 #change this bit to use Date::Manip? CAREFUL with timezones (see
1101 # mailing list archive)
1102 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1104 if ( $freq =~ /^\d+$/ ) {
1106 until ( $mon < 12 ) { $mon -= 12; $year++; }
1108 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1110 } elsif ( $freq =~ /^(\d+)w$/ ) {
1112 $mday += $weeks * 7;
1113 } elsif ( $freq =~ /^(\d+)d$/ ) {
1116 } elsif ( $freq =~ /^(\d+)h$/ ) {
1123 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1128 For backwards compatibility, returns the plandata field as well as all options
1129 from FS::part_pkg_option.
1135 carp "plandata is deprecated";
1137 $self->SUPER::plandata(@_);
1139 my $plandata = $self->get('plandata');
1140 my %options = $self->options;
1141 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1146 =item part_pkg_vendor
1148 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1149 L<FS::part_pkg_vendor>).
1153 sub part_pkg_vendor {
1155 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
1158 =item vendor_pkg_ids
1160 Returns a list of vendor/external package ids by exportnum
1164 sub vendor_pkg_ids {
1166 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1169 =item part_pkg_option
1171 Returns all options as FS::part_pkg_option objects (see
1172 L<FS::part_pkg_option>).
1176 sub part_pkg_option {
1178 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
1183 Returns a list of option names and values suitable for assigning to a hash.
1189 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1192 =item option OPTIONNAME [ QUIET ]
1194 Returns the option value for the given name, or the empty string. If a true
1195 value is passed as the second argument, warnings about missing the option
1201 my( $self, $opt, $ornull ) = @_;
1202 my $part_pkg_option =
1203 qsearchs('part_pkg_option', {
1204 pkgpart => $self->pkgpart,
1207 return $part_pkg_option->optionvalue if $part_pkg_option;
1208 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1209 split("\n", $self->get('plandata') );
1210 return $plandata{$opt} if exists $plandata{$opt};
1211 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1212 "not found in options or plandata!\n"
1217 =item bill_part_pkg_link
1219 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1223 sub bill_part_pkg_link {
1224 shift->_part_pkg_link('bill', @_);
1227 =item svc_part_pkg_link
1229 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1233 sub svc_part_pkg_link {
1234 shift->_part_pkg_link('svc', @_);
1237 =item supp_part_pkg_link
1239 Returns the associated part_pkg_link records of type 'supp' (supplemental
1244 sub supp_part_pkg_link {
1245 shift->_part_pkg_link('supp', @_);
1248 sub _part_pkg_link {
1249 my( $self, $type ) = @_;
1250 qsearch({ table => 'part_pkg_link',
1251 hashref => { 'src_pkgpart' => $self->pkgpart,
1252 'link_type' => $type,
1253 #protection against infinite recursive links
1254 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1256 order_by => "ORDER BY hidden",
1260 sub self_and_bill_linked {
1261 shift->_self_and_linked('bill', @_);
1264 sub self_and_svc_linked {
1265 shift->_self_and_linked('svc', @_);
1268 sub _self_and_linked {
1269 my( $self, $type, $hidden ) = @_;
1273 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1274 $self->_part_pkg_link($type) ) )
1276 $_->hidden($hidden) if $hidden;
1283 =item part_pkg_taxoverride [ CLASS ]
1285 Returns all associated FS::part_pkg_taxoverride objects (see
1286 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1287 of class CLASS if defined. Class may be one of 'setup', 'recur',
1288 the empty string (default), or a usage class number (see L<FS::usage_class>).
1289 When a class is specified, the empty string class (default) is returned
1290 if no more specific values exist.
1294 sub part_pkg_taxoverride {
1298 my $hashref = { 'pkgpart' => $self->pkgpart };
1299 $hashref->{'usage_class'} = $class if defined($class);
1300 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1302 unless ( scalar(@overrides) || !defined($class) || !$class ){
1303 $hashref->{'usage_class'} = '';
1304 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1310 =item has_taxproduct
1312 Returns true if this package has any taxproduct associated with it.
1316 sub has_taxproduct {
1319 $self->taxproductnum ||
1320 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1321 keys %{ {$self->options} }
1327 =item taxproduct [ CLASS ]
1329 Returns the associated tax product for this package definition (see
1330 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1331 the usage classnum (see L<FS::usage_class>). Returns the default
1332 tax product for this record if the more specific CLASS value does
1341 my $part_pkg_taxproduct;
1343 my $taxproductnum = $self->taxproductnum;
1345 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1346 $taxproductnum = $class_taxproductnum
1347 if $class_taxproductnum
1350 $part_pkg_taxproduct =
1351 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1353 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1354 $taxproductnum = $self->taxproductnum;
1355 $part_pkg_taxproduct =
1356 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1359 $part_pkg_taxproduct;
1362 =item taxproduct_description [ CLASS ]
1364 Returns the description of the associated tax product for this package
1365 definition (see L<FS::part_pkg_taxproduct>).
1369 sub taxproduct_description {
1371 my $part_pkg_taxproduct = $self->taxproduct(@_);
1372 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1375 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1377 Returns the package to taxrate m2m records for this package in the location
1378 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1379 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1380 (see L<FS::usage_class>).
1384 sub _expand_cch_taxproductnum {
1387 my $part_pkg_taxproduct = $self->taxproduct($class);
1389 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1390 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1393 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1394 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1395 OR taxproduct = '$a:$b:$c:'
1396 OR taxproduct = '$a:$b:".":$d'
1397 OR taxproduct = '$a:$b:".":' )";
1398 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1399 'hashref' => { 'data_vendor'=>'cch' },
1400 'extra_sql' => $extra_sql,
1405 sub part_pkg_taxrate {
1407 my ($data_vendor, $geocode, $class) = @_;
1410 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1411 dbh->quote($data_vendor);
1413 # CCH oddness in m2m
1414 $extra_sql .= ' AND ('.
1415 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1419 # much more CCH oddness in m2m -- this is kludgy
1420 my @tpnums = $self->_expand_cch_taxproductnum($class);
1421 if (scalar(@tpnums)) {
1422 $extra_sql .= ' AND ('.
1423 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1426 $extra_sql .= ' AND ( 0 = 1 )';
1429 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1430 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1431 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1433 # should qsearch preface columns with the table to facilitate joins?
1434 qsearch( { 'table' => 'part_pkg_taxrate',
1435 'select' => $select,
1436 'hashref' => { # 'data_vendor' => $data_vendor,
1437 # 'taxproductnum' => $self->taxproductnum,
1439 'addl_from' => $addl_from,
1440 'extra_sql' => $extra_sql,
1441 'order_by' => $order_by,
1445 =item part_pkg_discount
1447 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1452 sub part_pkg_discount {
1454 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1457 =item part_pkg_usage
1459 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1464 sub part_pkg_usage {
1466 qsearch('part_pkg_usage', { 'pkgpart' => $self->pkgpart });
1471 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1472 PLAN is the object's I<plan> field. There should be better docs
1473 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1479 my $plan = $self->plan;
1481 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1485 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1486 my $class = ref($self). "::$plan";
1487 warn "reblessing $self into $class" if $DEBUG > 1;
1490 bless($self, $class) unless $@;
1495 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1496 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1498 #fallback that return 0 for old legacy packages with no plan
1499 sub calc_remain { 0; }
1500 sub calc_units { 0; }
1502 #fallback for everything not based on flat.pm
1503 sub recur_temporality { 'upcoming'; }
1504 sub calc_cancel { 0; }
1506 #fallback for everything except bulk.pm
1507 sub hide_svc_detail { 0; }
1509 #fallback for packages that can't/won't summarize usage
1510 sub sum_usage { 0; }
1512 =item recur_cost_permonth CUST_PKG
1514 recur_cost divided by freq (only supported for monthly and longer frequencies)
1518 sub recur_cost_permonth {
1519 my($self, $cust_pkg) = @_;
1520 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1521 sprintf('%.2f', $self->recur_cost / $self->freq );
1524 =item cust_bill_pkg_recur CUST_PKG
1526 Actual recurring charge for the specified customer package from customer's most
1531 sub cust_bill_pkg_recur {
1532 my($self, $cust_pkg) = @_;
1533 my $cust_bill_pkg = qsearchs({
1534 'table' => 'cust_bill_pkg',
1535 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1536 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1537 'recur' => { op=>'>', value=>'0' },
1539 'order_by' => 'ORDER BY cust_bill._date DESC,
1540 cust_bill_pkg.sdate DESC
1543 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1544 $cust_bill_pkg->recur;
1547 =item unit_setup CUST_PKG
1549 Returns the setup fee for one unit of the package.
1554 my ($self, $cust_pkg) = @_;
1555 $self->option('setup_fee') || 0;
1558 =item format OPTION DATA
1560 Returns data formatted according to the function 'format' described
1561 in the plan info. Returns DATA if no such function exists.
1566 my ($self, $option, $data) = (shift, shift, shift);
1567 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1568 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1574 =item parse OPTION DATA
1576 Returns data parsed according to the function 'parse' described
1577 in the plan info. Returns DATA if no such function exists.
1582 my ($self, $option, $data) = (shift, shift, shift);
1583 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1584 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1594 =head1 CLASS METHODS
1602 # Used by FS::Upgrade to migrate to a new database.
1604 sub _upgrade_data { # class method
1605 my($class, %opts) = @_;
1607 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1609 my @part_pkg = qsearch({
1610 'table' => 'part_pkg',
1611 'extra_sql' => "WHERE ". join(' OR ',
1612 'plan IS NULL', "plan = '' ",
1616 foreach my $part_pkg (@part_pkg) {
1618 unless ( $part_pkg->plan ) {
1619 $part_pkg->plan('flat');
1626 # now upgrade to the explicit custom flag
1628 @part_pkg = qsearch({
1629 'table' => 'part_pkg',
1630 'hashref' => { disabled => 'Y', custom => '' },
1631 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1634 foreach my $part_pkg (@part_pkg) {
1635 my $new = new FS::part_pkg { $part_pkg->hash };
1637 my $comment = $part_pkg->comment;
1638 $comment =~ s/^\(CUSTOM\) //;
1639 $comment = '(none)' unless $comment =~ /\S/;
1640 $new->comment($comment);
1642 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1643 my $primary = $part_pkg->svcpart;
1644 my $options = { $part_pkg->options };
1646 my $error = $new->replace( $part_pkg,
1647 'pkg_svc' => $pkg_svc,
1648 'primary_svc' => $primary,
1649 'options' => $options,
1651 die $error if $error;
1654 # set family_pkgpart on any packages that don't have it
1655 @part_pkg = qsearch('part_pkg', { 'family_pkgpart' => '' });
1656 foreach my $part_pkg (@part_pkg) {
1657 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1658 my $error = $part_pkg->SUPER::replace;
1659 die $error if $error;
1662 my @part_pkg_option = qsearch('part_pkg_option',
1663 { 'optionname' => 'unused_credit',
1666 foreach my $old_opt (@part_pkg_option) {
1667 my $pkgpart = $old_opt->pkgpart;
1668 my $error = $old_opt->delete;
1669 die $error if $error;
1671 foreach (qw(unused_credit_cancel unused_credit_change)) {
1672 my $new_opt = new FS::part_pkg_option {
1673 'pkgpart' => $pkgpart,
1677 $error = $new_opt->insert;
1678 die $error if $error;
1682 # migrate use_disposition_taqua and use_disposition to disposition_in
1683 @part_pkg_option = qsearch('part_pkg_option',
1684 { 'optionname' => { op => 'LIKE',
1685 value => 'use_disposition%',
1689 my %newopts = map { $_->pkgpart => $_ }
1690 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1691 foreach my $old_opt (@part_pkg_option) {
1692 my $pkgpart = $old_opt->pkgpart;
1693 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1695 my $error = $old_opt->delete;
1696 die $error if $error;
1698 if ( exists($newopts{$pkgpart}) ) {
1699 my $opt = $newopts{$pkgpart};
1700 $opt->optionvalue($opt->optionvalue.",$newval");
1701 $error = $opt->replace;
1702 die $error if $error;
1704 my $new_opt = new FS::part_pkg_option {
1705 'pkgpart' => $pkgpart,
1706 'optionname' => 'disposition_in',
1707 'optionvalue' => $newval,
1709 $error = $new_opt->insert;
1710 die $error if $error;
1711 $newopts{$pkgpart} = $new_opt;
1715 # set any package with FCC voice lines to the "VoIP with broadband" category
1716 # for backward compatibility
1718 # recover from a bad upgrade bug
1719 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1720 if (!FS::upgrade_journal->is_done($upgrade)) {
1721 my $bad_upgrade = qsearchs('upgrade_journal',
1722 { upgrade => 'part_pkg_fcc_voip_class' }
1724 if ( $bad_upgrade ) {
1725 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1726 ' AND history_date > '.($bad_upgrade->_date - 3600);
1727 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1730 'table' => 'h_part_pkg_option',
1732 'extra_sql' => "$where AND history_action = 'delete'",
1733 'order_by' => 'ORDER BY history_date ASC',
1735 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1738 'table' => 'h_pkg_svc',
1740 'extra_sql' => "$where AND history_action = 'replace_old'",
1741 'order_by' => 'ORDER BY history_date ASC',
1744 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1745 my $pkgpart ||= $deleted->pkgpart;
1746 $opt{$pkgpart} ||= {
1752 if ( $deleted->isa('FS::part_pkg_option') ) {
1753 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1755 my $svcpart = $deleted->svcpart;
1756 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1757 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1758 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1761 foreach my $pkgpart (keys %opt) {
1762 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1763 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1765 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1768 } # $bad_upgrade exists
1769 else { # do the original upgrade, but correctly this time
1770 @part_pkg = qsearch('part_pkg', {
1771 fcc_ds0s => { op => '>', value => 0 },
1772 fcc_voip_class => ''
1774 foreach my $part_pkg (@part_pkg) {
1775 $part_pkg->set(fcc_voip_class => 2);
1776 my @pkg_svc = $part_pkg->pkg_svc;
1777 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1778 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1779 my $error = $part_pkg->replace(
1780 $part_pkg->replace_old,
1781 options => { $part_pkg->options },
1782 pkg_svc => \%quantity,
1783 hidden_svc => \%hidden,
1784 primary_svc => ($part_pkg->svcpart || ''),
1786 die $error if $error;
1789 FS::upgrade_journal->set_done($upgrade);
1794 =item curuser_pkgs_sql
1796 Returns an SQL fragment for searching for packages the current user can
1797 use, either via part_pkg.agentnum directly, or via agent type (see
1802 sub curuser_pkgs_sql {
1805 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1809 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1811 Returns an SQL fragment for searching for packages the provided agent or agents
1812 can use, either via part_pkg.agentnum directly, or via agent type (see
1817 sub agent_pkgs_sql {
1818 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1819 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1821 $class->_pkgs_sql(@agentnums); #is this why
1826 my( $class, @agentnums ) = @_;
1827 my $agentnums = join(',', @agentnums);
1831 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1832 OR ( agentnum IS NULL
1833 AND EXISTS ( SELECT 1
1835 LEFT JOIN agent_type USING ( typenum )
1836 LEFT JOIN agent AS typeagent USING ( typenum )
1837 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1838 AND typeagent.agentnum IN ($agentnums)
1856 #false laziness w/part_export & cdr
1858 foreach my $INC ( @INC ) {
1859 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1860 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1861 warn "attempting to load plan info from $file\n" if $DEBUG;
1862 $file =~ /\/(\w+)\.pm$/ or do {
1863 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1867 my $info = eval "use FS::part_pkg::$mod; ".
1868 "\\%FS::part_pkg::$mod\::info;";
1870 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1873 unless ( keys %$info ) {
1874 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1877 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1878 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1879 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1882 $info{$mod} = $info;
1883 $info->{'weight'} ||= 0; # quiet warnings
1887 # copy one level deep to allow replacement of fields and fieldorder
1888 tie %plans, 'Tie::IxHash',
1889 map { my %infohash = %{ $info{$_} };
1891 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1894 # inheritance of plan options
1895 foreach my $name (keys(%info)) {
1896 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1897 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1898 delete $plans{$name};
1901 my $parents = $info{$name}->{'inherit_fields'} || [];
1902 my (%fields, %field_exists, @fieldorder);
1903 foreach my $parent ($name, @$parents) {
1904 if ( !exists($info{$parent}) ) {
1905 warn "$name tried to inherit from nonexistent '$parent'\n";
1908 %fields = ( # avoid replacing existing fields
1909 %{ $info{$parent}->{'fields'} || {} },
1912 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1914 next if $field_exists{$_};
1915 $field_exists{$_} = 1;
1916 # allow inheritors to remove inherited fields from the fieldorder
1917 push @fieldorder, $_ if !exists($fields{$_}) or
1918 !exists($fields{$_}->{'disabled'});
1921 $plans{$name}->{'fields'} = \%fields;
1922 $plans{$name}->{'fieldorder'} = \@fieldorder;
1932 =head1 NEW PLAN CLASSES
1934 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1935 found in eg/plan_template.pm. Until then, it is suggested that you use the
1936 other modules in FS/FS/part_pkg/ as a guide.
1940 The delete method is unimplemented.
1942 setup and recur semantics are not yet defined (and are implemented in
1943 FS::cust_bill. hmm.). now they're deprecated and need to go.
1947 part_pkg_taxrate is Pg specific
1949 replace should be smarter about managing the related tables (options, pkg_svc)
1953 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1954 schema.html from the base documentation.