X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fmisc%2Femail-customers.html;h=d1d5ac735eb99cf66a40263cbd98a6b2d9828854;hb=0be0b02db98ed06dabe51805fe45b2e9704327b8;hp=f644db9e9db089d4b718042467f2445fec016274;hpb=c33e009d50f9af054a5a0195eca5df31c4fb9539;p=freeside.git diff --git a/httemplate/misc/email-customers.html b/httemplate/misc/email-customers.html index f644db9e9..d1d5ac735 100644 --- a/httemplate/misc/email-customers.html +++ b/httemplate/misc/email-customers.html @@ -1,116 +1,184 @@ +<%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 + + + +% if ($popup) { +<% include('/elements/header-popup.html', $title) %> +% } else { <% include('/elements/header.html', $title) %> +% } -
-% foreach my $key ( keys %search ) { -% my @values = ref($search{$key}) ? @{$search{$key}} : ( $search{$key} ); -% foreach my $value ( @values ) { - -% } + + + +%# 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. + +% if (%sub_param) { + % } + + -% if ( $cgi->param('magic') eq 'send' ) { +% if ( $cgi->param('action') eq 'send' ) { Sending notice <% include('/elements/progress-init.html', 'OneTrueForm', - [ keys(%search), qw( from subject html_body text_body ) ], + [ qw( search table from subject html_body text_body msgnum sub_param ) ], 'process/email-customers.html', - { 'message' => "Notice sent" }, #would be nice to show #, but.. + $pdest, ) %> -% } elsif ( $cgi->param('magic') eq 'preview' ) { +% } elsif ( $cgi->param('action') eq 'preview' ) { Preview notice % } -% if ( $cgi->param('magic') ) { +% if ( $cgi->param('action') ) { + + +% if ( $msg_template ) { + <% include('/elements/tr-fixed.html', + 'label' => 'Template:', + 'value' => $msg_template->msgname, + ) + %> +% } <% include('/elements/tr-fixed.html', 'field' => 'from', 'label' => 'From:', - 'value' => scalar( $cgi->param('from') ), + 'value' => scalar( $from ), ) %> <% include('/elements/tr-fixed.html', 'field' => 'subject', 'label' => 'Subject:', - 'value' => scalar( $cgi->param('subject') ), + 'value' => scalar( $subject ), ) %> - + - + % my $text_body = HTML::FormatText->new(leftmargin=>0)->format( % HTML::TreeBuilder->new_from_content( -% $cgi->param('html_body') +% $html_body % ) % ); - +
Message (HTML display): <% $cgi->param('html_body') %><% $html_body %>
Message (Text display):
<% $text_body %>
<% $text_body %>
-% if ( $cgi->param('magic') eq 'preview' ) { +% if ( $cgi->param('action') eq 'preview' ) {
- + % } -% } else { +% } elsif ($alternate_form) { - +<% $alternate_form %> - <% include('/elements/tr-input-text.html', - 'field' => 'from', - 'label' => 'From:', - ) - %> +% } else { + +Template: + <& /elements/select-msg_template.html, + onchange => 'toggle(this)', + &> +
+
+ <& /elements/tr-td-label.html, 'label' => 'From:' &> + + <% include('/elements/tr-input-text.html', 'field' => 'subject', 'label' => 'Subject:', + 'size' => 50, ) %> - - + +
<& /elements/input-text.html, + 'field' => 'from_name', + 'value' => $conf->config('invoice_from_name', $agent_virt_agentnum) || + $conf->config('company_name', $agent_virt_agentnum), #? + 'size' => 20, + &> <\ + <& /elements/input-text.html, + 'field' => 'from_addr', + 'type' => 'email', # HTML5, woot + 'value' => $conf->config('invoice_from', $agent_virt_agentnum), + 'size' => 20, + &>>
Message: <% include('/elements/htmlarea.html', 'field'=>'html_body') %>Message: <& /elements/htmlarea.html, + 'field' => 'html_body', + 'width' => 763, + &> +
%#Substitution vars: -

- + -% } +% } #end not preview or alternate form
-% if ( $cgi->param('magic') eq 'send' ) { +% if ( $cgi->param('action') eq 'send' ) { @@ -120,19 +188,57 @@ <%init> +my %opt = @_; + die "access denied" unless $FS::CurrentUser::CurrentUser->access_right('Bulk send customer notices'); -my %search = $cgi->Vars; -delete $search{$_} for qw( magic from subject html_body text_body ); -$search{$_} = [ split(/\0/, $search{$_}) ] - foreach grep { $_ eq 'payby' || $search{$_} =~ /\0/ } keys %search; +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 $title = 'Bulk send customer notices'; +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'))) }; +} +else { + %search = $cgi->Vars; + 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_ + # have had multiple values, only whether it does. + @search{keys %search} = map { /\0/ ? [ split /\0/, $_ ] : $_ } values %search; +} my $num_cust; -if ( $cgi->param('magic') eq 'preview' ) { - my $sql_query = FS::cust_main->search_sql(\%search); +my $from = ''; +if ( $cgi->param('from') ) { + $from = $cgi->param('from'); +} elsif ( $cgi->param('from_name') ) { + $from = ($cgi->param('from_name') . ' <' . $cgi->param('from_addr') . '>'); +} elsif ( $cgi->param('from_addr') ) { + $from = $cgi->param('from_addr'); +} + +my $subject = $cgi->param('subject') || ''; +my $html_body = $cgi->param('html_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) or die "Error preparing $count_query: ". dbh->errstr; @@ -140,6 +246,24 @@ if ( $cgi->param('magic') eq 'preview' ) { or die "Error executing $count_query: ". $count_sth->errstr; my $count_arrayref = $count_sth->fetchrow_arrayref; $num_cust = $count_arrayref->[0]; + + if ( $cgi->param('msgnum') ) { + $msg_template = qsearchs('msg_template', + { msgnum => $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 %msgopts = ( + 'cust_main' => $cust, + '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'}; + } }