X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fmisc%2Femail-customers.html;h=11ab050b68e8c3b16850402585b41345bff639d9;hb=755159a8654a2eda89badd1498f8def3a472cb15;hp=4e4c15f2a146b00e17982237e362d66631bb804a;hpb=63a268637b2d51a8766412617724b9436439deb6;p=freeside.git diff --git a/httemplate/misc/email-customers.html b/httemplate/misc/email-customers.html index 4e4c15f2a..11ab050b6 100644 --- a/httemplate/misc/email-customers.html +++ b/httemplate/misc/email-customers.html @@ -1,138 +1,286 @@ -<% include('/elements/header.html', $title) %> +<%doc> -
-% foreach my $key ( keys %search ) { -% my @values = ref($search{$key}) ? @{$search{$key}} : ( $search{$key} ); -% foreach my $value ( @values ) { - -% } +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) %> +% } else { +<% include('/elements/header.html', $title) %> % } -% if ( $cgi->param('magic') eq 'send' ) { + + + +%# 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 ( $cgi->param('action') eq 'send' ) { Sending notice - <% include('/elements/progress-init.html', + <& /elements/progress-init.html, 'OneTrueForm', - [ keys(%search), qw( from subject html_body text_body ) ], - '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('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' => $from, ) %> + <& /elements/tr-td-label.html, 'label' => 'To contacts:' &> + + + <% include('/elements/tr-fixed.html', 'field' => 'subject', 'label' => 'Subject:', - 'value' => scalar( $cgi->param('subject') ), + 'value' => $subject, ) %> - + - - + % my $text_body = HTML::FormatText->new(leftmargin=>0)->format( % HTML::TreeBuilder->new_from_content( -% $cgi->param('html_body') +% $html_body % ) % ); - - +
<% join('
', @contact_classname) %>
Message (HTML display): <% $cgi->param('html_body') %>Message (HTML display): + <% $html_body %>
Message (Text display): 
<% $text_body %>
Message (Text display): + + click to view + +
-% if ( $cgi->param('magic') eq 'preview' ) { +% if ( $cgi->param('action') eq 'preview' ) {
- + % } -% } else { +% } elsif ($opt{'alternate_form'}) { - +<% &{$opt{'alternate_form'}}() %> - <% include('/elements/tr-input-text.html', - 'field' => 'from', - 'label' => 'From:', - ) - %> +% } else { + + +Template: + <& /elements/select-msg_template.html, + onchange => 'toggle(this)', + &> +
+% } +% # 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 + }, + &> +
+% # if sending a one-off message, show a form to edit it +
+ <& /elements/tr-td-label.html, 'label' => 'From:' &> + + + <& /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 action or alternate form
-% if ( $cgi->param('magic') eq 'send' ) { +% if ( $cgi->param('action') eq 'send' ) { % } -<% 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 = $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 %search; +if ( $cgi->param('search') ) { + %search = %{ thaw(decode_base64( $cgi->param('search') )) }; +} +else { + %search = $cgi->Vars; + 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 = 'Bulk send customer notices'; +&{$opt{'post_search_hook'}}( + 'conf' => $conf, + 'search' => \%search, +) if $opt{'post_search_hook'}; my $num_cust; -if ( $cgi->param('magic') eq 'preview' ) { - my $sql_query = FS::cust_main->search(\%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 @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) or die "Error preparing $count_query: ". dbh->errstr; @@ -140,6 +288,45 @@ 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 => 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 %msgopts = ( + 'cust_main' => $cust, + '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 } + ]; +}