X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg.pm;h=d97658496306a519f1e245b20b10bbd9041c1459;hb=7b5280c065aaa4887ce4e36fb4be7a80a74a8392;hp=d7cc3cb3489fbba0c87647c9268c165634e5b2fc;hpb=b8cfd0780aa40bb07f3215bf9cb58011f5e32a35;p=freeside.git diff --git a/FS/FS/part_pkg.pm b/FS/FS/part_pkg.pm index d7cc3cb34..d97658496 100644 --- a/FS/FS/part_pkg.pm +++ b/FS/FS/part_pkg.pm @@ -1,17 +1,22 @@ package FS::part_pkg; use strict; -use vars qw( @ISA %freq %plans $DEBUG ); -use Carp qw(carp cluck); +use vars qw( @ISA %plans $DEBUG ); +use Carp qw(carp cluck confess); use Tie::IxHash; use FS::Conf; use FS::Record qw( qsearch qsearchs dbh dbdef ); use FS::pkg_svc; +use FS::part_svc; +use FS::cust_pkg; use FS::agent_type; use FS::type_pkgs; use FS::part_pkg_option; +use FS::pkg_class; -@ISA = qw( FS::Record ); +@ISA = qw( FS::Record ); # FS::option_Common ); # this can use option_Common + # when all the plandata bs is + # gone $DEBUG = 0; @@ -54,6 +59,10 @@ inherits from FS::Record. The following fields are currently supported: =item comment - Text name of this package definition (non-customer-viewable) +=item classnum - Optional package class (see L) + +=item promo_code - Promotional code + =item setup - Setup fee expression (deprecated) =item freq - Frequency of recurring fee @@ -107,16 +116,37 @@ sub clone { new $class ( \%hash ); # ? } -=item insert +=item insert [ , OPTION => VALUE ... ] Adds this package definition to the database. If there is an error, returns the error, otherwise returns false. +Currently available options are: I, I, I, +I and I. + +If I is set to a hashref with svcparts as keys and quantities as +values, appropriate FS::pkg_svc records will be inserted. + +If I is set to the svcpart of the primary service, the appropriate +FS::pkg_svc record will be updated. + +If I is set to a pkgnum of a FS::cust_pkg record (or the FS::cust_pkg +record itself), the object will be updated to point to this package definition. + +In conjunction with I, if I is set to a scalar reference, +the scalar will be updated with the custnum value from the cust_pkg record. + +If I is set to a hashref of options, appropriate FS::part_pkg_option +records will be inserted. + =cut sub insert { my $self = shift; - warn "FS::part_pkg::insert called on $self" if $DEBUG; + my %options = @_; + warn "FS::part_pkg::insert called on $self with options ". + join(', ', map "$_=>$options{$_}", keys %options) + if $DEBUG; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; @@ -141,7 +171,8 @@ sub insert { } if ( $plandata ) { - warn " inserting part_pkg_option records for plandata" if $DEBUG; + + warn " inserting part_pkg_option records for plandata" if $DEBUG; foreach my $part_pkg_option ( map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit; return "illegal plandata: $plandata"; @@ -160,6 +191,27 @@ sub insert { return $error; } } + + } elsif ( $options{'options'} ) { + + warn " inserting part_pkg_option records for options hashref" if $DEBUG; + foreach my $optionname ( keys %{$options{'options'}} ) { + + my $part_pkg_option = + new FS::part_pkg_option { + 'pkgpart' => $self->pkgpart, + 'optionname' => $optionname, + 'optionvalue' => $options{'options'}->{$optionname}, + }; + + my $error = $part_pkg_option->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + + } + } my $conf = new FS::Conf; @@ -179,6 +231,47 @@ sub insert { } } + warn " inserting pkg_svc records" if $DEBUG; + my $pkg_svc = $options{'pkg_svc'} || {}; + foreach my $part_svc ( qsearch('part_svc', {} ) ) { + my $quantity = $pkg_svc->{$part_svc->svcpart} || 0; + my $primary_svc = + ( $options{'primary_svc'} && $options{'primary_svc'}==$part_svc->svcpart ) + ? 'Y' + : ''; + + my $pkg_svc = new FS::pkg_svc( { + 'pkgpart' => $self->pkgpart, + 'svcpart' => $part_svc->svcpart, + 'quantity' => $quantity, + 'primary_svc' => $primary_svc, + } ); + my $error = $pkg_svc->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + if ( $options{'cust_pkg'} ) { + warn " updating cust_pkg record " if $DEBUG; + my $old_cust_pkg = + ref($options{'cust_pkg'}) + ? $options{'cust_pkg'} + : qsearchs('cust_pkg', { pkgnum => $options{'cust_pkg'} } ); + ${ $options{'custnum_ref'} } = $old_cust_pkg->custnum + if $options{'custnum_ref'}; + my %hash = $old_cust_pkg->hash; + $hash{'pkgpart'} = $self->pkgpart, + my $new_cust_pkg = new FS::cust_pkg \%hash; + local($FS::cust_pkg::disable_agentcheck) = 1; + my $error = $new_cust_pkg->replace($old_cust_pkg); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "Error modifying cust_pkg record: $error"; + } + } + warn " commiting transaction" if $DEBUG; $dbh->commit or die $dbh->errstr if $oldAutoCommit; @@ -196,15 +289,27 @@ sub delete { # check & make sure the pkgpart isn't in cust_pkg or type_pkgs? } -=item replace OLD_RECORD +=item replace OLD_RECORD [ , OPTION => VALUE ... ] Replaces OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. +Currently available options are: I and I + +If I is set to a hashref with svcparts as keys and quantities as +values, the appropriate FS::pkg_svc records will be replace. + +If I is set to the svcpart of the primary service, the appropriate +FS::pkg_svc record will be updated. + =cut sub replace { my( $new, $old ) = ( shift, shift ); + my %options = @_; + warn "FS::part_pkg::replace called on $new to replace $old ". + "with options %options" + if $DEBUG; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; @@ -217,9 +322,11 @@ sub replace { local $FS::UID::AutoCommit = 0; my $dbh = dbh; + warn " saving legacy plandata" if $DEBUG; my $plandata = $new->get('plandata'); $new->set('plandata', ''); + warn " deleting old part_pkg_option records" if $DEBUG; foreach my $part_pkg_option ( $old->part_pkg_option ) { my $error = $part_pkg_option->delete; if ( $error ) { @@ -228,12 +335,14 @@ sub replace { } } + warn " replacing part_pkg record" if $DEBUG; my $error = $new->SUPER::replace($old); if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } + warn " inserting part_pkg_option records for plandata" if $DEBUG; foreach my $part_pkg_option ( map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit; return "illegal plandata: $plandata"; @@ -253,6 +362,40 @@ sub replace { } } + warn " replacing pkg_svc records" if $DEBUG; + my $pkg_svc = $options{'pkg_svc'} || {}; + foreach my $part_svc ( qsearch('part_svc', {} ) ) { + my $quantity = $pkg_svc->{$part_svc->svcpart} || 0; + my $primary_svc = $options{'primary_svc'} == $part_svc->svcpart ? 'Y' : ''; + + my $old_pkg_svc = qsearchs('pkg_svc', { + 'pkgpart' => $old->pkgpart, + 'svcpart' => $part_svc->svcpart, + } ); + my $old_quantity = $old_pkg_svc ? $old_pkg_svc->quantity : 0; + my $old_primary_svc = + ( $old_pkg_svc && $old_pkg_svc->dbdef_table->column('primary_svc') ) + ? $old_pkg_svc->primary_svc + : ''; + next unless $old_quantity != $quantity || $old_primary_svc ne $primary_svc; + + my $new_pkg_svc = new FS::pkg_svc( { + 'pkgsvcnum' => ( $old_pkg_svc ? $old_pkg_svc->pkgsvcnum : '' ), + 'pkgpart' => $new->pkgpart, + 'svcpart' => $part_svc->svcpart, + 'quantity' => $quantity, + 'primary_svc' => $primary_svc, + } ); + my $error = $old_pkg_svc + ? $new_pkg_svc->replace($old_pkg_svc) + : $new_pkg_svc->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + warn " commiting transaction" if $DEBUG; $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; } @@ -280,7 +423,7 @@ sub check { my $error = $self->ut_number('freq'); return $error if $error; } else { - $self->freq =~ /^(\d+[dw]?)$/ + $self->freq =~ /^(\d+[hdw]?)$/ or return "Illegal or empty freq: ". $self->freq; $self->freq($1); } @@ -288,6 +431,7 @@ sub check { my $error = $self->ut_numbern('pkgpart') || $self->ut_text('pkg') || $self->ut_text('comment') + || $self->ut_textn('promo_code') || $self->ut_alphan('plan') || $self->ut_enum('setuptax', [ '', 'Y' ] ) || $self->ut_enum('recurtax', [ '', 'Y' ] ) @@ -297,12 +441,54 @@ sub check { ; return $error if $error; + if ( $self->classnum !~ /^$/ ) { + my $error = $self->ut_foreign_key('classnum', 'pkg_class', 'classnum'); + return $error if $error; + } else { + $self->classnum(''); + } + return 'Unknown plan '. $self->plan unless exists($plans{$self->plan}); + my $conf = new FS::Conf; + return 'Taxclass is required' + if ! $self->taxclass && $conf->exists('require_taxclasses'); + ''; } +=item pkg_class + +Returns the package class, as an FS::pkg_class object, or the empty string +if there is no package class. + +=cut + +sub pkg_class { + my $self = shift; + if ( $self->classnum ) { + qsearchs('pkg_class', { 'classnum' => $self->classnum } ); + } else { + return ''; + } +} + +=item classname + +Returns the package class name, or the empty string if there is no package +class. + +=cut + +sub classname { + my $self = shift; + my $pkg_class = $self->pkg_class; + $pkg_class + ? $pkg_class->classname + : ''; +} + =item pkg_svc Returns all FS::pkg_svc objects (see L) for this package @@ -345,9 +531,9 @@ sub svcpart { Returns a list of the acceptable payment types for this package. Eventually this should come out of a database table and be editable, but currently has the -following logic instead; +following logic instead: -If the package has B<0> setup and B<0> recur, the single item B is +If the package is free, the single item B is returned, otherwise, the single item B is returned. (CHEK? LEC? Probably shouldn't accept those by default, prone to abuse) @@ -356,15 +542,63 @@ returned, otherwise, the single item B is returned. sub payby { my $self = shift; - #if ( $self->setup == 0 && $self->recur == 0 ) { - if ( $self->setup =~ /^\s*0+(\.0*)?\s*$/ - && $self->recur =~ /^\s*0+(\.0*)?\s*$/ ) { + if ( $self->is_free ) { ( 'BILL' ); } else { ( 'CARD' ); } } +=item is_free + +Returns true if this package is free. + +=cut + +sub is_free { + my $self = shift; + unless ( $self->plan ) { + $self->setup =~ /^\s*0+(\.0*)?\s*$/ + && $self->recur =~ /^\s*0+(\.0*)?\s*$/; + } elsif ( $self->can('is_free_options') ) { + not grep { $_ !~ /^\s*0*(\.0*)?\s*$/ } + map { $self->option($_) } + $self->is_free_options; + } else { + warn "FS::part_pkg::is_free: FS::part_pkg::". $self->plan. " subclass ". + "provides neither is_free_options nor is_free method; returning false"; + 0; + } +} + + +sub freqs_href { + #method, class method or sub? #my $self = shift; + + tie my %freq, 'Tie::IxHash', + '0' => '(no recurring fee)', + '1h' => 'hourly', + '1d' => 'daily', + '2d' => 'every two days', + '1w' => 'weekly', + '2w' => 'biweekly (every 2 weeks)', + '1' => 'monthly', + '45d' => 'every 45 days', + '2' => 'bimonthly (every 2 months)', + '3' => 'quarterly (every 3 months)', + '6' => 'semiannually (every 6 months)', + '12' => 'annually', + '24' => 'biannually (every 2 years)', + '36' => 'triannually (every 3 years)', + '48' => '(every 4 years)', + '60' => '(every 5 years)', + '120' => '(every 10 years)', + ; + + \%freq; + +} + =item freq_pretty Returns an english representation of the I field, such as "monthly", @@ -372,28 +606,19 @@ Returns an english representation of the I field, such as "monthly", =cut -tie %freq, 'Tie::IxHash', - '0' => '(no recurring fee)', - '1d' => 'daily', - '1w' => 'weekly', - '2w' => 'biweekly (every 2 weeks)', - '1' => 'monthly', - '2' => 'bimonthly (every 2 months)', - '3' => 'quarterly (every 3 months)', - '6' => 'semiannually (every 6 months)', - '12' => 'annually', - '24' => 'biannually (every 2 years)', -; - sub freq_pretty { my $self = shift; my $freq = $self->freq; - if ( exists($freq{$freq}) ) { - $freq{$freq}; + + #my $freqs_href = $self->freqs_href; + my $freqs_href = freqs_href(); + + if ( exists($freqs_href->{$freq}) ) { + $freqs_href->{$freq}; } else { my $interval = 'month'; - if ( $freq =~ /^(\d+)([dw])$/ ) { - my %interval = ( 'd'=>'day', 'w'=>'week' ); + if ( $freq =~ /^(\d+)([hdw])$/ ) { + my %interval = ( 'h' => 'hour', 'd'=>'day', 'w'=>'week' ); $interval = $interval{$2}; } if ( $1 == 1 ) { @@ -454,7 +679,7 @@ Returns the option value for the given name, or the empty string. =cut sub option { - my( $self, $opt ) = @_; + my( $self, $opt, $ornull ) = @_; my $part_pkg_option = qsearchs('part_pkg_option', { pkgpart => $self->pkgpart, @@ -464,7 +689,9 @@ sub option { my %plandata = map { /^(\w+)=(.*)$/; ( $1 => $2 ); } split("\n", $self->get('plandata') ); return $plandata{$opt} if exists $plandata{$opt}; - cluck "Package definition option $opt not found in options or plandata!\n"; + cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ". + "NOT found in options or plandata!\n" + unless $ornull; ''; } @@ -479,9 +706,16 @@ on how to create new price plans, but until then, see L. sub _rebless { my $self = shift; my $plan = $self->plan; + unless ( $plan ) { + confess "no price plan found for pkgpart ". $self->pkgpart. "\n" + if $DEBUG; + return $self; + } + return $self if ref($self) =~ /::$plan$/; #already blessed into plan subclass my $class = ref($self). "::$plan"; + warn "reblessing $self into $class" if $DEBUG; eval "use $class;"; - #die $@ if $@; + die $@ if $@; bless($self, $class) unless $@; $self; } @@ -516,6 +750,11 @@ sub _calc_eval { $value; } +#fallback that return 0 for old legacy packages with no plan + +sub calc_remain { 0; } +sub calc_cancel { 0; } + =back =head1 SUBROUTINES @@ -528,6 +767,7 @@ sub _calc_eval { my %info; foreach my $INC ( @INC ) { + warn "globbing $INC/FS/part_pkg/*.pm\n" if $DEBUG; foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) { warn "attempting to load plan info from $file\n" if $DEBUG; $file =~ /\/(\w+)\.pm$/ or do { @@ -568,15 +808,18 @@ sub plan_info { =head1 NEW PLAN CLASSES -A module should be added in FS/FS/part_pkg/ (an example may be found in -eg/plan_template.pm) +A module should be added in FS/FS/part_pkg/ Eventually, an example may be +found in eg/plan_template.pm. Until then, it is suggested that you use the +other modules in FS/FS/part_pkg/ as a guide. =head1 BUGS The delete method is unimplemented. setup and recur semantics are not yet defined (and are implemented in -FS::cust_bill. hmm.). +FS::cust_bill. hmm.). now they're deprecated and need to go. + +plandata should go =head1 SEE ALSO