app/models/mailer_tags.rb @@ -8,6 +8,11 @@ Ported to 'mental' by: Sean Cribbs - seancribbs.com Version: 0.1 Contact: seancribbs@gmail.com +File upload facility and submit placeholder + by: Tobin Richard, Tricycle Developments - tricycledevelopments.com + Version: 0.2 + Contact: tobin.richard@gmail.com + The Mailer extension enables form mail on a page. You can define email templates using pages parts (email, and/or email_html). You configure the recipients and other Mailer settings in a config part. Following @@ -36,6 +41,9 @@ The following tags are available to help you build the form: <r:mailer:option name="" /> <r:mailer:submit /> <r:mailer:reset /> + <r:mailer:submit_placeholder /> + +... and the following to help you build the email or email_html templates. <r:mailer:get name="" /> Simple example of a form: @@ -49,9 +57,47 @@ Simple example of a form: <r:mailer:submit value="Send" /> </r:mailer:form> +Forms with file attachments: + +In many cases it is desirable to limit the maximum size of a file that may be uploaded. +This is set as the max_filesize attribute for mailers in the config page part. Any file +included in the form will have the limit imposed. Following is a simple example config +part that includes a file size limit of 100,000 bytes: + mailers: + contact: + subject: From the website of Whatever + from: noreply@mydomain.com + redirect_to: /contact/thank-you + max_filesize: 100000 + recipients: + - one@one.com + - two@two.com + +The following is a simple form that might be used to submit a file for the above +configuration: + <r:mailer:form name="contact"> + Type your message: <r:mailer:text name="themessage" /> <br/> + Select a file: <r:mailer:file name="thefile" /> <br/> + <r:mailer:submit value="submit"/> + </r:mailer:form> + +If a user does not select a file the other form contents will still be e-mailed. +The <r:mailer:get name="foo" /> (with <r:mailer:file name="foo" />) will provide the +uploaded file name. + +If you are using email or email_html parts then the <r:mailer:get name="" /> tag can be +used to retrieve the name of the uploaded file. If no file was uploaded "" will be +returned. + +If you wish to show show that activity is taking place during submission you may use +the <r:mailer:submit_placeholder /> tag in your form. This will insert a hidden div with +the contents of the submit_placeholder page part. The div will be displayed when the +user clicks any submit button. Todo: * Abstract tag naming, doesn't need to mimick HTML input types - * Support for file attachments to emails * Validate recipient emails addresses -- at least the format - * Better Error handling \ No newline at end of file + * Better Error handling + * Status indicator during file uploads + * Check _all_ file attachment sizes before displaying any file size errors rather + than stopping at the first. README @@ -1,5 +1,7 @@ require 'action_mailer' class MailerPage < Page + include MailerTags + TLDS = %w{com org net edu info mil gov biz ws} class MailerTagError < StandardError; end @@ -25,9 +27,9 @@ class MailerPage < Page @form_data = request.parameters[:mailer] @form_conf = config['mailers'][form_name].symbolize_keys || {} # If there are recipients defined, send email... - if form_conf.has_key? :recipients + if recipients if send_mail and form_conf.has_key? :redirect_to - response.redirect(form_conf[:redirect_to], :status => 302) + response.redirect( form_conf[:redirect_to], "302 Found" ) else super(request, response) end @@ -45,205 +47,86 @@ class MailerPage < Page false end - # Mailer Tags: + protected - desc %{ All mailer-related tags live inside this one. } - tag "mailer" do |tag| - tag.expand - end - - desc %{ - Generates a form for submitting email. The 'name' attribute is required - and should correspond with configuration given in the 'config' part/tab. - - Usage: - <pre><code> <r:mailer:form name="contact">...</r:mailer:form></code></pre>} - tag "mailer:form" do |tag| - @tag_attr = { :class=>get_class_name('form') }.update( tag.attr.symbolize_keys ) - raise_error_if_name_missing 'mailer:form' - # Build the html form tag... - results = %Q(<form action="#{ url }" method="post" class="#{ tag_attr[:class] }" enctype="multipart/form-data">) - results << %Q(<div><input type="hidden" name="mailer_name" value="#{ tag_attr[:name] }" /></div>) - results << %Q(<div class="mailer-error">#{form_error}</div>) if form_error - results << tag.expand - results << %Q(</form>) - end - - # Build tags for all of the <input /> tags... - %w(text password file submit reset checkbox radio hidden).each do |type| - desc %{ - Renders a #{type} form control for a mailer form. #{"The 'name' attribute is required." unless %(submit reset).include? type} - All unused attributes will be added as HTML attributes on the resulting tag.} - tag "mailer:#{type}" do |tag| - @tag_attr = tag.attr.symbolize_keys - raise_error_if_name_missing "mailer:#{type}" unless %(submit reset).include? type - input_tag_html( type ) - end - end - - desc %{ - Renders a @<select>...</select>@ tag for a mailer form. The 'name' attribute is required. @<r:option />@ tags may be nested - inside the tag to automatically generate options. - } - tag 'mailer:select' do |tag| - @tag_attr = { :id=>tag.attr['name'], :class=>get_class_name('select'), :size=>'1' }.update( tag.attr.symbolize_keys ) - raise_error_if_name_missing "mailer:select" - tag.locals.parent_tag_name = tag_attr[:name] - tag.locals.parent_tag_type = 'select' - results = %Q(<select name="mailer[#{tag_attr[:name]}]" #{add_attrs_to("")}>) - results << tag.expand - results << "</select>" - end - - desc %{ - Renders a <textarea>...</textarea> tag for a mailer form. The `name' attribute is required. } - tag 'mailer:textarea' do |tag| - @tag_attr = { :id=>tag.attr['name'], :class=>get_class_name('textarea'), :rows=>'5', :cols=>'35' }.update( tag.attr.symbolize_keys ) - raise_error_if_name_missing "mailer:textarea" - results = %Q(<textarea name="mailer[#{tag_attr[:name]}]" #{add_attrs_to("")}>) - results << tag.expand - results << "</textarea>" - end - - desc %{ - Renders a series of @<input type="radio" .../>@ tags for a mailer form. The 'name' attribute is required. - Nested @<r:option />@ tags will generate individual radio buttons with corresponding values. } - tag 'mailer:radiogroup' do |tag| - @tag_attr = tag.attr.symbolize_keys - raise_error_if_name_missing "mailer:radiogroup" - tag.locals.parent_tag_name = tag_attr[:name] - tag.locals.parent_tag_type = 'radiogroup' - tag.expand - end - - desc %{ Renders an @<option/>@ tag if the parent is a - @<r:mailer:select>...</r:mailer:select>@ tag, an @<input type="radio"/>@ tag if - the parent is a @<r:mailer:radiogroup>...</r:mailer:radiogroup>@ } - tag 'mailer:option' do |tag| - @tag_attr = tag.attr.symbolize_keys - raise_error_if_name_missing "mailer:option" - result = "" - if tag.locals.parent_tag_type == 'select' - result << %Q|<option value="#{tag_attr.delete(:value) || tag_attr[:name]}" #{add_attrs_to("")}>#{tag_attr[:name]}</option>| - elsif tag.locals.parent_tag_type == 'radiogroup' - tag.globals.option_count = tag.globals.option_count.nil? ? 1 : tag.globals.option_count += 1 - options = tag_attr.clone.update({ - :id => "#{tag.locals.parent_tag_name}_#{tag.globals.option_count}", - :value => tag_attr.delete(:value) || tag_attr[:name], - :name => tag.locals.parent_tag_name - }) - result << %Q|<label for="#{options[:id]}">| - result << input_tag_html( 'radio', options ) - result << %Q|<span>#{tag_attr[:name]}</span></label>| - end - end - - desc %{ - Renders an obfuscated email address @<option />@ tag - using the email.js file. Use nested @<r:address>...</r:address>@ to specify the email - address and @<r:label>...</r:label>@ to specify what the content of the tag should be. } - tag 'mailer:email_option' do |tag| - hash = tag.locals.params = {} - contents = tag.expand - address = hash['address'].blank? ? contents : hash['address'] - label = hash['label'] - if address =~ /([\w.%-]+)@([\w.-]+)\.([A-z]{2,4})/ - user, domain, tld = $1, $2, $3 - tld_num = TLDS.index(tld) - unless label.blank? - %{<script type="text/javascript"> - // <![CDATA[ - mail4('#{user}', '#{domain}', #{tld_num}, "#{label}"); - // ]]> - </script> - } + def recipients + chosen_recipient = form_data[:recipient_choice] + if form_conf[:recipient_list] && chosen_address = form_conf[:recipient_list][chosen_recipient] + [chosen_address] else - %{<script type="text/javascript"> - // <![CDATA[ - mail4('#{user}', '#{domain}', #{tld_num}, '#{user}'); - // ]]> - </script> - } - end + form_conf[:recipients] end end - tag "mailer:email_option:label" do |tag| - tag.locals.params['label'] = tag.expand.strip + def from + form_data[form_conf[:from_field]] || form_conf[:from] || "no-reply@#{request.host}" end - tag "mailer:email_option:address" do |tag| - tag.locals.params['address'] = tag.expand.strip + def cc + form_data[form_conf[:cc_field]] || form_conf[:cc] || "" end - - desc %{ - Renders the value of a datum submitted via a mailer form. Used in the 'email', 'email_html', and - 'config' parts to generate the resulting email. } - tag 'mailer:get' do |tag| - name = tag.attr['name'] - if name - form_data[name].is_a?(Array) ? form_data[name].to_sentence : form_data[name] - else - form_data.to_hash.to_yaml.to_s + def reply_to + form_data[form_conf[:reply_to_field]] || form_conf[:reply_to] || from end + + def subject + form_data[:subject] || form_conf[:subject] || "Form Mail from #{request.host}" end -protected + def html_body + html_body = render_part( :email_html ) || nil + end - # Since several form tags use the <input type="X" /> format, let's do that work in one place - def input_tag_html(type, opts=tag_attr) - options = { :id => tag_attr[:name], :value => "", :class=>get_class_name(type) }.update(opts) - results = %Q(<input type="#{type}" ) - results << %Q(name="mailer[#{options[:name]}]" ) if tag_attr[:name] - results << "#{add_attrs_to("", options)}/>" + def plain_body + part( :email ) ? render_part( :email ) : render_part( :email_plain ) end - def add_attrs_to(results, tag_attrs=tag_attr) - # Well, turns out I stringify the keys so I can sort them so I can test the tag output - tag_attrs.stringify_keys.sort.each do |name, value| - results << %Q(#{name.to_s}="#{value.to_s}" ) unless name == 'name' + def plain_or_default_body + (plain_body.nil? || plain_body.empty?) ? default_body : plain_body end - results + + def default_body + "The following information was posted:\n#{form_data.to_hash.to_yaml}" end - # Get the default css class based on type - def get_class_name(type, class_name=nil) - class_name = 'mailer-form' if class_name.nil? and %(form).include? type - class_name = 'mailer-field' if class_name.nil? and %(text password file select textarea).include? type - class_name = 'mailer-button' if class_name.nil? and %(submit reset).include? type - class_name = 'mailer-option' if class_name.nil? and %(checkbox radio).include? type - class_name + def max_filesize + form_conf[:max_filesize] || 0 end - # Raises a 'name missing' tag error - def raise_name_error(tag_name) - raise MailerTagError.new( "`#{tag_name}' tag requires a `name' attribute" ) + def attached_files + files = [] + form_data.each_value do |d| + files << d if d.is_a?(Tempfile) || d.class == StringIO end - def raise_error_if_name_missing(tag_name) - raise_name_error( tag_name ) if tag_attr[:name].nil? or tag_attr[:name].empty? + files end + # Does the work of actually sending the emails - def send_mail() - begin - # Data defined in config part - recipients = form_conf[:recipients] - from = form_data[form_conf[:from_field]] || form_conf[:from] || "no-reply@#{request.host}" - reply_to = form_data[form_conf[:reply_to_field]] || form_conf[:reply_to] || from - # Render the email templates from page parts - plain_body = part( :email ) ? render_part( :email ) : render_part( :email_plain ) - html_body = render_part( :email_html ) || nil - # If we haven't defined any kind of mail template, use a default text one. - if (plain_body.nil? or plain_body.empty?) and (html_body.nil? or html_body.empty?) - plain_body = <<-EMAIL -The following information was posted: -#{form_data.to_hash.to_yaml} - EMAIL + def send_mail + create_actionmailer_deliver_method + ActionMailer::Base.deliver_generic_mailer( + :recipients => recipients, + :from => from, + :subject => subject, + :plain_body => plain_or_default_body, + :html_body => html_body, + :cc => cc, + :headers => { 'Reply-To' => reply_to }, + :files => attached_files, + :filesize_limit => max_filesize + ) + true + rescue + @form_error = "Error encountered while trying to send email. #{$!}" + false end + # Since we can't have a subclass of ActionMailer in our behavior file, # We add a generic mailer method to the ActionMailer::Base clase. # Is this a hack? Yes. Does it work? Yes. + def create_actionmailer_deliver_method ActionMailer::Base.module_eval( <<-CODE ) unless ActionMailer::Base.respond_to? 'generic_mailer' def generic_mailer(options) @recipients = options[:recipients] @@ -253,31 +136,25 @@ The following information was posted: @subject = options[:subject] || "" @headers = options[:headers] || {} @charset = options[:charset] || "utf-8" - @content_type = "multipart/alternative" + @content_type = "multipart/mixed" if options.has_key? :plain_body part :content_type => "text/plain", :body => (options[:plain_body] || "") end if options.has_key? :html_body and !options[:html_body].blank? part :content_type => "text/html", :body => (options[:html_body] || "") end + # attchments + options[:files].each do |a| + # only attach files that are below the filesize limit + if (options[:filesize_limit] == 0 || a.size <= options[:filesize_limit]) then + attachment( :content_type => "application/octet-stream", + :body => a.read, + :filename => a.original_filename ) + else + raise "The file " + a.original_filename + " is too large. The maximum size allowed is " + options[:filesize_limit].to_s + " bytes." end - CODE - # Now deliver mail using our new generic_mail method - ActionMailer::Base.deliver_generic_mailer( - :recipients => recipients, - :from => from, - :subject => form_data[:subject] || form_conf[:subject] || "Form Mail from #{request.host}", - :plain_body => plain_body, - :html_body => html_body, - :cc => form_data[form_conf[:cc_field]] || form_conf[:cc] || "", - :headers => { 'Reply-To' => reply_to } - ) - rescue - @form_error = "Error encountered while trying to send email. #{$!}" - return false end - true end - + CODE + end end - app/models/mailer_page.rb @@ -1,5 +1,5 @@ class MailerExtension < Radiant::Extension - version "0.1" + version "0.2" description "Provides a page type for email forms and generic mailing functionality. Based on Matt McCray's behavior." url "http://dev.radiantcms.org/svn/radiant/branches/mental/extensions/mailer/" mailer_extension.rb @@ -2,13 +2,8 @@ require File.dirname(__FILE__) + '/../test_helper' class MailerExtensionTest < Test::Unit::TestCase - # Replace this with your real tests. - def test_this_extension - flunk - end - def test_initialization - assert_equal RADIANT_ROOT + '/vendor/extensions/mailer', MailerExtension.root + assert MailerExtension.root.match(%r{/vendor/extensions/mailer$}) assert_equal 'Mailer', MailerExtension.extension_name end test/functional/mailer_extension_test.rb a6dd0d045501d8210e7e558419634c6aa0115eda Glenn Murray glenn@trike.com.au http://github.com/tricycle/radiant-mailer-extension/commit/04ee071195a3a0eddb3392a4d1117ba8d2700605 04ee071195a3a0eddb3392a4d1117ba8d2700605 2008-07-30T17:37:13-07:00 2008-07-29T22:21:30-07:00 File upload facility and submit placeholder [Tobin Richard (tobin.richard@gmail.com) Tricycle Developments - tricycledevelopments.com] b22fb83bbd297584a3d3a0de32827223f147dfc6 Glenn Murray glenn@trike.com.au