From 75769d888d9c306d5d5ccde3260c0267268cf4ed Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 25 Oct 2011 22:35:14 +0000 Subject: [PATCH] add legacy_cust_bill to hold legacy invoice content, RT#12981 --- FS/FS.pm | 2 + FS/FS/Mason.pm | 5 + FS/FS/cust_main.pm | 20 +++ FS/FS/legacy_cust_bill.pm | 165 +++++++++++++++++++++ FS/MANIFEST | 2 + FS/t/legacy_cust_bill.t | 5 + httemplate/view/cust_main/payment_history.html | 9 ++ .../cust_main/payment_history/legacy_invoice.html | 23 +++ httemplate/view/legacy_cust_bill-pdf.cgi | 35 +++++ httemplate/view/legacy_cust_bill.html | 62 ++++++++ 10 files changed, 328 insertions(+) create mode 100644 FS/FS/legacy_cust_bill.pm create mode 100644 FS/t/legacy_cust_bill.t create mode 100644 httemplate/view/cust_main/payment_history/legacy_invoice.html create mode 100755 httemplate/view/legacy_cust_bill-pdf.cgi create mode 100755 httemplate/view/legacy_cust_bill.html diff --git a/FS/FS.pm b/FS/FS.pm index 972a21afb..8645c56cb 100644 --- a/FS/FS.pm +++ b/FS/FS.pm @@ -332,6 +332,8 @@ L - Invoice line item class L - Invoice line item detail class +L - Legacy data invoice class + L - (Old) Invoice event definition class L - (Old) Completed invoice event class diff --git a/FS/FS/Mason.pm b/FS/FS/Mason.pm index 7305702a4..3d4fac4b9 100644 --- a/FS/FS/Mason.pm +++ b/FS/FS/Mason.pm @@ -290,6 +290,11 @@ if ( -e $addl_handler_use_file ) { use FS::cust_msg; use FS::radius_group; use FS::template_content; + use FS::dsl_device; + use FS::nas; + use FS::nas; + use FS::export_nas; + use FS::legacy_cust_bill; # Sammath Naur if ( $FS::Mason::addl_handler_use ) { diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm index 0788e15de..f8e103eee 100644 --- a/FS/FS/cust_main.pm +++ b/FS/FS/cust_main.pm @@ -40,6 +40,7 @@ use FS::payby; use FS::cust_pkg; use FS::cust_svc; use FS::cust_bill; +use FS::legacy_cust_bill; use FS::cust_pay; use FS::cust_pay_pending; use FS::cust_pay_void; @@ -3575,6 +3576,25 @@ sub open_cust_bill { } +=item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ] + +Returns all the legacy invoices (see L) for this customer. + +=cut + +sub legacy_cust_bill { + my $self = shift; + + #return $self->num_legacy_cust_bill unless wantarray; + + map { $_ } #behavior of sort undefined in scalar context + sort { $a->_date <=> $b->_date } + qsearch({ 'table' => 'legacy_cust_bill', + 'hashref' => { 'custnum' => $self->custnum, }, + 'order_by' => 'ORDER BY _date ASC', + }); +} + =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ] Returns all the statements (see L) for this customer. diff --git a/FS/FS/legacy_cust_bill.pm b/FS/FS/legacy_cust_bill.pm new file mode 100644 index 000000000..b2bfeaaad --- /dev/null +++ b/FS/FS/legacy_cust_bill.pm @@ -0,0 +1,165 @@ +package FS::legacy_cust_bill; + +use strict; +use base qw( FS::Record ); +use FS::Record qw( qsearch qsearchs ); +use FS::cust_main; + +=head1 NAME + +FS::legacy_cust_bill - Object methods for legacy_cust_bill records + +=head1 SYNOPSIS + + use FS::legacy_cust_bill; + + $record = new FS::legacy_cust_bill \%hash; + $record = new FS::legacy_cust_bill { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::legacy_cust_bill object represents an invoice from a previous billing +system, about which full details are not availble. Instead, the rendered +content is stored in HTML or PDF format. FS::legacy_cust_bill invoices are +stored for informational and display purposes only; they have no effect upon +customer balances. + +FS::legacy_cust_bill inherits from FS::Record. The following fields are +currently supported: + +=over 4 + +=item legacyinvnum + +primary key + +=item legacyid + +Invoice number or identifier from previous system + +=item custnum + +Customer (see L. + +Note that this stores the hash reference, not a distinct copy of the hash it +points to. You can ask the object for a copy with the I method. + +=cut + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'legacy_cust_bill'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +# the insert method can be inherited from FS::Record + +=item delete + +Delete this record from the database. + +=cut + +# the delete method can be inherited from FS::Record + +=item replace OLD_RECORD + +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +=cut + +# the replace method can be inherited from FS::Record + +=item check + +Checks all fields to make sure this is a valid legacy invoice. If there is +an error, returns the error, otherwise returns false. Called by the insert +and replace methods. + +=cut + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('legacyinvnum') + || $self->ut_textn('legacyid') + || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum') + || $self->ut_number('_date') + || $self->ut_money('charged') + || $self->ut_anything('content_pdf') + || $self->ut_anything('content_html') + ; + return $error if $error; + + $self->SUPER::check; +} + +=item cust_main + +Returns the customer (see L) for this invoice. + +=cut + +sub cust_main { + my $self = shift; + qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L, schema.html from the base documentation. + +=cut + +1; + diff --git a/FS/MANIFEST b/FS/MANIFEST index eeca1b27b..37f1a5896 100644 --- a/FS/MANIFEST +++ b/FS/MANIFEST @@ -614,3 +614,5 @@ FS/dsl_device.pm t/dsl_device.t FS/export_nas.pm t/export_nas.t +FS/legacy_cust_bill.pm +t/legacy_cust_bill.t diff --git a/FS/t/legacy_cust_bill.t b/FS/t/legacy_cust_bill.t new file mode 100644 index 000000000..2d42e5a97 --- /dev/null +++ b/FS/t/legacy_cust_bill.t @@ -0,0 +1,5 @@ +BEGIN { $| = 1; print "1..1\n" } +END {print "not ok 1\n" unless $loaded;} +use FS::legacy_cust_bill; +$loaded=1; +print "ok 1\n"; diff --git a/httemplate/view/cust_main/payment_history.html b/httemplate/view/cust_main/payment_history.html index 64a708976..752f56562 100644 --- a/httemplate/view/cust_main/payment_history.html +++ b/httemplate/view/cust_main/payment_history.html @@ -396,6 +396,15 @@ my %opt = ( ) ); +#legacy invoices +foreach my $legacy_cust_bill ($cust_main->legacy_cust_bill) { + push @history, { + 'date' => $legacy_cust_bill->_date, + 'desc' => include('payment_history/legacy_invoice.html', $legacy_cust_bill, %opt ), + 'charge' => $legacy_cust_bill->charged, + }; +} + #invoices foreach my $cust_bill ($cust_main->cust_bill) { push @history, { diff --git a/httemplate/view/cust_main/payment_history/legacy_invoice.html b/httemplate/view/cust_main/payment_history/legacy_invoice.html new file mode 100644 index 000000000..e999a251e --- /dev/null +++ b/httemplate/view/cust_main/payment_history/legacy_invoice.html @@ -0,0 +1,23 @@ +<% $link %><% $invoice %><% $link ? '' : '' %> +<%init> + +my( $legacy_cust_bill ) = @_; #, %opt ) + +my $invoice; +if ( length($legacy_cust_bill->legacyid) ) { + $invoice = emt('Legacy Invoice #[_1]', $legacy_cust_bill->legacyid); +} else { + $invoice = emt('Legacy Invoice'); +} + +my $legacyinvnum = $legacy_cust_bill->legacyinvnum; + +my $link = ''; +if ( $FS::CurrentUser::CurrentUser->access_right('View invoices') ) { + $link = length($legacy_cust_bill->content_html) + ? qq!! + : length($legacy_cust_bill->content_pdf) + ? qq!! + : ''; + + diff --git a/httemplate/view/legacy_cust_bill-pdf.cgi b/httemplate/view/legacy_cust_bill-pdf.cgi new file mode 100755 index 000000000..c6ecfb17f --- /dev/null +++ b/httemplate/view/legacy_cust_bill-pdf.cgi @@ -0,0 +1,35 @@ +<% $content %>\ +<%init> + +die "access denied" + unless $FS::CurrentUser::CurrentUser->access_right('View invoices'); + +my $legacyinvnum; +my($query) = $cgi->keywords; +if ( $query =~ /^(\d+)(.pdf)?$/ ) { #.pdf probably not necessary anymore? + $legacyinvnum = $1; +} else { + $legacyinvnum = $cgi->param('legacyinvnum'); + $legacyinvnum =~ s/\.pdf//i; #probably not necessary anymore +} + +my $legacy_cust_bill = qsearchs({ + 'select' => 'legacy_cust_bill.*', + 'table' => 'legacy_cust_bill', + 'addl_from' => 'LEFT JOIN cust_main USING ( custnum )', + 'hashref' => { 'legacyinvnum' => $legacyinvnum }, + 'extra_sql' => ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql, +}); +die "Legacy invoice #$legacyinvnum not found!" unless $legacy_cust_bill; + +my $content = $legacy_cust_bill->content_pdf; + +#maybe should name the file after legacyid if present, but have to clean it +#my $filename = $legacy_cust_bill->legacyid + +http_header('Content-Type' => 'application/pdf' ); +http_header('Content-Disposition' => "filename=$legacyinvnum.pdf" ); +http_header('Content-Length' => length($content) ); +#http_header('Cache-control' => 'max-age=60' ); + + diff --git a/httemplate/view/legacy_cust_bill.html b/httemplate/view/legacy_cust_bill.html new file mode 100755 index 000000000..29e4e6ebe --- /dev/null +++ b/httemplate/view/legacy_cust_bill.html @@ -0,0 +1,62 @@ +<& /elements/header.html, mt('Legacy Invoice View'), menubar( + emt("View this customer (#[_1])",$display_custnum) => "${p}view/cust_main.cgi?$custnum", +) &> + +% if ( 0 ) { #implement resending of legacy invoices? +% #if ( $curuser->access_right('Resend invoices') ) { + + <% mt('Re-print this invoice') |h %> + +% if ( grep { $_ ne 'POST' } $legacy_cust_bill->cust_main->invoicing_list ) { + | <% mt('Re-email this invoice') |h %> +% } + +% if ( $conf->exists('hylafax') && length($legacy_cust_bill->cust_main->fax) ) { + | <% mt('Re-fax this invoice') |h %> +% } + +

