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 );
8 use Time::Local qw( timelocal_nocheck );
11 use FS::Record qw( qsearch qsearchs dbh dbdef );
17 use FS::part_pkg_option;
20 use FS::part_pkg_msgcat;
21 use FS::part_pkg_taxrate;
22 use FS::part_pkg_taxoverride;
23 use FS::part_pkg_taxproduct;
24 use FS::part_pkg_link;
25 use FS::part_pkg_discount;
26 use FS::part_pkg_usage;
27 use FS::part_pkg_vendor;
31 $skip_pkg_svc_hack = 0;
35 FS::part_pkg - Object methods for part_pkg objects
41 $record = new FS::part_pkg \%hash
42 $record = new FS::part_pkg { 'column' => 'value' };
44 $custom_record = $template_record->clone;
46 $error = $record->insert;
48 $error = $new_record->replace($old_record);
50 $error = $record->delete;
52 $error = $record->check;
54 @pkg_svc = $record->pkg_svc;
56 $svcnum = $record->svcpart;
57 $svcnum = $record->svcpart( 'svc_acct' );
61 An FS::part_pkg object represents a package definition. FS::part_pkg
62 inherits from FS::Record. The following fields are currently supported:
66 =item pkgpart - primary key (assigned automatically for new package definitions)
68 =item pkg - Text name of this package definition (customer-viewable)
70 =item comment - Text name of this package definition (non-customer-viewable)
72 =item classnum - Optional package class (see L<FS::pkg_class>)
74 =item promo_code - Promotional code
76 =item setup - Setup fee expression (deprecated)
78 =item freq - Frequency of recurring fee
80 =item recur - Recurring fee expression (deprecated)
82 =item setuptax - Setup fee tax exempt flag, empty or `Y'
84 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
86 =item taxclass - Tax class
88 =item plan - Price plan
90 =item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
92 =item disabled - Disabled flag, empty or `Y'
94 =item custom - Custom flag, empty or `Y'
96 =item setup_cost - for cost tracking
98 =item recur_cost - for cost tracking
100 =item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items.
102 =item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items.
104 =item agentnum - Optional agentnum (see L<FS::agent>)
106 =item fcc_ds0s - Optional DS0 equivalency number for FCC form 477
108 =item fcc_voip_class - Which column of FCC form 477 part II.B this package
111 =item successor - Foreign key for the part_pkg that replaced this record.
112 If this record is not obsolete, will be null.
114 =item family_pkgpart - Foreign key for the part_pkg that was the earliest
115 ancestor of this record. If this record is not a successor to another
116 part_pkg, will be equal to pkgpart.
126 Creates a new package definition. To add the package definition to
127 the database, see L<"insert">.
131 sub table { 'part_pkg'; }
135 An alternate constructor. Creates a new package definition by duplicating
136 an existing definition. A new pkgpart is assigned and the custom flag is
137 set to Y. To add the package definition to the database, see L<"insert">.
143 my $class = ref($self);
144 my %hash = $self->hash;
145 $hash{'pkgpart'} = '';
146 $hash{'custom'} = 'Y';
147 #new FS::part_pkg ( \%hash ); # ?
148 new $class ( \%hash ); # ?
151 =item insert [ , OPTION => VALUE ... ]
153 Adds this package definition to the database. If there is an error,
154 returns the error, otherwise returns false.
156 Currently available options are: I<pkg_svc>, I<primary_svc>, I<cust_pkg>,
157 I<custnum_ref> and I<options>.
159 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
160 values, appropriate FS::pkg_svc records will be inserted. I<hidden_svc> can
161 be set to a hashref of svcparts and flag values ('Y' or '') to set the
162 'hidden' field in these records.
164 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
165 FS::pkg_svc record will be updated.
167 If I<cust_pkg> is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg
168 record itself), the object will be updated to point to this package definition.
170 In conjunction with I<cust_pkg>, if I<custnum_ref> is set to a scalar reference,
171 the scalar will be updated with the custnum value from the cust_pkg record.
173 If I<tax_overrides> is set to a hashref with usage classes as keys and comma
174 separated tax class numbers as values, appropriate FS::part_pkg_taxoverride
175 records will be inserted.
177 If I<options> is set to a hashref of options, appropriate FS::part_pkg_option
178 records will be inserted.
185 warn "FS::part_pkg::insert called on $self with options ".
186 join(', ', map "$_=>$options{$_}", keys %options)
189 local $SIG{HUP} = 'IGNORE';
190 local $SIG{INT} = 'IGNORE';
191 local $SIG{QUIT} = 'IGNORE';
192 local $SIG{TERM} = 'IGNORE';
193 local $SIG{TSTP} = 'IGNORE';
194 local $SIG{PIPE} = 'IGNORE';
196 my $oldAutoCommit = $FS::UID::AutoCommit;
197 local $FS::UID::AutoCommit = 0;
200 warn " inserting part_pkg record" if $DEBUG;
201 my $error = $self->SUPER::insert( $options{options} );
203 $dbh->rollback if $oldAutoCommit;
208 if ( $self->get('family_pkgpart') eq '' ) {
209 $self->set('family_pkgpart' => $self->pkgpart);
210 $error = $self->SUPER::replace;
212 $dbh->rollback if $oldAutoCommit;
217 my $conf = new FS::Conf;
218 if ( $conf->exists('agent_defaultpkg') ) {
219 warn " agent_defaultpkg set; allowing all agents to purchase package"
221 foreach my $agent_type ( qsearch('agent_type', {} ) ) {
222 my $type_pkgs = new FS::type_pkgs({
223 'typenum' => $agent_type->typenum,
224 'pkgpart' => $self->pkgpart,
226 my $error = $type_pkgs->insert;
228 $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 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
260 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
262 ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart )
266 my $pkg_svc = new FS::pkg_svc( {
267 'pkgpart' => $self->pkgpart,
268 'svcpart' => $part_svc->svcpart,
269 'quantity' => $quantity,
270 'primary_svc' => $primary_svc,
271 'hidden' => $hidden_svc->{$part_svc->svcpart},
273 my $error = $pkg_svc->insert;
275 $dbh->rollback if $oldAutoCommit;
282 if ( $options{'cust_pkg'} ) {
283 warn " updating cust_pkg record " if $DEBUG;
285 ref($options{'cust_pkg'})
286 ? $options{'cust_pkg'}
287 : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } );
288 ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum
289 if $options{'custnum_ref'};
290 my %hash = $old_cust_pkg->hash;
291 $hash{'pkgpart'} = $self->pkgpart,
292 my $new_cust_pkg = new FS::cust_pkg \%hash;
293 local($FS::cust_pkg::disable_agentcheck) = 1;
294 my $error = $new_cust_pkg->replace($old_cust_pkg);
296 $dbh->rollback if $oldAutoCommit;
297 return "Error modifying cust_pkg record: $error";
301 if ( $options{'part_pkg_vendor'} ) {
302 while ( my ($exportnum, $vendor_pkg_id) =
303 each %{ $options{part_pkg_vendor} }
306 my $ppv = new FS::part_pkg_vendor( {
307 'pkgpart' => $self->pkgpart,
308 'exportnum' => $exportnum,
309 'vendor_pkg_id' => $vendor_pkg_id,
311 my $error = $ppv->insert;
313 $dbh->rollback if $oldAutoCommit;
314 return "Error inserting part_pkg_vendor record: $error";
319 warn " committing transaction" if $DEBUG and $oldAutoCommit;
320 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
327 Currently unimplemented.
332 return "Can't (yet?) delete package definitions.";
333 # check & make sure the pkgpart isn't in cust_pkg or type_pkgs?
336 =item replace OLD_RECORD [ , OPTION => VALUE ... ]
338 Replaces OLD_RECORD with this one in the database. If there is an error,
339 returns the error, otherwise returns false.
341 Currently available options are: I<pkg_svc>, I<hidden_svc>, I<primary_svc>
344 If I<pkg_svc> is set to a hashref with svcparts as keys and quantities as
345 values, the appropriate FS::pkg_svc records will be replaced. I<hidden_svc>
346 can be set to a hashref of svcparts and flag values ('Y' or '') to set the
347 'hidden' field in these records.
349 If I<primary_svc> is set to the svcpart of the primary service, the appropriate
350 FS::pkg_svc record will be updated.
352 If I<options> is set to a hashref, the appropriate FS::part_pkg_option records
360 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
365 ( ref($_[0]) eq 'HASH' )
369 $options->{options} = { $old->options } unless defined($options->{options});
371 warn "FS::part_pkg::replace called on $new to replace $old with options".
372 join(', ', map "$_ => ". $options->{$_}, keys %$options)
375 local $SIG{HUP} = 'IGNORE';
376 local $SIG{INT} = 'IGNORE';
377 local $SIG{QUIT} = 'IGNORE';
378 local $SIG{TERM} = 'IGNORE';
379 local $SIG{TSTP} = 'IGNORE';
380 local $SIG{PIPE} = 'IGNORE';
382 my $oldAutoCommit = $FS::UID::AutoCommit;
383 local $FS::UID::AutoCommit = 0;
386 my $conf = new FS::Conf;
387 if ( $conf->exists('part_pkg-lineage') ) {
388 if ( grep { $options->{options}->{$_} ne $old->option($_, 1) }
389 qw(setup_fee recur_fee) #others? config?
392 warn " superseding package" if $DEBUG;
394 my $error = $new->supersede($old, %$options);
396 $dbh->rollback if $oldAutoCommit;
400 warn " committing transaction" if $DEBUG and $oldAutoCommit;
401 $dbh->commit if $oldAutoCommit;
408 #plandata shit stays in replace for upgrades until after 2.0 (or edit
410 warn " saving legacy plandata" if $DEBUG;
411 my $plandata = $new->get('plandata');
412 $new->set('plandata', '');
414 warn " deleting old part_pkg_option records" if $DEBUG;
415 foreach my $part_pkg_option ( $old->part_pkg_option ) {
416 my $error = $part_pkg_option->delete;
418 $dbh->rollback if $oldAutoCommit;
423 warn " replacing part_pkg record" if $DEBUG;
424 my $error = $new->SUPER::replace($old, $options->{options} );
426 $dbh->rollback if $oldAutoCommit;
430 warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG;
431 foreach my $part_pkg_option (
432 map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
433 return "illegal plandata: $plandata";
435 new FS::part_pkg_option {
436 'pkgpart' => $new->pkgpart,
441 split("\n", $plandata)
443 my $error = $part_pkg_option->insert;
445 $dbh->rollback if $oldAutoCommit;
450 warn " replacing pkg_svc records" if $DEBUG;
451 my $pkg_svc = $options->{'pkg_svc'};
452 my $hidden_svc = $options->{'hidden_svc'} || {};
453 if ( $pkg_svc ) { # if it wasn't passed, don't change existing pkg_svcs
454 foreach my $part_svc ( qsearch('part_svc', {} ) ) {
455 my $quantity = $pkg_svc->{$part_svc->svcpart} || 0;
456 my $hidden = $hidden_svc->{$part_svc->svcpart} || '';
458 ( defined($options->{'primary_svc'}) && $options->{'primary_svc'}
459 && $options->{'primary_svc'} == $part_svc->svcpart
464 my $old_pkg_svc = qsearchs('pkg_svc', {
465 'pkgpart' => $old->pkgpart,
466 'svcpart' => $part_svc->svcpart,
469 my $old_quantity = 0;
470 my $old_primary_svc = '';
472 if ( $old_pkg_svc ) {
473 $old_quantity = $old_pkg_svc->quantity;
474 $old_primary_svc = $old_pkg_svc->primary_svc
475 if $old_pkg_svc->dbdef_table->column('primary_svc'); # is this needed?
476 $old_hidden = $old_pkg_svc->hidden;
479 next unless $old_quantity != $quantity ||
480 $old_primary_svc ne $primary_svc ||
481 $old_hidden ne $hidden;
483 my $new_pkg_svc = new FS::pkg_svc( {
484 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ),
485 'pkgpart' => $new->pkgpart,
486 'svcpart' => $part_svc->svcpart,
487 'quantity' => $quantity,
488 'primary_svc' => $primary_svc,
491 my $error = $old_pkg_svc
492 ? $new_pkg_svc->replace($old_pkg_svc)
493 : $new_pkg_svc->insert;
495 $dbh->rollback if $oldAutoCommit;
499 } #if $options->{pkg_svc}
501 my @part_pkg_vendor = $old->part_pkg_vendor;
502 my @current_exportnum = ();
503 if ( $options->{'part_pkg_vendor'} ) {
504 my($exportnum,$vendor_pkg_id);
505 while ( ($exportnum,$vendor_pkg_id)
506 = each %{$options->{'part_pkg_vendor'}} ) {
508 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
509 if($exportnum == $part_pkg_vendor->exportnum
510 && $vendor_pkg_id ne $part_pkg_vendor->vendor_pkg_id) {
511 $part_pkg_vendor->vendor_pkg_id($vendor_pkg_id);
512 my $error = $part_pkg_vendor->replace;
514 $dbh->rollback if $oldAutoCommit;
515 return "Error replacing part_pkg_vendor record: $error";
520 elsif($exportnum == $part_pkg_vendor->exportnum
521 && $vendor_pkg_id eq $part_pkg_vendor->vendor_pkg_id) {
526 unless ( $noinsert ) {
527 my $ppv = new FS::part_pkg_vendor( {
528 'pkgpart' => $new->pkgpart,
529 'exportnum' => $exportnum,
530 'vendor_pkg_id' => $vendor_pkg_id,
532 my $error = $ppv->insert;
534 $dbh->rollback if $oldAutoCommit;
535 return "Error inserting part_pkg_vendor record: $error";
538 push @current_exportnum, $exportnum;
541 foreach my $part_pkg_vendor ( @part_pkg_vendor ) {
542 unless ( grep($_ eq $part_pkg_vendor->exportnum, @current_exportnum) ) {
543 my $error = $part_pkg_vendor->delete;
545 $dbh->rollback if $oldAutoCommit;
546 return "Error deleting part_pkg_vendor record: $error";
551 # propagate changes to certain core fields
552 if ( $conf->exists('part_pkg-lineage') ) {
553 warn " propagating changes to family" if $DEBUG;
554 my $error = $new->propagate($old);
556 $dbh->rollback if $oldAutoCommit;
561 warn " committing transaction" if $DEBUG and $oldAutoCommit;
562 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
568 Checks all fields to make sure this is a valid package definition. If
569 there is an error, returns the error, otherwise returns false. Called by the
570 insert and replace methods.
576 warn "FS::part_pkg::check called on $self" if $DEBUG;
578 for (qw(setup recur plandata)) {
579 #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
580 return "Use of $_ field is deprecated; set a plan and options: ".
582 if length($self->get($_));
586 if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
587 my $error = $self->ut_number('freq');
588 return $error if $error;
590 $self->freq =~ /^(\d+[hdw]?)$/
591 or return "Illegal or empty freq: ". $self->freq;
595 my @null_agentnum_right = ( 'Edit global package definitions' );
596 push @null_agentnum_right, 'One-time charge'
597 if $self->freq =~ /^0/;
598 push @null_agentnum_right, 'Customize customer package'
599 if $self->disabled eq 'Y'; #good enough
601 my $error = $self->ut_numbern('pkgpart')
602 || $self->ut_text('pkg')
603 || $self->ut_text('comment')
604 || $self->ut_textn('promo_code')
605 || $self->ut_alphan('plan')
606 || $self->ut_enum('setuptax', [ '', 'Y' ] )
607 || $self->ut_enum('recurtax', [ '', 'Y' ] )
608 || $self->ut_textn('taxclass')
609 || $self->ut_enum('disabled', [ '', 'Y' ] )
610 || $self->ut_enum('custom', [ '', 'Y' ] )
611 || $self->ut_enum('no_auto', [ '', 'Y' ])
612 || $self->ut_enum('recur_show_zero', [ '', 'Y' ])
613 || $self->ut_enum('setup_show_zero', [ '', 'Y' ])
614 #|| $self->ut_moneyn('setup_cost')
615 #|| $self->ut_moneyn('recur_cost')
616 || $self->ut_floatn('setup_cost')
617 || $self->ut_floatn('recur_cost')
618 || $self->ut_floatn('pay_weight')
619 || $self->ut_floatn('credit_weight')
620 || $self->ut_numbern('taxproductnum')
621 || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
622 || $self->ut_foreign_keyn('addon_classnum', 'pkg_class', 'classnum')
623 || $self->ut_foreign_keyn('taxproductnum',
624 'part_pkg_taxproduct',
628 ? $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' )
629 : $self->ut_agentnum_acl('agentnum', \@null_agentnum_right)
631 || $self->ut_numbern('fcc_ds0s')
632 || $self->ut_numbern('fcc_voip_class')
633 || $self->ut_foreign_keyn('successor', 'part_pkg', 'pkgpart')
634 || $self->ut_foreign_keyn('family_pkgpart', 'part_pkg', 'pkgpart')
635 || $self->SUPER::check
637 return $error if $error;
639 return 'Unknown plan '. $self->plan
640 unless exists($plans{$self->plan});
642 my $conf = new FS::Conf;
643 return 'Taxclass is required'
644 if ! $self->taxclass && $conf->exists('require_taxclasses');
649 =item supersede OLD [, OPTION => VALUE ... ]
651 Inserts this package as a successor to the package OLD. All options are as
652 for C<insert>. After inserting, disables OLD and sets the new package as its
658 my ($new, $old, %options) = @_;
661 $new->set('pkgpart' => '');
662 $new->set('family_pkgpart' => $old->family_pkgpart);
663 warn " inserting successor package\n" if $DEBUG;
664 $error = $new->insert(%options);
665 return $error if $error;
667 warn " disabling superseded package\n" if $DEBUG;
668 $old->set('successor' => $new->pkgpart);
669 $old->set('disabled' => 'Y');
670 $error = $old->SUPER::replace; # don't change its options/pkg_svc records
671 return $error if $error;
673 warn " propagating changes to family" if $DEBUG;
674 $new->propagate($old);
679 If any of certain fields have changed from OLD to this package, then,
680 for all packages in the same lineage as this one, sets those fields
681 to their values in this package.
685 my @propagate_fields = (
686 qw( pkg classnum setup_cost recur_cost taxclass
687 setuptax recurtax pay_weight credit_weight
695 map { $_ => $new->get($_) }
696 grep { $new->get($_) ne $old->get($_) }
700 my @part_pkg = qsearch('part_pkg', {
701 'family_pkgpart' => $new->family_pkgpart
704 foreach my $part_pkg ( @part_pkg ) {
705 my $pkgpart = $part_pkg->pkgpart;
706 next if $pkgpart == $new->pkgpart; # don't modify $new
707 warn " propagating to pkgpart $pkgpart\n" if $DEBUG;
708 foreach ( keys %fields ) {
709 $part_pkg->set($_, $fields{$_});
711 # SUPER::replace to avoid changing non-core fields
712 my $error = $part_pkg->SUPER::replace;
713 push @error, "pkgpart $pkgpart: $error"
719 =item pkg_locale LOCALE
721 Returns a customer-viewable string representing this package for the given
722 locale, from the part_pkg_msgcat table. If the given locale is empty or no
723 localized string is found, returns the base pkg field.
728 my( $self, $locale ) = @_;
729 return $self->pkg unless $locale;
730 my $part_pkg_msgcat = $self->part_pkg_msgcat($locale) or return $self->pkg;
731 $part_pkg_msgcat->pkg;
734 =item part_pkg_msgcat LOCALE
736 Like pkg_locale, but returns the FS::part_pkg_msgcat object itself.
740 sub part_pkg_msgcat {
741 my( $self, $locale ) = @_;
742 qsearchs( 'part_pkg_msgcat', {
743 pkgpart => $self->pkgpart,
748 =item pkg_comment [ OPTION => VALUE... ]
750 Returns an (internal) string representing this package. Currently,
751 "pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the
752 future, omitting pkgpart. The comment will have '(CUSTOM) ' prepended if
755 If the option nopkgpart is true then the "pkgpart: ' is omitted.
763 #$self->pkg. ' - '. $self->comment;
764 #$self->pkg. ' ('. $self->comment. ')';
765 my $pre = $opt{nopkgpart} ? '' : $self->pkgpart. ': ';
766 $pre. $self->pkg. ' - '. $self->custom_comment;
769 sub price_info { # safety, in case a part_pkg hasn't defined price_info
775 ( $self->custom ? '(CUSTOM) ' : '' ). $self->comment . ' ' . $self->price_info;
780 Returns the package class, as an FS::pkg_class object, or the empty string
781 if there is no package class.
787 if ( $self->classnum ) {
788 qsearchs('pkg_class', { 'classnum' => $self->classnum } );
794 =item addon_pkg_class
796 Returns the add-on package class, as an FS::pkg_class object, or the empty
797 string if there is no add-on package class.
801 sub addon_pkg_class {
803 if ( $self->addon_classnum ) {
804 qsearchs('pkg_class', { 'classnum' => $self->addon_classnum } );
812 Returns the package category name, or the empty string if there is no package
819 my $pkg_class = $self->pkg_class;
821 ? $pkg_class->categoryname
827 Returns the package class name, or the empty string if there is no package
834 my $pkg_class = $self->pkg_class;
836 ? $pkg_class->classname
840 =item addon_classname
842 Returns the add-on package class name, or the empty string if there is no
843 add-on package class.
847 sub addon_classname {
849 my $pkg_class = $self->addon_pkg_class;
851 ? $pkg_class->classname
857 Returns the associated agent for this event, if any, as an FS::agent object.
863 qsearchs('agent', { 'agentnum' => $self->agentnum } );
866 =item pkg_svc [ HASHREF | OPTION => VALUE ]
868 Returns all FS::pkg_svc objects (see L<FS::pkg_svc>) for this package
869 definition (with non-zero quantity).
871 One option is available, I<disable_linked>. If set true it will return the
872 services for this package definition alone, omitting services from any add-on
879 Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this package
886 qsearch('type_pkgs', { 'pkgpart' => $self->pkgpart } );
892 # #sort { $b->primary cmp $a->primary }
893 # grep { $_->quantity }
894 # qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
896 my $opt = ref($_[0]) ? $_[0] : { @_ };
897 my %pkg_svc = map { $_->svcpart => $_ }
898 grep { $_->quantity }
899 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
901 unless ( $opt->{disable_linked} ) {
902 foreach my $dst_pkg ( map $_->dst_pkg, $self->svc_part_pkg_link ) {
903 my @pkg_svc = grep { $_->quantity }
904 qsearch( 'pkg_svc', { pkgpart=>$dst_pkg->pkgpart } );
905 foreach my $pkg_svc ( @pkg_svc ) {
906 if ( $pkg_svc{$pkg_svc->svcpart} ) {
907 my $quantity = $pkg_svc{$pkg_svc->svcpart}->quantity;
908 $pkg_svc{$pkg_svc->svcpart}->quantity($quantity + $pkg_svc->quantity);
910 $pkg_svc{$pkg_svc->svcpart} = $pkg_svc;
920 =item svcpart [ SVCDB ]
922 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
923 associated with this package definition (see L<FS::pkg_svc>). Returns
924 false if there not a primary service definition or exactly one service
925 definition with quantity 1, or if SVCDB is specified and does not match the
926 svcdb of the service definition. SVCDB can be specified as a scalar table
927 name, such as 'svc_acct', or as an arrayref of possible table names.
932 my $pkg_svc = shift->_primary_pkg_svc(@_);
933 $pkg_svc ? $pkg_svc->svcpart : '';
936 =item part_svc [ SVCDB ]
938 Like the B<svcpart> method, but returns the FS::part_svc object (see
944 my $pkg_svc = shift->_primary_pkg_svc(@_);
945 $pkg_svc ? $pkg_svc->part_svc : '';
948 sub _primary_pkg_svc {
951 my $svcdb = scalar(@_) ? shift : [];
952 $svcdb = ref($svcdb) ? $svcdb : [ $svcdb ];
953 my %svcdb = map { $_=>1 } @$svcdb;
956 grep { !scalar(@$svcdb) || $svcdb{ $_->part_svc->svcdb } }
959 my @pkg_svc = grep { $_->primary_svc =~ /^Y/i } @svcdb_pkg_svc;
960 @pkg_svc = grep {$_->quantity == 1 } @svcdb_pkg_svc
962 return '' if scalar(@pkg_svc) != 1;
966 =item svcpart_unique_svcdb SVCDB
968 Returns the svcpart of a service definition (see L<FS::part_svc>) matching
969 SVCDB associated with this package definition (see L<FS::pkg_svc>). Returns
970 false if there not a primary service definition for SVCDB or there are multiple
971 service definitions for SVCDB.
975 sub svcpart_unique_svcdb {
976 my( $self, $svcdb ) = @_;
977 my @svcdb_pkg_svc = grep { ( $svcdb eq $_->part_svc->svcdb ) } $self->pkg_svc;
978 return '' if scalar(@svcdb_pkg_svc) != 1;
979 $svcdb_pkg_svc[0]->svcpart;
984 Returns a list of the acceptable payment types for this package. Eventually
985 this should come out of a database table and be editable, but currently has the
986 following logic instead:
988 If the package is free, the single item B<BILL> is
989 returned, otherwise, the single item B<CARD> is returned.
991 (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse)
997 if ( $self->is_free ) {
1006 Returns true if this package is free.
1012 if ( $self->can('is_free_options') ) {
1013 not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ }
1014 map { $self->option($_) }
1015 $self->is_free_options;
1017 warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ".
1018 "provides neither is_free_options nor is_free method; returning false";
1023 sub can_discount { 0; }
1025 sub can_start_date { 1; }
1028 # moved to FS::Misc to make this accessible to other packages
1030 FS::Misc::pkg_freqs();
1035 Returns an english representation of the I<freq> field, such as "monthly",
1036 "weekly", "semi-annually", etc.
1042 my $freq = $self->freq;
1044 #my $freqs_href = $self->freqs_href;
1045 my $freqs_href = freqs_href();
1047 if ( exists($freqs_href->{$freq}) ) {
1048 $freqs_href->{$freq};
1050 my $interval = 'month';
1051 if ( $freq =~ /^(\d+)([hdw])$/ ) {
1052 my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' );
1053 $interval = $interval{$2};
1058 "every $freq ${interval}s";
1063 =item add_freq TIMESTAMP [ FREQ ]
1065 Adds a billing period of some frequency to the provided timestamp and
1066 returns the resulting timestamp, or -1 if the frequency could not be
1067 parsed (shouldn't happen). By default, the frequency of this package
1068 will be used; to override this, pass a different frequency as a second
1074 my( $self, $date, $freq ) = @_;
1075 $freq = $self->freq unless $freq;
1077 #change this bit to use Date::Manip? CAREFUL with timezones (see
1078 # mailing list archive)
1079 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($date) )[0,1,2,3,4,5];
1081 if ( $freq =~ /^\d+$/ ) {
1083 until ( $mon < 12 ) { $mon -= 12; $year++; }
1085 $mday = 28 if $mday > 28 && FS::Conf->new->exists('anniversary-rollback');
1087 } elsif ( $freq =~ /^(\d+)w$/ ) {
1089 $mday += $weeks * 7;
1090 } elsif ( $freq =~ /^(\d+)d$/ ) {
1093 } elsif ( $freq =~ /^(\d+)h$/ ) {
1100 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year);
1105 For backwards compatibility, returns the plandata field as well as all options
1106 from FS::part_pkg_option.
1112 carp "plandata is deprecated";
1114 $self->SUPER::plandata(@_);
1116 my $plandata = $self->get('plandata');
1117 my %options = $self->options;
1118 $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
1123 =item part_pkg_vendor
1125 Returns all vendor/external package ids as FS::part_pkg_vendor objects (see
1126 L<FS::part_pkg_vendor>).
1130 sub part_pkg_vendor {
1132 qsearch('part_pkg_vendor', { 'pkgpart' => $self->pkgpart } );
1135 =item vendor_pkg_ids
1137 Returns a list of vendor/external package ids by exportnum
1141 sub vendor_pkg_ids {
1143 map { $_->exportnum => $_->vendor_pkg_id } $self->part_pkg_vendor;
1146 =item part_pkg_option
1148 Returns all options as FS::part_pkg_option objects (see
1149 L<FS::part_pkg_option>).
1153 sub part_pkg_option {
1155 qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
1160 Returns a list of option names and values suitable for assigning to a hash.
1166 map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
1169 =item option OPTIONNAME [ QUIET ]
1171 Returns the option value for the given name, or the empty string. If a true
1172 value is passed as the second argument, warnings about missing the option
1178 my( $self, $opt, $ornull ) = @_;
1179 my $part_pkg_option =
1180 qsearchs('part_pkg_option', {
1181 pkgpart => $self->pkgpart,
1184 return $part_pkg_option->optionvalue if $part_pkg_option;
1185 my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); }
1186 split("\n", $self->get('plandata') );
1187 return $plandata{$opt} if exists $plandata{$opt};
1188 cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ".
1189 "not found in options or plandata!\n"
1194 =item bill_part_pkg_link
1196 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1200 sub bill_part_pkg_link {
1201 shift->_part_pkg_link('bill', @_);
1204 =item svc_part_pkg_link
1206 Returns the associated part_pkg_link records (see L<FS::part_pkg_link>).
1210 sub svc_part_pkg_link {
1211 shift->_part_pkg_link('svc', @_);
1214 =item supp_part_pkg_link
1216 Returns the associated part_pkg_link records of type 'supp' (supplemental
1221 sub supp_part_pkg_link {
1222 shift->_part_pkg_link('supp', @_);
1225 sub _part_pkg_link {
1226 my( $self, $type ) = @_;
1227 qsearch({ table => 'part_pkg_link',
1228 hashref => { 'src_pkgpart' => $self->pkgpart,
1229 'link_type' => $type,
1230 #protection against infinite recursive links
1231 'dst_pkgpart' => { op=>'!=', value=> $self->pkgpart },
1233 order_by => "ORDER BY hidden",
1237 sub self_and_bill_linked {
1238 shift->_self_and_linked('bill', @_);
1241 sub self_and_svc_linked {
1242 shift->_self_and_linked('svc', @_);
1245 sub _self_and_linked {
1246 my( $self, $type, $hidden ) = @_;
1250 foreach ( ( $self, map { $_->dst_pkg->_self_and_linked($type, $_->hidden) }
1251 $self->_part_pkg_link($type) ) )
1253 $_->hidden($hidden) if $hidden;
1260 =item part_pkg_taxoverride [ CLASS ]
1262 Returns all associated FS::part_pkg_taxoverride objects (see
1263 L<FS::part_pkg_taxoverride>). Limits the returned set to those
1264 of class CLASS if defined. Class may be one of 'setup', 'recur',
1265 the empty string (default), or a usage class number (see L<FS::usage_class>).
1266 When a class is specified, the empty string class (default) is returned
1267 if no more specific values exist.
1271 sub part_pkg_taxoverride {
1275 my $hashref = { 'pkgpart' => $self->pkgpart };
1276 $hashref->{'usage_class'} = $class if defined($class);
1277 my @overrides = qsearch('part_pkg_taxoverride', $hashref );
1279 unless ( scalar(@overrides) || !defined($class) || !$class ){
1280 $hashref->{'usage_class'} = '';
1281 @overrides = qsearch('part_pkg_taxoverride', $hashref );
1287 =item has_taxproduct
1289 Returns true if this package has any taxproduct associated with it.
1293 sub has_taxproduct {
1296 $self->taxproductnum ||
1297 scalar( grep { $_ =~/^usage_taxproductnum_/ && $self->option($_) }
1298 keys %{ {$self->options} }
1304 =item taxproduct [ CLASS ]
1306 Returns the associated tax product for this package definition (see
1307 L<FS::part_pkg_taxproduct>). CLASS may be one of 'setup', 'recur' or
1308 the usage classnum (see L<FS::usage_class>). Returns the default
1309 tax product for this record if the more specific CLASS value does
1318 my $part_pkg_taxproduct;
1320 my $taxproductnum = $self->taxproductnum;
1322 my $class_taxproductnum = $self->option("usage_taxproductnum_$class", 1);
1323 $taxproductnum = $class_taxproductnum
1324 if $class_taxproductnum
1327 $part_pkg_taxproduct =
1328 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1330 unless ($part_pkg_taxproduct || $taxproductnum eq $self->taxproductnum ) {
1331 $taxproductnum = $self->taxproductnum;
1332 $part_pkg_taxproduct =
1333 qsearchs( 'part_pkg_taxproduct', { 'taxproductnum' => $taxproductnum } );
1336 $part_pkg_taxproduct;
1339 =item taxproduct_description [ CLASS ]
1341 Returns the description of the associated tax product for this package
1342 definition (see L<FS::part_pkg_taxproduct>).
1346 sub taxproduct_description {
1348 my $part_pkg_taxproduct = $self->taxproduct(@_);
1349 $part_pkg_taxproduct ? $part_pkg_taxproduct->description : '';
1352 =item part_pkg_taxrate DATA_PROVIDER, GEOCODE, [ CLASS ]
1354 Returns the package to taxrate m2m records for this package in the location
1355 specified by GEOCODE (see L<FS::part_pkg_taxrate>) and usage class CLASS.
1356 CLASS may be one of 'setup', 'recur', or one of the usage classes numbers
1357 (see L<FS::usage_class>).
1361 sub _expand_cch_taxproductnum {
1364 my $part_pkg_taxproduct = $self->taxproduct($class);
1366 my ($a,$b,$c,$d) = ( $part_pkg_taxproduct
1367 ? ( split ':', $part_pkg_taxproduct->taxproduct )
1370 $a = '' unless $a; $b = '' unless $b; $c = '' unless $c; $d = '' unless $d;
1371 my $extra_sql = "AND ( taxproduct = '$a:$b:$c:$d'
1372 OR taxproduct = '$a:$b:$c:'
1373 OR taxproduct = '$a:$b:".":$d'
1374 OR taxproduct = '$a:$b:".":' )";
1375 map { $_->taxproductnum } qsearch( { 'table' => 'part_pkg_taxproduct',
1376 'hashref' => { 'data_vendor'=>'cch' },
1377 'extra_sql' => $extra_sql,
1382 sub part_pkg_taxrate {
1384 my ($data_vendor, $geocode, $class) = @_;
1387 my $extra_sql = 'WHERE part_pkg_taxproduct.data_vendor = '.
1388 dbh->quote($data_vendor);
1390 # CCH oddness in m2m
1391 $extra_sql .= ' AND ('.
1392 join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) }
1396 # much more CCH oddness in m2m -- this is kludgy
1397 my @tpnums = $self->_expand_cch_taxproductnum($class);
1398 if (scalar(@tpnums)) {
1399 $extra_sql .= ' AND ('.
1400 join(' OR ', map{ "taxproductnum = $_" } @tpnums ).
1403 $extra_sql .= ' AND ( 0 = 1 )';
1406 my $addl_from = 'LEFT JOIN part_pkg_taxproduct USING ( taxproductnum )';
1407 my $order_by = 'ORDER BY taxclassnum, length(geocode) desc, length(taxproduct) desc';
1408 my $select = 'DISTINCT ON(taxclassnum) *, taxproduct';
1410 # should qsearch preface columns with the table to facilitate joins?
1411 qsearch( { 'table' => 'part_pkg_taxrate',
1412 'select' => $select,
1413 'hashref' => { # 'data_vendor' => $data_vendor,
1414 # 'taxproductnum' => $self->taxproductnum,
1416 'addl_from' => $addl_from,
1417 'extra_sql' => $extra_sql,
1418 'order_by' => $order_by,
1422 =item part_pkg_discount
1424 Returns the package to discount m2m records (see L<FS::part_pkg_discount>)
1429 sub part_pkg_discount {
1431 qsearch('part_pkg_discount', { 'pkgpart' => $self->pkgpart });
1434 =item part_pkg_usage
1436 Returns the voice usage pools (see L<FS::part_pkg_usage>) defined for
1441 sub part_pkg_usage {
1443 qsearch('part_pkg_usage', { 'pkgpart' => $self->pkgpart });
1448 Reblesses the object into the FS::part_pkg::PLAN class (if available), where
1449 PLAN is the object's I<plan> field. There should be better docs
1450 on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
1456 my $plan = $self->plan;
1458 cluck "no price plan found for pkgpart ". $self->pkgpart. "\n"
1462 return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass
1463 my $class = ref($self). "::$plan";
1464 warn "reblessing $self into $class" if $DEBUG > 1;
1467 bless($self, $class) unless $@;
1472 sub calc_setup { die 'no calc_setup for '. shift->plan. "\n"; }
1473 sub calc_recur { die 'no calc_recur for '. shift->plan. "\n"; }
1475 #fallback that return 0 for old legacy packages with no plan
1476 sub calc_remain { 0; }
1477 sub calc_units { 0; }
1479 #fallback for everything not based on flat.pm
1480 sub recur_temporality { 'upcoming'; }
1481 sub calc_cancel { 0; }
1483 #fallback for everything except bulk.pm
1484 sub hide_svc_detail { 0; }
1486 #fallback for packages that can't/won't summarize usage
1487 sub sum_usage { 0; }
1489 =item recur_cost_permonth CUST_PKG
1491 recur_cost divided by freq (only supported for monthly and longer frequencies)
1495 sub recur_cost_permonth {
1496 my($self, $cust_pkg) = @_;
1497 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
1498 sprintf('%.2f', $self->recur_cost / $self->freq );
1501 =item cust_bill_pkg_recur CUST_PKG
1503 Actual recurring charge for the specified customer package from customer's most
1508 sub cust_bill_pkg_recur {
1509 my($self, $cust_pkg) = @_;
1510 my $cust_bill_pkg = qsearchs({
1511 'table' => 'cust_bill_pkg',
1512 'addl_from' => 'LEFT JOIN cust_bill USING ( invnum )',
1513 'hashref' => { 'pkgnum' => $cust_pkg->pkgnum,
1514 'recur' => { op=>'>', value=>'0' },
1516 'order_by' => 'ORDER BY cust_bill._date DESC,
1517 cust_bill_pkg.sdate DESC
1520 }) or return 0; #die "use cust_bill_pkg_recur credits with once_perinv condition";
1521 $cust_bill_pkg->recur;
1524 =item format OPTION DATA
1526 Returns data formatted according to the function 'format' described
1527 in the plan info. Returns DATA if no such function exists.
1532 my ($self, $option, $data) = (shift, shift, shift);
1533 if (exists($plans{$self->plan}->{fields}->{$option}{format})) {
1534 &{$plans{$self->plan}->{fields}->{$option}{format}}($data);
1540 =item parse OPTION DATA
1542 Returns data parsed according to the function 'parse' described
1543 in the plan info. Returns DATA if no such function exists.
1548 my ($self, $option, $data) = (shift, shift, shift);
1549 if (exists($plans{$self->plan}->{fields}->{$option}{parse})) {
1550 &{$plans{$self->plan}->{fields}->{$option}{parse}}($data);
1560 =head1 CLASS METHODS
1568 # Used by FS::Upgrade to migrate to a new database.
1570 sub _upgrade_data { # class method
1571 my($class, %opts) = @_;
1573 warn "[FS::part_pkg] upgrading $class\n" if $DEBUG;
1575 my @part_pkg = qsearch({
1576 'table' => 'part_pkg',
1577 'extra_sql' => "WHERE ". join(' OR ',
1578 'plan IS NULL', "plan = '' ",
1582 foreach my $part_pkg (@part_pkg) {
1584 unless ( $part_pkg->plan ) {
1585 $part_pkg->plan('flat');
1592 # now upgrade to the explicit custom flag
1594 @part_pkg = qsearch({
1595 'table' => 'part_pkg',
1596 'hashref' => { disabled => 'Y', custom => '' },
1597 'extra_sql' => "AND comment LIKE '(CUSTOM) %'",
1600 foreach my $part_pkg (@part_pkg) {
1601 my $new = new FS::part_pkg { $part_pkg->hash };
1603 my $comment = $part_pkg->comment;
1604 $comment =~ s/^\(CUSTOM\) //;
1605 $comment = '(none)' unless $comment =~ /\S/;
1606 $new->comment($comment);
1608 my $pkg_svc = { map { $_->svcpart => $_->quantity } $part_pkg->pkg_svc };
1609 my $primary = $part_pkg->svcpart;
1610 my $options = { $part_pkg->options };
1612 my $error = $new->replace( $part_pkg,
1613 'pkg_svc' => $pkg_svc,
1614 'primary_svc' => $primary,
1615 'options' => $options,
1617 die $error if $error;
1620 # set family_pkgpart on any packages that don't have it
1621 @part_pkg = qsearch('part_pkg', { 'family_pkgpart' => '' });
1622 foreach my $part_pkg (@part_pkg) {
1623 $part_pkg->set('family_pkgpart' => $part_pkg->pkgpart);
1624 my $error = $part_pkg->SUPER::replace;
1625 die $error if $error;
1628 my @part_pkg_option = qsearch('part_pkg_option',
1629 { 'optionname' => 'unused_credit',
1632 foreach my $old_opt (@part_pkg_option) {
1633 my $pkgpart = $old_opt->pkgpart;
1634 my $error = $old_opt->delete;
1635 die $error if $error;
1637 foreach (qw(unused_credit_cancel unused_credit_change)) {
1638 my $new_opt = new FS::part_pkg_option {
1639 'pkgpart' => $pkgpart,
1643 $error = $new_opt->insert;
1644 die $error if $error;
1648 # migrate use_disposition_taqua and use_disposition to disposition_in
1649 @part_pkg_option = qsearch('part_pkg_option',
1650 { 'optionname' => { op => 'LIKE',
1651 value => 'use_disposition%',
1655 my %newopts = map { $_->pkgpart => $_ }
1656 qsearch('part_pkg_option', { 'optionname' => 'disposition_in', } );
1657 foreach my $old_opt (@part_pkg_option) {
1658 my $pkgpart = $old_opt->pkgpart;
1659 my $newval = $old_opt->optionname eq 'use_disposition_taqua' ? '100'
1661 my $error = $old_opt->delete;
1662 die $error if $error;
1664 if ( exists($newopts{$pkgpart}) ) {
1665 my $opt = $newopts{$pkgpart};
1666 $opt->optionvalue($opt->optionvalue.",$newval");
1667 $error = $opt->replace;
1668 die $error if $error;
1670 my $new_opt = new FS::part_pkg_option {
1671 'pkgpart' => $pkgpart,
1672 'optionname' => 'disposition_in',
1673 'optionvalue' => $newval,
1675 $error = $new_opt->insert;
1676 die $error if $error;
1677 $newopts{$pkgpart} = $new_opt;
1681 # set any package with FCC voice lines to the "VoIP with broadband" category
1682 # for backward compatibility
1684 # recover from a bad upgrade bug
1685 my $upgrade = 'part_pkg_fcc_voip_class_FIX';
1686 if (!FS::upgrade_journal->is_done($upgrade)) {
1687 my $bad_upgrade = qsearchs('upgrade_journal',
1688 { upgrade => 'part_pkg_fcc_voip_class' }
1690 if ( $bad_upgrade ) {
1691 my $where = 'WHERE history_date <= '.$bad_upgrade->_date.
1692 ' AND history_date > '.($bad_upgrade->_date - 3600);
1693 my @h_part_pkg_option = map { FS::part_pkg_option->new($_->hashref) }
1696 'table' => 'h_part_pkg_option',
1698 'extra_sql' => "$where AND history_action = 'delete'",
1699 'order_by' => 'ORDER BY history_date ASC',
1701 my @h_pkg_svc = map { FS::pkg_svc->new($_->hashref) }
1704 'table' => 'h_pkg_svc',
1706 'extra_sql' => "$where AND history_action = 'replace_old'",
1707 'order_by' => 'ORDER BY history_date ASC',
1710 foreach my $deleted (@h_part_pkg_option, @h_pkg_svc) {
1711 my $pkgpart ||= $deleted->pkgpart;
1712 $opt{$pkgpart} ||= {
1718 if ( $deleted->isa('FS::part_pkg_option') ) {
1719 $opt{$pkgpart}{options}{ $deleted->optionname } = $deleted->optionvalue;
1721 my $svcpart = $deleted->svcpart;
1722 $opt{$pkgpart}{pkg_svc}{$svcpart} = $deleted->quantity;
1723 $opt{$pkgpart}{hidden_svc}{$svcpart} ||= $deleted->hidden;
1724 $opt{$pkgpart}{primary_svc} = $svcpart if $deleted->primary_svc;
1727 foreach my $pkgpart (keys %opt) {
1728 my $part_pkg = FS::part_pkg->by_key($pkgpart);
1729 my $error = $part_pkg->replace( $part_pkg->replace_old, $opt{$pkgpart} );
1731 die "error recovering damaged pkgpart $pkgpart:\n$error\n";
1734 } # $bad_upgrade exists
1735 else { # do the original upgrade, but correctly this time
1736 @part_pkg = qsearch('part_pkg', {
1737 fcc_ds0s => { op => '>', value => 0 },
1738 fcc_voip_class => ''
1740 foreach my $part_pkg (@part_pkg) {
1741 $part_pkg->set(fcc_voip_class => 2);
1742 my @pkg_svc = $part_pkg->pkg_svc;
1743 my %quantity = map {$_->svcpart, $_->quantity} @pkg_svc;
1744 my %hidden = map {$_->svcpart, $_->hidden } @pkg_svc;
1745 my $error = $part_pkg->replace(
1746 $part_pkg->replace_old,
1747 options => { $part_pkg->options },
1748 pkg_svc => \%quantity,
1749 hidden_svc => \%hidden,
1750 primary_svc => ($part_pkg->svcpart || ''),
1752 die $error if $error;
1755 FS::upgrade_journal->set_done($upgrade);
1760 =item curuser_pkgs_sql
1762 Returns an SQL fragment for searching for packages the current user can
1763 use, either via part_pkg.agentnum directly, or via agent type (see
1768 sub curuser_pkgs_sql {
1771 $class->_pkgs_sql( $FS::CurrentUser::CurrentUser->agentnums );
1775 =item agent_pkgs_sql AGENT | AGENTNUM, ...
1777 Returns an SQL fragment for searching for packages the provided agent or agents
1778 can use, either via part_pkg.agentnum directly, or via agent type (see
1783 sub agent_pkgs_sql {
1784 my $class = shift; #i'm a class method, not a sub (the question is... why??)
1785 my @agentnums = map { ref($_) ? $_->agentnum : $_ } @_;
1787 $class->_pkgs_sql(@agentnums); #is this why
1792 my( $class, @agentnums ) = @_;
1793 my $agentnums = join(',', @agentnums);
1797 ( agentnum IS NOT NULL AND agentnum IN ($agentnums) )
1798 OR ( agentnum IS NULL
1799 AND EXISTS ( SELECT 1
1801 LEFT JOIN agent_type USING ( typenum )
1802 LEFT JOIN agent AS typeagent USING ( typenum )
1803 WHERE type_pkgs.pkgpart = part_pkg.pkgpart
1804 AND typeagent.agentnum IN ($agentnums)
1822 #false laziness w/part_export & cdr
1824 foreach my $INC ( @INC ) {
1825 warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG;
1826 foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
1827 warn "attempting to load plan info from $file\n" if $DEBUG;
1828 $file =~ /\/(\w+)\.pm$/ or do {
1829 warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
1833 my $info = eval "use FS::part_pkg::$mod; ".
1834 "\\%FS::part_pkg::$mod\::info;";
1836 die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
1839 unless ( keys %$info ) {
1840 warn "no %info hash found in FS::part_pkg::$mod, skipping\n";
1843 warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
1844 #if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
1845 # warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
1848 $info{$mod} = $info;
1849 $info->{'weight'} ||= 0; # quiet warnings
1853 # copy one level deep to allow replacement of fields and fieldorder
1854 tie %plans, 'Tie::IxHash',
1855 map { my %infohash = %{ $info{$_} };
1857 sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
1860 # inheritance of plan options
1861 foreach my $name (keys(%info)) {
1862 if (exists($info{$name}->{'disabled'}) and $info{$name}->{'disabled'}) {
1863 warn "skipping disabled plan FS::part_pkg::$name" if $DEBUG;
1864 delete $plans{$name};
1867 my $parents = $info{$name}->{'inherit_fields'} || [];
1868 my (%fields, %field_exists, @fieldorder);
1869 foreach my $parent ($name, @$parents) {
1870 if ( !exists($info{$parent}) ) {
1871 warn "$name tried to inherit from nonexistent '$parent'\n";
1874 %fields = ( # avoid replacing existing fields
1875 %{ $info{$parent}->{'fields'} || {} },
1878 foreach (@{ $info{$parent}->{'fieldorder'} || [] }) {
1880 next if $field_exists{$_};
1881 $field_exists{$_} = 1;
1882 # allow inheritors to remove inherited fields from the fieldorder
1883 push @fieldorder, $_ if !exists($fields{$_}) or
1884 !exists($fields{$_}->{'disabled'});
1887 $plans{$name}->{'fields'} = \%fields;
1888 $plans{$name}->{'fieldorder'} = \@fieldorder;
1898 =head1 NEW PLAN CLASSES
1900 A module should be added in FS/FS/part_pkg/ Eventually, an example may be
1901 found in eg/plan_template.pm. Until then, it is suggested that you use the
1902 other modules in FS/FS/part_pkg/ as a guide.
1906 The delete method is unimplemented.
1908 setup and recur semantics are not yet defined (and are implemented in
1909 FS::cust_bill. hmm.). now they're deprecated and need to go.
1913 part_pkg_taxrate is Pg specific
1915 replace should be smarter about managing the related tables (options, pkg_svc)
1919 L<FS::Record>, L<FS::cust_pkg>, L<FS::type_pkgs>, L<FS::pkg_svc>, L<Safe>.
1920 schema.html from the base documentation.