From c112a7e56557acce5a54d3b57e4cdbab7c43ecc5 Mon Sep 17 00:00:00 2001 From: Jonathan Prykop Date: Thu, 25 Jun 2015 00:51:02 -0500 Subject: [PATCH] RT#34078: Payment History Report / Statement --- FS/FS/Conf.pm | 7 --- FS/FS/cust_main.pm | 27 +------- FS/FS/cust_main_Mixin.pm | 11 +--- FS/FS/msg_template.pm | 37 +---------- FS/FS/msg_template/InitialData.pm | 9 --- httemplate/edit/msg_template.html | 3 +- httemplate/elements/customer-statement.html | 45 +++++++++++++ httemplate/misc/email-customer-statement.html | 91 +++++++++++++++++++++++++++ httemplate/misc/email-customers-history.html | 51 --------------- httemplate/misc/email-customers.html | 47 ++++++++------ 10 files changed, 169 insertions(+), 159 deletions(-) create mode 100644 httemplate/elements/customer-statement.html create mode 100644 httemplate/misc/email-customer-statement.html delete mode 100644 httemplate/misc/email-customers-history.html diff --git a/FS/FS/Conf.pm b/FS/FS/Conf.pm index c17eb4a4a..c5c0e465b 100644 --- a/FS/FS/Conf.pm +++ b/FS/FS/Conf.pm @@ -2688,13 +2688,6 @@ and customer address. Include units.', }, { - 'key' => 'payment_history_msgnum', - 'section' => 'notification', - 'description' => 'Template to use for sending payment history to customer', - %msg_template_options, - }, - - { 'key' => 'payby', 'section' => 'billing', 'description' => 'Available payment types.', diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm index d17a636d4..01a47d0d2 100644 --- a/FS/FS/cust_main.pm +++ b/FS/FS/cust_main.pm @@ -4488,7 +4488,7 @@ I - optional already-loaded FS::Conf object. =cut # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history, -# and also payment_history_text, which should both be kept customer-friendly. +# and also for sending customer statements, which should both be kept customer-friendly. # If you add anything that shouldn't be passed on through the API or exposed # to customers, add a new option to include it, don't include it by default sub payment_history { @@ -4610,31 +4610,6 @@ sub payment_history { return @out; } -=item payment_history_text - -Accepts the same options as L and returns those -results as a string table with fixed-width columns, max width 80 char. - -=cut - -sub payment_history_text { - my $self = shift; - my $opt = ref($_[0]) ? $_[0] : { @_ }; - my $out = sprintf("%-12s",'Date'); - $out .= sprintf("%11s",'Amount') . ' '; - $out .= sprintf("%11s",'Balance') . ' '; - $out .= 'Description'; #don't need to pad with spaces - $out .= "\n"; - foreach my $item ($self->payment_history($opt)) { - $out .= sprintf("%-10.10s",$$item{'date_pretty'}) . ' '; #12 width - $out .= sprintf("%11.11s",$$item{'amount_pretty'}) . ' '; #13 width - $out .= sprintf("%11.11s",$$item{'balance_pretty'}) . ' '; #13 width - $out .= sprintf("%.42s",$$item{'description'}); #max 42 width - $out .= "\n"; - } - return $out; -} - =back =head1 CLASS METHODS diff --git a/FS/FS/cust_main_Mixin.pm b/FS/FS/cust_main_Mixin.pm index 211dc32b4..40c0ae9f9 100644 --- a/FS/FS/cust_main_Mixin.pm +++ b/FS/FS/cust_main_Mixin.pm @@ -380,11 +380,6 @@ HTML body Text body -=item sub_param - -Optional list of parameter hashrefs to be passed -along to L. - =back Returns an error message, or false for success. @@ -461,8 +456,6 @@ sub email_search_result { 'cust_main' => $cust_main, 'object' => $obj, ); - $message{'sub_param'} = $param->{'sub_param'} - if $param->{'sub_param'}; } else { my @to = $cust_main->invoicing_list_emailonly; @@ -540,9 +533,7 @@ sub process_email_search_result { $param->{'search'} = thaw(decode_base64($param->{'search'})) or die "process_email_search_result requires search params.\n"; - $param->{'sub_param'} = thaw(decode_base64($param->{'sub_param'})) - or die "process_email_search_result error decoding sub_param\n" - if $param->{'sub_param'}; + # $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ] # unless ref($param->{'payby'}); diff --git a/FS/FS/msg_template.pm b/FS/FS/msg_template.pm index 644663e71..cb13696a5 100644 --- a/FS/FS/msg_template.pm +++ b/FS/FS/msg_template.pm @@ -268,19 +268,7 @@ invoicing_list addresses. Multiple addresses may be comma-separated. =item substitutions -A hash reference of additional string substitutions - -=item sub_param - -A hash reference, keys are the names of existing substitutions, -values are an addition parameter object to pass to the subroutine -for that substitution, e.g. - - 'sub_param' => { - 'payment_history' => { - 'start_date' => 1434764295, - }, - }, +A hash reference of additional substitutions =back @@ -336,10 +324,7 @@ sub prepare { } elsif( ref($name) eq 'ARRAY' ) { # [ foo => sub { ... } ] - my @subparam = (); - push(@subparam, $opt{'sub_param'}->{$name->[0]}) - if $opt{'sub_param'} && $opt{'sub_param'}->{$name->[0]}; - $hash{$prefix.($name->[0])} = $name->[1]->($obj,@subparam); + $hash{$prefix.($name->[0])} = $name->[1]->($obj); } else { warn "bad msg_template substitution: '$name'\n"; @@ -352,10 +337,7 @@ sub prepare { $hash{$_} = $opt{substitutions}->{$_} foreach keys %{$opt{substitutions}}; } - foreach my $key (keys %hash) { - next if $self->no_encode($key); - $hash{$key} = encode_entities($_ || ''); - }; + $_ = encode_entities($_ || '') foreach values(%hash); ### # clean up template @@ -522,13 +504,6 @@ my $usage_warning = sub { #my $conf = new FS::Conf; -# for substitutions that handle their own encoding -sub no_encode { - my $self = shift; - my $field = shift; - return ($field eq 'payment_history'); -} - #return contexts and fill-in values # If you add anything, be sure to add a description in # httemplate/edit/msg_template.html. @@ -587,12 +562,6 @@ sub substitutions { [ selfservice_server_base_url => sub { $conf->config('selfservice_server-base_url') #, shift->agentnum) } ], - [ payment_history => sub { - my $cust_main = shift; - my $param = shift || {}; - #html works, see no_encode method - return '
' . encode_entities($cust_main->payment_history_text($param)) . '
'; - } ], ], # next_bill_date 'cust_pkg' => [qw( diff --git a/FS/FS/msg_template/InitialData.pm b/FS/FS/msg_template/InitialData.pm index 87c407c35..a4e27fdc9 100644 --- a/FS/FS/msg_template/InitialData.pm +++ b/FS/FS/msg_template/InitialData.pm @@ -21,15 +21,6 @@ If you did not request this password reset, you may safely ignore and delete thi END ], }, - { msgname => 'payment_history_template', - mime_type => 'text/html', - _conf => 'payment_history_msgnum', - _insert_args => [ subject => '{ $company_name } payment history', - body => <<'END', -{ $payment_history } -END - ], - }, ]; } diff --git a/httemplate/edit/msg_template.html b/httemplate/edit/msg_template.html index a1026fed3..c6b2a7d8d 100644 --- a/httemplate/edit/msg_template.html +++ b/httemplate/edit/msg_template.html @@ -210,7 +210,6 @@ my %substitutions = ( '$company_address'=> 'Our company address', '$company_phonenum' => 'Our phone number', '$selfservice_server_base_url' => 'Base URL of customer self-service', - '$payment_history' => 'List of invoices/payments/credits/refunds', ], 'contact' => [ # duplicate this for shipping '$name' => 'Company and contact name', @@ -323,7 +322,7 @@ my $widget = new HTML::Widgets::SelectLayers( my @hints = @{ $substitutions{$section} }; while(@hints) { my $key = shift @hints; - $html .= qq!\n$key!; + $html .= qq!\n$key!; $html .= "\n".shift(@hints).''; } $html .= "\n"; diff --git a/httemplate/elements/customer-statement.html b/httemplate/elements/customer-statement.html new file mode 100644 index 000000000..63c21cba3 --- /dev/null +++ b/httemplate/elements/customer-statement.html @@ -0,0 +1,45 @@ +<%doc> + +Formats customer payment history into a table. + + include('/elements/customer-statement.html', + 'history' => \@history + ); + +Option 'history' should be of the form returned by $cust_main->payment_history. +This element might be used directly by selfservice, so it does not (and should not) +pull data from the database. + + + +% my $style = 'text-align: left; margin: 0; padding: 0 1em 0 0;'; +% my $moneystyle = 'text-align: right; margin: 0; padding: 0 1em 0 0;'; + + + + + + + + + +% my $col1 = "#ffffff"; +% my $col2 = "#dddddd"; +% my $col = $col1; +% foreach my $item (@{$opt{'history'}}) { + + + + + + +% $col = $col eq $col1 ? $col2 : $col1; +% } + +
DateDescriptionAmountBalance
<% $$item{'date_pretty'} %><% $$item{'description'} %><% $$item{'amount_pretty'} %><% $$item{'balance_pretty'} %>
+ +<%init> +my %opt = @_; + +die "Invalid type for history" unless ref($opt{'history'}) eq 'ARRAY'; + diff --git a/httemplate/misc/email-customer-statement.html b/httemplate/misc/email-customer-statement.html new file mode 100644 index 000000000..65660f1be --- /dev/null +++ b/httemplate/misc/email-customer-statement.html @@ -0,0 +1,91 @@ + + <% include('email-customers.html', + 'form_action' => 'email-customer-statement.html', + 'title' => 'Send statement to customer', + 'no_search_fields' => [ 'start_date', 'end_date' ], + 'alternate_form' => $alternate_form, + 'post_search_hook' => $post_search_hook, + ) + %> + +<%init> + +die "access denied" + unless $FS::CurrentUser::CurrentUser->access_right('View invoices'); + +my $alternate_form = sub { + # this could maaaybe be a separate element, for cleanliness + # but it's really only for use by this page, and it's not overly complicated + my $noinit = 0; + return join("\n", + '', + ( + map { + my $label = ucfirst($_); + $label =~ s/_/ /; + include('/elements/tr-input-date-field.html',{ + 'name' => $_, + 'value' => $cgi->param($_) || '', + 'label' => $label, + 'noinit' => $noinit++ + }); + } + qw( start_date end_date ) + ), + '
', + '', + '', + ); +}; + +my $post_search_hook = sub { + my %opt = @_; + return unless $cgi->param('action') eq 'preview'; + my $cust_main = qsearchs('cust_main',$opt{'search'}) + or die "Could not find customer"; + + # so that the statement indicates the latest date + my $date_format = $opt{'conf'}->config('date_format') || '%m/%d/%Y'; + $cgi->param('end_date', time2str($date_format, time)) + unless $cgi->param('end_date'); + + # set from/subject/html_body based on date range + + $cgi->param('from', + $opt{'conf'}->config('invoice_from') + ); + + # shortcut for common text + my $summary_text = $cust_main->name_short . + ($cgi->param('start_date') ? ' from ' : '') . + $cgi->param('start_date') . + ($cgi->param('end_date') ? ' through ' : '') . + $cgi->param('end_date'); + + $cgi->param('subject', + $opt{'conf'}->config('company_name') . + ' statement for ' . + $summary_text + ); + + $cgi->param('html_body', + '

' . + $opt{'conf'}->config('company_name') . + ' statement of charges and payments for ' . + $summary_text . + "

" . + include('/elements/customer-statement.html', + 'history' => [ + $cust_main->payment_history( + map { + $_ => parse_datetime($cgi->param($_)) + } + qw( start_date end_date ), + ), + ], + ) + ); +}; + + + diff --git a/httemplate/misc/email-customers-history.html b/httemplate/misc/email-customers-history.html deleted file mode 100644 index 2f9a38d23..000000000 --- a/httemplate/misc/email-customers-history.html +++ /dev/null @@ -1,51 +0,0 @@ - - <% include('email-customers.html', - 'form_action' => 'email-customers-history.html', - 'sub_param_process' => $sub_param_process, - 'alternate_form' => $alternate_form, - 'title' => 'Send payment history', - ) - %> - -<%init> - -my $sub_param_process = sub { - my $conf = shift; - my %sub_param; - foreach my $field ( qw( start_date end_date ) ) { - $sub_param{'payment_history'}->{$field} = parse_datetime($cgi->param($field)); - $cgi->delete($field); - } - $cgi->param('msgnum',$conf->config('payment_history_msgnum')); - return %sub_param; -}; - -my $alternate_form = sub { - my %sub_param = @_; - # this could maaaybe be a separate element, for cleanliness - # but it's really only for use by this page, and it's not overly complicated - my $noinit = 0; - return join("\n", - '', - ( - map { - my $label = ucfirst($_); - $label =~ s/_/ /; - include('/elements/tr-input-date-field.html',{ - 'name' => $_, - 'value' => $sub_param{'payment_history'}->{$_} || '', - 'label' => $label, - 'noinit' => $noinit++ - }); - } - qw( start_date end_date ) - ), - '
', - '', - '', - '', - ); -}; - - - diff --git a/httemplate/misc/email-customers.html b/httemplate/misc/email-customers.html index d1d5ac735..3327303e4 100644 --- a/httemplate/misc/email-customers.html +++ b/httemplate/misc/email-customers.html @@ -6,18 +6,23 @@ frozen hash in the 'search' cgi param. Form allows selecting an existing msg_te or creating a custom message, and shows a preview of the message before sending. If linked to as a popup, include the cgi parameter 'popup' for proper header handling. -This may also be used as an element in other pages, enabling you to pass along -additional substitution parameters to a message template, with the following options: +This may also be used as an element in other pages, enabling you to provide an +alternate initial form while using this for search freezing/thawing and +preview/send actions, with the following options: form_action - the URL to submit the form to -sub_param_process - subroutine to override cgi param values (such as msgnum) -and parse/delete additional form fields from the cgi; should return a %sub_param -hash to be passed along for message substitution +title - the title of the page -alternate_form - an alternate form for template selection/message creation +no_search_fields - arrayref of additional fields that are not search parameters -title - the title of the page +alternate_form - subroutine that returns alternate html for the initial form, +replaces msgnum/from/subject/html_body/action inputs and submit button, +not used if an action is specified + +post_search_hook - sub hook for additional processing after search has been processed from cgi, +gets passed options 'conf' and 'search' (a reference to the unfrozen %search hash), +should be used to set msgnum or from/subject/html_body cgi params @@ -35,9 +40,6 @@ title - the title of the page %# multi-valued search params. We are no longer in search context, so we %# pack the search into a Storable string for later use. -% if (%sub_param) { - -% } @@ -47,7 +49,7 @@ title - the title of the page <% include('/elements/progress-init.html', 'OneTrueForm', - [ qw( search table from subject html_body text_body msgnum sub_param ) ], + [ qw( search table from subject html_body text_body msgnum ) ], 'process/email-customers.html', $pdest, ) @@ -105,7 +107,7 @@ title - the title of the page -% if ( $cgi->param('action') eq 'preview' ) { +% if ( $cgi->param('action') eq 'preview' ) {