X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg.pm;h=d4570f7fc3ceffeafab9e0abbfc131f3d8b09b02;hb=6a24254d490f3d023728044daba0765f20f6971e;hp=d97658496306a519f1e245b20b10bbd9041c1459;hpb=7b5280c065aaa4887ce4e36fb4be7a80a74a8392;p=freeside.git diff --git a/FS/FS/part_pkg.pm b/FS/FS/part_pkg.pm index d97658496..d4570f7fc 100644 --- a/FS/FS/part_pkg.pm +++ b/FS/FS/part_pkg.pm @@ -3,6 +3,7 @@ package FS::part_pkg; use strict; use vars qw( @ISA %plans $DEBUG ); use Carp qw(carp cluck confess); +use Scalar::Util qw( blessed ); use Tie::IxHash; use FS::Conf; use FS::Record qw( qsearch qsearchs dbh dbdef ); @@ -13,11 +14,12 @@ use FS::agent_type; use FS::type_pkgs; use FS::part_pkg_option; use FS::pkg_class; +use FS::agent; +use FS::part_pkg_taxoverride; +use FS::part_pkg_taxproduct; +#XXX#use FS::part_pkg_link; -@ISA = qw( FS::Record ); # FS::option_Common ); # this can use option_Common - # when all the plandata bs is - # gone - +@ISA = qw( FS::m2m_Common FS::option_Common ); $DEBUG = 0; =head1 NAME @@ -81,6 +83,12 @@ inherits from FS::Record. The following fields are currently supported: =item disabled - Disabled flag, empty or `Y' +=item pay_weight - Weight (relative to credit_weight and other package definitions) that controls payment application to specific line items. + +=item credit_weight - Weight (relative to other package definitions) that controls credit application to specific line items. + +=item agentnum - Optional agentnum (see L) + =back =head1 METHODS @@ -159,61 +167,13 @@ sub insert { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - warn " saving legacy plandata" if $DEBUG; - my $plandata = $self->get('plandata'); - $self->set('plandata', ''); - warn " inserting part_pkg record" if $DEBUG; - my $error = $self->SUPER::insert; + my $error = $self->SUPER::insert( $options{options} ); if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } - if ( $plandata ) { - - 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"; - }; - new FS::part_pkg_option { - 'pkgpart' => $self->pkgpart, - 'optionname' => $1, - 'optionvalue' => $2, - }; - } - split("\n", $plandata) - ) { - my $error = $part_pkg_option->insert; - if ( $error ) { - $dbh->rollback if $oldAutoCommit; - 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; if ( $conf->exists('agent_defaultpkg') ) { warn " agent_defaultpkg set; allowing all agents to purchase package" @@ -305,10 +265,19 @@ 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" + my $new = shift; + + my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') ) + ? shift + : $new->replace_old; + + my $options = + ( ref($_[0]) eq 'HASH' ) + ? shift + : { @_ }; + + warn "FS::part_pkg::replace called on $new to replace $old with options". + join(', ', map "$_ => ". $options->{$_}, keys %$options) if $DEBUG; local $SIG{HUP} = 'IGNORE'; @@ -322,6 +291,8 @@ sub replace { local $FS::UID::AutoCommit = 0; my $dbh = dbh; + #plandata shit stays in replace for upgrades until after 2.0 (or edit + #_upgrade_data) warn " saving legacy plandata" if $DEBUG; my $plandata = $new->get('plandata'); $new->set('plandata', ''); @@ -336,13 +307,13 @@ sub replace { } warn " replacing part_pkg record" if $DEBUG; - my $error = $new->SUPER::replace($old); + my $error = $new->SUPER::replace($old, $options->{options} ); if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } - warn " inserting part_pkg_option records for plandata" if $DEBUG; + warn " inserting part_pkg_option records for plandata: $plandata|" if $DEBUG; foreach my $part_pkg_option ( map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit; return "illegal plandata: $plandata"; @@ -363,10 +334,10 @@ sub replace { } warn " replacing pkg_svc records" if $DEBUG; - my $pkg_svc = $options{'pkg_svc'} || {}; + 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 $primary_svc = $options->{'primary_svc'} == $part_svc->svcpart ? 'Y' : ''; my $old_pkg_svc = qsearchs('pkg_svc', { 'pkgpart' => $old->pkgpart, @@ -414,7 +385,8 @@ sub check { for (qw(setup recur plandata)) { #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; } - return "Use of $_ field is deprecated; set a plan and options" + return "Use of $_ field is deprecated; set a plan and options: ". + $self->get($_) if length($self->get($_)); $self->set($_, ''); } @@ -437,6 +409,9 @@ sub check { || $self->ut_enum('recurtax', [ '', 'Y' ] ) || $self->ut_textn('taxclass') || $self->ut_enum('disabled', [ '', 'Y' ] ) + || $self->ut_floatn('pay_weight') + || $self->ut_floatn('credit_weight') + || $self->ut_agentnum_acl('agentnum', 'Edit global package definitions') || $self->SUPER::check ; return $error if $error; @@ -458,6 +433,22 @@ sub check { ''; } +=item pkg_comment + +Returns an (internal) string representing this package. Currently, +"pkgpart: pkg - comment", is returned. "pkg - comment" may be returned in the +future, omitting pkgpart. + +=cut + +sub pkg_comment { + my $self = shift; + + #$self->pkg. ' - '. $self->comment; + #$self->pkg. ' ('. $self->comment. ')'; + $self->pkgpart. ': '. $self->pkg. ' - '. $self->comment; +} + =item pkg_class Returns the package class, as an FS::pkg_class object, or the empty string @@ -489,6 +480,17 @@ sub classname { : ''; } +=item agent + +Returns the associated agent for this event, if any, as an FS::agent object. + +=cut + +sub agent { + my $self = shift; + qsearchs('agent', { 'agentnum' => $self->agentnum } ); +} + =item pkg_svc Returns all FS::pkg_svc objects (see L) for this package @@ -576,23 +578,27 @@ 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)', + '0' => '(no recurring fee)', + '1h' => 'hourly', + '1d' => 'daily', + '2d' => 'every two days', + '3d' => 'every three days', + '1w' => 'weekly', + '2w' => 'biweekly (every 2 weeks)', + '1' => 'monthly', + '45d' => 'every 45 days', + '2' => 'bimonthly (every 2 months)', + '3' => 'quarterly (every 3 months)', + '4' => 'every 4 months', + '137d' => 'every 4 1/2 months (137 days)', + '6' => 'semiannually (every 6 months)', + '12' => 'annually', + '13' => 'every 13 months (annually +1 month)', + '24' => 'biannually (every 2 years)', + '36' => 'triannually (every 3 years)', + '48' => '(every 4 years)', + '60' => '(every 5 years)', + '120' => '(every 10 years)', ; \%freq; @@ -690,11 +696,81 @@ sub option { split("\n", $self->get('plandata') ); return $plandata{$opt} if exists $plandata{$opt}; cluck "WARNING: (pkgpart ". $self->pkgpart. ") Package def option $opt ". - "NOT found in options or plandata!\n" + "not found in options or plandata!\n" unless $ornull; ''; } +=item dst_pkgpart + +=cut + +sub part_pkg_link { + (); + #XXX + #my $self = shift; + #qsearch('part_pkg_link', { 'src_pkgpart' => $self->pkgpart } ); +} + +=item part_pkg_taxoverride + +Returns all associated FS::part_pkg_taxoverride objects (see +L). + +=cut + +sub part_pkg_taxoverride { + my $self = shift; + qsearch('part_pkg_taxoverride', { 'pkgpart' => $self->pkgpart } ); +} + +=item taxproduct_description + +Returns the description of the associated tax product for this package +definition (see L). + +=cut + +sub taxproduct_description { + my $self = shift; + my $part_pkg_taxproduct = + qsearchs( 'part_pkg_taxproduct', + { 'taxproductnum' => $self->taxproductnum } + ); + $part_pkg_taxproduct ? $part_pkg_taxproduct->description : ''; +} + +=item part_pkg_taxrate DATA_PROVIDER, GEOCODE + +Returns the package to taxrate m2m records for this package in the location +specified by GEOCODE (see L and ). + +=cut + +sub part_pkg_taxrate { + my $self = shift; + my ($data_vendor, $geocode) = @_; + + my $dbh = dbh; + # CCH oddness in m2m + my $extra_sql = 'AND ('. + join(' OR ', map{ 'geocode = '. $dbh->quote(substr($geocode, 0, $_)) } + qw(10 5 2) + ). + ')'; + my $order_by = 'ORDER BY taxclassnum, length(geocode) desc'; + my $select = 'DISTINCT ON(taxclassnum) *'; + + qsearch( { 'table' => 'part_pkg_taxrate', + 'select' => 'distinct on(taxclassnum) *', + 'hashref' => { 'data_vendor' => $data_vendor, + 'taxproductnum' => $self->taxproductnum, + }, + 'extra_sql' => $extra_sql, + 'order_by' => $order_by, + } ); +} + =item _rebless Reblesses the object into the FS::part_pkg::PLAN class (if available), where @@ -707,7 +783,7 @@ sub _rebless { my $self = shift; my $plan = $self->plan; unless ( $plan ) { - confess "no price plan found for pkgpart ". $self->pkgpart. "\n" + cluck "no price plan found for pkgpart ". $self->pkgpart. "\n" if $DEBUG; return $self; } @@ -757,6 +833,74 @@ sub calc_cancel { 0; } =back +=cut + +# _upgrade_data +# +# Used by FS::Upgrade to migrate to a new database. + +sub _upgrade_data { # class method + my($class, %opts) = @_; + + warn "[FS::part_pkg] upgrading $class\n" if $DEBUG; + + my @part_pkg = qsearch({ + 'table' => 'part_pkg', + 'extra_sql' => "WHERE ". join(' OR ', + ( map "($_ IS NOT NULL AND $_ != '' )", + qw( plandata setup recur ) ), + 'plan IS NULL', "plan = '' ", + ), + }); + + foreach my $part_pkg (@part_pkg) { + + unless ( $part_pkg->plan ) { + + $part_pkg->plan('flat'); + + if ( $part_pkg->setup =~ /^\s*([\d\.]+)\s*$/ ) { + + my $opt = new FS::part_pkg_option { + 'pkgpart' => $part_pkg->pkgpart, + 'optionname' => 'setup_fee', + 'optionvalue' => $1, + }; + my $error = $opt->insert; + die $error if $error; + + $part_pkg->setup(''); + + } else { + die "Can't parse part_pkg.setup for fee; convert pkgnum ". + $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n"; + } + + if ( $part_pkg->recur =~ /^\s*([\d\.]+)\s*$/ ) { + + my $opt = new FS::part_pkg_option { + 'pkgpart' => $part_pkg->pkgpart, + 'optionname' => 'recur_fee', + 'optionvalue' => $1, + }; + my $error = $opt->insert; + die $error if $error; + + $part_pkg->recur(''); + + } else { + die "Can't parse part_pkg.setup for fee; convert pkgnum ". + $part_pkg->pkgnum. " manually: ". $part_pkg->setup. "\n"; + } + + } + + $part_pkg->replace; #this should take care of plandata, right? + + } + +} + =head1 SUBROUTINES =over 4 @@ -804,6 +948,39 @@ sub plan_info { \%plans; } +=item format OPTION DATA + +Returns data formatted according to the function 'format' described +in the plan info. Returns DATA if no such function exists. + +=cut + +sub format { + my ($self, $option, $data) = (shift, shift, shift); + if (exists($plans{$self->plan}->{fields}->{$option}{format})) { + &{$plans{$self->plan}->{fields}->{$option}{format}}($data); + }else{ + $data; + } +} + +=item parse OPTION DATA + +Returns data parsed according to the function 'parse' described +in the plan info. Returns DATA if no such function exists. + +=cut + +sub parse { + my ($self, $option, $data) = (shift, shift, shift); + if (exists($plans{$self->plan}->{fields}->{$option}{parse})) { + &{$plans{$self->plan}->{fields}->{$option}{parse}}($data); + }else{ + $data; + } +} + + =back =head1 NEW PLAN CLASSES