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 $cache_enabled %cache_link %cache_pkg_svc
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_usage;
32 use FS::part_pkg_vendor;
37 $skip_pkg_svc_hack = 0;
45 FS::part_pkg - Object methods for part_pkg objects
51 $record = new FS::part_pkg \%hash
52 $record = new FS::part_pkg { 'column' => 'value' };
54 $custom_record = $template_record->clone;
56 $error = $record->insert;
58 $error = $new_record->replace($old_record);
60 $error = $record->delete;
62 $error = $record->check;
64 @pkg_svc = $record->pkg_svc;
66 $svcnum = $record->svcpart;
67 $svcnum = $record->svcpart( 'svc_acct' );
71 An FS::part_pkg object represents a package definition. FS::part_pkg
72 inherits from FS::Record. The following fields are currently supported:
76 =item pkgpart - primary key (assigned automatically for new package definitions)
78 =item pkg - Text name of this package definition (customer-viewable)
80 =item comment - Text name of this package definition (non-customer-viewable)
82 =item classnum - Optional package class (see L<FS::pkg_class>)
84 =item promo_code - Promotional code
86 =item setup - Setup fee expression (deprecated)
88 =item freq - Frequency of recurring fee
90 =item recur - Recurring fee expression (deprecated)
92 =item setuptax - Setup fee tax exempt flag, empty or `Y'
94 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
96 =item taxclass - Tax class
98 =item plan - Price plan
100 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
102 =item disabled - Disabled flag, empty or `Y'
104 =item custom - Custom flag, empty or `Y'
106 =item setup_cost - for cost tracking
108 =item recur_cost - for cost tracking
110 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
112 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
114 =item agentnum - Optional agentnum (see L<FS::agent>)
116 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
118 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
121 =item successor - Foreign key for the part_pkg that replaced this record.
122 If this record is not obsolete, will be null.
124 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
125 ancestor of this record. If this record is not a successor to another
126 part_pkg, will be equal to pkgpart.
128 =item delay_start - Number of days to delay package start, by default
130 =item start_on_hold - 'Y' to suspend this package immediately when it is
131 ordered. The package will not start billing or have a setup fee charged
132 until it is manually unsuspended.
142 Creates a new package definition. To add the package definition to
143 the database, see L<"insert">.
147 sub table { 'part_pkg'; }
151 An alternate constructor. Creates a new package definition by duplicating
152 an existing definition. A new pkgpart is assigned and the custom flag is
153 set to Y. To add the package definition to the database, see L<"insert">.
159 my $class = ref($self);
160 my %hash = $self->hash;
161 $hash{'pkgpart'} = '';
162 $hash{'custom'} = 'Y';
163 #new FS::part_pkg ( \%hash ); # ?
164 new $class ( \%hash ); # ?
167 =item insert [ , OPTION => VALUE ... ]
169 Adds this package definition to the database. If there is an error,
170 returns the error, otherwise returns false.
172 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
173 I<custnum_ref> and I<options>.
175 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
176 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
177 be set to a hashref of svcparts and flag values ('Y' or '') to set the
178 'hidden' field in these records, and I<provision_hold> can be set similarly
179 for the 'provision_hold' field in these records.
181 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
182 FS::pkg_svc record will be updated.
184 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
185 record itself), the object will be updated to point to this package definition.
187 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
188 the scalar will be updated with the custnum value from the cust_pkg record.
190 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
191 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
192 records will be inserted.
194 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
195 records will be inserted.
202 warn "FS::part_pkg::insert called on $self with options ".
203 join(', ', map "$_=>$options{$_}", keys %options)
206 local $SIG{HUP} = 'IGNORE';
207 local $SIG{INT} = 'IGNORE';
208 local $SIG{QUIT} = 'IGNORE';
209 local $SIG{TERM} = 'IGNORE';
210 local $SIG{TSTP} = 'IGNORE';
211 local $SIG{PIPE} = 'IGNORE';
213 my $oldAutoCommit = $FS::UID::AutoCommit;
214 local $FS::UID::AutoCommit = 0;
217 warn " inserting part_pkg record" if $DEBUG;
218 my $error = $self->SUPER::insert( $options{options} );
220 $dbh->rollback if $oldAutoCommit;
225 if ( $self->get('family_pkgpart') eq '' ) {
226 $self->set('family_pkgpart' => $self->pkgpart);
227 $error = $self->SUPER::replace;
229 $dbh->rollback if $oldAutoCommit;
234 warn " inserting part_pkg_taxoverride records" if $DEBUG;
235 my %overrides = %{ $options{'tax_overrides'} || {} };
236 foreach my $usage_class ( keys %overrides ) {
238 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
239 ? $overrides{$usage_class}
241 my @overrides = (grep "$_", split(',', $override) );
242 my $error = $self->process_m2m (
243 'link_table' => 'part_pkg_taxoverride',
244 'target_table' => 'tax_class',
245 'hashref' => { 'usage_class' => $usage_class },
246 'params' => \@overrides,
249 $dbh->rollback if $oldAutoCommit;
254 unless ( $skip_pkg_svc_hack ) {
256 warn " inserting pkg_svc records" if $DEBUG;
257 my $pkg_svc = $options{'pkg_svc'} || {};
258 my $hidden_svc = $options{'hidden_svc'} || {};
259 my $provision_hold = $options{'provision_hold'} || {};
260 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
261 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
263 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
267 my $pkg_svc = new FS::pkg_svc( {
268 'pkgpart' => $self->pkgpart,
269 'svcpart' => $part_svc->svcpart,
270 'quantity' => $quantity,
271 'primary_svc' => $primary_svc,
272 'hidden' => $hidden_svc->{$part_svc->svcpart},
273 'provision_hold' => $provision_hold->{$part_svc->svcpart},
275 my $error = $pkg_svc->insert;
277 $dbh->rollback if $oldAutoCommit;
284 if ( $options{'cust_pkg'} ) {
285 warn " updating cust_pkg record " if $DEBUG;
287 ref($options{'cust_pkg'})
288 ? $options{'cust_pkg'}
289 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
290 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
291 if $options{'custnum_ref'};
292 my %hash = $old_cust_pkg->hash;
293 $hash{'pkgpart'} = $self->pkgpart,
294 my $new_cust_pkg = new FS::cust_pkg \%hash;
295 local($FS::cust_pkg::disable_agentcheck) = 1;
296 my $error = $new_cust_pkg->replace($old_cust_pkg);
298 $dbh->rollback if $oldAutoCommit;
299 return "Error modifying cust_pkg record: $error";
303 if ( $options{'part_pkg_vendor'} ) {
304 while ( my ($exportnum, $vendor_pkg_id) =
305 each %{ $options{part_pkg_vendor} }
308 my $ppv = new FS::part_pkg_vendor( {
309 'pkgpart' => $self->pkgpart,
310 'exportnum' => $exportnum,
311 'vendor_pkg_id' => $vendor_pkg_id,
313 my $error = $ppv->insert;
315 $dbh->rollback if $oldAutoCommit;
316 return "Error inserting part_pkg_vendor record: $error";
321 if ( $options{fcc_options} ) {
322 warn " updating fcc options " if $DEBUG;
323 $self->set_fcc_options( $options{fcc_options} );
326 warn " committing transaction" if $DEBUG and $oldAutoCommit;
327 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
334 Currently unimplemented.
339 return "Can't (yet?) delete package definitions.";
340 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
343 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
345 Replaces OLD_RECORD with this one in the database. If there is an error,
346 returns the error, otherwise returns false.
348 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>,
349 I<provision_hold> and I<options>
351 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
352 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
353 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
354 'hidden' field in these records. I<provision_hold> can be set
355 to a hashref of svcparts and flag values ('Y' or '') to set the field
358 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
359 FS::pkg_svc record will be updated.
361 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
369 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
374 ( ref($_[0]) eq 'HASH' )
378 $options->{options} = { $old->options } unless defined($options->{options});
380 warn "FS::part_pkg::replace called on $new to replace $old with options".
381 join(', ', map "$_ => ". $options->{$_}, keys %$options)
384 local $SIG{HUP} = 'IGNORE';
385 local $SIG{INT} = 'IGNORE';
386 local $SIG{QUIT} = 'IGNORE';
387 local $SIG{TERM} = 'IGNORE';
388 local $SIG{TSTP} = 'IGNORE';
389 local $SIG{PIPE} = 'IGNORE';
391 my $oldAutoCommit = $FS::UID::AutoCommit;
392 local $FS::UID::AutoCommit = 0;
395 my $conf = new FS::Conf;
396 if ( $conf->exists('part_pkg-lineage') ) {
397 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
398 qw(setup_fee recur_fee) #others? config?
401 warn " superseding package" if $DEBUG;
403 my $error = $new->supersede($old, %$options);
405 $dbh->rollback if $oldAutoCommit;
409 warn " committing transaction" if $DEBUG and $oldAutoCommit;
410 $dbh->commit if $oldAutoCommit;
417 #plandata shit stays in replace for upgrades until after 2.0 (or edit
419 warn " saving legacy plandata" if $DEBUG;
420 my $plandata = $new->get('plandata');
421 $new->set('plandata', '');
423 warn " deleting old part_pkg_option records" if $DEBUG;
424 foreach my $part_pkg_option ( $old->part_pkg_option ) {
425 my $error = $part_pkg_option->delete;
427 $dbh->rollback if $oldAutoCommit;
432 warn " replacing part_pkg record" if $DEBUG;
433 my $error = $new->SUPER::replace($old, $options->{options} );
435 $dbh->rollback if $oldAutoCommit;
439 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
440 foreach my $part_pkg_option (
441 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
442 return "illegal plandata: $plandata";
444 new FS::part_pkg_option {
445 'pkgpart' => $new->pkgpart,
450 split("\n", $plandata)
452 my $error = $part_pkg_option->insert;
454 $dbh->rollback if $oldAutoCommit;
459 warn " replacing pkg_svc records" if $DEBUG;
460 my $pkg_svc = $options->{'pkg_svc'};
461 my $hidden_svc = $options->{'hidden_svc'} || {};
462 my $provision_hold = $options->{'provision_hold'} || {};
463 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
464 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
465 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
466 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
467 my $provision_hold = $provision_hold->{$part_svc->svcpart} || '';
469 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
470 && $options->{'primary_svc'} == $part_svc->svcpart
475 my $old_pkg_svc = qsearchs('pkg_svc', {
476 'pkgpart' => $old->pkgpart,
477 'svcpart' => $part_svc->svcpart,
480 my $old_quantity = 0;
481 my $old_primary_svc = '';
483 my $old_provision_hold = '';
484 if ( $old_pkg_svc ) {
485 $old_quantity = $old_pkg_svc->quantity;
486 $old_primary_svc = $old_pkg_svc->primary_svc
487 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
488 $old_hidden = $old_pkg_svc->hidden;
489 $old_provision_hold = $old_pkg_svc->provision_hold;
492 next unless $old_quantity != $quantity ||
493 $old_primary_svc ne $primary_svc ||
494 $old_hidden ne $hidden ||
495 $old_provision_hold ne $provision_hold;
497 my $new_pkg_svc = new FS::pkg_svc( {
498 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
499 'pkgpart' => $new->pkgpart,
500 'svcpart' => $part_svc->svcpart,
501 'quantity' => $quantity,
502 'primary_svc' => $primary_svc,
504 'provision_hold' => $provision_hold,
506 my $error = $old_pkg_svc
507 ? $new_pkg_svc->replace($old_pkg_svc)
508 : $new_pkg_svc->insert;
510 $dbh->rollback if $oldAutoCommit;
514 } #if $options->{pkg_svc}
516 my @part_pkg_vendor = $old->part_pkg_vendor;
517 my @current_exportnum = ();
518 if ( $options->{'part_pkg_vendor'} ) {
519 my($exportnum,$vendor_pkg_id);
520 while ( ($exportnum,$vendor_pkg_id)
521 = each %{$options->{'part_pkg_vendor'}} ) {
523 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
524 if($exportnum == $part_pkg_vendor->exportnum
525 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
526 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
527 my $error = $part_pkg_vendor->replace;
529 $dbh->rollback if $oldAutoCommit;
530 return "Error replacing part_pkg_vendor record: $error";
535 elsif($exportnum == $part_pkg_vendor->exportnum
536 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
541 unless ( $noinsert ) {
542 my $ppv = new FS::part_pkg_vendor( {
543 'pkgpart' => $new->pkgpart,
544 'exportnum' => $exportnum,
545 'vendor_pkg_id' => $vendor_pkg_id,
547 my $error = $ppv->insert;
549 $dbh->rollback if $oldAutoCommit;
550 return "Error inserting part_pkg_vendor record: $error";
553 push @current_exportnum, $exportnum;
556 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
557 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
558 my $error = $part_pkg_vendor->delete;
560 $dbh->rollback if $oldAutoCommit;
561 return "Error deleting part_pkg_vendor record: $error";
566 # propagate changes to certain core fields
567 if ( $conf->exists('part_pkg-lineage') ) {
568 warn " propagating changes to family" if $DEBUG;
569 my $error = $new->propagate($old);
571 $dbh->rollback if $oldAutoCommit;
576 if ( $options->{fcc_options} ) {
577 warn " updating fcc options " if $DEBUG;
578 $new->set_fcc_options( $options->{fcc_options} );
581 warn " committing transaction" if $DEBUG and $oldAutoCommit;
582 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
588 Checks all fields to make sure this is a valid package definition. If
589 there is an error, returns the error, otherwise returns false. Called by the
590 insert and replace methods.
596 warn "FS::part_pkg::check called on $self" if $DEBUG;
598 for (qw(setup recur plandata)) {
599 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
600 return "Use of $_ field is deprecated; set a plan and options: ".
602 if length($self->get($_));
606 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
607 my $error = $self->ut_number('freq');
608 return $error if $error;
610 $self->freq =~ /^(\d+[hdw]?)$/
611 or return "Illegal or empty freq: ". $self->freq;
615 my @null_agentnum_right = ( 'Edit global package definitions' );
616 push @null_agentnum_right, 'One-time charge'
617 if $self->freq =~ /^0/;
618 push @null_agentnum_right, 'Customize customer package'
619 if $self->disabled eq 'Y'; #good enough
621 my $error = $self->ut_numbern('pkgpart')
622 || $self->ut_text('pkg')
623 || $self->ut_textn('comment')
624 || $self->ut_textn('promo_code')
625 || $self->ut_alphan('plan')
626 || $self->ut_flag('setuptax')
627 || $self->ut_flag('recurtax')
628 || $self->ut_textn('taxclass')
629 || $self->ut_flag('disabled')
630 || $self->ut_flag('custom')
631 || $self->ut_flag('no_auto')
632 || $self->ut_flag('recur_show_zero')
633 || $self->ut_flag('setup_show_zero')
634 || $self->ut_flag('start_on_hold')
635 #|| $self->ut_moneyn('setup_cost')
636 #|| $self->ut_moneyn('recur_cost')
637 || $self->ut_floatn('setup_cost')
638 || $self->ut_floatn('recur_cost')
639 || $self->ut_floatn('pay_weight')
640 || $self->ut_floatn('credit_weight')
641 || $self->ut_numbern('taxproductnum')
642 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
643 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
644 || $self->ut_foreign_keyn('taxproductnum',
645 'part_pkg_taxproduct',
649 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
650 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
652 || $self->ut_numbern('fcc_ds0s')
653 || $self->ut_numbern('fcc_voip_class')
654 || $self->ut_numbern('delay_start')
655 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
656 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
657 || $self->ut_alphan('agent_pkgpartid')
658 || $self->SUPER::check
660 return $error if $error;
662 return 'Unknown plan '. $self->plan
663 unless exists($plans{$self->plan});
665 my $conf = new FS::Conf;
666 return 'Taxclass is required'
667 if ! $self->taxclass && $conf->exists('require_taxclasses');
672 =item supersede OLD [, OPTION => VALUE ... ]
674 Inserts this package as a successor to the package OLD. All options are as
675 for C<insert>. After inserting, disables OLD and sets the new package as its
681 my ($new, $old, %options) = @_;
684 $new->set('pkgpart' => '');
685 $new->set('family_pkgpart' => $old->family_pkgpart);
686 warn " inserting successor package\n" if $DEBUG;
687 $error = $new->insert(%options);
688 return $error if $error;
690 warn " disabling superseded package\n" if $DEBUG;
691 $old->set('successor' => $new->pkgpart);
692 $old->set('disabled' => 'Y');
693 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
694 return $error if $error;
696 warn " propagating changes to family" if $DEBUG;
697 $new->propagate($old);
702 If any of certain fields have changed from OLD to this package, then,
703 for all packages in the same lineage as this one, sets those fields
704 to their values in this package.
708 my @propagate_fields = (
709 qw( pkg classnum setup_cost recur_cost taxclass
710 setuptax recurtax pay_weight credit_weight
718 map { $_ => $new->get($_) }
719 grep { $new->get($_) ne $old->get($_) }
723 my @part_pkg = qsearch('part_pkg', {
724 'family_pkgpart' => $new->family_pkgpart
727 foreach my $part_pkg ( @part_pkg ) {
728 my $pkgpart = $part_pkg->pkgpart;
729 next if $pkgpart == $new->pkgpart; # don't modify $new
730 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
731 foreach ( keys %fields ) {
732 $part_pkg->set($_, $fields{$_});
734 # SUPER::replace to avoid changing non-core fields
735 my $error = $part_pkg->SUPER::replace;
736 push @error, "pkgpart $pkgpart: $error"
742 =item set_fcc_options HASHREF
744 Sets the FCC options on this package definition to the values specified
749 sub set_fcc_options {
751 my $pkgpart = $self->pkgpart;
759 my %existing_num = map { $_->fccoptionname => $_->num }
760 qsearch('part_pkg_fcc_option', { pkgpart => $pkgpart });
762 local $FS::Record::nowarn_identical = 1;
763 # set up params for process_o2m
766 foreach my $name (keys %$options ) {
767 $params->{ "num$i" } = $existing_num{$name} || '';
768 $params->{ "num$i".'_fccoptionname' } = $name;
769 $params->{ "num$i".'_optionvalue' } = $options->{$name};
774 table => 'part_pkg_fcc_option',
775 fields => [qw( fccoptionname optionvalue )],
780 =item pkg_locale LOCALE
782 Returns a customer-viewable string representing this package for the given
783 locale, from the part_pkg_msgcat table. If the given locale is empty or no
784 localized string is found, returns the base pkg field.
789 my( $self, $locale ) = @_;
790 return $self->pkg unless $locale;
791 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
792 $part_pkg_msgcat->pkg;
795 =item part_pkg_msgcat LOCALE
797 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
801 sub part_pkg_msgcat {
802 my( $self, $locale ) = @_;
803 qsearchs( 'part_pkg_msgcat', {
804 pkgpart => $self->pkgpart,
809 =item pkg_comment [ OPTION => VALUE... ]
811 Returns an (internal) string representing this package. Currently,
812 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
813 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
816 If the option nopkgpart is true then the "pkgpart: ' is omitted.
824 #$self->pkg. ' - '. $self->comment;
825 #$self->pkg. ' ('. $self->comment. ')';
826 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
827 my $custom_comment = $self->custom_comment(%opt);
828 $pre. $self->pkg. ( $custom_comment ? " - $custom_comment" : '' );
831 #without price info (so without hitting the DB again)
832 sub pkg_comment_only {
836 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
837 my $comment = $self->comment;
838 $pre. $self->pkg. ( $comment ? " - $comment" : '' );
841 sub price_info { # safety, in case a part_pkg hasn't defined price_info
847 my $price_info = $self->price_info(@_);
848 ( $self->custom ? '(CUSTOM) ' : '' ).
850 ( ( ($self->custom || $self->comment) && $price_info ) ? ' - ' : '' ).
856 $self->pkg. ' - '. ($self->price_info || 'No charge');
861 Returns the package class, as an FS::pkg_class object, or the empty string
862 if there is no package class.
868 if ( $self->classnum ) {
869 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
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.
944 qsearchs('agent', { 'agentnum' => $self->agentnum } );
947 =item pkg_svc [ HASHREF | OPTION => VALUE ]
949 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
950 definition (with non-zero quantity).
952 One option is available, I<disable_linked>. If set true it will return the
953 services for this package definition alone, omitting services from any add-on
960 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
967 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
973 return @{ $cache_pkg_svc{$self->pkgpart} }
974 if $cache_enabled && $cache_pkg_svc{$self->pkgpart};
976 # #sort { $b->primary cmp $a->primary }
977 # grep { $_->quantity }
978 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
980 my $opt = ref($_[0]) ? $_[0] : { @_ };
981 my %pkg_svc = map { $_->svcpart => $_ } $self->_pkg_svc;
983 unless ( $opt->{disable_linked} ) {
984 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
985 my @pkg_svc = $dst_pkg->_pkg_svc;
986 foreach my $pkg_svc ( @pkg_svc ) {
987 if ( $pkg_svc{$pkg_svc->svcpart} ) {
988 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
989 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
991 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
997 my @pkg_svc = values(%pkg_svc);
999 $cache_pkg_svc{$self->pkgpart} = \@pkg_svc if $cache_enabled;
1007 grep { $_->quantity }
1009 'select' => 'pkg_svc.*, part_svc.*',
1010 'table' => 'pkg_svc',
1011 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
1012 'hashref' => { 'pkgpart' => $self->pkgpart },
1016 =item svcpart [ SVCDB ]
1018 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
1019 associated with this package definition (see L<FS::pkg_svc>). Returns
1020 false if there not a primary service definition or exactly one service
1021 definition with quantity 1, or if SVCDB is specified and does not match the
1022 svcdb of the service definition. SVCDB can be specified as a scalar table
1023 name, such as 'svc_acct', or as an arrayref of possible table names.
1028 my $pkg_svc = shift->_primary_pkg_svc(@_);
1029 $pkg_svc ? $pkg_svc->svcpart : '';
1032 =item part_svc [ SVCDB ]
1034 Like the B<svcpart> method, but returns the FS::part_svc object (see
1040 my $pkg_svc = shift->_primary_pkg_svc(@_);
1041 $pkg_svc ? $pkg_svc->part_svc : '';
1044 sub _primary_pkg_svc {
1047 my $svcdb = scalar(@_) ? shift : [];
1048 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1049 my %svcdb = map { $_=>1 } @$svcdb;
1052 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1055 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1056 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1058 return '' if scalar(@pkg_svc) != 1;
1062 =item svcpart_unique_svcdb SVCDB
1064 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1065 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1066 false if there not a primary service definition for SVCDB or there are multiple
1067 service definitions for SVCDB.
1071 sub svcpart_unique_svcdb {
1072 my( $self, $svcdb ) = @_;
1073 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1074 return '' if scalar(@svcdb_pkg_svc) != 1;
1075 $svcdb_pkg_svc[0]->svcpart;
1080 Returns a list of the acceptable payment types for this package. Eventually
1081 this should come out of a database table and be editable, but currently has the
1082 following logic instead:
1084 If the package is free, the single item B<BILL> is
1085 returned, otherwise, the single item B<CARD> is returned.
1087 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1093 if ( $self->is_free ) {
1102 Returns true if this package is free.
1108 if ( $self->can('is_free_options') ) {
1109 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1110 map { $self->option($_) }
1111 $self->is_free_options;
1113 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1114 "provides neither is_free_options nor is_free method; returning false";
1119 # whether the plan allows discounts to be applied to this package
1120 sub can_discount { 0; }
1122 # whether the plan allows changing the start date
1123 sub can_start_date {
1125 $self->start_on_hold ? 0 : 1;
1128 # the delay start date if present
1129 sub delay_start_date {
1132 my $delay = $self->delay_start or return '';
1134 # avoid timelocal silliness
1135 my $dt = DateTime->today(time_zone => 'local');
1136 $dt->add(days => $delay);
1141 # moved to FS::Misc to make this accessible to other packages
1143 FS::Misc::pkg_freqs();
1148 Returns an english representation of the I<freq> field, such as "monthly",
1149 "weekly", "semi-annually", etc.
1155 my $freq = $self->freq;
1157 #my $freqs_href = $self->freqs_href;
1158 my $freqs_href = freqs_href();
1160 if ( exists($freqs_href->{$freq}) ) {
1161 $freqs_href->{$freq};
1163 my $interval = 'month';
1164 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1165 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1166 $interval = $interval{$2};
1171 "every $freq ${interval}s";
1176 =item add_freq TIMESTAMP [ FREQ ]
1178 Adds a billing period of some frequency to the provided timestamp and
1179 returns the resulting timestamp, or -1 if the frequency could not be
1180 parsed (shouldn't happen). By default, the frequency of this package
1181 will be used; to override this, pass a different frequency as a second
1187 my( $self, $date, $freq ) = @_;
1188 $freq = $self->freq unless $freq;
1190 #change this bit to use Date::Manip? CAREFUL with timezones (see
1191 # mailing list archive)
1192 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1194 if ( $freq =~ /^\d+$/ ) {
1196 until ( $mon < 12 ) { $mon -= 12; $year++; }
1198 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1200 } elsif ( $freq =~ /^(\d+)w$/ ) {
1202 $mday += $weeks * 7;
1203 } elsif ( $freq =~ /^(\d+)d$/ ) {
1206 } elsif ( $freq =~ /^(\d+)h$/ ) {
1213 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1218 For backwards compatibility, returns the plandata field as well as all options
1219 from FS::part_pkg_option.
1225 carp "plandata is deprecated";
1227 $self->SUPER::plandata(@_);
1229 my $plandata = $self->get('plandata');
1230 my %options = $self->options;
1231 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1236 =item part_pkg_vendor
1238 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1239 L<FS::part_pkg_vendor>).
1243 sub part_pkg_vendor {
1245 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
1248 =item vendor_pkg_ids
1250 Returns a list of vendor/external package ids by exportnum
1254 sub vendor_pkg_ids {
1256 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1259 =item part_pkg_option
1261 Returns all options as FS::part_pkg_option objects (see
1262 L<FS::part_pkg_option>).
1266 sub part_pkg_option {
1268 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
1273 Returns a list of option names and values suitable for assigning to a hash.
1279 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1282 =item option OPTIONNAME [ QUIET ]
1284 Returns the option value for the given name, or the empty string. If a true
1285 value is passed as the second argument, warnings about missing the option
1291 my( $self, $opt, $ornull ) = @_;
1293 #cache: was pulled up in the original part_pkg query
1294 return $self->hashref->{"_opt_$opt"}
1295 if exists $self->hashref->{"_opt_$opt"};
1297 cluck "$self -> option: searching for $opt" if $DEBUG;
1298 my $part_pkg_option =
1299 qsearchs('part_pkg_option', {
1300 pkgpart => $self->pkgpart,
1303 return $part_pkg_option->optionvalue if $part_pkg_option;
1305 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1306 split("\n", $self->get('plandata') );
1307 return $plandata{$opt} if exists $plandata{$opt};
1308 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1309 "not found in options or plandata!\n"
1315 =item fcc_option OPTIONNAME
1317 Returns the FCC 477 report option value for the given name, or the empty
1323 my ($self, $name) = @_;
1324 my $part_pkg_fcc_option =
1325 qsearchs('part_pkg_fcc_option', {
1326 pkgpart => $self->pkgpart,
1327 fccoptionname => $name,
1329 $part_pkg_fcc_option ? $part_pkg_fcc_option->optionvalue : '';
1334 Returns all FCC 477 report options for this package, as a hash-like list.
1340 map { $_->fccoptionname => $_->optionvalue }
1341 qsearch('part_pkg_fcc_option', { pkgpart => $self->pkgpart });
1344 =item bill_part_pkg_link
1346 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1350 sub bill_part_pkg_link {
1351 shift->_part_pkg_link('bill', @_);
1354 =item svc_part_pkg_link
1356 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1360 sub svc_part_pkg_link {
1361 shift->_part_pkg_link('svc', @_);
1364 =item supp_part_pkg_link
1366 Returns the associated part_pkg_link records of type 'supp' (supplemental
1371 sub supp_part_pkg_link {
1372 shift->_part_pkg_link('supp', @_);
1375 sub _part_pkg_link {
1376 my( $self, $type ) = @_;
1378 return @{ $cache_link{$type}->{$self->pkgpart} }
1379 if $cache_enabled && $cache_link{$type}->{$self->pkgpart};
1381 cluck $type.'_part_pkg_link called' if $DEBUG;
1384 qsearch({ table => 'part_pkg_link',
1385 hashref => { src_pkgpart => $self->pkgpart,
1387 #protection against infinite recursive links
1388 dst_pkgpart => { op=>'!=', value=> $self->pkgpart },
1390 order_by => "ORDER BY hidden",
1393 $cache_link{$type}->{$self->pkgpart} = \@ppl if $cache_enabled;
1398 sub self_and_bill_linked {
1399 shift->_self_and_linked('bill', @_);
1402 sub self_and_svc_linked {
1403 shift->_self_and_linked('svc', @_);
1406 sub _self_and_linked {
1407 my( $self, $type, $hidden ) = @_;
1411 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1412 $self->_part_pkg_link($type) ) )
1414 $_->hidden($hidden) if $hidden;
1421 =item part_pkg_taxoverride [ CLASS ]
1423 Returns all associated FS::part_pkg_taxoverride objects (see
1424 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1425 of class CLASS if defined. Class may be one of 'setup', 'recur',
1426 the empty string (default), or a usage class number (see L<FS::usage_class>).
1427 When a class is specified, the empty string class (default) is returned
1428 if no more specific values exist.
1432 sub part_pkg_taxoverride {
1436 my $hashref = { 'pkgpart' => $self->pkgpart };
1437 $hashref->{'usage_class'} = $class if defined($class);
1438 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1440 unless ( scalar(@overrides) || !defined($class) || !$class ){
1441 $hashref->{'usage_class'} = '';
1442 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1448 =item has_taxproduct
1450 Returns true if this package has any taxproduct associated with it.
1454 sub has_taxproduct {
1457 $self->taxproductnum ||
1458 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1459 keys %{ {$self->options} }
1465 =item taxproduct [ CLASS ]
1467 Returns the associated tax product for this package definition (see
1468 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1469 the usage classnum (see L<FS::usage_class>). Returns the default
1470 tax product for this record if the more specific CLASS value does
1479 my $part_pkg_taxproduct;
1481 my $taxproductnum = $self->taxproductnum;
1483 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1484 $taxproductnum = $class_taxproductnum
1485 if $class_taxproductnum
1488 $part_pkg_taxproduct =
1489 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1491 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1492 $taxproductnum = $self->taxproductnum;
1493 $part_pkg_taxproduct =
1494 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1497 $part_pkg_taxproduct;
1500 =item taxproduct_description [ CLASS ]
1502 Returns the description of the associated tax product for this package
1503 definition (see L<FS::part_pkg_taxproduct>).
1507 sub taxproduct_description {
1509 my $part_pkg_taxproduct = $self->taxproduct(@_);
1510 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1514 =item tax_rates DATA_PROVIDER, GEOCODE, [ CLASS ]
1516 Returns the tax table entries (L<FS::tax_rate> objects) that apply to this
1517 package in the location specified by GEOCODE, for usage class CLASS (one of
1518 'setup', 'recur', null, or a C<usage_class> number).
1524 my ($vendor, $geocode, $class) = @_;
1525 # if this part_pkg is overridden into a specific taxclass, get that class
1526 my @taxclassnums = map { $_->taxclassnum }
1527 $self->part_pkg_taxoverride($class);
1528 # otherwise, get its tax product category
1529 if (!@taxclassnums) {
1530 my $part_pkg_taxproduct = $self->taxproduct($class);
1531 # If this isn't defined, then the class has no taxproduct designation,
1532 # so return no tax rates.
1533 return () if !$part_pkg_taxproduct;
1535 # convert the taxproduct to the tax classes that might apply to it in
1537 @taxclassnums = map { $_->taxclassnum }
1538 grep { $_->taxable eq 'Y' } # why do we need this?
1539 $part_pkg_taxproduct->part_pkg_taxrate($geocode);
1541 return unless @taxclassnums;
1543 # then look up the actual tax_rate entries
1544 warn "Found taxclassnum values of ". join(',', @taxclassnums) ."\n"
1546 my $extra_sql = "AND taxclassnum IN (". join(',', @taxclassnums) . ")";
1547 my @taxes = qsearch({ 'table' => 'tax_rate',
1548 'hashref' => { 'geocode' => $geocode,
1549 'data_vendor' => $vendor,
1551 'extra_sql' => $extra_sql,
1553 warn "Found taxes ". join(',', map {$_->taxnum} @taxes) ."\n"
1559 =item part_pkg_discount
1561 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1566 sub part_pkg_discount {
1568 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1571 =item part_pkg_usage
1573 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1578 sub part_pkg_usage {
1580 qsearch('part_pkg_usage', { 'pkgpart' => $self->pkgpart });
1585 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1586 PLAN is the object's I<plan> field. There should be better docs
1587 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1593 my $plan = $self->plan;
1595 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1599 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1600 my $class = ref($self). "::$plan";
1601 warn "reblessing $self into $class" if $DEBUG > 1;
1604 bless($self, $class) unless $@;
1609 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1610 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1612 #fallback that return 0 for old legacy packages with no plan
1613 sub calc_remain { 0; }
1614 sub calc_units { 0; }
1616 #fallback for everything not based on flat.pm
1617 sub recur_temporality { 'upcoming'; }
1618 sub calc_cancel { 0; }
1620 #fallback for everything except bulk.pm
1621 sub hide_svc_detail { 0; }
1623 #fallback for packages that can't/won't summarize usage
1624 sub sum_usage { 0; }
1626 =item recur_cost_permonth CUST_PKG
1628 recur_cost divided by freq (only supported for monthly and longer frequencies)
1632 sub recur_cost_permonth {
1633 my($self, $cust_pkg) = @_;
1634 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1635 sprintf('%.2f', ($self->recur_cost || 0) / $self->freq );
1638 =item cust_bill_pkg_recur CUST_PKG
1640 Actual recurring charge for the specified customer package from customer's most
1645 sub cust_bill_pkg_recur {
1646 my($self, $cust_pkg) = @_;
1647 my $cust_bill_pkg = qsearchs({
1648 'table' => 'cust_bill_pkg',
1649 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1650 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1651 'recur' => { op=>'>', value=>'0' },
1653 'order_by' => 'ORDER BY cust_bill._date DESC,
1654 cust_bill_pkg.sdate DESC
1657 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1658 $cust_bill_pkg->recur;
1661 =item unit_setup CUST_PKG
1663 Returns the setup fee for one unit of the package.
1668 my ($self, $cust_pkg) = @_;
1669 $self->option('setup_fee') || 0;
1674 unit_setup minus setup_cost
1680 $self->unit_setup(@_) - ($self->setup_cost || 0);
1683 =item recur_margin_permonth
1685 base_recur_permonth minus recur_cost_permonth
1689 sub recur_margin_permonth {
1691 $self->base_recur_permonth(@_) - $self->recur_cost_permonth(@_);
1694 =item format OPTION DATA
1696 Returns data formatted according to the function 'format' described
1697 in the plan info. Returns DATA if no such function exists.
1702 my ($self, $option, $data) = (shift, shift, shift);
1703 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1704 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1710 =item parse OPTION DATA
1712 Returns data parsed according to the function 'parse' described
1713 in the plan info. Returns DATA if no such function exists.
1718 my ($self, $option, $data) = (shift, shift, shift);
1719 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1720 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1730 =head1 CLASS METHODS
1738 # Used by FS::Upgrade to migrate to a new database.
1740 sub _upgrade_data { # class method
1741 my($class, %opts) = @_;
1743 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1745 my @part_pkg = qsearch({
1746 'table' => 'part_pkg',
1747 'extra_sql' => "WHERE ". join(' OR ',
1748 'plan IS NULL', "plan = '' ",
1752 foreach my $part_pkg (@part_pkg) {
1754 unless ( $part_pkg->plan ) {
1755 $part_pkg->plan('flat');
1761 # the rest can be done asynchronously
1764 sub queueable_upgrade {
1765 # now upgrade to the explicit custom flag
1767 my $search = FS::Cursor->new({
1768 'table' => 'part_pkg',
1769 'hashref' => { disabled => 'Y', custom => '' },
1770 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1774 while (my $part_pkg = $search->fetch) {
1775 my $new = new FS::part_pkg { $part_pkg->hash };
1777 my $comment = $part_pkg->comment;
1778 $comment =~ s/^\(CUSTOM\) //;
1779 $comment = '(none)' unless $comment =~ /\S/;
1780 $new->comment($comment);
1782 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1783 my $primary = $part_pkg->svcpart;
1784 my $options = { $part_pkg->options };
1786 my $error = $new->replace( $part_pkg,
1787 'pkg_svc' => $pkg_svc,
1788 'primary_svc' => $primary,
1789 'options' => $options,
1792 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
1799 # set family_pkgpart on any packages that don't have it
1800 $search = FS::Cursor->new('part_pkg', { 'family_pkgpart' => '' });
1801 while (my $part_pkg = $search->fetch) {
1802 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1803 my $error = $part_pkg->SUPER::replace;
1805 warn "pkgpart#".$part_pkg->pkgpart.": $error\n";
1812 my @part_pkg_option = qsearch('part_pkg_option',
1813 { 'optionname' => 'unused_credit',
1816 foreach my $old_opt (@part_pkg_option) {
1817 my $pkgpart = $old_opt->pkgpart;
1818 my $error = $old_opt->delete;
1819 die $error if $error;
1821 foreach (qw(unused_credit_cancel unused_credit_change)) {
1822 my $new_opt = new FS::part_pkg_option {
1823 'pkgpart' => $pkgpart,
1827 $error = $new_opt->insert;
1828 die $error if $error;
1832 # migrate use_disposition_taqua and use_disposition to disposition_in
1833 @part_pkg_option = qsearch('part_pkg_option',
1834 { 'optionname' => { op => 'LIKE',
1835 value => 'use_disposition%',
1839 my %newopts = map { $_->pkgpart => $_ }
1840 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1841 foreach my $old_opt (@part_pkg_option) {
1842 my $pkgpart = $old_opt->pkgpart;
1843 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1845 my $error = $old_opt->delete;
1846 die $error if $error;
1848 if ( exists($newopts{$pkgpart}) ) {
1849 my $opt = $newopts{$pkgpart};
1850 $opt->optionvalue($opt->optionvalue.",$newval");
1851 $error = $opt->replace;
1852 die $error if $error;
1854 my $new_opt = new FS::part_pkg_option {
1855 'pkgpart' => $pkgpart,
1856 'optionname' => 'disposition_in',
1857 'optionvalue' => $newval,
1859 $error = $new_opt->insert;
1860 die $error if $error;
1861 $newopts{$pkgpart} = $new_opt;
1865 # set any package with FCC voice lines to the "VoIP with broadband" category
1866 # for backward compatibility
1868 # recover from a bad upgrade bug
1869 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1870 if (!FS::upgrade_journal->is_done($upgrade)) {
1871 my $bad_upgrade = qsearchs('upgrade_journal',
1872 { upgrade => 'part_pkg_fcc_voip_class' }
1874 if ( $bad_upgrade ) {
1875 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1876 ' AND history_date > '.($bad_upgrade->_date - 3600);
1877 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1880 'table' => 'h_part_pkg_option',
1882 'extra_sql' => "$where AND history_action = 'delete'",
1883 'order_by' => 'ORDER BY history_date ASC',
1885 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1888 'table' => 'h_pkg_svc',
1890 'extra_sql' => "$where AND history_action = 'replace_old'",
1891 'order_by' => 'ORDER BY history_date ASC',
1894 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1895 my $pkgpart ||= $deleted->pkgpart;
1896 $opt{$pkgpart} ||= {
1902 if ( $deleted->isa('FS::part_pkg_option') ) {
1903 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1905 my $svcpart = $deleted->svcpart;
1906 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1907 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1908 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1911 foreach my $pkgpart (keys %opt) {
1912 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1913 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1915 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1918 } # $bad_upgrade exists
1919 else { # do the original upgrade, but correctly this time
1920 my @part_pkg = qsearch('part_pkg', {
1921 fcc_ds0s => { op => '>', value => 0 },
1922 fcc_voip_class => ''
1924 foreach my $part_pkg (@part_pkg) {
1925 $part_pkg->set(fcc_voip_class => 2);
1926 my @pkg_svc = $part_pkg->pkg_svc;
1927 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1928 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1929 my $error = $part_pkg->replace(
1930 $part_pkg->replace_old,
1931 options => { $part_pkg->options },
1932 pkg_svc => \%quantity,
1933 hidden_svc => \%hidden,
1934 primary_svc => ($part_pkg->svcpart || ''),
1936 die $error if $error;
1939 FS::upgrade_journal->set_done($upgrade);
1944 =item curuser_pkgs_sql
1946 Returns an SQL fragment for searching for packages the current user can
1947 use, either via part_pkg.agentnum directly, or via agent type (see
1952 sub curuser_pkgs_sql {
1955 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1959 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1961 Returns an SQL fragment for searching for packages the provided agent or agents
1962 can use, either via part_pkg.agentnum directly, or via agent type (see
1967 sub agent_pkgs_sql {
1968 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1969 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1971 $class->_pkgs_sql(@agentnums); #is this why
1976 my( $class, @agentnums ) = @_;
1977 my $agentnums = join(',', @agentnums);
1981 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1982 OR ( agentnum IS NULL
1983 AND EXISTS ( SELECT 1
1985 LEFT JOIN agent_type USING ( typenum )
1986 LEFT JOIN agent AS typeagent USING ( typenum )
1987 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1988 AND typeagent.agentnum IN ($agentnums)
2006 #false laziness w/part_export & cdr
2008 foreach my $INC ( @INC ) {
2009 warn "globbing $INC/FS/part_pkg/[a-z]*.pm\n" if $DEBUG;
2010 foreach my $file ( glob("$INC/FS/part_pkg/[a-z]*.pm") ) {
2011 warn "attempting to load plan info from $file\n" if $DEBUG;
2012 $file =~ /\/(\w+)\.pm$/ or do {
2013 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
2017 my $info = eval "use FS::part_pkg::$mod; ".
2018 "\\%FS::part_pkg::$mod\::info;";
2020 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
2023 unless ( keys %$info ) {
2024 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
2027 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
2028 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
2029 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
2032 $info{$mod} = $info;
2033 $info->{'weight'} ||= 0; # quiet warnings
2037 # copy one level deep to allow replacement of fields and fieldorder
2038 tie %plans, 'Tie::IxHash',
2039 map { my %infohash = %{ $info{$_} };
2041 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
2044 # inheritance of plan options
2045 foreach my $name (keys(%info)) {
2046 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
2047 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
2048 delete $plans{$name};
2051 my $parents = $info{$name}->{'inherit_fields'} || [];
2052 my (%fields, %field_exists, @fieldorder);
2053 foreach my $parent ($name, @$parents) {
2054 if ( !exists($info{$parent}) ) {
2055 warn "$name tried to inherit from nonexistent '$parent'\n";
2058 %fields = ( # avoid replacing existing fields
2059 %{ $info{$parent}->{'fields'} || {} },
2062 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
2064 next if $field_exists{$_};
2065 $field_exists{$_} = 1;
2066 # allow inheritors to remove inherited fields from the fieldorder
2067 push @fieldorder, $_ if !exists($fields{$_}) or
2068 !exists($fields{$_}->{'disabled'});
2071 $plans{$name}->{'fields'} = \%fields;
2072 $plans{$name}->{'fieldorder'} = \@fieldorder;
2082 =head1 NEW PLAN CLASSES
2084 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
2085 found in eg/plan_template.pm. Until then, it is suggested that you use the
2086 other modules in FS/FS/part_pkg/ as a guide.
2090 The delete method is unimplemented.
2092 setup and recur semantics are not yet defined (and are implemented in
2093 FS::cust_bill. hmm.). now they're deprecated and need to go.
2097 part_pkg_taxrate is Pg specific
2099 replace should be smarter about managing the related tables (options, pkg_svc)
2103 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2104 schema.html from the base documentation.