2 use base qw( FS::m2m_Common FS::o2m_Common FS::option_Common );
5 use vars qw( %plans $DEBUG $setup_hack $skip_pkg_svc_hack );
6 use Carp qw(carp cluck confess);
7 use Scalar::Util qw( blessed );
9 use Time::Local qw( timelocal timelocal_nocheck ); # eventually replace with DateTime
12 use FS::Record qw( qsearch qsearchs dbh dbdef );
18 use FS::part_pkg_option;
19 use FS::part_pkg_msgcat;
20 use FS::part_pkg_taxrate;
21 use FS::part_pkg_taxoverride;
22 use FS::part_pkg_taxproduct;
23 use FS::part_pkg_link;
24 use FS::part_pkg_discount;
25 use FS::part_pkg_vendor;
26 use FS::part_pkg_currency;
30 $skip_pkg_svc_hack = 0;
34 FS::part_pkg - Object methods for part_pkg objects
40 $record = new FS::part_pkg \%hash
41 $record = new FS::part_pkg { 'column' => 'value' };
43 $custom_record = $template_record->clone;
45 $error = $record->insert;
47 $error = $new_record->replace($old_record);
49 $error = $record->delete;
51 $error = $record->check;
53 @pkg_svc = $record->pkg_svc;
55 $svcnum = $record->svcpart;
56 $svcnum = $record->svcpart( 'svc_acct' );
60 An FS::part_pkg object represents a package definition. FS::part_pkg
61 inherits from FS::Record. The following fields are currently supported:
65 =item pkgpart - primary key (assigned automatically for new package definitions)
67 =item pkg - Text name of this package definition (customer-viewable)
69 =item comment - Text name of this package definition (non-customer-viewable)
71 =item classnum - Optional package class (see L<FS::pkg_class>)
73 =item promo_code - Promotional code
75 =item setup - Setup fee expression (deprecated)
77 =item freq - Frequency of recurring fee
79 =item recur - Recurring fee expression (deprecated)
81 =item setuptax - Setup fee tax exempt flag, empty or `Y'
83 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
85 =item taxclass - Tax class
87 =item plan - Price plan
89 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
91 =item disabled - Disabled flag, empty or `Y'
93 =item custom - Custom flag, empty or `Y'
95 =item setup_cost - for cost tracking
97 =item recur_cost - for cost tracking
99 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
101 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
103 =item agentnum - Optional agentnum (see L<FS::agent>)
105 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
107 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
110 =item successor - Foreign key for the part_pkg that replaced this record.
111 If this record is not obsolete, will be null.
113 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
114 ancestor of this record. If this record is not a successor to another
115 part_pkg, will be equal to pkgpart.
117 =item delay_start - Number of days to delay package start, by default
127 Creates a new package definition. To add the package definition to
128 the database, see L<"insert">.
132 sub table { 'part_pkg'; }
136 An alternate constructor. Creates a new package definition by duplicating
137 an existing definition. A new pkgpart is assigned and the custom flag is
138 set to Y. To add the package definition to the database, see L<"insert">.
144 my $class = ref($self);
145 my %hash = $self->hash;
146 $hash{'pkgpart'} = '';
147 $hash{'custom'} = 'Y';
148 #new FS::part_pkg ( \%hash ); # ?
149 new $class ( \%hash ); # ?
152 =item insert [ , OPTION => VALUE ... ]
154 Adds this package definition to the database. If there is an error,
155 returns the error, otherwise returns false.
157 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
158 I<custnum_ref> and I<options>.
160 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
161 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
162 be set to a hashref of svcparts and flag values ('Y' or '') to set the
163 'hidden' field in these records.
165 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
166 FS::pkg_svc record will be updated.
168 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
169 record itself), the object will be updated to point to this package definition.
171 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
172 the scalar will be updated with the custnum value from the cust_pkg record.
174 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
175 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
176 records will be inserted.
178 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
179 records will be inserted.
181 If I<part_pkg_currency> is set to a hashref of options (with the keys as
182 option_CURRENCY), appropriate FS::part_pkg::currency records will be inserted.
189 warn "FS::part_pkg::insert called on $self with options ".
190 join(', ', map "$_=>$options{$_}", keys %options)
193 local $SIG{HUP} = 'IGNORE';
194 local $SIG{INT} = 'IGNORE';
195 local $SIG{QUIT} = 'IGNORE';
196 local $SIG{TERM} = 'IGNORE';
197 local $SIG{TSTP} = 'IGNORE';
198 local $SIG{PIPE} = 'IGNORE';
200 my $oldAutoCommit = $FS::UID::AutoCommit;
201 local $FS::UID::AutoCommit = 0;
204 warn " inserting part_pkg record" if $DEBUG;
205 my $error = $self->SUPER::insert( $options{options} );
207 $dbh->rollback if $oldAutoCommit;
212 if ( $self->get('family_pkgpart') eq '' ) {
213 $self->set('family_pkgpart' => $self->pkgpart);
214 $error = $self->SUPER::replace;
216 $dbh->rollback if $oldAutoCommit;
221 my $conf = new FS::Conf;
222 if ( $conf->exists('agent_defaultpkg') ) {
223 warn " agent_defaultpkg set; allowing all agents to purchase package"
225 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
226 my $type_pkgs = new FS::type_pkgs({
227 'typenum' => $agent_type->typenum,
228 'pkgpart' => $self->pkgpart,
230 my $error = $type_pkgs->insert;
232 $dbh->rollback if $oldAutoCommit;
238 warn " inserting part_pkg_taxoverride records" if $DEBUG;
239 my %overrides = %{ $options{'tax_overrides'} || {} };
240 foreach my $usage_class ( keys %overrides ) {
242 ( exists($overrides{$usage_class}) && defined($overrides{$usage_class}) )
243 ? $overrides{$usage_class}
245 my @overrides = (grep "$_", split(',', $override) );
246 my $error = $self->process_m2m (
247 'link_table' => 'part_pkg_taxoverride',
248 'target_table' => 'tax_class',
249 'hashref' => { 'usage_class' => $usage_class },
250 'params' => \@overrides,
253 $dbh->rollback if $oldAutoCommit;
258 warn " inserting part_pkg_currency records" if $DEBUG;
259 my %part_pkg_currency = %{ $options{'part_pkg_currency'} || {} };
260 foreach my $key ( keys %part_pkg_currency ) {
261 $key =~ /^(.+)_([A-Z]{3})$/ or next;
262 my $part_pkg_currency = new FS::part_pkg_currency {
263 'pkgpart' => $self->pkgpart,
266 'optionvalue' => $part_pkg_currency{$key},
268 my $error = $part_pkg_currency->insert;
270 $dbh->rollback if $oldAutoCommit;
275 unless ( $skip_pkg_svc_hack ) {
277 warn " inserting pkg_svc records" if $DEBUG;
278 my $pkg_svc = $options{'pkg_svc'} || {};
279 my $hidden_svc = $options{'hidden_svc'} || {};
280 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
281 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
283 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
287 my $pkg_svc = new FS::pkg_svc( {
288 'pkgpart' => $self->pkgpart,
289 'svcpart' => $part_svc->svcpart,
290 'quantity' => $quantity,
291 'primary_svc' => $primary_svc,
292 'hidden' => $hidden_svc->{$part_svc->svcpart},
294 my $error = $pkg_svc->insert;
296 $dbh->rollback if $oldAutoCommit;
303 if ( $options{'cust_pkg'} ) {
304 warn " updating cust_pkg record " if $DEBUG;
306 ref($options{'cust_pkg'})
307 ? $options{'cust_pkg'}
308 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
309 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
310 if $options{'custnum_ref'};
311 my %hash = $old_cust_pkg->hash;
312 $hash{'pkgpart'} = $self->pkgpart,
313 my $new_cust_pkg = new FS::cust_pkg \%hash;
314 local($FS::cust_pkg::disable_agentcheck) = 1;
315 my $error = $new_cust_pkg->replace($old_cust_pkg);
317 $dbh->rollback if $oldAutoCommit;
318 return "Error modifying cust_pkg record: $error";
322 if ( $options{'part_pkg_vendor'} ) {
323 while ( my ($exportnum, $vendor_pkg_id) =
324 each %{ $options{part_pkg_vendor} }
327 my $ppv = new FS::part_pkg_vendor( {
328 'pkgpart' => $self->pkgpart,
329 'exportnum' => $exportnum,
330 'vendor_pkg_id' => $vendor_pkg_id,
332 my $error = $ppv->insert;
334 $dbh->rollback if $oldAutoCommit;
335 return "Error inserting part_pkg_vendor record: $error";
340 warn " committing transaction" if $DEBUG and $oldAutoCommit;
341 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
348 Currently unimplemented.
353 return "Can't (yet?) delete package definitions.";
354 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
357 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
359 Replaces OLD_RECORD with this one in the database. If there is an error,
360 returns the error, otherwise returns false.
362 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
365 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
366 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
367 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
368 'hidden' field in these records. I<bulk_skip> can be set to a hashref of
369 svcparts and flag values ('Y' or '') to set the 'bulk_skip' field in those
372 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
373 FS::pkg_svc record will be updated.
375 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
378 If I<part_pkg_currency> is set to a hashref of options (with the keys as
379 option_CURRENCY), appropriate FS::part_pkg::currency records will be replaced.
386 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
391 ( ref($_[0]) eq 'HASH' )
395 $options->{options} = { $old->options } unless defined($options->{options});
397 warn "FS::part_pkg::replace called on $new to replace $old with options".
398 join(', ', map "$_ => ". $options->{$_}, keys %$options)
401 local $SIG{HUP} = 'IGNORE';
402 local $SIG{INT} = 'IGNORE';
403 local $SIG{QUIT} = 'IGNORE';
404 local $SIG{TERM} = 'IGNORE';
405 local $SIG{TSTP} = 'IGNORE';
406 local $SIG{PIPE} = 'IGNORE';
408 my $oldAutoCommit = $FS::UID::AutoCommit;
409 local $FS::UID::AutoCommit = 0;
412 my $conf = new FS::Conf;
413 if ( $conf->exists('part_pkg-lineage') ) {
414 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
415 qw(setup_fee recur_fee) #others? config?
418 warn " superseding package" if $DEBUG;
420 my $error = $new->supersede($old, %$options);
422 $dbh->rollback if $oldAutoCommit;
426 warn " committing transaction" if $DEBUG and $oldAutoCommit;
427 $dbh->commit if $oldAutoCommit;
434 #plandata shit stays in replace for upgrades until after 2.0 (or edit
436 warn " saving legacy plandata" if $DEBUG;
437 my $plandata = $new->get('plandata');
438 $new->set('plandata', '');
440 warn " deleting old part_pkg_option records" if $DEBUG;
441 foreach my $part_pkg_option ( $old->part_pkg_option ) {
442 my $error = $part_pkg_option->delete;
444 $dbh->rollback if $oldAutoCommit;
449 warn " replacing part_pkg record" if $DEBUG;
450 my $error = $new->SUPER::replace($old, $options->{options} );
452 $dbh->rollback if $oldAutoCommit;
456 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
457 foreach my $part_pkg_option (
458 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
459 return "illegal plandata: $plandata";
461 new FS::part_pkg_option {
462 'pkgpart' => $new->pkgpart,
467 split("\n", $plandata)
469 my $error = $part_pkg_option->insert;
471 $dbh->rollback if $oldAutoCommit;
476 #trivial nit: not the most efficient to delete and reinsert
477 warn " deleting old part_pkg_currency records" if $DEBUG;
478 foreach my $part_pkg_currency ( $old->part_pkg_currency ) {
479 my $error = $part_pkg_currency->delete;
481 $dbh->rollback if $oldAutoCommit;
482 return "error deleting part_pkg_currency record: $error";
486 warn " inserting new part_pkg_currency records" if $DEBUG;
487 my %part_pkg_currency = %{ $options->{'part_pkg_currency'} || {} };
488 foreach my $key ( keys %part_pkg_currency ) {
489 $key =~ /^(.+)_([A-Z]{3})$/ or next;
490 my $part_pkg_currency = new FS::part_pkg_currency {
491 'pkgpart' => $new->pkgpart,
494 'optionvalue' => $part_pkg_currency{$key},
496 my $error = $part_pkg_currency->insert;
498 $dbh->rollback if $oldAutoCommit;
499 return "error inserting part_pkg_currency record: $error";
504 warn " replacing pkg_svc records" if $DEBUG;
505 my $pkg_svc = $options->{'pkg_svc'};
506 my $hidden_svc = $options->{'hidden_svc'} || {};
507 my $bulk_skip = $options->{'bulk_skip'} || {};
508 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
509 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
510 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
511 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
512 my $bulk_skip = $bulk_skip->{$part_svc->svcpart} || '';
514 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
515 && $options->{'primary_svc'} == $part_svc->svcpart
520 my $old_pkg_svc = qsearchs('pkg_svc', {
521 'pkgpart' => $old->pkgpart,
522 'svcpart' => $part_svc->svcpart,
525 my $old_quantity = 0;
526 my $old_primary_svc = '';
528 my $old_bulk_skip = '';
529 if ( $old_pkg_svc ) {
530 $old_quantity = $old_pkg_svc->quantity;
531 $old_primary_svc = $old_pkg_svc->primary_svc
532 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
533 $old_hidden = $old_pkg_svc->hidden;
534 $old_bulk_skip = $old_pkg_svc->old_bulk_skip;
537 next unless $old_quantity != $quantity
538 || $old_primary_svc ne $primary_svc
539 || $old_hidden ne $hidden
540 || $old_bulk_skip ne $bulk_skip;
542 my $new_pkg_svc = new FS::pkg_svc( {
543 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
544 'pkgpart' => $new->pkgpart,
545 'svcpart' => $part_svc->svcpart,
546 'quantity' => $quantity,
547 'primary_svc' => $primary_svc,
549 'bulk_skip' => $bulk_skip,
551 my $error = $old_pkg_svc
552 ? $new_pkg_svc->replace($old_pkg_svc)
553 : $new_pkg_svc->insert;
555 $dbh->rollback if $oldAutoCommit;
559 } #if $options->{pkg_svc}
561 my @part_pkg_vendor = $old->part_pkg_vendor;
562 my @current_exportnum = ();
563 if ( $options->{'part_pkg_vendor'} ) {
564 my($exportnum,$vendor_pkg_id);
565 while ( ($exportnum,$vendor_pkg_id)
566 = each %{$options->{'part_pkg_vendor'}} ) {
568 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
569 if($exportnum == $part_pkg_vendor->exportnum
570 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
571 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
572 my $error = $part_pkg_vendor->replace;
574 $dbh->rollback if $oldAutoCommit;
575 return "Error replacing part_pkg_vendor record: $error";
580 elsif($exportnum == $part_pkg_vendor->exportnum
581 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
586 unless ( $noinsert ) {
587 my $ppv = new FS::part_pkg_vendor( {
588 'pkgpart' => $new->pkgpart,
589 'exportnum' => $exportnum,
590 'vendor_pkg_id' => $vendor_pkg_id,
592 my $error = $ppv->insert;
594 $dbh->rollback if $oldAutoCommit;
595 return "Error inserting part_pkg_vendor record: $error";
598 push @current_exportnum, $exportnum;
601 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
602 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
603 my $error = $part_pkg_vendor->delete;
605 $dbh->rollback if $oldAutoCommit;
606 return "Error deleting part_pkg_vendor record: $error";
611 # propagate changes to certain core fields
612 if ( $conf->exists('part_pkg-lineage') ) {
613 warn " propagating changes to family" if $DEBUG;
614 my $error = $new->propagate($old);
616 $dbh->rollback if $oldAutoCommit;
621 warn " committing transaction" if $DEBUG and $oldAutoCommit;
622 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
628 Checks all fields to make sure this is a valid package definition. If
629 there is an error, returns the error, otherwise returns false. Called by the
630 insert and replace methods.
636 warn "FS::part_pkg::check called on $self" if $DEBUG;
638 for (qw(setup recur plandata)) {
639 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
640 return "Use of $_ field is deprecated; set a plan and options: ".
642 if length($self->get($_));
646 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
647 my $error = $self->ut_number('freq');
648 return $error if $error;
650 $self->freq =~ /^(\d+[hdw]?)$/
651 or return "Illegal or empty freq: ". $self->freq;
655 my @null_agentnum_right = ( 'Edit global package definitions' );
656 push @null_agentnum_right, 'One-time charge'
657 if $self->freq =~ /^0/;
658 push @null_agentnum_right, 'Customize customer package'
659 if $self->disabled eq 'Y'; #good enough
661 my $error = $self->ut_numbern('pkgpart')
662 || $self->ut_text('pkg')
663 || $self->ut_textn('comment')
664 || $self->ut_textn('promo_code')
665 || $self->ut_alphan('plan')
666 || $self->ut_enum('setuptax', [ '', 'Y' ] )
667 || $self->ut_enum('recurtax', [ '', 'Y' ] )
668 || $self->ut_textn('taxclass')
669 || $self->ut_enum('disabled', [ '', 'Y' ] )
670 || $self->ut_enum('custom', [ '', 'Y' ] )
671 || $self->ut_enum('no_auto', [ '', 'Y' ])
672 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
673 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
674 #|| $self->ut_moneyn('setup_cost')
675 #|| $self->ut_moneyn('recur_cost')
676 || $self->ut_floatn('setup_cost')
677 || $self->ut_floatn('recur_cost')
678 || $self->ut_floatn('pay_weight')
679 || $self->ut_floatn('credit_weight')
680 || $self->ut_numbern('taxproductnum')
681 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
682 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
683 || $self->ut_foreign_keyn('taxproductnum',
684 'part_pkg_taxproduct',
688 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
689 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
691 || $self->ut_numbern('fcc_ds0s')
692 || $self->ut_numbern('fcc_voip_class')
693 || $self->ut_numbern('delay_start')
694 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
695 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
696 || $self->SUPER::check
698 return $error if $error;
700 return 'Unknown plan '. $self->plan
701 unless exists($plans{$self->plan});
703 my $conf = new FS::Conf;
704 return 'Taxclass is required'
705 if ! $self->taxclass && $conf->exists('require_taxclasses');
710 =item supersede OLD [, OPTION => VALUE ... ]
712 Inserts this package as a successor to the package OLD. All options are as
713 for C<insert>. After inserting, disables OLD and sets the new package as its
719 my ($new, $old, %options) = @_;
722 $new->set('pkgpart' => '');
723 $new->set('family_pkgpart' => $old->family_pkgpart);
724 warn " inserting successor package\n" if $DEBUG;
725 $error = $new->insert(%options);
726 return $error if $error;
728 warn " disabling superseded package\n" if $DEBUG;
729 $old->set('successor' => $new->pkgpart);
730 $old->set('disabled' => 'Y');
731 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
732 return $error if $error;
734 warn " propagating changes to family" if $DEBUG;
735 $new->propagate($old);
740 If any of certain fields have changed from OLD to this package, then,
741 for all packages in the same lineage as this one, sets those fields
742 to their values in this package.
746 my @propagate_fields = (
747 qw( pkg classnum setup_cost recur_cost taxclass
748 setuptax recurtax pay_weight credit_weight
756 map { $_ => $new->get($_) }
757 grep { $new->get($_) ne $old->get($_) }
761 my @part_pkg = qsearch('part_pkg', {
762 'family_pkgpart' => $new->family_pkgpart
765 foreach my $part_pkg ( @part_pkg ) {
766 my $pkgpart = $part_pkg->pkgpart;
767 next if $pkgpart == $new->pkgpart; # don't modify $new
768 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
769 foreach ( keys %fields ) {
770 $part_pkg->set($_, $fields{$_});
772 # SUPER::replace to avoid changing non-core fields
773 my $error = $part_pkg->SUPER::replace;
774 push @error, "pkgpart $pkgpart: $error"
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 sub price_info { # safety, in case a part_pkg hasn't defined price_info
837 my $price_info = $self->price_info(@_);
838 ( $self->custom ? '(CUSTOM) ' : '' ).
840 ( ($self->custom || $self->comment) ? ' - ' : '' ).
841 ($price_info || 'No charge');
846 $self->pkg. ' - '. ($self->price_info || 'No charge');
851 Returns the package class, as an FS::pkg_class object, or the empty string
852 if there is no package class.
854 =item addon_pkg_class
856 Returns the add-on package class, as an FS::pkg_class object, or the empty
857 string if there is no add-on package class.
861 sub addon_pkg_class {
863 if ( $self->addon_classnum ) {
864 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
872 Returns the package category name, or the empty string if there is no package
879 my $pkg_class = $self->pkg_class;
881 ? $pkg_class->categoryname
887 Returns the package class name, or the empty string if there is no package
894 my $pkg_class = $self->pkg_class;
896 ? $pkg_class->classname
900 =item addon_classname
902 Returns the add-on package class name, or the empty string if there is no
903 add-on package class.
907 sub addon_classname {
909 my $pkg_class = $self->addon_pkg_class;
911 ? $pkg_class->classname
917 Returns the associated agent for this event, if any, as an FS::agent object.
919 =item pkg_svc [ HASHREF | OPTION => VALUE ]
921 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
922 definition (with non-zero quantity).
924 One option is available, I<disable_linked>. If set true it will return the
925 services for this package definition alone, omitting services from any add-on
932 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
940 # #sort { $b->primary cmp $a->primary }
941 # grep { $_->quantity }
942 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
944 my $opt = ref($_[0]) ? $_[0] : { @_ };
945 my %pkg_svc = map { $_->svcpart => $_ }
946 grep { $_->quantity }
947 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
949 unless ( $opt->{disable_linked} ) {
950 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
951 my @pkg_svc = grep { $_->quantity }
952 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
953 foreach my $pkg_svc ( @pkg_svc ) {
954 if ( $pkg_svc{$pkg_svc->svcpart} ) {
955 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
956 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
958 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
968 =item svcpart [ SVCDB ]
970 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
971 associated with this package definition (see L<FS::pkg_svc>). Returns
972 false if there not a primary service definition or exactly one service
973 definition with quantity 1, or if SVCDB is specified and does not match the
974 svcdb of the service definition. SVCDB can be specified as a scalar table
975 name, such as 'svc_acct', or as an arrayref of possible table names.
980 my $pkg_svc = shift->_primary_pkg_svc(@_);
981 $pkg_svc ? $pkg_svc->svcpart : '';
984 =item part_svc [ SVCDB ]
986 Like the B<svcpart> method, but returns the FS::part_svc object (see
992 my $pkg_svc = shift->_primary_pkg_svc(@_);
993 $pkg_svc ? $pkg_svc->part_svc : '';
996 sub _primary_pkg_svc {
999 my $svcdb = scalar(@_) ? shift : [];
1000 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
1001 my %svcdb = map { $_=>1 } @$svcdb;
1004 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
1007 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
1008 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
1010 return '' if scalar(@pkg_svc) != 1;
1014 =item svcpart_unique_svcdb SVCDB
1016 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
1017 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
1018 false if there not a primary service definition for SVCDB or there are multiple
1019 service definitions for SVCDB.
1023 sub svcpart_unique_svcdb {
1024 my( $self, $svcdb ) = @_;
1025 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
1026 return '' if scalar(@svcdb_pkg_svc) != 1;
1027 $svcdb_pkg_svc[0]->svcpart;
1032 Returns a list of the acceptable payment types for this package. Eventually
1033 this should come out of a database table and be editable, but currently has the
1034 following logic instead:
1036 If the package is free, the single item B<BILL> is
1037 returned, otherwise, the single item B<CARD> is returned.
1039 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
1045 if ( $self->is_free ) {
1054 Returns true if this package is free.
1060 if ( $self->can('is_free_options') ) {
1061 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1062 map { $self->option($_) }
1063 $self->is_free_options;
1065 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1066 "provides neither is_free_options nor is_free method; returning false";
1071 # whether the plan allows discounts to be applied to this package
1072 sub can_discount { 0; }
1074 # whether the plan allows changing the start date
1075 sub can_start_date { 1; }
1077 # whether the plan supports part_pkg_usageprice add-ons (a specific kind of
1078 # pre-selectable usage pricing, there's others this doesn't refer to)
1079 sub can_usageprice { 0; }
1081 # the delay start date if present
1082 sub delay_start_date {
1085 my $delay = $self->delay_start or return '';
1087 # avoid timelocal silliness
1088 my $dt = DateTime->today(time_zone => 'local');
1089 $dt->add(days => $delay);
1093 sub can_currency_exchange { 0; }
1096 # moved to FS::Misc to make this accessible to other packages
1098 FS::Misc::pkg_freqs();
1103 Returns an english representation of the I<freq> field, such as "monthly",
1104 "weekly", "semi-annually", etc.
1110 my $freq = $self->freq;
1112 #my $freqs_href = $self->freqs_href;
1113 my $freqs_href = freqs_href();
1115 if ( exists($freqs_href->{$freq}) ) {
1116 $freqs_href->{$freq};
1118 my $interval = 'month';
1119 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1120 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1121 $interval = $interval{$2};
1126 "every $freq ${interval}s";
1131 =item add_freq TIMESTAMP [ FREQ ]
1133 Adds a billing period of some frequency to the provided timestamp and
1134 returns the resulting timestamp, or -1 if the frequency could not be
1135 parsed (shouldn't happen). By default, the frequency of this package
1136 will be used; to override this, pass a different frequency as a second
1142 my( $self, $date, $freq ) = @_;
1143 $freq = $self->freq unless $freq;
1145 #change this bit to use Date::Manip? CAREFUL with timezones (see
1146 # mailing list archive)
1147 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1149 if ( $freq =~ /^\d+$/ ) {
1151 until ( $mon < 12 ) { $mon -= 12; $year++; }
1153 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1155 } elsif ( $freq =~ /^(\d+)w$/ ) {
1157 $mday += $weeks * 7;
1158 } elsif ( $freq =~ /^(\d+)d$/ ) {
1161 } elsif ( $freq =~ /^(\d+)h$/ ) {
1168 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1173 For backwards compatibility, returns the plandata field as well as all options
1174 from FS::part_pkg_option.
1180 carp "plandata is deprecated";
1182 $self->SUPER::plandata(@_);
1184 my $plandata = $self->get('plandata');
1185 my %options = $self->options;
1186 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1191 =item part_pkg_vendor
1193 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1194 L<FS::part_pkg_vendor>).
1196 =item vendor_pkg_ids
1198 Returns a list of vendor/external package ids by exportnum
1202 sub vendor_pkg_ids {
1204 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1207 =item part_pkg_option
1209 Returns all options as FS::part_pkg_option objects (see
1210 L<FS::part_pkg_option>).
1214 Returns a list of option names and values suitable for assigning to a hash.
1220 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1223 =item option OPTIONNAME [ QUIET ]
1225 Returns the option value for the given name, or the empty string. If a true
1226 value is passed as the second argument, warnings about missing the option
1232 my( $self, $opt, $ornull ) = @_;
1233 my $part_pkg_option =
1234 qsearchs('part_pkg_option', {
1235 pkgpart => $self->pkgpart,
1238 return $part_pkg_option->optionvalue if $part_pkg_option;
1239 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1240 split("\n", $self->get('plandata') );
1241 return $plandata{$opt} if exists $plandata{$opt};
1242 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1243 "not found in options or plandata!\n"
1248 =item part_pkg_currency [ CURRENCY ]
1250 Returns all currency options as FS::part_pkg_currency objects (see
1251 L<FS::part_pkg_currency>), or, if a currency is specified, only return the
1252 objects for that currency.
1256 sub part_pkg_currency {
1258 my %hash = ( 'pkgpart' => $self->pkgpart );
1259 $hash{'currency'} = shift if @_;
1260 qsearch('part_pkg_currency', \%hash );
1263 =item part_pkg_currency_options CURRENCY
1265 Returns a list of option names and values from FS::part_pkg_currency for the
1270 sub part_pkg_currency_options {
1272 map { $_->optionname => $_->optionvalue } $self->part_pkg_currency(shift);
1275 =item part_pkg_currency_option CURRENCY OPTIONNAME
1277 Returns the option value for the given name and currency.
1281 sub part_pkg_currency_option {
1282 my( $self, $currency, $optionname ) = @_;
1283 my $part_pkg_currency =
1284 qsearchs('part_pkg_currency', { 'pkgpart' => $self->pkgpart,
1285 'currency' => $currency,
1286 'optionname' => $optionname,
1289 #fatal if not found? that works for our use cases from
1290 #part_pkg/currency_fixed, but isn't how we would typically/expect the method
1291 #to behave. have to catch it there if we change it here...
1292 or die "Unknown price for ". $self->pkg_comment. " in $currency\n";
1294 $part_pkg_currency->optionvalue;
1297 =item bill_part_pkg_link
1299 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1303 sub bill_part_pkg_link {
1304 shift->_part_pkg_link('bill', @_);
1307 =item svc_part_pkg_link
1309 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1313 sub svc_part_pkg_link {
1314 shift->_part_pkg_link('svc', @_);
1317 =item supp_part_pkg_link
1319 Returns the associated part_pkg_link records of type 'supp' (supplemental
1324 sub supp_part_pkg_link {
1325 shift->_part_pkg_link('supp', @_);
1328 sub _part_pkg_link {
1329 my( $self, $type ) = @_;
1330 qsearch({ table => 'part_pkg_link',
1331 hashref => { 'src_pkgpart' => $self->pkgpart,
1332 'link_type' => $type,
1333 #protection against infinite recursive links
1334 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1336 order_by => "ORDER BY hidden",
1340 sub self_and_bill_linked {
1341 shift->_self_and_linked('bill', @_);
1344 sub self_and_svc_linked {
1345 shift->_self_and_linked('svc', @_);
1348 sub _self_and_linked {
1349 my( $self, $type, $hidden ) = @_;
1353 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1354 $self->_part_pkg_link($type) ) )
1356 $_->hidden($hidden) if $hidden;
1363 =item part_pkg_taxoverride [ CLASS ]
1365 Returns all associated FS::part_pkg_taxoverride objects (see
1366 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1367 of class CLASS if defined. Class may be one of 'setup', 'recur',
1368 the empty string (default), or a usage class number (see L<FS::usage_class>).
1369 When a class is specified, the empty string class (default) is returned
1370 if no more specific values exist.
1374 sub part_pkg_taxoverride {
1378 my $hashref = { 'pkgpart' => $self->pkgpart };
1379 $hashref->{'usage_class'} = $class if defined($class);
1380 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1382 unless ( scalar(@overrides) || !defined($class) || !$class ){
1383 $hashref->{'usage_class'} = '';
1384 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1390 =item has_taxproduct
1392 Returns true if this package has any taxproduct associated with it.
1396 sub has_taxproduct {
1399 $self->taxproductnum ||
1400 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1401 keys %{ {$self->options} }
1407 =item taxproduct [ CLASS ]
1409 Returns the associated tax product for this package definition (see
1410 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1411 the usage classnum (see L<FS::usage_class>). Returns the default
1412 tax product for this record if the more specific CLASS value does
1421 my $part_pkg_taxproduct;
1423 my $taxproductnum = $self->taxproductnum;
1425 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1426 $taxproductnum = $class_taxproductnum
1427 if $class_taxproductnum
1430 $part_pkg_taxproduct =
1431 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1433 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1434 $taxproductnum = $self->taxproductnum;
1435 $part_pkg_taxproduct =
1436 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1439 $part_pkg_taxproduct;
1442 =item taxproduct_description [ CLASS ]
1444 Returns the description of the associated tax product for this package
1445 definition (see L<FS::part_pkg_taxproduct>).
1449 sub taxproduct_description {
1451 my $part_pkg_taxproduct = $self->taxproduct(@_);
1452 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1455 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1457 Returns the package to taxrate m2m records for this package in the location
1458 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1459 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1460 (see L<FS::usage_class>).
1464 sub _expand_cch_taxproductnum {
1467 my $part_pkg_taxproduct = $self->taxproduct($class);
1469 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1470 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1473 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1474 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1475 OR taxproduct = '$a:$b:$c:'
1476 OR taxproduct = '$a:$b:".":$d'
1477 OR taxproduct = '$a:$b:".":' )";
1478 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1479 'hashref' => { 'data_vendor'=>'cch' },
1480 'extra_sql' => $extra_sql,
1485 sub part_pkg_taxrate {
1487 my ($data_vendor, $geocode, $class) = @_;
1490 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1491 dbh->quote($data_vendor);
1493 # CCH oddness in m2m
1494 $extra_sql .= ' AND ('.
1495 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1499 # much more CCH oddness in m2m -- this is kludgy
1500 my @tpnums = $self->_expand_cch_taxproductnum($class);
1501 if (scalar(@tpnums)) {
1502 $extra_sql .= ' AND ('.
1503 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1506 $extra_sql .= ' AND ( 0 = 1 )';
1509 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1510 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1511 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1513 # should qsearch preface columns with the table to facilitate joins?
1514 qsearch( { 'table' => 'part_pkg_taxrate',
1515 'select' => $select,
1516 'hashref' => { # 'data_vendor' => $data_vendor,
1517 # 'taxproductnum' => $self->taxproductnum,
1519 'addl_from' => $addl_from,
1520 'extra_sql' => $extra_sql,
1521 'order_by' => $order_by,
1525 =item part_pkg_discount
1527 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1530 =item part_pkg_usage
1532 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1537 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1538 PLAN is the object's I<plan> field. There should be better docs
1539 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1545 my $plan = $self->plan;
1547 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1551 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1552 my $class = ref($self). "::$plan";
1553 warn "reblessing $self into $class" if $DEBUG > 1;
1556 bless($self, $class) unless $@;
1561 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1562 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1564 #fallback that return 0 for old legacy packages with no plan
1565 sub calc_remain { 0; }
1566 sub calc_units { 0; }
1568 #fallback for everything not based on flat.pm
1569 sub recur_temporality { 'upcoming'; }
1570 sub calc_cancel { 0; }
1572 #fallback for everything except bulk.pm
1573 sub hide_svc_detail { 0; }
1575 #fallback for packages that can't/won't summarize usage
1576 sub sum_usage { 0; }
1578 =item recur_cost_permonth CUST_PKG
1580 recur_cost divided by freq (only supported for monthly and longer frequencies)
1584 sub recur_cost_permonth {
1585 my($self, $cust_pkg) = @_;
1586 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1587 sprintf('%.2f', $self->recur_cost / $self->freq );
1590 =item cust_bill_pkg_recur CUST_PKG
1592 Actual recurring charge for the specified customer package from customer's most
1597 sub cust_bill_pkg_recur {
1598 my($self, $cust_pkg) = @_;
1599 my $cust_bill_pkg = qsearchs({
1600 'table' => 'cust_bill_pkg',
1601 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1602 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1603 'recur' => { op=>'>', value=>'0' },
1605 'order_by' => 'ORDER BY cust_bill._date DESC,
1606 cust_bill_pkg.sdate DESC
1609 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1610 $cust_bill_pkg->recur;
1613 =item unit_setup CUST_PKG
1615 Returns the setup fee for one unit of the package.
1620 my ($self, $cust_pkg) = @_;
1621 $self->option('setup_fee') || 0;
1624 =item format OPTION DATA
1626 Returns data formatted according to the function 'format' described
1627 in the plan info. Returns DATA if no such function exists.
1632 my ($self, $option, $data) = (shift, shift, shift);
1633 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1634 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1640 =item parse OPTION DATA
1642 Returns data parsed according to the function 'parse' described
1643 in the plan info. Returns DATA if no such function exists.
1648 my ($self, $option, $data) = (shift, shift, shift);
1649 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1650 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1660 =head1 CLASS METHODS
1668 # Used by FS::Upgrade to migrate to a new database.
1670 sub _upgrade_data { # class method
1671 my($class, %opts) = @_;
1673 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1675 my @part_pkg = qsearch({
1676 'table' => 'part_pkg',
1677 'extra_sql' => "WHERE ". join(' OR ',
1678 'plan IS NULL', "plan = '' ",
1682 foreach my $part_pkg (@part_pkg) {
1684 unless ( $part_pkg->plan ) {
1685 $part_pkg->plan('flat');
1692 # now upgrade to the explicit custom flag
1694 @part_pkg = qsearch({
1695 'table' => 'part_pkg',
1696 'hashref' => { disabled => 'Y', custom => '' },
1697 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1700 foreach my $part_pkg (@part_pkg) {
1701 my $new = new FS::part_pkg { $part_pkg->hash };
1703 my $comment = $part_pkg->comment;
1704 $comment =~ s/^\(CUSTOM\) //;
1705 $comment = '(none)' unless $comment =~ /\S/;
1706 $new->comment($comment);
1708 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1709 my $primary = $part_pkg->svcpart;
1710 my $options = { $part_pkg->options };
1712 my $error = $new->replace( $part_pkg,
1713 'pkg_svc' => $pkg_svc,
1714 'primary_svc' => $primary,
1715 'options' => $options,
1717 die $error if $error;
1720 # set family_pkgpart on any packages that don't have it
1721 @part_pkg = qsearch('part_pkg', { 'family_pkgpart' => '' });
1722 foreach my $part_pkg (@part_pkg) {
1723 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1724 my $error = $part_pkg->SUPER::replace;
1725 die $error if $error;
1728 my @part_pkg_option = qsearch('part_pkg_option',
1729 { 'optionname' => 'unused_credit',
1732 foreach my $old_opt (@part_pkg_option) {
1733 my $pkgpart = $old_opt->pkgpart;
1734 my $error = $old_opt->delete;
1735 die $error if $error;
1737 foreach (qw(unused_credit_cancel unused_credit_change)) {
1738 my $new_opt = new FS::part_pkg_option {
1739 'pkgpart' => $pkgpart,
1743 $error = $new_opt->insert;
1744 die $error if $error;
1748 # migrate use_disposition_taqua and use_disposition to disposition_in
1749 @part_pkg_option = qsearch('part_pkg_option',
1750 { 'optionname' => { op => 'LIKE',
1751 value => 'use_disposition%',
1755 my %newopts = map { $_->pkgpart => $_ }
1756 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1757 foreach my $old_opt (@part_pkg_option) {
1758 my $pkgpart = $old_opt->pkgpart;
1759 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1761 my $error = $old_opt->delete;
1762 die $error if $error;
1764 if ( exists($newopts{$pkgpart}) ) {
1765 my $opt = $newopts{$pkgpart};
1766 $opt->optionvalue($opt->optionvalue.",$newval");
1767 $error = $opt->replace;
1768 die $error if $error;
1770 my $new_opt = new FS::part_pkg_option {
1771 'pkgpart' => $pkgpart,
1772 'optionname' => 'disposition_in',
1773 'optionvalue' => $newval,
1775 $error = $new_opt->insert;
1776 die $error if $error;
1777 $newopts{$pkgpart} = $new_opt;
1781 # set any package with FCC voice lines to the "VoIP with broadband" category
1782 # for backward compatibility
1784 # recover from a bad upgrade bug
1785 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1786 if (!FS::upgrade_journal->is_done($upgrade)) {
1787 my $bad_upgrade = qsearchs('upgrade_journal',
1788 { upgrade => 'part_pkg_fcc_voip_class' }
1790 if ( $bad_upgrade ) {
1791 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1792 ' AND history_date > '.($bad_upgrade->_date - 3600);
1793 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1796 'table' => 'h_part_pkg_option',
1798 'extra_sql' => "$where AND history_action = 'delete'",
1799 'order_by' => 'ORDER BY history_date ASC',
1801 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1804 'table' => 'h_pkg_svc',
1806 'extra_sql' => "$where AND history_action = 'replace_old'",
1807 'order_by' => 'ORDER BY history_date ASC',
1810 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1811 my $pkgpart ||= $deleted->pkgpart;
1812 $opt{$pkgpart} ||= {
1818 if ( $deleted->isa('FS::part_pkg_option') ) {
1819 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1821 my $svcpart = $deleted->svcpart;
1822 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1823 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1824 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1827 foreach my $pkgpart (keys %opt) {
1828 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1829 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1831 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1834 } # $bad_upgrade exists
1835 else { # do the original upgrade, but correctly this time
1836 @part_pkg = qsearch('part_pkg', {
1837 fcc_ds0s => { op => '>', value => 0 },
1838 fcc_voip_class => ''
1840 foreach my $part_pkg (@part_pkg) {
1841 $part_pkg->set(fcc_voip_class => 2);
1842 my @pkg_svc = $part_pkg->pkg_svc;
1843 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1844 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1845 my $error = $part_pkg->replace(
1846 $part_pkg->replace_old,
1847 options => { $part_pkg->options },
1848 pkg_svc => \%quantity,
1849 hidden_svc => \%hidden,
1850 primary_svc => ($part_pkg->svcpart || ''),
1852 die $error if $error;
1855 FS::upgrade_journal->set_done($upgrade);
1860 =item curuser_pkgs_sql
1862 Returns an SQL fragment for searching for packages the current user can
1863 use, either via part_pkg.agentnum directly, or via agent type (see
1868 sub curuser_pkgs_sql {
1871 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1875 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1877 Returns an SQL fragment for searching for packages the provided agent or agents
1878 can use, either via part_pkg.agentnum directly, or via agent type (see
1883 sub agent_pkgs_sql {
1884 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1885 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1887 $class->_pkgs_sql(@agentnums); #is this why
1892 my( $class, @agentnums ) = @_;
1893 my $agentnums = join(',', @agentnums);
1897 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1898 OR ( agentnum IS NULL
1899 AND EXISTS ( SELECT 1
1901 LEFT JOIN agent_type USING ( typenum )
1902 LEFT JOIN agent AS typeagent USING ( typenum )
1903 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1904 AND typeagent.agentnum IN ($agentnums)
1922 #false laziness w/part_export & cdr
1924 foreach my $INC ( @INC ) {
1925 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1926 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1927 warn "attempting to load plan info from $file\n" if $DEBUG;
1928 $file =~ /\/(\w+)\.pm$/ or do {
1929 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1933 my $info = eval "use FS::part_pkg::$mod; ".
1934 "\\%FS::part_pkg::$mod\::info;";
1936 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1939 unless ( keys %$info ) {
1940 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1943 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1944 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1945 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1948 $info{$mod} = $info;
1949 $info->{'weight'} ||= 0; # quiet warnings
1953 # copy one level deep to allow replacement of fields and fieldorder
1954 tie %plans, 'Tie::IxHash',
1955 map { my %infohash = %{ $info{$_} };
1957 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1960 # inheritance of plan options
1961 foreach my $name (keys(%info)) {
1962 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1963 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1964 delete $plans{$name};
1967 my $parents = $info{$name}->{'inherit_fields'} || [];
1968 my (%fields, %field_exists, @fieldorder);
1969 foreach my $parent ($name, @$parents) {
1970 if ( !exists($info{$parent}) ) {
1971 warn "$name tried to inherit from nonexistent '$parent'\n";
1974 %fields = ( # avoid replacing existing fields
1975 %{ $info{$parent}->{'fields'} || {} },
1978 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1980 next if $field_exists{$_};
1981 $field_exists{$_} = 1;
1982 # allow inheritors to remove inherited fields from the fieldorder
1983 push @fieldorder, $_ if !exists($fields{$_}) or
1984 !exists($fields{$_}->{'disabled'});
1987 $plans{$name}->{'fields'} = \%fields;
1988 $plans{$name}->{'fieldorder'} = \@fieldorder;
1998 =head1 NEW PLAN CLASSES
2000 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
2001 found in eg/plan_template.pm. Until then, it is suggested that you use the
2002 other modules in FS/FS/part_pkg/ as a guide.
2006 The delete method is unimplemented.
2008 setup and recur semantics are not yet defined (and are implemented in
2009 FS::cust_bill. hmm.). now they're deprecated and need to go.
2013 part_pkg_taxrate is Pg specific
2015 replace should be smarter about managing the related tables (options, pkg_svc)
2019 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
2020 schema.html from the base documentation.