X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fmisc%2Femail-customers.html;h=47e6a5b48d2e796c5387faf39ebd272716707c35;hp=83e86158fe2241bd7a7531faf5e24f0f80b47193;hb=9aee669886202be7035e6c6049fc71bc99dd3013;hpb=4bbd2db7a016d9da19f1524895e3d04c3abf89a4 diff --git a/httemplate/misc/email-customers.html b/httemplate/misc/email-customers.html index 83e86158f..47e6a5b48 100644 --- a/httemplate/misc/email-customers.html +++ b/httemplate/misc/email-customers.html @@ -1,11 +1,42 @@ +<%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 + + % if ($popup) { -<% include('/elements/header-popup.html', $title) %> +<& /elements/header-popup.html, $title &> % } else { -<% include('/elements/header.html', $title) %> +<& /elements/header.html, $title &> % } -
+ %# Mixing search params with from address, subject, etc. required special-case %# handling of those, risked name conflicts, and caused massive problems with @@ -19,13 +50,12 @@ Sending notice - <% include('/elements/progress-init.html', + <& /elements/progress-init.html, 'OneTrueForm', [ qw( search table from subject html_body text_body msgnum ) ], - 'process/email-customers.html', + $process_url, $pdest, - ) - %> + &> % } elsif ( $cgi->param('action') eq 'preview' ) { @@ -35,34 +65,32 @@ % if ( $cgi->param('action') ) { - - +
+ % if ( $msg_template ) { - <% include('/elements/tr-fixed.html', + <& /elements/tr-fixed.html, 'label' => 'Template:', 'value' => $msg_template->msgname, - ) - %> + &> % } - <% include('/elements/tr-fixed.html', + <& /elements/tr-fixed.html, 'field' => 'from', 'label' => 'From:', - 'value' => scalar( $from ), - ) - %> + 'value' => $from, + &> - <% include('/elements/tr-fixed.html', + <& /elements/tr-fixed.html, 'field' => 'subject', 'label' => 'Subject:', - 'value' => scalar( $subject ), - ) - %> + 'value' => $subject, + &> + - + @@ -72,16 +100,34 @@ % ) % ); + - - +
 
Message (HTML display): Message (HTML display): <% $html_body %>
 
Message (Text display): 
<% $text_body %>
Message (Text display): + + (view) + + +
-% if ( $cgi->param('action') eq 'preview' ) { +% if ( $cgi->param('action') eq 'preview' ) { % } -<% 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') || ''; @@ -173,19 +232,22 @@ $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 popup url ); + 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 = ''; @@ -203,6 +265,7 @@ 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) @@ -214,17 +277,18 @@ if ( $cgi->param('action') eq 'preview' ) { 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'}; } }