[freeside-commits] branch master updated. 94fefd033f726f9810bdaa905465af435d875a2f
Mark Wells
mark at 420.am
Thu Apr 9 22:58:44 PDT 2015
The branch, master has been updated
via 94fefd033f726f9810bdaa905465af435d875a2f (commit)
via f27cc902969814f2c11a49ebaadccc9ca31cfe8d (commit)
via 7be090f63c78d5e1f969177a76efd861880c6f28 (commit)
from 876bc8b0e9976e0c4761bf6679354febe7c2ae69 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 94fefd033f726f9810bdaa905465af435d875a2f
Author: Mark Wells <mark at freeside.biz>
Date: Thu Apr 9 22:58:08 2015 -0700
future package change: let future package be modified in place, #20687, fixes #33782
diff --git a/FS/FS/cust_pkg.pm b/FS/FS/cust_pkg.pm
index be5bdea..eaadd95 100644
--- a/FS/FS/cust_pkg.pm
+++ b/FS/FS/cust_pkg.pm
@@ -1967,6 +1967,40 @@ sub change {
my $error;
+ if ( $opt->{'cust_location'} ) {
+ $error = $opt->{'cust_location'}->find_or_insert;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "creating location record: $error";
+ }
+ $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
+ }
+
+ # Before going any further here: if the package is still in the pre-setup
+ # state, it's safe to modify it in place. No need to charge/credit for
+ # partial period, transfer services, transfer usage pools, copy invoice
+ # details, or change any dates.
+ if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
+ foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
+ if ( length($opt->{$_}) ) {
+ $self->set($_, $opt->{$_});
+ }
+ }
+ # almost. if the new pkgpart specifies start/adjourn/expire timers,
+ # apply those.
+ if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
+ $self->set_initial_timers;
+ }
+ $error = $self->replace;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "modifying package: $error";
+ } else {
+ $dbh->commit if $oldAutoCommit;
+ return '';
+ }
+ }
+
my %hash = ();
my $time = time;
@@ -1977,15 +2011,6 @@ sub change {
$hash{"change_$_"} = $self->$_()
foreach qw( pkgnum pkgpart locationnum );
- if ( $opt->{'cust_location'} ) {
- $error = $opt->{'cust_location'}->find_or_insert;
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return "creating location record: $error";
- }
- $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
- }
-
if ( $opt->{'cust_pkg'} ) {
# treat changing to a package with a different pkgpart as a
# pkgpart change (because it is)
@@ -2032,6 +2057,9 @@ sub change {
# 2. (more importantly) changing a package before it's billed
$hash{'waive_setup'} = $self->waive_setup;
+ # if this package is scheduled for a future package change, preserve that
+ $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
+
my $custnum = $self->custnum;
if ( $opt->{cust_main} ) {
my $cust_main = $opt->{cust_main};
commit f27cc902969814f2c11a49ebaadccc9ca31cfe8d
Author: Mark Wells <mark at freeside.biz>
Date: Wed Apr 8 19:13:48 2015 -0700
quotations + tax refactor, part 1
diff --git a/FS/FS/cust_bill_pkg.pm b/FS/FS/cust_bill_pkg.pm
index d0cec90..b6e4395 100644
--- a/FS/FS/cust_bill_pkg.pm
+++ b/FS/FS/cust_bill_pkg.pm
@@ -207,7 +207,6 @@ sub insert {
{
my $tax_location = $self->get($tax_link_table) || [];
foreach my $link ( @$tax_location ) {
- $DB::single=1; #XXX
my $pkey = $link->primary_key;
next if $link->get($pkey); # don't try to double-insert
# This cust_bill_pkg can be linked on either side (i.e. it can be the
diff --git a/FS/FS/prospect_main.pm b/FS/FS/prospect_main.pm
index 81f71a9..7c58de3 100644
--- a/FS/FS/prospect_main.pm
+++ b/FS/FS/prospect_main.pm
@@ -339,9 +339,9 @@ sub convert_cust_main {
$cust_main->set('last', 'Unknown');
}
- #v3 payby
- $cust_main->payby('BILL');
- $cust_main->paydate('12/2037');
+ #v3 payby no longer allowed
+ #$cust_main->payby('BILL');
+ #$cust_main->paydate('12/2037');
$cust_main->insert( {}, \@invoicing_list,
'prospectnum' => $self->prospectnum,
diff --git a/FS/FS/quotation.pm b/FS/FS/quotation.pm
index 60abd38..930083e 100644
--- a/FS/FS/quotation.pm
+++ b/FS/FS/quotation.pm
@@ -5,7 +5,7 @@ use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record
use strict;
use Tie::RefHash;
use FS::CurrentUser;
-use FS::UID qw( dbh );
+use FS::UID qw( dbh myconnect );
use FS::Maketext qw( emt );
use FS::Record qw( qsearch qsearchs );
use FS::Conf;
@@ -15,6 +15,9 @@ use FS::quotation_pkg;
use FS::quotation_pkg_tax;
use FS::type_pkgs;
+our $DEBUG = 1;
+use Data::Dumper;
+
=head1 NAME
FS::quotation - Object methods for quotation records
@@ -383,7 +386,7 @@ sub convert_cust_main {
}
-=item order
+=item order [ HASHREF ]
This method is for use with quotations which are already associated with a customer.
@@ -391,14 +394,21 @@ Orders this quotation's packages as real packages for the customer.
If there is an error, returns an error message, otherwise returns false.
+If HASHREF is passed, it will be filled with a hash mapping the
+C<quotationpkgnum> of each quoted package to the C<pkgnum> of the package
+as ordered.
+
=cut
sub order {
my $self = shift;
+ my $pkgnum_map = shift || {};
tie my %all_cust_pkg, 'Tie::RefHash';
foreach my $quotation_pkg ($self->quotation_pkg) {
my $cust_pkg = FS::cust_pkg->new;
+ $pkgnum_map->{ $quotation_pkg->quotationpkgnum } = $cust_pkg;
+
foreach (qw(pkgpart locationnum start_date contract_end quantity waive_setup)) {
$cust_pkg->set( $_, $quotation_pkg->get($_) );
}
@@ -412,8 +422,15 @@ sub order {
$all_cust_pkg{$cust_pkg} = []; # no services
}
- $self->cust_main->order_pkgs( \%all_cust_pkg );
+ my $error = $self->cust_main->order_pkgs( \%all_cust_pkg );
+
+ foreach my $quotationpkgnum (keys %$pkgnum_map) {
+ # convert the objects to just pkgnums
+ my $cust_pkg = $pkgnum_map->{$quotationpkgnum};
+ $pkgnum_map->{$quotationpkgnum} = $cust_pkg->pkgnum;
+ }
+ $error;
}
=item charge
@@ -583,126 +600,195 @@ sub estimate {
my $self = shift;
my $conf = FS::Conf->new;
- my $dbh = dbh;
- my $oldAutoCommit = $FS::UID::AutoCommit;
- local $FS::UID::AutoCommit = 0;
+ my %pkgnum_of; # quotationpkgnum => temporary pkgnum
+
+ my $me = "[quotation #".$self->quotationnum."]"; # for debug messages
+
+ my @return_bill = ([]);
+ my $error;
+
+ ###### BEGIN TRANSACTION ######
+ local $@;
+ eval {
+ my $temp_dbh = myconnect();
+ local $FS::UID::dbh = $temp_dbh;
+ local $FS::UID::AutoCommit = 0;
+
+ my $fake_self = FS::quotation->new({ $self->hash });
+
+ # if this is a prospect, make them into a customer for now
+ # XXX prospects currently can't have service locations
+ my $cust_or_prospect = $self->cust_or_prospect;
+ my $cust_main;
+ if ( $cust_or_prospect->isa('FS::prospect_main') ) {
+ $cust_main = $cust_or_prospect->convert_cust_main;
+ die "$cust_main (simulating customer signup)\n" unless ref $cust_main;
+ $fake_self->set('prospectnum', '');
+ $fake_self->set('custnum', $cust_main->custnum);
+ } else {
+ $cust_main = $cust_or_prospect;
+ }
- # bring individual items up to date (set setup/recur and discounts)
- my @quotation_pkg = $self->quotation_pkg;
- foreach my $pkg (@quotation_pkg) {
- my $error = $pkg->estimate;
- if ($error) {
- $dbh->rollback if $oldAutoCommit;
- die "error calculating estimate for pkgpart " . $pkg->pkgpart.": $error\n";
+ # order packages
+ $error = $fake_self->order(\%pkgnum_of);
+ die "$error (simulating package order)\n" if $error;
+
+ my @new_pkgs = map { FS::cust_pkg->by_key($_) } values(%pkgnum_of);
+
+ # simulate the first bill
+ my %bill_opt = (
+ 'pkg_list' => \@new_pkgs,
+ 'time' => time, # an option to adjust this?
+ 'return_bill' => $return_bill[0],
+ 'no_usage_reset' => 1,
+ );
+ $error = $cust_main->bill(%bill_opt);
+ die "$error (simulating initial billing)\n" if $error;
+
+ # pick dates for future bills
+ my %next_bill_pkgs;
+ foreach (@new_pkgs) {
+ my $bill = $_->get('bill');
+ next if !$bill;
+ push @{ $next_bill_pkgs{$bill} ||= [] }, $_;
}
- # delete old tax records
- foreach my $quotation_pkg_tax ($pkg->quotation_pkg_tax) {
- $error = $quotation_pkg_tax->delete;
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- die "error flushing tax records for pkgpart ". $pkg->pkgpart.": $error\n";
- }
+ my $i = 1;
+ foreach my $next_bill (keys %next_bill_pkgs) {
+ $bill_opt{'time'} = $next_bill;
+ $bill_opt{'return_bill'} = $return_bill[$i] = [];
+ $bill_opt{'pkg_list'} = $next_bill_pkgs{$next_bill};
+ $error = $cust_main->bill(%bill_opt);
+ die "$error (simulating recurring billing cycle $i)\n" if $error;
+ $i++;
}
+
+ $temp_dbh->rollback;
+ };
+ return $@ if $@;
+ ###### END TRANSACTION ######
+ my %quotationpkgnum_of = reverse %pkgnum_of;
+
+ if ($DEBUG) {
+ warn "pkgnums:\n".Dumper(\%pkgnum_of);
+ warn Dumper(\@return_bill);
}
- # annoyingly duplicates handle_taxes--fix this in 4.x
- if ( $conf->exists('enable_taxproducts') ) {
- warn "can't calculate external taxes for quotations yet\n";
- # then we're done
- return;
+ # careful: none of the pkgnums in here are correct outside the sandbox.
+ my %quotation_pkg; # quotationpkgnum => quotation_pkg
+ foreach my $qp ($self->quotation_pkg) {
+ $quotation_pkg{$qp->quotationpkgnum} = $qp;
+ $qp->set($_, 0) foreach qw(unitsetup unitrecur);
+ $qp->set('freq', '');
+ # flush old tax records
+ foreach ($qp->quotation_pkg_tax, $qp->quotation_pkg_discount) {
+ $error = $_->delete;
+ return "$error (flushing tax records for pkgpart ".$qp->part_pkg->pkgpart.")"
+ if $error;
+ }
}
- my %taxnum_exemptions; # for monthly exemptions; as yet unused
-
- foreach my $pkg (@quotation_pkg) {
- my $location = $pkg->cust_location;
-
- my $part_item = $pkg->part_pkg; # we don't have fees on these yet
- my @loc_keys = qw( district city county state country);
- my %taxhash = map { $_ => $location->$_ } @loc_keys;
- $taxhash{'taxclass'} = $part_item->taxclass;
- my @taxes;
- my %taxhash_elim = %taxhash;
- my @elim = qw( district city county state );
- do {
- @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
- if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
- #then try a match without taxclass
- my %no_taxclass = %taxhash_elim;
- $no_taxclass{ 'taxclass' } = '';
- @taxes = qsearch( 'cust_main_county', \%no_taxclass );
- }
-
- $taxhash_elim{ shift(@elim) } = '';
- } while ( !scalar(@taxes) && scalar(@elim) );
-
- foreach my $tax_def (@taxes) {
- my $taxnum = $tax_def->taxnum;
- $taxnum_exemptions{$taxnum} ||= [];
-
- # XXX do some kind of equivalent to set_exemptions here
- # but for now just declare that there are no exemptions,
- # and then hack the taxable amounts if the package def
- # excludes setup/recur
- $pkg->set('cust_tax_exempt_pkg', []);
-
- if ( $part_item->setuptax or $tax_def->setuptax ) {
- $pkg->set('unitsetup', 0);
- }
- if ( $part_item->recurtax or $tax_def->recurtax ) {
- $pkg->set('unitrecur', 0);
- }
+ my %quotation_pkg_tax; # quotationpkgnum => taxnum => quotation_pkg_tax obj
- my %taxline;
- foreach my $pass (qw(first recur)) {
- if ($pass eq 'recur') {
- $pkg->set('unitsetup', 0);
- }
+ for (my $i = 0; $i < scalar(@return_bill); $i++) {
+ my $this_bill = $return_bill[$i]->[0];
+ if (!$this_bill) {
+ warn "$me billing cycle $i produced no invoice\n";
+ next;
+ }
- my $taxline = $tax_def->taxline(
- [ $pkg ],
- exemptions => $taxnum_exemptions{$taxnum}
- );
- if ($taxline and !ref($taxline)) {
- $dbh->rollback if $oldAutoCommit;
- die "error calculating '".$tax_def->taxname .
- "' for pkgpart '".$pkg->pkgpart."': $taxline\n";
- }
- $taxline{$pass} = $taxline;
+ my @nonpkg_lines;
+ my %cust_bill_pkg;
+ foreach my $cust_bill_pkg (@{ $this_bill->get('cust_bill_pkg') }) {
+ my $pkgnum = $cust_bill_pkg->pkgnum;
+ $cust_bill_pkg{ $cust_bill_pkg->billpkgnum } = $cust_bill_pkg;
+ if ( !$pkgnum ) {
+ # taxes/fees; come back to it
+ push @nonpkg_lines, $cust_bill_pkg;
+ next;
}
-
- my $quotation_pkg_tax = FS::quotation_pkg_tax->new({
- quotationpkgnum => $pkg->quotationpkgnum,
- itemdesc => ($tax_def->taxname || 'Tax'),
- taxnum => $taxnum,
- taxtype => ref($tax_def),
- });
- my $setup_amount = 0;
- my $recur_amount = 0;
- if ($taxline{first}) {
- $setup_amount = $taxline{first}->setup; # "first cycle", not setup
+ my $quotationpkgnum = $quotationpkgnum_of{$pkgnum};
+ my $qp = $quotation_pkg{$quotationpkgnum};
+ if (!$qp) {
+ # XXX supplemental packages could do this (they have separate pkgnums)
+ # handle that special case at some point
+ warn "$me simulated bill returned a package not on the quotation (pkgpart ".$cust_bill_pkg->pkgpart.")\n";
+ next;
+ }
+ if ( $i == 0 ) {
+ # then this is the first (setup) invoice
+ $qp->set('start_date', $cust_bill_pkg->sdate);
+ $qp->set('unitsetup', $qp->unitsetup + $cust_bill_pkg->unitsetup);
+ # pkgpart_override is a possibility
+ } else {
+ # recurring invoice (should be only one of these per package, though
+ # it may have multiple lineitems with the same pkgnum)
+ $qp->set('unitrecur', $qp->unitrecur + $cust_bill_pkg->unitrecur);
}
- if ($taxline{recur}) {
- $recur_amount = $taxline{recur}->setup;
- $setup_amount -= $recur_amount; # to get the actual setup amount
+ }
+ foreach my $cust_bill_pkg (@nonpkg_lines) {
+ if ($cust_bill_pkg->feepart) {
+ warn "$me simulated bill included a non-package fee (feepart ".
+ $cust_bill_pkg->feepart.")\n";
+ next;
}
- if ( $recur_amount > 0 or $setup_amount > 0 ) {
- $quotation_pkg_tax->set('setup_amount', sprintf('%.2f', $setup_amount));
- $quotation_pkg_tax->set('recur_amount', sprintf('%.2f', $recur_amount));
-
- my $error = $quotation_pkg_tax->insert;
- if ($error) {
- $dbh->rollback if $oldAutoCommit;
- die "error recording '".$tax_def->taxname .
- "' for pkgpart '".$pkg->pkgpart."': $error\n";
- } # if $error
- } # else there are no non-zero taxes; continue
- } # foreach $tax_def
- } # foreach $pkg
-
- $dbh->commit if $oldAutoCommit;
- '';
+ my $links = $cust_bill_pkg->get('cust_bill_pkg_tax_location') ||
+ $cust_bill_pkg->get('cust_bill_pkg_tax_rate_location') ||
+ [];
+ # breadth-first unrolled recursion
+ while (my $tax_link = shift @$links) {
+ my $target = $cust_bill_pkg{ $tax_link->taxable_billpkgnum }
+ or die "$me unable to resolve tax link (taxnum ".$tax_link->taxnum.")\n";
+ if ($target->pkgnum) {
+ my $quotationpkgnum = $quotationpkgnum_of{$target->pkgnum};
+ # create this if there isn't one yet
+ my $qpt =
+ $quotation_pkg_tax{$quotationpkgnum}{$tax_link->taxnum} ||=
+ FS::quotation_pkg_tax->new({
+ quotationpkgnum => $quotationpkgnum,
+ itemdesc => $cust_bill_pkg->itemdesc,
+ taxnum => $tax_link->taxnum,
+ taxtype => $tax_link->taxtype,
+ setup_amount => 0,
+ recur_amount => 0,
+ });
+ if ( $i == 0 ) { # first invoice
+ $qpt->set('setup_amount', $qpt->setup_amount + $tax_link->amount);
+ } else { # subsequent invoices
+ # this isn't perfectly accurate, but that's why it's an estimate
+ $qpt->set('recur_amount', $qpt->recur_amount + $tax_link->amount);
+ $qpt->set('setup_amount', sprintf('%.2f', $qpt->setup_amount - $tax_link->amount));
+ $qpt->set('setup_amount', 0) if $qpt->setup_amount < 0;
+ }
+ } elsif ($target->feepart) {
+ # do nothing; we already warned for the fee itself
+ } else {
+ # tax on tax: the tax target is another tax item
+ # since this is an estimate, I'm just going to assign it to the
+ # first of the underlying packages
+ my $sublinks = $target->cust_bill_pkg_tax_rate_location;
+ if ($sublinks and $sublinks->[0]) {
+ $tax_link->set('taxable_billpkgnum', $sublinks->[0]->taxable_billpkgnum);
+ push @$links, $tax_link; #try again
+ } else {
+ warn "$me unable to assign tax on tax; ignoring\n";
+ }
+ }
+ } # while my $tax_link
+ } # foreach my $cust_bill_pkg
+ #XXX discounts
+ }
+ foreach my $quotation_pkg (values %quotation_pkg) {
+ $error = $quotation_pkg->replace;
+ return "$error (recording estimate for ".$quotation_pkg->part_pkg->pkg.")"
+ if $error;
+ }
+ foreach my $quotation_pkg_tax (map { values %$_ } values %quotation_pkg_tax) {
+ $error = $quotation_pkg_tax->insert;
+ return "$error (recording estimated tax for ".$quotation_pkg_tax->itemdesc.")"
+ if $error;
+ }
+ return;
}
=back
diff --git a/FS/FS/quotation_pkg.pm b/FS/FS/quotation_pkg.pm
index 1b5b419..1674d2b 100644
--- a/FS/FS/quotation_pkg.pm
+++ b/FS/FS/quotation_pkg.pm
@@ -70,6 +70,11 @@ The amount per package that will be charged in setup/one-time fees.
The amount per package that will be charged per billing cycle.
+=item freq
+
+The length of the billing cycle. If zero it's a one-time charge; if any
+other number it's that many months; other values are in L<FS::Misc::pkg_freqs>.
+
=back
=head1 METHODS
@@ -180,6 +185,8 @@ and replace methods.
sub check {
my $self = shift;
+ my @freqs = ('', keys (%{ FS::Misc->pkg_freqs }));
+
my $error =
$self->ut_numbern('quotationpkgnum')
|| $self->ut_foreign_key( 'quotationnum', 'quotation', 'quotationnum' )
@@ -190,6 +197,7 @@ sub check {
|| $self->ut_numbern('quantity')
|| $self->ut_moneyn('unitsetup')
|| $self->ut_moneyn('unitrecur')
+ || $self->ut_enum('freq', \@freqs)
|| $self->ut_enum('waive_setup', [ '', 'Y'] )
;
@@ -431,11 +439,6 @@ sub cust_bill_pkg_display {
$recur->{'type'} = 'R';
if ( $type eq 'S' ) {
-sub tax_locationnum {
- my $self = shift;
- $self->locationnum;
-}
-
return ($setup);
} elsif ( $type eq 'R' ) {
return ($recur);
@@ -472,6 +475,11 @@ sub prospect_main {
$quotation->prospect_main;
}
+sub tax_locationnum {
+ my $self = shift;
+ $self->locationnum;
+}
+
sub _upgrade_data {
my $class = shift;
commit 7be090f63c78d5e1f969177a76efd861880c6f28
Author: Mark Wells <mark at freeside.biz>
Date: Wed Apr 8 19:09:36 2015 -0700
quantities for setup fees on non-flat-rate packages, #13136
diff --git a/FS/FS/part_pkg/recur_Common.pm b/FS/FS/part_pkg/recur_Common.pm
index ebf8869..b73c62c 100644
--- a/FS/FS/part_pkg/recur_Common.pm
+++ b/FS/FS/part_pkg/recur_Common.pm
@@ -34,7 +34,7 @@ sub calc_setup {
delete $param->{'setup_charge'};
}
- sprintf('%.2f', $charge - $discount);
+ sprintf('%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
}
sub cutoff_day {
-----------------------------------------------------------------------
Summary of changes:
FS/FS/cust_bill_pkg.pm | 1 -
FS/FS/cust_pkg.pm | 46 ++++--
FS/FS/part_pkg/recur_Common.pm | 2 +-
FS/FS/prospect_main.pm | 6 +-
FS/FS/quotation.pm | 306 +++++++++++++++++++++++++---------------
FS/FS/quotation_pkg.pm | 18 ++-
6 files changed, 250 insertions(+), 129 deletions(-)
More information about the freeside-commits
mailing list