+<%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 provide
+an alternate initial form while using this for search freezing/thawing and
+preview/send actions, with the following options:
+
+acl - the access right to use (defaults to 'Bulk send customer notices')
+
+form_action - the URL to submit the form to
+
+process_url - the URL for starting the JSRPC process
+
+title - the title of the page
+
+no_search_fields - arrayref of additional fields that are not search parameters
+
+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
+
+</%doc>
+
+% if ($popup) {
+<% include('/elements/header-popup.html', $title) %>
+% } else {
<% include('/elements/header.html', $title) %>
+% }
-<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)) %>">
+<INPUT TYPE="hidden" NAME="popup" VALUE="<% $popup %>">
+<INPUT TYPE="hidden" NAME="url" VALUE="<% $url | h %>">
+<INPUT TYPE="hidden" NAME="to_contact_classnum" VALUE="<% join(',', @contact_classnum) %>">
% if ( $cgi->param('action') eq 'send' ) {
<FONT SIZE="+2">Sending notice</FONT>
- <% include('/elements/progress-init.html',
+ <& /elements/progress-init.html,
'OneTrueForm',
- [ qw( search table from subject html_body text_body msgnum ) ],
- 'process/email-customers.html',
- { 'message' => "Notice sent" }, #would be nice to show #, but..
- )
- %>
+ [ qw( search table from subject html_body text_body
+ msgnum to_contact_classnum ) ],
+ $process_url,
+ $pdest,
+ &>
% } elsif ( $cgi->param('action') eq 'preview' ) {
% if ( $cgi->param('action') ) {
<TABLE BGCOLOR="#cccccc" CELLSPACING=0>
- <INPUT TYPE="hidden" NAME="msgnum" VALUE="<% $cgi->param('msgnum') %>">
-
+ <INPUT TYPE="hidden" NAME="msgnum" VALUE="<% scalar($cgi->param('msgnum')) %>">
% if ( $msg_template ) {
<% include('/elements/tr-fixed.html',
'label' => 'Template:',
<% include('/elements/tr-fixed.html',
'field' => 'from',
'label' => 'From:',
- 'value' => scalar( $from ),
+ 'value' => $from,
)
%>
+ <& /elements/tr-td-label.html, 'label' => 'To contacts:' &>
+ <td><% join('<BR>', @contact_classname) %></td>
+ </tr>
+
<% include('/elements/tr-fixed.html',
'field' => 'subject',
'label' => 'Subject:',
- 'value' => scalar( $subject ),
+ 'value' => $subject,
)
%>
<INPUT TYPE="hidden" NAME="html_body" VALUE="<% $html_body |h %>">
<TR>
- <TD ALIGN="right" VALIGN="top">Message (HTML display): </TD>
+ <TH ALIGN="right" VALIGN="top">Message (HTML display): </TD>
<TD CLASS="background" ALIGN="left"><% $html_body %></TD>
</TR>
% );
<INPUT TYPE="hidden" NAME="text_body" VALUE="<% $text_body |h %>">
<TR>
- <TD ALIGN="right" VALIGN="top">Message (Text display): </TD>
- <TD CLASS="background" STYLE="background-color:white" ALIGN="left"><PRE><% $text_body %></PRE></TD>
+ <TH ALIGN="right" VALIGN="top">Message (Text display): </TD>
+ <TD CLASS="background" STYLE="background-color:white" ALIGN="left">
+ <a href="javascript:void(0)" onclick="this.style.display='none'; document.getElementById('email-message-text').style.display=''">click to view</a>
+ <PRE id="email-message-text" style="display: none;"><% $text_body %></PRE>
+ </TD>
</TR>
</TABLE>
-% if ( $cgi->param('action') eq 'preview' ) {
+% if ( $cgi->param('action') eq 'preview' ) {
<SCRIPT>
function areyousure(href) {
% }
+% } elsif ($opt{'alternate_form'}) {
+
+<% &{$opt{'alternate_form'}}() %>
+
% } else {
<SCRIPT TYPE="text/javascript">
onchange => 'toggle(this)',
&>
<BR>
+% }
+% # select destination contact classes
+Send to contacts:
+ <& /elements/checkboxes.html,
+ 'style' => 'display: inline; vertical-align: top',
+ 'disable_links' => 1,
+ 'names_list' => \@contact_checkboxes,
+ 'element_name_prefix' => 'contact_class_',
+ 'checked_callback' => sub {
+ my($cgi, $name) = @_;
+ $name eq 'invoice' #others default to unchecked
+ },
+ &>
+<BR>
+% # if sending a one-off message, show a form to edit it
<TABLE BGCOLOR="#cccccc" CELLSPACING=0 WIDTH="100%" id="table_no_template">
<& /elements/tr-td-label.html, 'label' => 'From:' &>
<TD><& /elements/input-text.html,
'field' => 'from_name',
- 'value' => $conf->config('company_name', $agent_virt_agentnum), #?
+ 'value' => $conf->config('invoice_from_name', $agent_virt_agentnum) ||
+ $conf->config('company_name', $agent_virt_agentnum), #?
'size' => 20,
&> <\
<& /elements/input-text.html,
'size' => 20,
&>></TD>
- <% include('/elements/tr-input-text.html',
+ <& /elements/tr-input-text.html,
'field' => 'subject',
'label' => 'Subject:',
'size' => 50,
- )
- %>
+ &>
<TR>
<TD ALIGN="right" VALIGN="top" STYLE="padding-top:3px">Message: </TD>
<INPUT TYPE="hidden" NAME="action" VALUE="preview">
<INPUT TYPE="submit" VALUE="Preview notice">
-% }
+% } #end not action or alternate form
</FORM>
</SCRIPT>
% }
-<% include('/elements/footer.html') %>
+<& /elements/footer.html &>
<%init>
+my %opt = @_;
+
+$opt{'acl'} ||= 'Bulk send customer notices';
+
die "access denied"
- unless $FS::CurrentUser::CurrentUser->access_right('Bulk send customer notices');
+ unless $FS::CurrentUser::CurrentUser->access_right($opt{'acl'});
my $conf = FS::Conf->new;
+my @no_search_fields = qw( action table from subject html_body text_body popup url );
+
+my $form_action = $opt{'form_action'} || 'email-customers.html';
+my $process_url = $opt{'process_url'} || 'process/email-customers.html';
+my $title = $opt{'title'} || 'Send customer notices';
+push( @no_search_fields, @{$opt{'no_search_fields'}} ) if $opt{'no_search_fields'};
my $table = $cgi->param('table') or die "'table' required";
my $agent_virt_agentnum = $cgi->param('agent_virt_agentnum') || '';
+my $popup = $cgi->param('popup');
+my $url = $cgi->param('url');
+my $pdest = { 'message' => "Notice sent" };
+$pdest->{'url'} = $cgi->param('url') if $url;
+
my %search;
if ( $cgi->param('search') ) {
- %search = %{ thaw(decode_base64($cgi->param('search'))) };
+ %search = %{ thaw(decode_base64( $cgi->param('search') )) };
}
else {
%search = $cgi->Vars;
- delete $search{$_} for qw( action table from subject html_body text_body );
+ delete $search{$_} for @no_search_fields;
# 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_
# have had multiple values, only whether it does.
@search{keys %search} = map { /\0/ ? [ split /\0/, $_ ] : $_ } values %search;
-}
+}
-my $title = 'Send customer notices';
+&{$opt{'post_search_hook'}}(
+ 'conf' => $conf,
+ 'search' => \%search,
+) if $opt{'post_search_hook'};
my $num_cust;
my $from = '';
my $subject = $cgi->param('subject') || '';
my $html_body = $cgi->param('html_body') || '';
+my @contact_classnum;
+my @contact_classname;
+
+my $subject = $cgi->param('subject');
+my $body = $cgi->param('body');
+
my $msg_template = '';
if ( $cgi->param('action') eq 'preview' ) {
+
my $sql_query = "FS::$table"->search(\%search);
my $count_query = delete($sql_query->{'count_query'});
my $count_sth = dbh->prepare($count_query)
if ( $cgi->param('msgnum') ) {
$msg_template = qsearchs('msg_template',
- { msgnum => $cgi->param('msgnum') } )
+ { msgnum => scalar($cgi->param('msgnum')) } )
or die "template not found: ".$cgi->param('msgnum');
$sql_query->{'extra_sql'} .= ' LIMIT 1';
$sql_query->{'select'} = "$table.*";
$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,
);
+ my %message = $msg_template->prepare(%msgopts);
($from, $subject, $html_body) = @message{'from', 'subject', 'html_body'};
}
+
+ # contact_class_X params
+ foreach my $param ( $cgi->multi_param ) {
+ if ( $param =~ /^contact_class_(\w+)$/ ) {
+ push @contact_classnum, $1;
+ if ( $1 eq 'invoice' ) {
+ push @contact_classname, 'Invoice recipients';
+ } else {
+ my $contact_class = FS::contact_class->by_key($1);
+ push @contact_classname, encode_entities($contact_class->classname);
+ }
+ }
+ }
}
+my @contact_checkboxes = (
+ [ 'invoice' => { label => 'Invoice recipients' } ]
+);
+foreach my $class (qsearch('contact_class', { disabled => '' })) {
+ push @contact_checkboxes, [
+ $class->classnum,
+ { label => $class->classname }
+ ];
+}
</%init>
projects / freeside.git / blobdiff