summaryrefslogtreecommitdiff
path: root/httemplate
diff options
context:
space:
mode:
Diffstat (limited to 'httemplate')
-rw-r--r--httemplate/edit/msg_template.html3
-rw-r--r--httemplate/misc/email-customers-history.html51
-rw-r--r--httemplate/misc/email-customers.html53
-rw-r--r--httemplate/view/cust_main/menu.html18
4 files changed, 115 insertions, 10 deletions
diff --git a/httemplate/edit/msg_template.html b/httemplate/edit/msg_template.html
index 7f3824127..ced98fe1f 100644
--- a/httemplate/edit/msg_template.html
+++ b/httemplate/edit/msg_template.html
@@ -210,6 +210,7 @@ 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',
@@ -322,7 +323,7 @@ my $widget = new HTML::Widgets::SelectLayers(
my @hints = @{ $substitutions{$section} };
while(@hints) {
my $key = shift @hints;
- $html .= qq!\n<TR><TD><A href="javascript:insertHtml('{$key}')">$key</A></TD>!;
+ $html .= qq!\n<TR><TD STYLE="padding-right: .25em;"><A href="javascript:insertHtml('{$key}')">$key</A></TD>!;
$html .= "\n<TD>".shift(@hints).'</TD></TR>';
}
$html .= "\n</TABLE>";
diff --git a/httemplate/misc/email-customers-history.html b/httemplate/misc/email-customers-history.html
new file mode 100644
index 000000000..2f9a38d23
--- /dev/null
+++ b/httemplate/misc/email-customers-history.html
@@ -0,0 +1,51 @@
+
+ <% 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",
+ '<TABLE BORDER="0">',
+ (
+ 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 )
+ ),
+ '</TABLE>',
+ '<INPUT TYPE="hidden" NAME="msgnum" VALUE="' . $cgi->param('msgnum') . '">',
+ '<INPUT TYPE="hidden" NAME="action" VALUE="preview">',
+ '<INPUT TYPE="submit" VALUE="Preview notice">',
+ );
+};
+
+</%init>
+
diff --git a/httemplate/misc/email-customers.html b/httemplate/misc/email-customers.html
index 83e86158f..d1d5ac735 100644
--- a/httemplate/misc/email-customers.html
+++ b/httemplate/misc/email-customers.html
@@ -1,3 +1,26 @@
+<%doc>
+
+Allows emailing one or more customers, based on a search for customers. Search can
+be specified either through cust_main fields as cgi params, or through a base64 encoded
+frozen hash in the 'search' cgi param. Form allows selecting an existing msg_template,
+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:
+
+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
+
+alternate_form - an alternate form for template selection/message creation
+
+title - the title of the page
+
+</%doc>
+
% if ($popup) {
<% include('/elements/header-popup.html', $title) %>
% } else {
@@ -5,13 +28,16 @@
% }
-<FORM NAME="OneTrueForm" ACTION="email-customers.html" METHOD="POST">
+<FORM NAME="OneTrueForm" ACTION="<% $form_action %>" METHOD="POST">
<INPUT TYPE="hidden" NAME="table" VALUE="<% $table %>">
%# Mixing search params with from address, subject, etc. required special-case
%# handling of those, risked name conflicts, and caused massive problems with
%# multi-valued search params. We are no longer in search context, so we
%# pack the search into a Storable string for later use.
<INPUT TYPE="hidden" NAME="search" VALUE="<% encode_base64(nfreeze(\%search)) %>">
+% if (%sub_param) {
+<INPUT TYPE="hidden" NAME="sub_param" VALUE="<% encode_base64(nfreeze(\%sub_param)) %>">
+% }
<INPUT TYPE="hidden" NAME="popup" VALUE="<% $popup %>">
<INPUT TYPE="hidden" NAME="url" VALUE="<% $url | h %>">
@@ -21,7 +47,7 @@
<% include('/elements/progress-init.html',
'OneTrueForm',
- [ qw( search table from subject html_body text_body msgnum ) ],
+ [ qw( search table from subject html_body text_body msgnum sub_param ) ],
'process/email-customers.html',
$pdest,
)
@@ -93,6 +119,10 @@
% }
+% } elsif ($alternate_form) {
+
+<% $alternate_form %>
+
% } else {
<SCRIPT TYPE="text/javascript">
@@ -144,7 +174,7 @@ Template:
<INPUT TYPE="hidden" NAME="action" VALUE="preview">
<INPUT TYPE="submit" VALUE="Preview notice">
-% }
+% } #end not preview or alternate form
</FORM>
@@ -158,11 +188,18 @@ Template:
<%init>
+my %opt = @_;
+
die "access denied"
unless $FS::CurrentUser::CurrentUser->access_right('Bulk send customer notices');
my $conf = FS::Conf->new;
+my $form_action = $opt{'form_action'} || 'email-customers.html';
+my %sub_param = $opt{'sub_param_process'} ? &{$opt{'sub_param_process'}}($conf) : ();
+my $alternate_form = $opt{'alternate_form'} ? &{$opt{'alternate_form'}}(%sub_param) : ();
+my $title = $opt{'title'} || 'Send customer notices';
+
my $table = $cgi->param('table') or die "'table' required";
my $agent_virt_agentnum = $cgi->param('agent_virt_agentnum') || '';
@@ -177,7 +214,7 @@ if ( $cgi->param('search') ) {
}
else {
%search = $cgi->Vars;
- delete $search{$_} for qw( action table from subject html_body text_body popup url );
+ delete $search{$_} for qw( action table from subject html_body text_body popup url sub_param );
# FS::$table->search is expected to know which parameters might be
# multi-valued, and to accept scalar values for them also. No good
# solution to this since CGI can't tell whether a parameter _might_
@@ -185,8 +222,6 @@ else {
@search{keys %search} = map { /\0/ ? [ split /\0/, $_ ] : $_ } values %search;
}
-my $title = 'Send customer notices';
-
my $num_cust;
my $from = '';
if ( $cgi->param('from') ) {
@@ -221,10 +256,12 @@ if ( $cgi->param('action') eq 'preview' ) {
$sql_query->{'order_by'} = '';
my $object = qsearchs($sql_query);
my $cust = $object->cust_main;
- my %message = $msg_template->prepare(
+ my %msgopts = (
'cust_main' => $cust,
- 'object' => $object
+ 'object' => $object,
);
+ $msgopts{'sub_param'} = \%sub_param if %sub_param;
+ my %message = $msg_template->prepare(%msgopts);
($from, $subject, $html_body) = @message{'from', 'subject', 'html_body'};
}
}
diff --git a/httemplate/view/cust_main/menu.html b/httemplate/view/cust_main/menu.html
index e85cc2529..ff8937a8f 100644
--- a/httemplate/view/cust_main/menu.html
+++ b/httemplate/view/cust_main/menu.html
@@ -112,6 +112,9 @@ my $conf = FS::Conf->new;
my %payby = map { $_ => 1 } $conf->config('payby');
+# cached for conditions, to avoid looking it up twice
+my $invoicing_list_emailonly = $cust_main->invoicing_list_emailonly;
+
# nice declarative menu; should be a parameter to some kind of menu generator
my @menu = (
[
@@ -197,7 +200,8 @@ my @menu = (
'misc/email-customers.html?table=cust_main;search_hash='.
'agent_virt_agentnum='.$agentnum.";custnum=$custnum";
},
- condition => sub { shift->invoicing_list_emailonly },
+ condition => sub { $invoicing_list_emailonly },
+ acl => 'Bulk send customer notices',
},
],
[
@@ -478,6 +482,18 @@ my @menu = (
FS::cust_pay_pending->count('custnum = ?', shift->custnum) > 0
},
},
+ {
+ label => 'Email payment history to this customer',
+ url => sub {
+ my $cust_main = shift;
+ my $agentnum = $cust_main->agentnum;
+ 'misc/email-customers-history.html?table=cust_main;search_hash='.
+ 'agent_virt_agentnum='.$agentnum.";custnum=$custnum;url=".
+ uri_escape($cgi->self_url);
+ },
+ condition => sub { $invoicing_list_emailonly },
+ acl => 'Bulk send customer notices',
+ },
],
[
{