2 use base qw( FS::part_pkg::API
3 FS::m2m_Common FS::o2m_Common FS::option_Common
7 use vars qw( %plans $DEBUG $setup_hack $skip_pkg_svc_hack );
8 use Carp qw(carp cluck confess);
9 use Scalar::Util qw( blessed );
11 use Time::Local qw( timelocal timelocal_nocheck ); # eventually replace with DateTime
14 use FS::Record qw( qsearch qsearchs dbh dbdef );
15 use FS::Cursor; # for upgrade
21 use FS::part_pkg_option;
22 use FS::part_pkg_fcc_option;
25 use FS::part_pkg_msgcat;
26 use FS::part_pkg_taxrate;
27 use FS::part_pkg_taxoverride;
28 use FS::part_pkg_taxproduct;
29 use FS::part_pkg_link;
30 use FS::part_pkg_discount;
31 use FS::part_pkg_vendor;
32 use FS::part_pkg_currency;
36 $skip_pkg_svc_hack = 0;
40 FS::part_pkg - Object methods for part_pkg objects
46 $record = new FS::part_pkg \%hash
47 $record = new FS::part_pkg { 'column' => 'value' };
49 $custom_record = $template_record->clone;
51 $error = $record->insert;
53 $error = $new_record->replace($old_record);
55 $error = $record->delete;
57 $error = $record->check;
59 @pkg_svc = $record->pkg_svc;
61 $svcnum = $record->svcpart;
62 $svcnum = $record->svcpart( 'svc_acct' );
66 An FS::part_pkg object represents a package definition. FS::part_pkg
67 inherits from FS::Record. The following fields are currently supported:
71 =item pkgpart - primary key (assigned automatically for new package definitions)
73 =item pkg - Text name of this package definition (customer-viewable)
75 =item comment - Text name of this package definition (non-customer-viewable)
77 =item classnum - Optional package class (see L<FS::pkg_class>)
79 =item promo_code - Promotional code
81 =item setup - Setup fee expression (deprecated)
83 =item freq - Frequency of recurring fee
85 =item recur - Recurring fee expression (deprecated)
87 =item setuptax - Setup fee tax exempt flag, empty or `Y'
89 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
91 =item taxclass - Tax class
93 =item plan - Price plan
95 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
97 =item disabled - Disabled flag, empty or `Y'
99 =item custom - Custom flag, empty or `Y'
101 =item setup_cost - for cost tracking
103 =item recur_cost - for cost tracking
105 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
107 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
109 =item agentnum - Optional agentnum (see L<FS::agent>)
111 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
113 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
116 =item successor - Foreign key for the part_pkg that replaced this record.
117 If this record is not obsolete, will be null.
119 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
120 ancestor of this record. If this record is not a successor to another
121 part_pkg, will be equal to pkgpart.
123 =item delay_start - Number of days to delay package start, by default
133 Creates a new package definition. To add the package definition to
134 the database, see L<"insert">.
138 sub table { 'part_pkg'; }
142 An alternate constructor. Creates a new package definition by duplicating
143 an existing definition. A new pkgpart is assigned and the custom flag is
144 set to Y. To add the package definition to the database, see L<"insert">.
150 my $class = ref($self);
151 my %hash = $self->hash;
152 $hash{'pkgpart'} = '';
153 $hash{'custom'} = 'Y';
154 #new FS::part_pkg ( \%hash ); # ?
155 new $class ( \%hash ); # ?
158 =item insert [ , OPTION => VALUE ... ]
160 Adds this package definition to the database. If there is an error,
161 returns the error, otherwise returns false.
163 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
164 I<custnum_ref> and I<options>.
166 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
167 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
168 be set to a hashref of svcparts and flag values ('Y' or '') to set the
169 'hidden' field in these records.
171 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
172 FS::pkg_svc record will be updated.
174 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
175 record itself), the object will be updated to point to this package definition.
177 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
178 the scalar will be updated with the custnum value from the cust_pkg record.
180 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
181 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
182 records will be inserted.
184 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
185 records will be inserted.
187 If I<part_pkg_currency> is set to a hashref of options (with the keys as
188 option_CURRENCY), appropriate FS::part_pkg::currency records will be inserted.
195 warn "FS::part_pkg::insert called on $self with options ".
196 join(', ', map "$_=>$options{$_}", keys %options)
199 local $SIG{HUP} = 'IGNORE';
200 local $SIG{INT} = 'IGNORE';
201 local $SIG{QUIT} = 'IGNORE';
202 local $SIG{TERM} = 'IGNORE';
203 local $SIG{TSTP} = 'IGNORE';
204 local $SIG{PIPE} = 'IGNORE';
206 my $oldAutoCommit = $FS::UID::AutoCommit;
207 local $FS::UID::AutoCommit = 0;
210 warn " inserting part_pkg record" if $DEBUG;
211 my $error = $self->SUPER::insert( $options{options} );
213 $dbh->rollback if $oldAutoCommit;
218 if ( $self->get('family_pkgpart') eq '' ) {
219 $self->set('family_pkgpart' => $self->pkgpart);
220 $error = $self->SUPER::replace;
222 $dbh->rollback if $oldAutoCommit;
227 warn " inserting part_pkg_taxoverride records" if $DEBUG;
228 my %overrides = %{ $options{'tax_overrides'} || {} };
229 foreach my $usage_class ( keys %overrides ) {
231 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
232 ? $overrides{$usage_class}
234 my @overrides = (grep "$_", split(',', $override) );
235 my $error = $self->process_m2m (
236 'link_table' => 'part_pkg_taxoverride',
237 'target_table' => 'tax_class',
238 'hashref' => { 'usage_class' => $usage_class },
239 'params' => \@overrides,
242 $dbh->rollback if $oldAutoCommit;
247 warn " inserting part_pkg_currency records" if $DEBUG;
248 my %part_pkg_currency = %{ $options{'part_pkg_currency'} || {} };
249 foreach my $key ( keys %part_pkg_currency ) {
250 $key =~ /^(.+)_([A-Z]{3})$/ or next;
251 my( $optionname, $currency ) = ( $1, $2 );
252 if ( $part_pkg_currency{$key} =~ /^\s*$/ ) {
253 if ( $self->option($optionname) == 0 ) {
254 $part_pkg_currency{$key} = '0';
256 $dbh->rollback if $oldAutoCommit;
257 ( my $thing = $optionname ) =~ s/_/ /g;
258 return ucfirst($thing). " $currency is required";
261 my $part_pkg_currency = new FS::part_pkg_currency {
262 'pkgpart' => $self->pkgpart,
263 'optionname' => $optionname,
264 'currency' => $currency,
265 'optionvalue' => $part_pkg_currency{$key},
267 my $error = $part_pkg_currency->insert;
269 $dbh->rollback if $oldAutoCommit;
274 unless ( $skip_pkg_svc_hack ) {
276 warn " inserting pkg_svc records" if $DEBUG;
277 my $pkg_svc = $options{'pkg_svc'} || {};
278 my $hidden_svc = $options{'hidden_svc'} || {};
279 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
280 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
282 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
286 my $pkg_svc = new FS::pkg_svc( {
287 'pkgpart' => $self->pkgpart,
288 'svcpart' => $part_svc->svcpart,
289 'quantity' => $quantity,
290 'primary_svc' => $primary_svc,
291 'hidden' => $hidden_svc->{$part_svc->svcpart},
293 my $error = $pkg_svc->insert;
295 $dbh->rollback if $oldAutoCommit;
302 if ( $options{'cust_pkg'} ) {
303 warn " updating cust_pkg record " if $DEBUG;
305 ref($options{'cust_pkg'})
306 ? $options{'cust_pkg'}
307 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
308 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
309 if $options{'custnum_ref'};
310 my %hash = $old_cust_pkg->hash;
311 $hash{'pkgpart'} = $self->pkgpart,
312 my $new_cust_pkg = new FS::cust_pkg \%hash;
313 local($FS::cust_pkg::disable_agentcheck) = 1;
314 my $error = $new_cust_pkg->replace($old_cust_pkg);
316 $dbh->rollback if $oldAutoCommit;
317 return "Error modifying cust_pkg record: $error";
321 if ( $options{'part_pkg_vendor'} ) {
322 while ( my ($exportnum, $vendor_pkg_id) =
323 each %{ $options{part_pkg_vendor} }
326 my $ppv = new FS::part_pkg_vendor( {
327 'pkgpart' => $self->pkgpart,
328 'exportnum' => $exportnum,
329 'vendor_pkg_id' => $vendor_pkg_id,
331 my $error = $ppv->insert;
333 $dbh->rollback if $oldAutoCommit;
334 return "Error inserting part_pkg_vendor record: $error";
339 if ( $options{fcc_options} ) {
340 warn " updating fcc options " if $DEBUG;
341 $self->process_fcc_options( $options{fcc_options} );
344 warn " committing transaction" if $DEBUG and $oldAutoCommit;
345 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
352 Currently unimplemented.
357 return "Can't (yet?) delete package definitions.";
358 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
361 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
363 Replaces OLD_RECORD with this one in the database. If there is an error,
364 returns the error, otherwise returns false.
366 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
369 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
370 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
371 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
372 'hidden' field in these records. I<bulk_skip> can be set to a hashref of
373 svcparts and flag values ('Y' or '') to set the 'bulk_skip' field in those
376 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
377 FS::pkg_svc record will be updated.
379 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
382 If I<part_pkg_currency> is set to a hashref of options (with the keys as
383 option_CURRENCY), appropriate FS::part_pkg::currency records will be replaced.
390 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
395 ( ref($_[0]) eq 'HASH' )
399 $options->{options} = { $old->options } unless defined($options->{options});
401 warn "FS::part_pkg::replace called on $new to replace $old with options".
402 join(', ', map "$_ => ". $options->{$_}, keys %$options)
405 local $SIG{HUP} = 'IGNORE';
406 local $SIG{INT} = 'IGNORE';
407 local $SIG{QUIT} = 'IGNORE';
408 local $SIG{TERM} = 'IGNORE';
409 local $SIG{TSTP} = 'IGNORE';
410 local $SIG{PIPE} = 'IGNORE';
412 my $oldAutoCommit = $FS::UID::AutoCommit;
413 local $FS::UID::AutoCommit = 0;
416 my $conf = new FS::Conf;
417 if ( $conf->exists('part_pkg-lineage') ) {
418 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
419 qw(setup_fee recur_fee) #others? config?
422 warn " superseding package" if $DEBUG;
424 my $error = $new->supersede($old, %$options);
426 $dbh->rollback if $oldAutoCommit;
430 warn " committing transaction" if $DEBUG and $oldAutoCommit;
431 $dbh->commit if $oldAutoCommit;
438 #plandata shit stays in replace for upgrades until after 2.0 (or edit
440 warn " saving legacy plandata" if $DEBUG;
441 my $plandata = $new->get('plandata');
442 $new->set('plandata', '');
444 warn " deleting old part_pkg_option records" if $DEBUG;
445 foreach my $part_pkg_option ( $old->part_pkg_option ) {
446 my $error = $part_pkg_option->delete;
448 $dbh->rollback if $oldAutoCommit;
453 warn " replacing part_pkg record" if $DEBUG;
454 my $error = $new->SUPER::replace($old, $options->{options} );
456 $dbh->rollback if $oldAutoCommit;
460 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
461 foreach my $part_pkg_option (
462 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
463 return "illegal plandata: $plandata";
465 new FS::part_pkg_option {
466 'pkgpart' => $new->pkgpart,
471 split("\n", $plandata)
473 my $error = $part_pkg_option->insert;
475 $dbh->rollback if $oldAutoCommit;
480 #trivial nit: not the most efficient to delete and reinsert
481 warn " deleting old part_pkg_currency records" if $DEBUG;
482 foreach my $part_pkg_currency ( $old->part_pkg_currency ) {
483 my $error = $part_pkg_currency->delete;
485 $dbh->rollback if $oldAutoCommit;
486 return "error deleting part_pkg_currency record: $error";
490 warn " inserting new part_pkg_currency records" if $DEBUG;
491 my %part_pkg_currency = %{ $options->{'part_pkg_currency'} || {} };
492 foreach my $key ( keys %part_pkg_currency ) {
493 $key =~ /^(.+)_([A-Z]{3})$/ or next;
494 my $part_pkg_currency = new FS::part_pkg_currency {
495 'pkgpart' => $new->pkgpart,
498 'optionvalue' => $part_pkg_currency{$key},
500 my $error = $part_pkg_currency->insert;
502 $dbh->rollback if $oldAutoCommit;
503 return "error inserting part_pkg_currency record: $error";
508 warn " replacing pkg_svc records" if $DEBUG;
509 my $pkg_svc = $options->{'pkg_svc'};
510 my $hidden_svc = $options->{'hidden_svc'} || {};
511 my $bulk_skip = $options->{'bulk_skip'} || {};
512 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
513 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
514 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
515 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
516 my $bulk_skip = $bulk_skip->{$part_svc->svcpart} || '';
518 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
519 && $options->{'primary_svc'} == $part_svc->svcpart
524 my $old_pkg_svc = qsearchs('pkg_svc', {
525 'pkgpart' => $old->pkgpart,
526 'svcpart' => $part_svc->svcpart,
529 my $old_quantity = 0;
530 my $old_primary_svc = '';
532 my $old_bulk_skip = '';
533 if ( $old_pkg_svc ) {
534 $old_quantity = $old_pkg_svc->quantity;
535 $old_primary_svc = $old_pkg_svc->primary_svc
536 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
537 $old_hidden = $old_pkg_svc->hidden;
538 $old_bulk_skip = $old_pkg_svc->old_bulk_skip;
541 next unless $old_quantity != $quantity
542 || $old_primary_svc ne $primary_svc
543 || $old_hidden ne $hidden
544 || $old_bulk_skip ne $bulk_skip;
546 my $new_pkg_svc = new FS::pkg_svc( {
547 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
548 'pkgpart' => $new->pkgpart,
549 'svcpart' => $part_svc->svcpart,
550 'quantity' => $quantity,
551 'primary_svc' => $primary_svc,
553 'bulk_skip' => $bulk_skip,
555 my $error = $old_pkg_svc
556 ? $new_pkg_svc->replace($old_pkg_svc)
557 : $new_pkg_svc->insert;
559 $dbh->rollback if $oldAutoCommit;
563 } #if $options->{pkg_svc}
565 my @part_pkg_vendor = $old->part_pkg_vendor;
566 my @current_exportnum = ();
567 if ( $options->{'part_pkg_vendor'} ) {
568 my($exportnum,$vendor_pkg_id);
569 while ( ($exportnum,$vendor_pkg_id)
570 = each %{$options->{'part_pkg_vendor'}} ) {
572 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
573 if($exportnum == $part_pkg_vendor->exportnum
574 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
575 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
576 my $error = $part_pkg_vendor->replace;
578 $dbh->rollback if $oldAutoCommit;
579 return "Error replacing part_pkg_vendor record: $error";
584 elsif($exportnum == $part_pkg_vendor->exportnum
585 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
590 unless ( $noinsert ) {
591 my $ppv = new FS::part_pkg_vendor( {
592 'pkgpart' => $new->pkgpart,
593 'exportnum' => $exportnum,
594 'vendor_pkg_id' => $vendor_pkg_id,
596 my $error = $ppv->insert;
598 $dbh->rollback if $oldAutoCommit;
599 return "Error inserting part_pkg_vendor record: $error";
602 push @current_exportnum, $exportnum;
605 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
606 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
607 my $error = $part_pkg_vendor->delete;
609 $dbh->rollback if $oldAutoCommit;
610 return "Error deleting part_pkg_vendor record: $error";
615 # propagate changes to certain core fields
616 if ( $conf->exists('part_pkg-lineage') ) {
617 warn " propagating changes to family" if $DEBUG;
618 my $error = $new->propagate($old);
620 $dbh->rollback if $oldAutoCommit;
625 if ( $options->{fcc_options} ) {
626 warn " updating fcc options " if $DEBUG;
627 $new->process_fcc_options( $options->{fcc_options} );
630 warn " committing transaction" if $DEBUG and $oldAutoCommit;
631 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
637 Checks all fields to make sure this is a valid package definition. If
638 there is an error, returns the error, otherwise returns false. Called by the
639 insert and replace methods.
645 warn "FS::part_pkg::check called on $self" if $DEBUG;
647 for (qw(setup recur plandata)) {
648 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
649 return "Use of $_ field is deprecated; set a plan and options: ".
651 if length($self->get($_));
655 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
656 my $error = $self->ut_number('freq');
657 return $error if $error;
659 $self->freq =~ /^(\d+[hdw]?)$/
660 or return "Illegal or empty freq: ". $self->freq;
664 my @null_agentnum_right = ( 'Edit global package definitions' );
665 push @null_agentnum_right, 'One-time charge'
666 if $self->freq =~ /^0/;
667 push @null_agentnum_right, 'Customize customer package'
668 if $self->disabled eq 'Y'; #good enough
670 my $error = $self->ut_numbern('pkgpart')
671 || $self->ut_text('pkg')
672 || $self->ut_textn('comment')
673 || $self->ut_textn('promo_code')
674 || $self->ut_alphan('plan')
675 || $self->ut_enum('setuptax', [ '', 'Y' ] )
676 || $self->ut_enum('recurtax', [ '', 'Y' ] )
677 || $self->ut_textn('taxclass')
678 || $self->ut_enum('disabled', [ '', 'Y' ] )
679 || $self->ut_enum('custom', [ '', 'Y' ] )
680 || $self->ut_enum('no_auto', [ '', 'Y' ])
681 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
682 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
683 #|| $self->ut_moneyn('setup_cost')
684 #|| $self->ut_moneyn('recur_cost')
685 || $self->ut_floatn('setup_cost')
686 || $self->ut_floatn('recur_cost')
687 || $self->ut_floatn('pay_weight')
688 || $self->ut_floatn('credit_weight')
689 || $self->ut_numbern('taxproductnum')
690 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
691 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
692 || $self->ut_foreign_keyn('taxproductnum',
693 'part_pkg_taxproduct',
697 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
698 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
700 || $self->ut_numbern('fcc_ds0s')
701 || $self->ut_numbern('fcc_voip_class')
702 || $self->ut_numbern('delay_start')
703 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
704 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
705 || $self->ut_alphan('agent_pkgpartid')
706 || $self->SUPER::check
708 return $error if $error;
710 return 'Unknown plan '. $self->plan
711 unless exists($plans{$self->plan});
713 my $conf = new FS::Conf;
714 return 'Taxclass is required'
715 if ! $self->taxclass && $conf->exists('require_taxclasses');
720 =item supersede OLD [, OPTION => VALUE ... ]
722 Inserts this package as a successor to the package OLD. All options are as
723 for C<insert>. After inserting, disables OLD and sets the new package as its
729 my ($new, $old, %options) = @_;
732 $new->set('pkgpart' => '');
733 $new->set('family_pkgpart' => $old->family_pkgpart);
734 warn " inserting successor package\n" if $DEBUG;
735 $error = $new->insert(%options);
736 return $error if $error;
738 warn " disabling superseded package\n" if $DEBUG;
739 $old->set('successor' => $new->pkgpart);
740 $old->set('disabled' => 'Y');
741 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
742 return $error if $error;
744 warn " propagating changes to family" if $DEBUG;
745 $new->propagate($old);
750 If any of certain fields have changed from OLD to this package, then,
751 for all packages in the same lineage as this one, sets those fields
752 to their values in this package.
756 my @propagate_fields = (
757 qw( pkg classnum setup_cost recur_cost taxclass
758 setuptax recurtax pay_weight credit_weight
766 map { $_ => $new->get($_) }
767 grep { $new->get($_) ne $old->get($_) }
771 my @part_pkg = qsearch('part_pkg', {
772 'family_pkgpart' => $new->family_pkgpart
775 foreach my $part_pkg ( @part_pkg ) {
776 my $pkgpart = $part_pkg->pkgpart;
777 next if $pkgpart == $new->pkgpart; # don't modify $new
778 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
779 foreach ( keys %fields ) {
780 $part_pkg->set($_, $fields{$_});
782 # SUPER::replace to avoid changing non-core fields
783 my $error = $part_pkg->SUPER::replace;
784 push @error, "pkgpart $pkgpart: $error"
790 =item process_fcc_options HASHREF
792 Sets the FCC options on this package definition to the values specified
797 sub process_fcc_options {
799 my $pkgpart = $self->pkgpart;
807 my %existing_num = map { $_->fccoptionname => $_->num }
808 qsearch('part_pkg_fcc_option', { pkgpart => $pkgpart });
810 local $FS::Record::nowarn_identical = 1;
811 # set up params for process_o2m
814 foreach my $name (keys %$options ) {
815 $params->{ "num$i" } = $existing_num{$name} || '';
816 $params->{ "num$i".'_fccoptionname' } = $name;
817 $params->{ "num$i".'_optionvalue' } = $options->{$name};
822 table => 'part_pkg_fcc_option',
823 fields => [qw( fccoptionname optionvalue )],
828 =item pkg_locale LOCALE
830 Returns a customer-viewable string representing this package for the given
831 locale, from the part_pkg_msgcat table. If the given locale is empty or no
832 localized string is found, returns the base pkg field.
837 my( $self, $locale ) = @_;
838 return $self->pkg unless $locale;
839 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
840 $part_pkg_msgcat->pkg;
843 =item part_pkg_msgcat LOCALE
845 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
849 sub part_pkg_msgcat {
850 my( $self, $locale ) = @_;
851 qsearchs( 'part_pkg_msgcat', {
852 pkgpart => $self->pkgpart,
857 =item pkg_comment [ OPTION => VALUE... ]
859 Returns an (internal) string representing this package. Currently,
860 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
861 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
864 If the option nopkgpart is true then the "pkgpart: ' is omitted.
872 #$self->pkg. ' - '. $self->comment;
873 #$self->pkg. ' ('. $self->comment. ')';
874 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
875 my $custom_comment = $self->custom_comment(%opt);
876 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
879 #without price info (so without hitting the DB again)
880 sub pkg_comment_only {
884 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
885 my $comment = $self->comment;
886 $pre. $self->pkg. ( $comment ? " - $comment" : '' );
889 sub price_info { # safety, in case a part_pkg hasn't defined price_info
895 my $price_info = $self->price_info(@_);
896 ( $self->custom ? '(CUSTOM) ' : '' ).
898 ( ($self->custom || $self->comment) ? ' - ' : '' ).
899 ($price_info || 'No charge');
904 $self->pkg. ' - '. ($self->price_info || 'No charge');
909 Returns the package class, as an FS::pkg_class object, or the empty string
910 if there is no package class.
912 =item addon_pkg_class
914 Returns the add-on package class, as an FS::pkg_class object, or the empty
915 string if there is no add-on package class.
919 sub addon_pkg_class {
921 if ( $self->addon_classnum ) {
922 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
930 Returns the package category name, or the empty string if there is no package
937 my $pkg_class = $self->pkg_class;
939 ? $pkg_class->categoryname
945 Returns the package class name, or the empty string if there is no package
952 my $pkg_class = $self->pkg_class;
954 ? $pkg_class->classname
958 =item addon_classname
960 Returns the add-on package class name, or the empty string if there is no
961 add-on package class.
965 sub addon_classname {
967 my $pkg_class = $self->addon_pkg_class;
969 ? $pkg_class->classname
975 Returns the associated agent for this event, if any, as an FS::agent object.
977 =item pkg_svc [ HASHREF | OPTION => VALUE ]
979 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
980 definition (with non-zero quantity).
982 One option is available, I<disable_linked>. If set true it will return the
983 services for this package definition alone, omitting services from any add-on
990 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
998 # #sort { $b->primary cmp $a->primary }
999 # grep { $_->quantity }
1000 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
1002 my $opt = ref($_[0]) ? $_[0] : { @_ };
1003 my %pkg_svc = map { $_->svcpart => $_ }
1004 grep { $_->quantity }
1005 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
1007 unless ( $opt->{disable_linked} ) {
1008 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
1009 my @pkg_svc = grep { $_->quantity }
1010 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
1011 foreach my $pkg_svc ( @pkg_svc ) {
1012 if ( $pkg_svc{$pkg_svc->svcpart} ) {
1013 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
1014 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
1016 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
1026 =item svcpart [ SVCDB ]
1028 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
1029 associated with this package definition (see L<FS::pkg_svc>). Returns
1030 false if there not a primary service definition or exactly one service
1031 definition with quantity 1, or if SVCDB is specified and does not match the
1032 svcdb of the service definition. SVCDB can be specified as a scalar table
1033 name, such as 'svc_acct', or as an arrayref of possible table names.
1038 my $pkg_svc = shift->_primary_pkg_svc(@_);
1039 $pkg_svc ? $pkg_svc->svcpart : '';
1042 =item part_svc [ SVCDB ]
1044 Like the B<svcpart> method, but returns the FS::part_svc object (see
1050 my $pkg_svc = shift->_primary_pkg_svc(@_);
1051 $pkg_svc ? $pkg_svc->part_svc : '';
1054 sub _primary_pkg_svc {
1057 my $svcdb = scalar(@_) ? shift : [];
1058 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1059 my %svcdb = map { $_=>1 } @$svcdb;
1062 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1065 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1066 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1068 return '' if scalar(@pkg_svc) != 1;
1072 =item svcpart_unique_svcdb SVCDB
1074 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1075 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1076 false if there not a primary service definition for SVCDB or there are multiple
1077 service definitions for SVCDB.
1081 sub svcpart_unique_svcdb {
1082 my( $self, $svcdb ) = @_;
1083 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1084 return '' if scalar(@svcdb_pkg_svc) != 1;
1085 $svcdb_pkg_svc[0]->svcpart;
1090 Returns a list of the acceptable payment types for this package. Eventually
1091 this should come out of a database table and be editable, but currently has the
1092 following logic instead:
1094 If the package is free, the single item B<BILL> is
1095 returned, otherwise, the single item B<CARD> is returned.
1097 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1103 if ( $self->is_free ) {
1112 Returns true if this package is free.
1118 if ( $self->can('is_free_options') ) {
1119 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1120 map { $self->option($_) }
1121 $self->is_free_options;
1123 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1124 "provides neither is_free_options nor is_free method; returning false";
1129 # whether the plan allows discounts to be applied to this package
1130 sub can_discount { 0; }
1132 # whether the plan allows changing the start date
1133 sub can_start_date { 1; }
1135 # whether the plan supports part_pkg_usageprice add-ons (a specific kind of
1136 # pre-selectable usage pricing, there's others this doesn't refer to)
1137 sub can_usageprice { 0; }
1139 # the delay start date if present
1140 sub delay_start_date {
1143 my $delay = $self->delay_start or return '';
1145 # avoid timelocal silliness
1146 my $dt = DateTime->today(time_zone => 'local');
1147 $dt->add(days => $delay);
1151 sub can_currency_exchange { 0; }
1154 # moved to FS::Misc to make this accessible to other packages
1156 FS::Misc::pkg_freqs();
1161 Returns an english representation of the I<freq> field, such as "monthly",
1162 "weekly", "semi-annually", etc.
1168 my $freq = $self->freq;
1170 #my $freqs_href = $self->freqs_href;
1171 my $freqs_href = freqs_href();
1173 if ( exists($freqs_href->{$freq}) ) {
1174 $freqs_href->{$freq};
1176 my $interval = 'month';
1177 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1178 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1179 $interval = $interval{$2};
1184 "every $freq ${interval}s";
1189 =item add_freq TIMESTAMP [ FREQ ]
1191 Adds a billing period of some frequency to the provided timestamp and
1192 returns the resulting timestamp, or -1 if the frequency could not be
1193 parsed (shouldn't happen). By default, the frequency of this package
1194 will be used; to override this, pass a different frequency as a second
1200 my( $self, $date, $freq ) = @_;
1201 $freq = $self->freq unless $freq;
1203 #change this bit to use Date::Manip? CAREFUL with timezones (see
1204 # mailing list archive)
1205 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1207 if ( $freq =~ /^\d+$/ ) {
1209 until ( $mon < 12 ) { $mon -= 12; $year++; }
1211 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1213 } elsif ( $freq =~ /^(\d+)w$/ ) {
1215 $mday += $weeks * 7;
1216 } elsif ( $freq =~ /^(\d+)d$/ ) {
1219 } elsif ( $freq =~ /^(\d+)h$/ ) {
1226 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1231 For backwards compatibility, returns the plandata field as well as all options
1232 from FS::part_pkg_option.
1238 carp "plandata is deprecated";
1240 $self->SUPER::plandata(@_);
1242 my $plandata = $self->get('plandata');
1243 my %options = $self->options;
1244 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1249 =item part_pkg_vendor
1251 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1252 L<FS::part_pkg_vendor>).
1254 =item vendor_pkg_ids
1256 Returns a list of vendor/external package ids by exportnum
1260 sub vendor_pkg_ids {
1262 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1265 =item part_pkg_option
1267 Returns all options as FS::part_pkg_option objects (see
1268 L<FS::part_pkg_option>).
1272 Returns a list of option names and values suitable for assigning to a hash.
1278 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1281 =item option OPTIONNAME [ QUIET ]
1283 Returns the option value for the given name, or the empty string. If a true
1284 value is passed as the second argument, warnings about missing the option
1290 my( $self, $opt, $ornull ) = @_;
1291 cluck "$self -> option: searching for $opt"
1293 my $part_pkg_option =
1294 qsearchs('part_pkg_option', {
1295 pkgpart => $self->pkgpart,
1298 return $part_pkg_option->optionvalue if $part_pkg_option;
1299 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1300 split("\n", $self->get('plandata') );
1301 return $plandata{$opt} if exists $plandata{$opt};
1302 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1303 "not found in options or plandata!\n"
1308 =item part_pkg_currency [ CURRENCY ]
1310 Returns all currency options as FS::part_pkg_currency objects (see
1311 L<FS::part_pkg_currency>), or, if a currency is specified, only return the
1312 objects for that currency.
1316 sub part_pkg_currency {
1318 my %hash = ( 'pkgpart' => $self->pkgpart );
1319 $hash{'currency'} = shift if @_;
1320 qsearch('part_pkg_currency', \%hash );
1323 =item part_pkg_currency_options CURRENCY
1325 Returns a list of option names and values from FS::part_pkg_currency for the
1330 sub part_pkg_currency_options {
1332 map { $_->optionname => $_->optionvalue } $self->part_pkg_currency(shift);
1335 =item part_pkg_currency_option CURRENCY OPTIONNAME
1337 Returns the option value for the given name and currency.
1341 sub part_pkg_currency_option {
1342 my( $self, $currency, $optionname ) = @_;
1343 my $part_pkg_currency =
1344 qsearchs('part_pkg_currency', { 'pkgpart' => $self->pkgpart,
1345 'currency' => $currency,
1346 'optionname' => $optionname,
1349 #fatal if not found? that works for our use cases from
1350 #part_pkg/currency_fixed, but isn't how we would typically/expect the method
1351 #to behave. have to catch it there if we change it here...
1352 or die "Unknown price for ". $self->pkg_comment. " in $currency\n";
1354 $part_pkg_currency->optionvalue;
1357 =item fcc_option OPTIONNAME
1359 Returns the FCC 477 report option value for the given name, or the empty
1365 my ($self, $name) = @_;
1366 my $part_pkg_fcc_option =
1367 qsearchs('part_pkg_fcc_option', {
1368 pkgpart => $self->pkgpart,
1369 fccoptionname => $name,
1371 $part_pkg_fcc_option ? $part_pkg_fcc_option->optionvalue : '';
1376 Returns all FCC 477 report options for this package, as a hash-like list.
1382 map { $_->fccoptionname => $_->optionvalue }
1383 qsearch('part_pkg_fcc_option', { pkgpart => $self->pkgpart });
1386 =item bill_part_pkg_link
1388 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1392 sub bill_part_pkg_link {
1393 shift->_part_pkg_link('bill', @_);
1396 =item svc_part_pkg_link
1398 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1402 sub svc_part_pkg_link {
1403 shift->_part_pkg_link('svc', @_);
1406 =item supp_part_pkg_link
1408 Returns the associated part_pkg_link records of type 'supp' (supplemental
1413 sub supp_part_pkg_link {
1414 shift->_part_pkg_link('supp', @_);
1417 sub _part_pkg_link {
1418 my( $self, $type ) = @_;
1419 qsearch({ table => 'part_pkg_link',
1420 hashref => { 'src_pkgpart' => $self->pkgpart,
1421 'link_type' => $type,
1422 #protection against infinite recursive links
1423 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1425 order_by => "ORDER BY hidden",
1429 sub self_and_bill_linked {
1430 shift->_self_and_linked('bill', @_);
1433 sub self_and_svc_linked {
1434 shift->_self_and_linked('svc', @_);
1437 sub _self_and_linked {
1438 my( $self, $type, $hidden ) = @_;
1442 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1443 $self->_part_pkg_link($type) ) )
1445 $_->hidden($hidden) if $hidden;
1452 =item part_pkg_taxoverride [ CLASS ]
1454 Returns all associated FS::part_pkg_taxoverride objects (see
1455 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1456 of class CLASS if defined. Class may be one of 'setup', 'recur',
1457 the empty string (default), or a usage class number (see L<FS::usage_class>).
1458 When a class is specified, the empty string class (default) is returned
1459 if no more specific values exist.
1463 sub part_pkg_taxoverride {
1467 my $hashref = { 'pkgpart' => $self->pkgpart };
1468 $hashref->{'usage_class'} = $class if defined($class);
1469 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1471 unless ( scalar(@overrides) || !defined($class) || !$class ){
1472 $hashref->{'usage_class'} = '';
1473 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1479 =item has_taxproduct
1481 Returns true if this package has any taxproduct associated with it.
1485 sub has_taxproduct {
1488 $self->taxproductnum ||
1489 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1490 keys %{ {$self->options} }
1496 =item taxproduct [ CLASS ]
1498 Returns the associated tax product for this package definition (see
1499 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1500 the usage classnum (see L<FS::usage_class>). Returns the default
1501 tax product for this record if the more specific CLASS value does
1510 my $part_pkg_taxproduct;
1512 my $taxproductnum = $self->taxproductnum;
1514 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1515 $taxproductnum = $class_taxproductnum
1516 if $class_taxproductnum
1519 $part_pkg_taxproduct =
1520 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1522 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1523 $taxproductnum = $self->taxproductnum;
1524 $part_pkg_taxproduct =
1525 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1528 $part_pkg_taxproduct;
1531 =item taxproduct_description [ CLASS ]
1533 Returns the description of the associated tax product for this package
1534 definition (see L<FS::part_pkg_taxproduct>).
1538 sub taxproduct_description {
1540 my $part_pkg_taxproduct = $self->taxproduct(@_);
1541 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1545 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1547 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1548 package in the location specified by GEOCODE, for usage class CLASS (one of
1549 'setup', 'recur', null, or a C<usage_class> number).
1555 my ($vendor, $geocode, $class) = @_;
1556 my @taxclassnums = map { $_->taxclassnum }
1557 $self->part_pkg_taxoverride($class);
1558 if (!@taxclassnums) {
1559 my $part_pkg_taxproduct = $self->taxproduct($class);
1560 # If this isn't defined, then the class has no taxproduct designation,
1561 # so return no tax rates.
1562 return () if !$part_pkg_taxproduct;
1564 # convert the taxproduct to the tax classes that might apply to it in
1566 @taxclassnums = map { $_->taxclassnum }
1567 grep { $_->taxable eq 'Y' } # why do we need this?
1568 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1570 return unless @taxclassnums;
1572 # then look up the actual tax_rate entries
1573 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1575 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1576 my @taxes = qsearch({ 'table' => 'tax_rate',
1577 'hashref' => { 'geocode' => $geocode,
1578 'data_vendor' => $vendor },
1579 'extra_sql' => $extra_sql,
1581 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1587 =item part_pkg_discount
1589 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1592 =item part_pkg_usage
1594 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1599 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1600 PLAN is the object's I<plan> field. There should be better docs
1601 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1607 my $plan = $self->plan;
1609 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1613 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1614 my $class = ref($self). "::$plan";
1615 warn "reblessing $self into $class" if $DEBUG > 1;
1618 bless($self, $class) unless $@;
1623 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1624 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1626 #fallback that return 0 for old legacy packages with no plan
1627 sub calc_remain { 0; }
1628 sub calc_units { 0; }
1630 #fallback for everything not based on flat.pm
1631 sub recur_temporality { 'upcoming'; }
1632 sub calc_cancel { 0; }
1634 #fallback for everything except bulk.pm
1635 sub hide_svc_detail { 0; }
1637 #fallback for packages that can't/won't summarize usage
1638 sub sum_usage { 0; }
1640 =item recur_cost_permonth CUST_PKG
1642 recur_cost divided by freq (only supported for monthly and longer frequencies)
1646 sub recur_cost_permonth {
1647 my($self, $cust_pkg) = @_;
1648 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1649 sprintf('%.2f', $self->recur_cost / $self->freq );
1652 =item cust_bill_pkg_recur CUST_PKG
1654 Actual recurring charge for the specified customer package from customer's most
1659 sub cust_bill_pkg_recur {
1660 my($self, $cust_pkg) = @_;
1661 my $cust_bill_pkg = qsearchs({
1662 'table' => 'cust_bill_pkg',
1663 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1664 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1665 'recur' => { op=>'>', value=>'0' },
1667 'order_by' => 'ORDER BY cust_bill._date DESC,
1668 cust_bill_pkg.sdate DESC
1671 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1672 $cust_bill_pkg->recur;
1675 =item unit_setup CUST_PKG
1677 Returns the setup fee for one unit of the package.
1682 my ($self, $cust_pkg) = @_;
1683 $self->option('setup_fee') || 0;
1688 unit_setup minus setup_cost
1694 $self->unit_setup(@_) - $self->setup_cost;
1697 =item recur_margin_permonth
1699 base_recur_permonth minus recur_cost_permonth
1703 sub recur_margin_permonth {
1705 $self->base_recur_permonth(@_) - $self->recur_cost_permonth(@_);
1708 =item format OPTION DATA
1710 Returns data formatted according to the function 'format' described
1711 in the plan info. Returns DATA if no such function exists.
1716 my ($self, $option, $data) = (shift, shift, shift);
1717 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1718 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1724 =item parse OPTION DATA
1726 Returns data parsed according to the function 'parse' described
1727 in the plan info. Returns DATA if no such function exists.
1732 my ($self, $option, $data) = (shift, shift, shift);
1733 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1734 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1744 =head1 CLASS METHODS
1752 # Used by FS::Upgrade to migrate to a new database.
1754 sub _upgrade_data { # class method
1755 my($class, %opts) = @_;
1757 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1759 my @part_pkg = qsearch({
1760 'table' => 'part_pkg',
1761 'extra_sql' => "WHERE ". join(' OR ',
1762 'plan IS NULL', "plan = '' ",
1766 foreach my $part_pkg (@part_pkg) {
1768 unless ( $part_pkg->plan ) {
1769 $part_pkg->plan('flat');
1775 # the rest can be done asynchronously
1778 sub queueable_upgrade {
1779 # now upgrade to the explicit custom flag
1781 my $search = FS::Cursor->new({
1782 'table' => 'part_pkg',
1783 'hashref' => { disabled => 'Y', custom => '' },
1784 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1788 while (my $part_pkg = $search->fetch) {
1789 my $new = new FS::part_pkg { $part_pkg->hash };
1791 my $comment = $part_pkg->comment;
1792 $comment =~ s/^\(CUSTOM\) //;
1793 $comment = '(none)' unless $comment =~ /\S/;
1794 $new->comment($comment);
1796 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1797 my $primary = $part_pkg->svcpart;
1798 my $options = { $part_pkg->options };
1800 my $error = $new->replace( $part_pkg,
1801 'pkg_svc' => $pkg_svc,
1802 'primary_svc' => $primary,
1803 'options' => $options,
1806 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
1813 # set family_pkgpart on any packages that don't have it
1814 $search = FS::Cursor->new('part_pkg', { 'family_pkgpart' => '' });
1815 while (my $part_pkg = $search->fetch) {
1816 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1817 my $error = $part_pkg->SUPER::replace;
1819 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
1826 my @part_pkg_option = qsearch('part_pkg_option',
1827 { 'optionname' => 'unused_credit',
1830 foreach my $old_opt (@part_pkg_option) {
1831 my $pkgpart = $old_opt->pkgpart;
1832 my $error = $old_opt->delete;
1833 die $error if $error;
1835 foreach (qw(unused_credit_cancel unused_credit_change)) {
1836 my $new_opt = new FS::part_pkg_option {
1837 'pkgpart' => $pkgpart,
1841 $error = $new_opt->insert;
1842 die $error if $error;
1846 # migrate use_disposition_taqua and use_disposition to disposition_in
1847 @part_pkg_option = qsearch('part_pkg_option',
1848 { 'optionname' => { op => 'LIKE',
1849 value => 'use_disposition%',
1853 my %newopts = map { $_->pkgpart => $_ }
1854 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1855 foreach my $old_opt (@part_pkg_option) {
1856 my $pkgpart = $old_opt->pkgpart;
1857 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1859 my $error = $old_opt->delete;
1860 die $error if $error;
1862 if ( exists($newopts{$pkgpart}) ) {
1863 my $opt = $newopts{$pkgpart};
1864 $opt->optionvalue($opt->optionvalue.",$newval");
1865 $error = $opt->replace;
1866 die $error if $error;
1868 my $new_opt = new FS::part_pkg_option {
1869 'pkgpart' => $pkgpart,
1870 'optionname' => 'disposition_in',
1871 'optionvalue' => $newval,
1873 $error = $new_opt->insert;
1874 die $error if $error;
1875 $newopts{$pkgpart} = $new_opt;
1879 # set any package with FCC voice lines to the "VoIP with broadband" category
1880 # for backward compatibility
1882 # recover from a bad upgrade bug
1883 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1884 if (!FS::upgrade_journal->is_done($upgrade)) {
1885 my $bad_upgrade = qsearchs('upgrade_journal',
1886 { upgrade => 'part_pkg_fcc_voip_class' }
1888 if ( $bad_upgrade ) {
1889 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1890 ' AND history_date > '.($bad_upgrade->_date - 3600);
1891 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1894 'table' => 'h_part_pkg_option',
1896 'extra_sql' => "$where AND history_action = 'delete'",
1897 'order_by' => 'ORDER BY history_date ASC',
1899 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1902 'table' => 'h_pkg_svc',
1904 'extra_sql' => "$where AND history_action = 'replace_old'",
1905 'order_by' => 'ORDER BY history_date ASC',
1908 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1909 my $pkgpart ||= $deleted->pkgpart;
1910 $opt{$pkgpart} ||= {
1916 if ( $deleted->isa('FS::part_pkg_option') ) {
1917 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1919 my $svcpart = $deleted->svcpart;
1920 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1921 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1922 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1925 foreach my $pkgpart (keys %opt) {
1926 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1927 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1929 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1932 } # $bad_upgrade exists
1933 else { # do the original upgrade, but correctly this time
1934 my @part_pkg = qsearch('part_pkg', {
1935 fcc_ds0s => { op => '>', value => 0 },
1936 fcc_voip_class => ''
1938 foreach my $part_pkg (@part_pkg) {
1939 $part_pkg->set(fcc_voip_class => 2);
1940 my @pkg_svc = $part_pkg->pkg_svc;
1941 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1942 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1943 my $error = $part_pkg->replace(
1944 $part_pkg->replace_old,
1945 options => { $part_pkg->options },
1946 pkg_svc => \%quantity,
1947 hidden_svc => \%hidden,
1948 primary_svc => ($part_pkg->svcpart || ''),
1950 die $error if $error;
1953 FS::upgrade_journal->set_done($upgrade);
1958 =item curuser_pkgs_sql
1960 Returns an SQL fragment for searching for packages the current user can
1961 use, either via part_pkg.agentnum directly, or via agent type (see
1966 sub curuser_pkgs_sql {
1969 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1973 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1975 Returns an SQL fragment for searching for packages the provided agent or agents
1976 can use, either via part_pkg.agentnum directly, or via agent type (see
1981 sub agent_pkgs_sql {
1982 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1983 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1985 $class->_pkgs_sql(@agentnums); #is this why
1990 my( $class, @agentnums ) = @_;
1991 my $agentnums = join(',', @agentnums);
1995 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1996 OR ( agentnum IS NULL
1997 AND EXISTS ( SELECT 1
1999 LEFT JOIN agent_type USING ( typenum )
2000 LEFT JOIN agent AS typeagent USING ( typenum )
2001 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
2002 AND typeagent.agentnum IN ($agentnums)
2020 #false laziness w/part_export & cdr
2022 foreach my $INC ( @INC ) {
2023 warn "globbing $INC/FS/part_pkg/[a-z]*.pm\n" if $DEBUG;
2024 foreach my $file ( glob("$INC/FS/part_pkg/[a-z]*.pm") ) {
2025 warn "attempting to load plan info from $file\n" if $DEBUG;
2026 $file =~ /\/(\w+)\.pm$/ or do {
2027 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
2031 my $info = eval "use FS::part_pkg::$mod; ".
2032 "\\%FS::part_pkg::$mod\::info;";
2034 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
2037 unless ( keys %$info ) {
2038 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
2041 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
2042 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
2043 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
2046 $info{$mod} = $info;
2047 $info->{'weight'} ||= 0; # quiet warnings
2051 # copy one level deep to allow replacement of fields and fieldorder
2052 tie %plans, 'Tie::IxHash',
2053 map { my %infohash = %{ $info{$_} };
2055 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
2058 # inheritance of plan options
2059 foreach my $name (keys(%info)) {
2060 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
2061 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
2062 delete $plans{$name};
2065 my $parents = $info{$name}->{'inherit_fields'} || [];
2066 my (%fields, %field_exists, @fieldorder);
2067 foreach my $parent ($name, @$parents) {
2068 if ( !exists($info{$parent}) ) {
2069 warn "$name tried to inherit from nonexistent '$parent'\n";
2072 %fields = ( # avoid replacing existing fields
2073 %{ $info{$parent}->{'fields'} || {} },
2076 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
2078 next if $field_exists{$_};
2079 $field_exists{$_} = 1;
2080 # allow inheritors to remove inherited fields from the fieldorder
2081 push @fieldorder, $_ if !exists($fields{$_}) or
2082 !exists($fields{$_}->{'disabled'});
2085 $plans{$name}->{'fields'} = \%fields;
2086 $plans{$name}->{'fieldorder'} = \@fieldorder;
2096 =head1 NEW PLAN CLASSES
2098 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
2099 found in eg/plan_template.pm. Until then, it is suggested that you use the
2100 other modules in FS/FS/part_pkg/ as a guide.
2104 The delete method is unimplemented.
2106 setup and recur semantics are not yet defined (and are implemented in
2107 FS::cust_bill. hmm.). now they're deprecated and need to go.
2111 part_pkg_taxrate is Pg specific
2113 replace should be smarter about managing the related tables (options, pkg_svc)
2117 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2118 schema.html from the base documentation.