+ +% } + +% if ( length($legacy_cust_bill->content_pdf) ) { + + <% mt('View typeset invoice PDF') |h %> +

+% } + +<% $legacy_cust_bill->content_html %> + +<& /elements/footer.html &> +<%init> + +my $curuser = $FS::CurrentUser::CurrentUser; + +die "access denied" + unless $curuser->access_right('View invoices'); + +my $legacyinvnum; +my($query) = $cgi->keywords; +if ( $query =~ /^(\d+)$/ ) { + $legacyinvnum = $3; +} else { + $legacyinvnum = $cgi->param('legacyinvnum'); +} + +my $conf = new FS::Conf; + +my $legacy_cust_bill = qsearchs({ + 'select' => 'legacy_cust_bill.*', + 'table' => 'legacy_cust_bill', + 'addl_from' => 'LEFT JOIN cust_main USING ( custnum )', + 'hashref' => { 'legacyinvnum' => $legacyinvnum }, + 'extra_sql' => ' AND '. $curuser->agentnums_sql, +}); +die "Legacy invoice #$legacyinvnum not found!" unless $legacy_cust_bill; + +my $custnum = $legacy_cust_bill->custnum; +my $display_custnum = $legacy_cust_bill->cust_main->display_custnum; + +my $link = "legacyinvnum=$legacyinvnum"; + + -- 2.11.0