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;
19 use FS::part_pkg_msgcat;
20 use FS::part_pkg_taxrate;
21 use FS::part_pkg_taxoverride;
22 use FS::part_pkg_taxproduct;
23 use FS::part_pkg_link;
24 use FS::part_pkg_discount;
25 use FS::part_pkg_vendor;
26 use FS::part_pkg_currency;
30 $skip_pkg_svc_hack = 0;
34 FS::part_pkg - Object methods for part_pkg objects
40 $record = new FS::part_pkg \%hash
41 $record = new FS::part_pkg { 'column' => 'value' };
43 $custom_record = $template_record->clone;
45 $error = $record->insert;
47 $error = $new_record->replace($old_record);
49 $error = $record->delete;
51 $error = $record->check;
53 @pkg_svc = $record->pkg_svc;
55 $svcnum = $record->svcpart;
56 $svcnum = $record->svcpart( 'svc_acct' );
60 An FS::part_pkg object represents a package definition. FS::part_pkg
61 inherits from FS::Record. The following fields are currently supported:
65 =item pkgpart - primary key (assigned automatically for new package definitions)
67 =item pkg - Text name of this package definition (customer-viewable)
69 =item comment - Text name of this package definition (non-customer-viewable)
71 =item classnum - Optional package class (see L<FS::pkg_class>)
73 =item promo_code - Promotional code
75 =item setup - Setup fee expression (deprecated)
77 =item freq - Frequency of recurring fee
79 =item recur - Recurring fee expression (deprecated)
81 =item setuptax - Setup fee tax exempt flag, empty or `Y'
83 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
85 =item taxclass - Tax class
87 =item plan - Price plan
89 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
91 =item disabled - Disabled flag, empty or `Y'
93 =item custom - Custom flag, empty or `Y'
95 =item setup_cost - for cost tracking
97 =item recur_cost - for cost tracking
99 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
101 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
103 =item agentnum - Optional agentnum (see L<FS::agent>)
105 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
107 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
110 =item successor - Foreign key for the part_pkg that replaced this record.
111 If this record is not obsolete, will be null.
113 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
114 ancestor of this record. If this record is not a successor to another
115 part_pkg, will be equal to pkgpart.
117 =item delay_start - Number of days to delay package start, by default
127 Creates a new package definition. To add the package definition to
128 the database, see L<"insert">.
132 sub table { 'part_pkg'; }
136 An alternate constructor. Creates a new package definition by duplicating
137 an existing definition. A new pkgpart is assigned and the custom flag is
138 set to Y. To add the package definition to the database, see L<"insert">.
144 my $class = ref($self);
145 my %hash = $self->hash;
146 $hash{'pkgpart'} = '';
147 $hash{'custom'} = 'Y';
148 #new FS::part_pkg ( \%hash ); # ?
149 new $class ( \%hash ); # ?
152 =item insert [ , OPTION => VALUE ... ]
154 Adds this package definition to the database. If there is an error,
155 returns the error, otherwise returns false.
157 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
158 I<custnum_ref> and I<options>.
160 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
161 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
162 be set to a hashref of svcparts and flag values ('Y' or '') to set the
163 'hidden' field in these records.
165 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
166 FS::pkg_svc record will be updated.
168 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
169 record itself), the object will be updated to point to this package definition.
171 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
172 the scalar will be updated with the custnum value from the cust_pkg record.
174 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
175 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
176 records will be inserted.
178 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
179 records will be inserted.
181 If I<part_pkg_currency> is set to a hashref of options (with the keys as
182 option_CURRENCY), appropriate FS::part_pkg::currency records will be inserted.
189 warn "FS::part_pkg::insert called on $self with options ".
190 join(', ', map "$_=>$options{$_}", keys %options)
193 local $SIG{HUP} = 'IGNORE';
194 local $SIG{INT} = 'IGNORE';
195 local $SIG{QUIT} = 'IGNORE';
196 local $SIG{TERM} = 'IGNORE';
197 local $SIG{TSTP} = 'IGNORE';
198 local $SIG{PIPE} = 'IGNORE';
200 my $oldAutoCommit = $FS::UID::AutoCommit;
201 local $FS::UID::AutoCommit = 0;
204 warn " inserting part_pkg record" if $DEBUG;
205 my $error = $self->SUPER::insert( $options{options} );
207 $dbh->rollback if $oldAutoCommit;
212 if ( $self->get('family_pkgpart') eq '' ) {
213 $self->set('family_pkgpart' => $self->pkgpart);
214 $error = $self->SUPER::replace;
216 $dbh->rollback if $oldAutoCommit;
221 my $conf = new FS::Conf;
222 if ( $conf->exists('agent_defaultpkg') ) {
223 warn " agent_defaultpkg set; allowing all agents to purchase package"
225 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
226 my $type_pkgs = new FS::type_pkgs({
227 'typenum' => $agent_type->typenum,
228 'pkgpart' => $self->pkgpart,
230 my $error = $type_pkgs->insert;
232 $dbh->rollback if $oldAutoCommit;
238 warn " inserting part_pkg_taxoverride records" if $DEBUG;
239 my %overrides = %{ $options{'tax_overrides'} || {} };
240 foreach my $usage_class ( keys %overrides ) {
242 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
243 ? $overrides{$usage_class}
245 my @overrides = (grep "$_", split(',', $override) );
246 my $error = $self->process_m2m (
247 'link_table' => 'part_pkg_taxoverride',
248 'target_table' => 'tax_class',
249 'hashref' => { 'usage_class' => $usage_class },
250 'params' => \@overrides,
253 $dbh->rollback if $oldAutoCommit;
258 warn " inserting part_pkg_currency records" if $DEBUG;
259 my %part_pkg_currency = %{ $options{'part_pkg_currency'} || {} };
260 foreach my $key ( keys %part_pkg_currency ) {
261 $key =~ /^(.+)_([A-Z]{3})$/ or next;
262 my( $optionname, $currency ) = ( $1, $2 );
263 if ( $part_pkg_currency{$key} =~ /^\s*$/ ) {
264 if ( $self->option($optionname) == 0 ) {
265 $part_pkg_currency{$key} = '0';
267 $dbh->rollback if $oldAutoCommit;
268 ( my $thing = $optionname ) =~ s/_/ /g;
269 return ucfirst($thing). " $currency is required";
272 my $part_pkg_currency = new FS::part_pkg_currency {
273 'pkgpart' => $self->pkgpart,
274 'optionname' => $optionname,
275 'currency' => $currency,
276 'optionvalue' => $part_pkg_currency{$key},
278 my $error = $part_pkg_currency->insert;
280 $dbh->rollback if $oldAutoCommit;
285 unless ( $skip_pkg_svc_hack ) {
287 warn " inserting pkg_svc records" if $DEBUG;
288 my $pkg_svc = $options{'pkg_svc'} || {};
289 my $hidden_svc = $options{'hidden_svc'} || {};
290 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
291 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
293 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
297 my $pkg_svc = new FS::pkg_svc( {
298 'pkgpart' => $self->pkgpart,
299 'svcpart' => $part_svc->svcpart,
300 'quantity' => $quantity,
301 'primary_svc' => $primary_svc,
302 'hidden' => $hidden_svc->{$part_svc->svcpart},
304 my $error = $pkg_svc->insert;
306 $dbh->rollback if $oldAutoCommit;
313 if ( $options{'cust_pkg'} ) {
314 warn " updating cust_pkg record " if $DEBUG;
316 ref($options{'cust_pkg'})
317 ? $options{'cust_pkg'}
318 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
319 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
320 if $options{'custnum_ref'};
321 my %hash = $old_cust_pkg->hash;
322 $hash{'pkgpart'} = $self->pkgpart,
323 my $new_cust_pkg = new FS::cust_pkg \%hash;
324 local($FS::cust_pkg::disable_agentcheck) = 1;
325 my $error = $new_cust_pkg->replace($old_cust_pkg);
327 $dbh->rollback if $oldAutoCommit;
328 return "Error modifying cust_pkg record: $error";
332 if ( $options{'part_pkg_vendor'} ) {
333 while ( my ($exportnum, $vendor_pkg_id) =
334 each %{ $options{part_pkg_vendor} }
337 my $ppv = new FS::part_pkg_vendor( {
338 'pkgpart' => $self->pkgpart,
339 'exportnum' => $exportnum,
340 'vendor_pkg_id' => $vendor_pkg_id,
342 my $error = $ppv->insert;
344 $dbh->rollback if $oldAutoCommit;
345 return "Error inserting part_pkg_vendor record: $error";
350 warn " committing transaction" if $DEBUG and $oldAutoCommit;
351 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
358 Currently unimplemented.
363 return "Can't (yet?) delete package definitions.";
364 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
367 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
369 Replaces OLD_RECORD with this one in the database. If there is an error,
370 returns the error, otherwise returns false.
372 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
375 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
376 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
377 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
378 'hidden' field in these records. I<bulk_skip> can be set to a hashref of
379 svcparts and flag values ('Y' or '') to set the 'bulk_skip' field in those
382 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
383 FS::pkg_svc record will be updated.
385 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
388 If I<part_pkg_currency> is set to a hashref of options (with the keys as
389 option_CURRENCY), appropriate FS::part_pkg::currency records will be replaced.
396 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
401 ( ref($_[0]) eq 'HASH' )
405 $options->{options} = { $old->options } unless defined($options->{options});
407 warn "FS::part_pkg::replace called on $new to replace $old with options".
408 join(', ', map "$_ => ". $options->{$_}, keys %$options)
411 local $SIG{HUP} = 'IGNORE';
412 local $SIG{INT} = 'IGNORE';
413 local $SIG{QUIT} = 'IGNORE';
414 local $SIG{TERM} = 'IGNORE';
415 local $SIG{TSTP} = 'IGNORE';
416 local $SIG{PIPE} = 'IGNORE';
418 my $oldAutoCommit = $FS::UID::AutoCommit;
419 local $FS::UID::AutoCommit = 0;
422 my $conf = new FS::Conf;
423 if ( $conf->exists('part_pkg-lineage') ) {
424 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
425 qw(setup_fee recur_fee) #others? config?
428 warn " superseding package" if $DEBUG;
430 my $error = $new->supersede($old, %$options);
432 $dbh->rollback if $oldAutoCommit;
436 warn " committing transaction" if $DEBUG and $oldAutoCommit;
437 $dbh->commit if $oldAutoCommit;
444 #plandata shit stays in replace for upgrades until after 2.0 (or edit
446 warn " saving legacy plandata" if $DEBUG;
447 my $plandata = $new->get('plandata');
448 $new->set('plandata', '');
450 warn " deleting old part_pkg_option records" if $DEBUG;
451 foreach my $part_pkg_option ( $old->part_pkg_option ) {
452 my $error = $part_pkg_option->delete;
454 $dbh->rollback if $oldAutoCommit;
459 warn " replacing part_pkg record" if $DEBUG;
460 my $error = $new->SUPER::replace($old, $options->{options} );
462 $dbh->rollback if $oldAutoCommit;
466 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
467 foreach my $part_pkg_option (
468 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
469 return "illegal plandata: $plandata";
471 new FS::part_pkg_option {
472 'pkgpart' => $new->pkgpart,
477 split("\n", $plandata)
479 my $error = $part_pkg_option->insert;
481 $dbh->rollback if $oldAutoCommit;
486 #trivial nit: not the most efficient to delete and reinsert
487 warn " deleting old part_pkg_currency records" if $DEBUG;
488 foreach my $part_pkg_currency ( $old->part_pkg_currency ) {
489 my $error = $part_pkg_currency->delete;
491 $dbh->rollback if $oldAutoCommit;
492 return "error deleting part_pkg_currency record: $error";
496 warn " inserting new part_pkg_currency records" if $DEBUG;
497 my %part_pkg_currency = %{ $options->{'part_pkg_currency'} || {} };
498 foreach my $key ( keys %part_pkg_currency ) {
499 $key =~ /^(.+)_([A-Z]{3})$/ or next;
500 my $part_pkg_currency = new FS::part_pkg_currency {
501 'pkgpart' => $new->pkgpart,
504 'optionvalue' => $part_pkg_currency{$key},
506 my $error = $part_pkg_currency->insert;
508 $dbh->rollback if $oldAutoCommit;
509 return "error inserting part_pkg_currency record: $error";
514 warn " replacing pkg_svc records" if $DEBUG;
515 my $pkg_svc = $options->{'pkg_svc'};
516 my $hidden_svc = $options->{'hidden_svc'} || {};
517 my $bulk_skip = $options->{'bulk_skip'} || {};
518 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
519 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
520 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
521 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
522 my $bulk_skip = $bulk_skip->{$part_svc->svcpart} || '';
524 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
525 && $options->{'primary_svc'} == $part_svc->svcpart
530 my $old_pkg_svc = qsearchs('pkg_svc', {
531 'pkgpart' => $old->pkgpart,
532 'svcpart' => $part_svc->svcpart,
535 my $old_quantity = 0;
536 my $old_primary_svc = '';
538 my $old_bulk_skip = '';
539 if ( $old_pkg_svc ) {
540 $old_quantity = $old_pkg_svc->quantity;
541 $old_primary_svc = $old_pkg_svc->primary_svc
542 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
543 $old_hidden = $old_pkg_svc->hidden;
544 $old_bulk_skip = $old_pkg_svc->old_bulk_skip;
547 next unless $old_quantity != $quantity
548 || $old_primary_svc ne $primary_svc
549 || $old_hidden ne $hidden
550 || $old_bulk_skip ne $bulk_skip;
552 my $new_pkg_svc = new FS::pkg_svc( {
553 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
554 'pkgpart' => $new->pkgpart,
555 'svcpart' => $part_svc->svcpart,
556 'quantity' => $quantity,
557 'primary_svc' => $primary_svc,
559 'bulk_skip' => $bulk_skip,
561 my $error = $old_pkg_svc
562 ? $new_pkg_svc->replace($old_pkg_svc)
563 : $new_pkg_svc->insert;
565 $dbh->rollback if $oldAutoCommit;
569 } #if $options->{pkg_svc}
571 my @part_pkg_vendor = $old->part_pkg_vendor;
572 my @current_exportnum = ();
573 if ( $options->{'part_pkg_vendor'} ) {
574 my($exportnum,$vendor_pkg_id);
575 while ( ($exportnum,$vendor_pkg_id)
576 = each %{$options->{'part_pkg_vendor'}} ) {
578 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
579 if($exportnum == $part_pkg_vendor->exportnum
580 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
581 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
582 my $error = $part_pkg_vendor->replace;
584 $dbh->rollback if $oldAutoCommit;
585 return "Error replacing part_pkg_vendor record: $error";
590 elsif($exportnum == $part_pkg_vendor->exportnum
591 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
596 unless ( $noinsert ) {
597 my $ppv = new FS::part_pkg_vendor( {
598 'pkgpart' => $new->pkgpart,
599 'exportnum' => $exportnum,
600 'vendor_pkg_id' => $vendor_pkg_id,
602 my $error = $ppv->insert;
604 $dbh->rollback if $oldAutoCommit;
605 return "Error inserting part_pkg_vendor record: $error";
608 push @current_exportnum, $exportnum;
611 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
612 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
613 my $error = $part_pkg_vendor->delete;
615 $dbh->rollback if $oldAutoCommit;
616 return "Error deleting part_pkg_vendor record: $error";
621 # propagate changes to certain core fields
622 if ( $conf->exists('part_pkg-lineage') ) {
623 warn " propagating changes to family" if $DEBUG;
624 my $error = $new->propagate($old);
626 $dbh->rollback if $oldAutoCommit;
631 warn " committing transaction" if $DEBUG and $oldAutoCommit;
632 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
638 Checks all fields to make sure this is a valid package definition. If
639 there is an error, returns the error, otherwise returns false. Called by the
640 insert and replace methods.
646 warn "FS::part_pkg::check called on $self" if $DEBUG;
648 for (qw(setup recur plandata)) {
649 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
650 return "Use of $_ field is deprecated; set a plan and options: ".
652 if length($self->get($_));
656 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
657 my $error = $self->ut_number('freq');
658 return $error if $error;
660 $self->freq =~ /^(\d+[hdw]?)$/
661 or return "Illegal or empty freq: ". $self->freq;
665 my @null_agentnum_right = ( 'Edit global package definitions' );
666 push @null_agentnum_right, 'One-time charge'
667 if $self->freq =~ /^0/;
668 push @null_agentnum_right, 'Customize customer package'
669 if $self->disabled eq 'Y'; #good enough
671 my $error = $self->ut_numbern('pkgpart')
672 || $self->ut_text('pkg')
673 || $self->ut_textn('comment')
674 || $self->ut_textn('promo_code')
675 || $self->ut_alphan('plan')
676 || $self->ut_enum('setuptax', [ '', 'Y' ] )
677 || $self->ut_enum('recurtax', [ '', 'Y' ] )
678 || $self->ut_textn('taxclass')
679 || $self->ut_enum('disabled', [ '', 'Y' ] )
680 || $self->ut_enum('custom', [ '', 'Y' ] )
681 || $self->ut_enum('no_auto', [ '', 'Y' ])
682 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
683 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
684 #|| $self->ut_moneyn('setup_cost')
685 #|| $self->ut_moneyn('recur_cost')
686 || $self->ut_floatn('setup_cost')
687 || $self->ut_floatn('recur_cost')
688 || $self->ut_floatn('pay_weight')
689 || $self->ut_floatn('credit_weight')
690 || $self->ut_numbern('taxproductnum')
691 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
692 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
693 || $self->ut_foreign_keyn('taxproductnum',
694 'part_pkg_taxproduct',
698 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
699 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
701 || $self->ut_numbern('fcc_ds0s')
702 || $self->ut_numbern('fcc_voip_class')
703 || $self->ut_numbern('delay_start')
704 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
705 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
706 || $self->ut_alphan('agent_pkgpartid')
707 || $self->SUPER::check
709 return $error if $error;
711 return 'Unknown plan '. $self->plan
712 unless exists($plans{$self->plan});
714 my $conf = new FS::Conf;
715 return 'Taxclass is required'
716 if ! $self->taxclass && $conf->exists('require_taxclasses');
721 =item supersede OLD [, OPTION => VALUE ... ]
723 Inserts this package as a successor to the package OLD. All options are as
724 for C<insert>. After inserting, disables OLD and sets the new package as its
730 my ($new, $old, %options) = @_;
733 $new->set('pkgpart' => '');
734 $new->set('family_pkgpart' => $old->family_pkgpart);
735 warn " inserting successor package\n" if $DEBUG;
736 $error = $new->insert(%options);
737 return $error if $error;
739 warn " disabling superseded package\n" if $DEBUG;
740 $old->set('successor' => $new->pkgpart);
741 $old->set('disabled' => 'Y');
742 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
743 return $error if $error;
745 warn " propagating changes to family" if $DEBUG;
746 $new->propagate($old);
751 If any of certain fields have changed from OLD to this package, then,
752 for all packages in the same lineage as this one, sets those fields
753 to their values in this package.
757 my @propagate_fields = (
758 qw( pkg classnum setup_cost recur_cost taxclass
759 setuptax recurtax pay_weight credit_weight
767 map { $_ => $new->get($_) }
768 grep { $new->get($_) ne $old->get($_) }
772 my @part_pkg = qsearch('part_pkg', {
773 'family_pkgpart' => $new->family_pkgpart
776 foreach my $part_pkg ( @part_pkg ) {
777 my $pkgpart = $part_pkg->pkgpart;
778 next if $pkgpart == $new->pkgpart; # don't modify $new
779 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
780 foreach ( keys %fields ) {
781 $part_pkg->set($_, $fields{$_});
783 # SUPER::replace to avoid changing non-core fields
784 my $error = $part_pkg->SUPER::replace;
785 push @error, "pkgpart $pkgpart: $error"
791 =item pkg_locale LOCALE
793 Returns a customer-viewable string representing this package for the given
794 locale, from the part_pkg_msgcat table. If the given locale is empty or no
795 localized string is found, returns the base pkg field.
800 my( $self, $locale ) = @_;
801 return $self->pkg unless $locale;
802 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
803 $part_pkg_msgcat->pkg;
806 =item part_pkg_msgcat LOCALE
808 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
812 sub part_pkg_msgcat {
813 my( $self, $locale ) = @_;
814 qsearchs( 'part_pkg_msgcat', {
815 pkgpart => $self->pkgpart,
820 =item pkg_comment [ OPTION => VALUE... ]
822 Returns an (internal) string representing this package. Currently,
823 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
824 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
827 If the option nopkgpart is true then the "pkgpart: ' is omitted.
835 #$self->pkg. ' - '. $self->comment;
836 #$self->pkg. ' ('. $self->comment. ')';
837 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
838 my $custom_comment = $self->custom_comment(%opt);
839 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
842 #without price info (so without hitting the DB again)
843 sub pkg_comment_only {
847 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
848 my $comment = $self->comment;
849 $pre. $self->pkg. ( $comment ? " - $comment" : '' );
852 sub price_info { # safety, in case a part_pkg hasn't defined price_info
858 my $price_info = $self->price_info(@_);
859 ( $self->custom ? '(CUSTOM) ' : '' ).
861 ( ($self->custom || $self->comment) ? ' - ' : '' ).
862 ($price_info || 'No charge');
867 $self->pkg. ' - '. ($self->price_info || 'No charge');
872 Returns the package class, as an FS::pkg_class object, or the empty string
873 if there is no package class.
875 =item addon_pkg_class
877 Returns the add-on package class, as an FS::pkg_class object, or the empty
878 string if there is no add-on package class.
882 sub addon_pkg_class {
884 if ( $self->addon_classnum ) {
885 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
893 Returns the package category name, or the empty string if there is no package
900 my $pkg_class = $self->pkg_class;
902 ? $pkg_class->categoryname
908 Returns the package class name, or the empty string if there is no package
915 my $pkg_class = $self->pkg_class;
917 ? $pkg_class->classname
921 =item addon_classname
923 Returns the add-on package class name, or the empty string if there is no
924 add-on package class.
928 sub addon_classname {
930 my $pkg_class = $self->addon_pkg_class;
932 ? $pkg_class->classname
938 Returns the associated agent for this event, if any, as an FS::agent object.
940 =item pkg_svc [ HASHREF | OPTION => VALUE ]
942 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
943 definition (with non-zero quantity).
945 One option is available, I<disable_linked>. If set true it will return the
946 services for this package definition alone, omitting services from any add-on
953 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
961 # #sort { $b->primary cmp $a->primary }
962 # grep { $_->quantity }
963 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
965 my $opt = ref($_[0]) ? $_[0] : { @_ };
966 my %pkg_svc = map { $_->svcpart => $_ }
967 grep { $_->quantity }
968 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
970 unless ( $opt->{disable_linked} ) {
971 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
972 my @pkg_svc = grep { $_->quantity }
973 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
974 foreach my $pkg_svc ( @pkg_svc ) {
975 if ( $pkg_svc{$pkg_svc->svcpart} ) {
976 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
977 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
979 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
989 =item svcpart [ SVCDB ]
991 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
992 associated with this package definition (see L<FS::pkg_svc>). Returns
993 false if there not a primary service definition or exactly one service
994 definition with quantity 1, or if SVCDB is specified and does not match the
995 svcdb of the service definition. SVCDB can be specified as a scalar table
996 name, such as 'svc_acct', or as an arrayref of possible table names.
1001 my $pkg_svc = shift->_primary_pkg_svc(@_);
1002 $pkg_svc ? $pkg_svc->svcpart : '';
1005 =item part_svc [ SVCDB ]
1007 Like the B<svcpart> method, but returns the FS::part_svc object (see
1013 my $pkg_svc = shift->_primary_pkg_svc(@_);
1014 $pkg_svc ? $pkg_svc->part_svc : '';
1017 sub _primary_pkg_svc {
1020 my $svcdb = scalar(@_) ? shift : [];
1021 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1022 my %svcdb = map { $_=>1 } @$svcdb;
1025 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1028 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1029 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1031 return '' if scalar(@pkg_svc) != 1;
1035 =item svcpart_unique_svcdb SVCDB
1037 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1038 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1039 false if there not a primary service definition for SVCDB or there are multiple
1040 service definitions for SVCDB.
1044 sub svcpart_unique_svcdb {
1045 my( $self, $svcdb ) = @_;
1046 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1047 return '' if scalar(@svcdb_pkg_svc) != 1;
1048 $svcdb_pkg_svc[0]->svcpart;
1053 Returns a list of the acceptable payment types for this package. Eventually
1054 this should come out of a database table and be editable, but currently has the
1055 following logic instead:
1057 If the package is free, the single item B<BILL> is
1058 returned, otherwise, the single item B<CARD> is returned.
1060 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1066 if ( $self->is_free ) {
1075 Returns true if this package is free.
1081 if ( $self->can('is_free_options') ) {
1082 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1083 map { $self->option($_) }
1084 $self->is_free_options;
1086 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1087 "provides neither is_free_options nor is_free method; returning false";
1092 # whether the plan allows discounts to be applied to this package
1093 sub can_discount { 0; }
1095 # whether the plan allows changing the start date
1096 sub can_start_date { 1; }
1098 # whether the plan supports part_pkg_usageprice add-ons (a specific kind of
1099 # pre-selectable usage pricing, there's others this doesn't refer to)
1100 sub can_usageprice { 0; }
1102 # the delay start date if present
1103 sub delay_start_date {
1106 my $delay = $self->delay_start or return '';
1108 # avoid timelocal silliness
1109 my $dt = DateTime->today(time_zone => 'local');
1110 $dt->add(days => $delay);
1114 sub can_currency_exchange { 0; }
1117 # moved to FS::Misc to make this accessible to other packages
1119 FS::Misc::pkg_freqs();
1124 Returns an english representation of the I<freq> field, such as "monthly",
1125 "weekly", "semi-annually", etc.
1131 my $freq = $self->freq;
1133 #my $freqs_href = $self->freqs_href;
1134 my $freqs_href = freqs_href();
1136 if ( exists($freqs_href->{$freq}) ) {
1137 $freqs_href->{$freq};
1139 my $interval = 'month';
1140 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1141 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1142 $interval = $interval{$2};
1147 "every $freq ${interval}s";
1152 =item add_freq TIMESTAMP [ FREQ ]
1154 Adds a billing period of some frequency to the provided timestamp and
1155 returns the resulting timestamp, or -1 if the frequency could not be
1156 parsed (shouldn't happen). By default, the frequency of this package
1157 will be used; to override this, pass a different frequency as a second
1163 my( $self, $date, $freq ) = @_;
1164 $freq = $self->freq unless $freq;
1166 #change this bit to use Date::Manip? CAREFUL with timezones (see
1167 # mailing list archive)
1168 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1170 if ( $freq =~ /^\d+$/ ) {
1172 until ( $mon < 12 ) { $mon -= 12; $year++; }
1174 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1176 } elsif ( $freq =~ /^(\d+)w$/ ) {
1178 $mday += $weeks * 7;
1179 } elsif ( $freq =~ /^(\d+)d$/ ) {
1182 } elsif ( $freq =~ /^(\d+)h$/ ) {
1189 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1194 For backwards compatibility, returns the plandata field as well as all options
1195 from FS::part_pkg_option.
1201 carp "plandata is deprecated";
1203 $self->SUPER::plandata(@_);
1205 my $plandata = $self->get('plandata');
1206 my %options = $self->options;
1207 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1212 =item part_pkg_vendor
1214 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1215 L<FS::part_pkg_vendor>).
1217 =item vendor_pkg_ids
1219 Returns a list of vendor/external package ids by exportnum
1223 sub vendor_pkg_ids {
1225 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1228 =item part_pkg_option
1230 Returns all options as FS::part_pkg_option objects (see
1231 L<FS::part_pkg_option>).
1235 Returns a list of option names and values suitable for assigning to a hash.
1241 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1244 =item option OPTIONNAME [ QUIET ]
1246 Returns the option value for the given name, or the empty string. If a true
1247 value is passed as the second argument, warnings about missing the option
1253 my( $self, $opt, $ornull ) = @_;
1254 cluck "$self -> option: searching for $opt"
1256 my $part_pkg_option =
1257 qsearchs('part_pkg_option', {
1258 pkgpart => $self->pkgpart,
1261 return $part_pkg_option->optionvalue if $part_pkg_option;
1262 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1263 split("\n", $self->get('plandata') );
1264 return $plandata{$opt} if exists $plandata{$opt};
1265 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1266 "not found in options or plandata!\n"
1271 =item part_pkg_currency [ CURRENCY ]
1273 Returns all currency options as FS::part_pkg_currency objects (see
1274 L<FS::part_pkg_currency>), or, if a currency is specified, only return the
1275 objects for that currency.
1279 sub part_pkg_currency {
1281 my %hash = ( 'pkgpart' => $self->pkgpart );
1282 $hash{'currency'} = shift if @_;
1283 qsearch('part_pkg_currency', \%hash );
1286 =item part_pkg_currency_options CURRENCY
1288 Returns a list of option names and values from FS::part_pkg_currency for the
1293 sub part_pkg_currency_options {
1295 map { $_->optionname => $_->optionvalue } $self->part_pkg_currency(shift);
1298 =item part_pkg_currency_option CURRENCY OPTIONNAME
1300 Returns the option value for the given name and currency.
1304 sub part_pkg_currency_option {
1305 my( $self, $currency, $optionname ) = @_;
1306 my $part_pkg_currency =
1307 qsearchs('part_pkg_currency', { 'pkgpart' => $self->pkgpart,
1308 'currency' => $currency,
1309 'optionname' => $optionname,
1312 #fatal if not found? that works for our use cases from
1313 #part_pkg/currency_fixed, but isn't how we would typically/expect the method
1314 #to behave. have to catch it there if we change it here...
1315 or die "Unknown price for ". $self->pkg_comment. " in $currency\n";
1317 $part_pkg_currency->optionvalue;
1320 =item bill_part_pkg_link
1322 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1326 sub bill_part_pkg_link {
1327 shift->_part_pkg_link('bill', @_);
1330 =item svc_part_pkg_link
1332 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1336 sub svc_part_pkg_link {
1337 shift->_part_pkg_link('svc', @_);
1340 =item supp_part_pkg_link
1342 Returns the associated part_pkg_link records of type 'supp' (supplemental
1347 sub supp_part_pkg_link {
1348 shift->_part_pkg_link('supp', @_);
1351 sub _part_pkg_link {
1352 my( $self, $type ) = @_;
1353 qsearch({ table => 'part_pkg_link',
1354 hashref => { 'src_pkgpart' => $self->pkgpart,
1355 'link_type' => $type,
1356 #protection against infinite recursive links
1357 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1359 order_by => "ORDER BY hidden",
1363 sub self_and_bill_linked {
1364 shift->_self_and_linked('bill', @_);
1367 sub self_and_svc_linked {
1368 shift->_self_and_linked('svc', @_);
1371 sub _self_and_linked {
1372 my( $self, $type, $hidden ) = @_;
1376 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1377 $self->_part_pkg_link($type) ) )
1379 $_->hidden($hidden) if $hidden;
1386 =item part_pkg_taxoverride [ CLASS ]
1388 Returns all associated FS::part_pkg_taxoverride objects (see
1389 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1390 of class CLASS if defined. Class may be one of 'setup', 'recur',
1391 the empty string (default), or a usage class number (see L<FS::usage_class>).
1392 When a class is specified, the empty string class (default) is returned
1393 if no more specific values exist.
1397 sub part_pkg_taxoverride {
1401 my $hashref = { 'pkgpart' => $self->pkgpart };
1402 $hashref->{'usage_class'} = $class if defined($class);
1403 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1405 unless ( scalar(@overrides) || !defined($class) || !$class ){
1406 $hashref->{'usage_class'} = '';
1407 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1413 =item has_taxproduct
1415 Returns true if this package has any taxproduct associated with it.
1419 sub has_taxproduct {
1422 $self->taxproductnum ||
1423 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1424 keys %{ {$self->options} }
1430 =item taxproduct [ CLASS ]
1432 Returns the associated tax product for this package definition (see
1433 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1434 the usage classnum (see L<FS::usage_class>). Returns the default
1435 tax product for this record if the more specific CLASS value does
1444 my $part_pkg_taxproduct;
1446 my $taxproductnum = $self->taxproductnum;
1448 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1449 $taxproductnum = $class_taxproductnum
1450 if $class_taxproductnum
1453 $part_pkg_taxproduct =
1454 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1456 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1457 $taxproductnum = $self->taxproductnum;
1458 $part_pkg_taxproduct =
1459 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1462 $part_pkg_taxproduct;
1465 =item taxproduct_description [ CLASS ]
1467 Returns the description of the associated tax product for this package
1468 definition (see L<FS::part_pkg_taxproduct>).
1472 sub taxproduct_description {
1474 my $part_pkg_taxproduct = $self->taxproduct(@_);
1475 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1479 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1481 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1482 package in the location specified by GEOCODE, for usage class CLASS (one of
1483 'setup', 'recur', null, or a C<usage_class> number).
1489 my ($vendor, $geocode, $class) = @_;
1490 my @taxclassnums = map { $_->taxclassnum }
1491 $self->part_pkg_taxoverride($class);
1492 if (!@taxclassnums) {
1493 my $part_pkg_taxproduct = $self->taxproduct($class);
1494 @taxclassnums = map { $_->taxclassnum }
1495 grep { $_->taxable eq 'Y' } # why do we need this?
1496 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1498 return unless @taxclassnums;
1500 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1502 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1503 my @taxes = qsearch({ 'table' => 'tax_rate',
1504 'hashref' => { 'geocode' => $geocode,
1505 'data_vendor' => $vendor },
1506 'extra_sql' => $extra_sql,
1508 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1514 =item part_pkg_discount
1516 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1519 =item part_pkg_usage
1521 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1526 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1527 PLAN is the object's I<plan> field. There should be better docs
1528 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1534 my $plan = $self->plan;
1536 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1540 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1541 my $class = ref($self). "::$plan";
1542 warn "reblessing $self into $class" if $DEBUG > 1;
1545 bless($self, $class) unless $@;
1550 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1551 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1553 #fallback that return 0 for old legacy packages with no plan
1554 sub calc_remain { 0; }
1555 sub calc_units { 0; }
1557 #fallback for everything not based on flat.pm
1558 sub recur_temporality { 'upcoming'; }
1559 sub calc_cancel { 0; }
1561 #fallback for everything except bulk.pm
1562 sub hide_svc_detail { 0; }
1564 #fallback for packages that can't/won't summarize usage
1565 sub sum_usage { 0; }
1567 =item recur_cost_permonth CUST_PKG
1569 recur_cost divided by freq (only supported for monthly and longer frequencies)
1573 sub recur_cost_permonth {
1574 my($self, $cust_pkg) = @_;
1575 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1576 sprintf('%.2f', $self->recur_cost / $self->freq );
1579 =item cust_bill_pkg_recur CUST_PKG
1581 Actual recurring charge for the specified customer package from customer's most
1586 sub cust_bill_pkg_recur {
1587 my($self, $cust_pkg) = @_;
1588 my $cust_bill_pkg = qsearchs({
1589 'table' => 'cust_bill_pkg',
1590 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1591 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1592 'recur' => { op=>'>', value=>'0' },
1594 'order_by' => 'ORDER BY cust_bill._date DESC,
1595 cust_bill_pkg.sdate DESC
1598 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1599 $cust_bill_pkg->recur;
1602 =item unit_setup CUST_PKG
1604 Returns the setup fee for one unit of the package.
1609 my ($self, $cust_pkg) = @_;
1610 $self->option('setup_fee') || 0;
1613 =item format OPTION DATA
1615 Returns data formatted according to the function 'format' described
1616 in the plan info. Returns DATA if no such function exists.
1621 my ($self, $option, $data) = (shift, shift, shift);
1622 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1623 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1629 =item parse OPTION DATA
1631 Returns data parsed according to the function 'parse' described
1632 in the plan info. Returns DATA if no such function exists.
1637 my ($self, $option, $data) = (shift, shift, shift);
1638 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1639 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1649 =head1 CLASS METHODS
1657 # Used by FS::Upgrade to migrate to a new database.
1659 sub _upgrade_data { # class method
1660 my($class, %opts) = @_;
1662 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1664 my @part_pkg = qsearch({
1665 'table' => 'part_pkg',
1666 'extra_sql' => "WHERE ". join(' OR ',
1667 'plan IS NULL', "plan = '' ",
1671 foreach my $part_pkg (@part_pkg) {
1673 unless ( $part_pkg->plan ) {
1674 $part_pkg->plan('flat');
1681 # now upgrade to the explicit custom flag
1683 @part_pkg = qsearch({
1684 'table' => 'part_pkg',
1685 'hashref' => { disabled => 'Y', custom => '' },
1686 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1689 foreach my $part_pkg (@part_pkg) {
1690 my $new = new FS::part_pkg { $part_pkg->hash };
1692 my $comment = $part_pkg->comment;
1693 $comment =~ s/^\(CUSTOM\) //;
1694 $comment = '(none)' unless $comment =~ /\S/;
1695 $new->comment($comment);
1697 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1698 my $primary = $part_pkg->svcpart;
1699 my $options = { $part_pkg->options };
1701 my $error = $new->replace( $part_pkg,
1702 'pkg_svc' => $pkg_svc,
1703 'primary_svc' => $primary,
1704 'options' => $options,
1706 die $error if $error;
1709 # set family_pkgpart on any packages that don't have it
1710 @part_pkg = qsearch('part_pkg', { 'family_pkgpart' => '' });
1711 foreach my $part_pkg (@part_pkg) {
1712 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1713 my $error = $part_pkg->SUPER::replace;
1714 die $error if $error;
1717 my @part_pkg_option = qsearch('part_pkg_option',
1718 { 'optionname' => 'unused_credit',
1721 foreach my $old_opt (@part_pkg_option) {
1722 my $pkgpart = $old_opt->pkgpart;
1723 my $error = $old_opt->delete;
1724 die $error if $error;
1726 foreach (qw(unused_credit_cancel unused_credit_change)) {
1727 my $new_opt = new FS::part_pkg_option {
1728 'pkgpart' => $pkgpart,
1732 $error = $new_opt->insert;
1733 die $error if $error;
1737 # migrate use_disposition_taqua and use_disposition to disposition_in
1738 @part_pkg_option = qsearch('part_pkg_option',
1739 { 'optionname' => { op => 'LIKE',
1740 value => 'use_disposition%',
1744 my %newopts = map { $_->pkgpart => $_ }
1745 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1746 foreach my $old_opt (@part_pkg_option) {
1747 my $pkgpart = $old_opt->pkgpart;
1748 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1750 my $error = $old_opt->delete;
1751 die $error if $error;
1753 if ( exists($newopts{$pkgpart}) ) {
1754 my $opt = $newopts{$pkgpart};
1755 $opt->optionvalue($opt->optionvalue.",$newval");
1756 $error = $opt->replace;
1757 die $error if $error;
1759 my $new_opt = new FS::part_pkg_option {
1760 'pkgpart' => $pkgpart,
1761 'optionname' => 'disposition_in',
1762 'optionvalue' => $newval,
1764 $error = $new_opt->insert;
1765 die $error if $error;
1766 $newopts{$pkgpart} = $new_opt;
1770 # set any package with FCC voice lines to the "VoIP with broadband" category
1771 # for backward compatibility
1773 # recover from a bad upgrade bug
1774 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1775 if (!FS::upgrade_journal->is_done($upgrade)) {
1776 my $bad_upgrade = qsearchs('upgrade_journal',
1777 { upgrade => 'part_pkg_fcc_voip_class' }
1779 if ( $bad_upgrade ) {
1780 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1781 ' AND history_date > '.($bad_upgrade->_date - 3600);
1782 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1785 'table' => 'h_part_pkg_option',
1787 'extra_sql' => "$where AND history_action = 'delete'",
1788 'order_by' => 'ORDER BY history_date ASC',
1790 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1793 'table' => 'h_pkg_svc',
1795 'extra_sql' => "$where AND history_action = 'replace_old'",
1796 'order_by' => 'ORDER BY history_date ASC',
1799 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1800 my $pkgpart ||= $deleted->pkgpart;
1801 $opt{$pkgpart} ||= {
1807 if ( $deleted->isa('FS::part_pkg_option') ) {
1808 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1810 my $svcpart = $deleted->svcpart;
1811 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1812 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1813 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1816 foreach my $pkgpart (keys %opt) {
1817 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1818 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1820 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1823 } # $bad_upgrade exists
1824 else { # do the original upgrade, but correctly this time
1825 @part_pkg = qsearch('part_pkg', {
1826 fcc_ds0s => { op => '>', value => 0 },
1827 fcc_voip_class => ''
1829 foreach my $part_pkg (@part_pkg) {
1830 $part_pkg->set(fcc_voip_class => 2);
1831 my @pkg_svc = $part_pkg->pkg_svc;
1832 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1833 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1834 my $error = $part_pkg->replace(
1835 $part_pkg->replace_old,
1836 options => { $part_pkg->options },
1837 pkg_svc => \%quantity,
1838 hidden_svc => \%hidden,
1839 primary_svc => ($part_pkg->svcpart || ''),
1841 die $error if $error;
1844 FS::upgrade_journal->set_done($upgrade);
1849 =item curuser_pkgs_sql
1851 Returns an SQL fragment for searching for packages the current user can
1852 use, either via part_pkg.agentnum directly, or via agent type (see
1857 sub curuser_pkgs_sql {
1860 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1864 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1866 Returns an SQL fragment for searching for packages the provided agent or agents
1867 can use, either via part_pkg.agentnum directly, or via agent type (see
1872 sub agent_pkgs_sql {
1873 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1874 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1876 $class->_pkgs_sql(@agentnums); #is this why
1881 my( $class, @agentnums ) = @_;
1882 my $agentnums = join(',', @agentnums);
1886 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1887 OR ( agentnum IS NULL
1888 AND EXISTS ( SELECT 1
1890 LEFT JOIN agent_type USING ( typenum )
1891 LEFT JOIN agent AS typeagent USING ( typenum )
1892 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1893 AND typeagent.agentnum IN ($agentnums)
1911 #false laziness w/part_export & cdr
1913 foreach my $INC ( @INC ) {
1914 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1915 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1916 warn "attempting to load plan info from $file\n" if $DEBUG;
1917 $file =~ /\/(\w+)\.pm$/ or do {
1918 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1922 my $info = eval "use FS::part_pkg::$mod; ".
1923 "\\%FS::part_pkg::$mod\::info;";
1925 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1928 unless ( keys %$info ) {
1929 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1932 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1933 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1934 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1937 $info{$mod} = $info;
1938 $info->{'weight'} ||= 0; # quiet warnings
1942 # copy one level deep to allow replacement of fields and fieldorder
1943 tie %plans, 'Tie::IxHash',
1944 map { my %infohash = %{ $info{$_} };
1946 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1949 # inheritance of plan options
1950 foreach my $name (keys(%info)) {
1951 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1952 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1953 delete $plans{$name};
1956 my $parents = $info{$name}->{'inherit_fields'} || [];
1957 my (%fields, %field_exists, @fieldorder);
1958 foreach my $parent ($name, @$parents) {
1959 if ( !exists($info{$parent}) ) {
1960 warn "$name tried to inherit from nonexistent '$parent'\n";
1963 %fields = ( # avoid replacing existing fields
1964 %{ $info{$parent}->{'fields'} || {} },
1967 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1969 next if $field_exists{$_};
1970 $field_exists{$_} = 1;
1971 # allow inheritors to remove inherited fields from the fieldorder
1972 push @fieldorder, $_ if !exists($fields{$_}) or
1973 !exists($fields{$_}->{'disabled'});
1976 $plans{$name}->{'fields'} = \%fields;
1977 $plans{$name}->{'fieldorder'} = \@fieldorder;
1987 =head1 NEW PLAN CLASSES
1989 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1990 found in eg/plan_template.pm. Until then, it is suggested that you use the
1991 other modules in FS/FS/part_pkg/ as a guide.
1995 The delete method is unimplemented.
1997 setup and recur semantics are not yet defined (and are implemented in
1998 FS::cust_bill. hmm.). now they're deprecated and need to go.
2002 part_pkg_taxrate is Pg specific
2004 replace should be smarter about managing the related tables (options, pkg_svc)
2008 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2009 schema.html from the base documentation.