aussiegeek-ar_sendmail_delayed 1.3.2

data/History.txt

@@ -0,0 +1,52 @@
+= 1.3.1
+
+* Fix bug #12530, gmail causes SSL errors.  Submitted by Kyle Maxwell
+  and Alex Ostleitner.
+* Try ActionMailer::Base::server_settings then ::smtp_settings.  Fixes
+  bug #12516.  Submitted by Alex Ostleitner.
+
+= 1.3.0
+
+* New Features
+  * Added automatic mail queue cleanup.
+    * MAY CAUSE LOSS OF DATA.  If you haven't run ar_sendmail within
+      the expiry time, set it to 0.
+* Bugs fixed
+  * Authentication errors are now handled by retrying once.
+
+= 1.2.0
+
+* Bugs fixed
+  * Handle SMTPServerBusy by backing off @delay seconds then re-queueing
+  * Allow email delivery class to be set in ARMailer.
+  * ar_sendmail --mailq works with --table-name now.
+* Miscellaneous Updates
+  * Added documentation to require 'action_mailer/ar_mailer' in
+    instructions.
+  * Moved to ZSS p4 repository
+  * Supports TLS now.  Requested by Dave Thomas. smtp_tls.rb from Kyle
+    Maxwell & etc.
+
+= 1.1.0
+
+* Features
+  * Added --chdir to set rails directory
+  * Added --environment to set RAILS_ENV
+  * Exits cleanly on TERM or INT signals
+  * Added FreeBSD rc.d script
+  * Exceptions during SMTP sending are now logged
+  * No longer waits if sending email took too long
+* Bugs fixed
+  * Fixed last send attempt in --mailq
+  * Better SMTP error handling
+    * Messages are removed from the queue on 5xx errors
+    * Added Net::SMTP.reset to avoid needing to recreate the connection
+
+= 1.0.1
+
+* Bugs fixed
+  * From and to of email destination were swapped
+
+= 1.0.0
+
+* Birthday

data/LICENSE.txt

@@ -0,0 +1,28 @@
+Original code copyright 2006, 2007, Eric Hodel, The Robot Co-op.  All
+rights reserved.  Some code under other license, see individual files
+for details.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ar_sendmail
+lib/action_mailer/ar_mailer.rb
+lib/action_mailer/ar_sendmail.rb
+lib/smtp_tls.rb
+share/ar_sendmail
+test/action_mailer.rb
+test/test_armailer.rb
+test/test_arsendmail.rb

data/README.txt

@@ -0,0 +1,39 @@
+= ar_mailer
+
+A two-phase delivery agent for ActionMailer
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/seattlerb
+
+Documentation:
+
+http://seattlerb.org/ar_mailer
+
+Bugs:
+
+http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
+
+== About
+
+Even delivering email to the local machine may take too long when you have to
+send hundreds of messages.  ar_mailer allows you to store messages into the
+database for later delivery by a separate process, ar_sendmail.
+
+== Installing ar_mailer
+
+Just install the gem:
+
+  $ sudo gem install ar_mailer
+
+See ActionMailer::ARMailer for instructions on converting to ARMailer.
+
+See ar_sendmail -h for options to ar_sendmail.
+
+NOTE: You may need to delete an smtp_tls.rb file if you have one lying
+around.  ar_mailer supplies it own.
+
+=== ar_sendmail on FreeBSD or NetBSD
+
+An rc.d script is included in share/ar_sendmail.
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'hoe'
+
+require './lib/action_mailer/ar_sendmail'
+
+Hoe.new 'ar_mailer_delayed', ActionMailer::ARSendmail::VERSION do |s|
+  s.rubyforge_name = 'alangems'
+  s.summary = s.paragraphs_of('README.txt', 1).join(' ')
+  s.description = s.paragraphs_of('README.txt', 9).join(' ')
+  s.url = s.paragraphs_of('README.txt', 5).join(' ')
+  s.author = 'Alan Harper'
+  s.email = 'alan@aussiegeek.net'
+  s.changes = s.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+

data/bin/ar_sendmail

@@ -0,0 +1,6 @@
+#!/usr/local/bin/ruby
+
+require 'action_mailer/ar_sendmail'
+
+ActionMailer::ARSendmail.run
+

data/lib/action_mailer/ar_mailer.rb

@@ -0,0 +1,98 @@
+require 'action_mailer'
+
+##
+# Adds sending email through an ActiveRecord table as a delivery method for
+# ActionMailer.
+#
+# == Converting to ActionMailer::ARMailer
+#
+# Go to your Rails project:
+#
+#   $ cd your_rails_project
+#
+# Create a new migration:
+#
+#   $ ar_sendmail --create-migration
+#
+# You'll need to redirect this into a file.  If you want a different name
+# provide the --table-name option.
+#
+# Create a new model:
+#
+#   $ ar_sendmail --create-model
+#
+# You'll need to redirect this into a file.  If you want a different name
+# provide the --table-name option.
+#
+# Change your email classes to inherit from ActionMailer::ARMailer instead of
+# ActionMailer::Base:
+#
+#   --- app/model/emailer.rb.orig   2006-08-10 13:16:33.000000000 -0700
+#   +++ app/model/emailer.rb        2006-08-10 13:16:43.000000000 -0700
+#   @@ -1,4 +1,4 @@
+#   -class Emailer < ActionMailer::Base
+#   +class Emailer < ActionMailer::ARMailer
+#    
+#   def comment_notification(comment)
+#     from comment.author.email
+#
+# You'll need to be sure to set the From address for your emails.  Something
+# like:
+#
+#   def list_send(recipient)
+#     from 'no_reply@example.com'
+#     # ...
+#
+# Edit config/environment.rb and require ar_mailer.rb:
+#
+#  require 'action_mailer/ar_mailer'
+#
+# Edit config/environments/production.rb and set the delivery agent:
+#
+#   $ grep delivery_method config/environments/production.rb
+#   ActionMailer::Base.delivery_method = :activerecord
+#
+# Run ar_sendmail:
+#
+#   $ ar_sendmail
+#
+# You can also run it from cron with -o, or as a daemon with -d.
+#
+# See <tt>ar_sendmail -h</tt> for full details.
+#
+# == Alternate Mail Storage
+#
+# If you want to set the ActiveRecord model that emails will be stored in,
+# see ActionMailer::ARMailer::email_class=
+
+class ActionMailer::ARMailer < ActionMailer::Base
+
+  @@email_class = Email
+
+  ##
+  # Current email class for deliveries.
+
+  def self.email_class
+    @@email_class
+  end
+
+  ##
+  # Sets the email class for deliveries.
+
+  def self.email_class=(klass)
+    @@email_class = klass
+  end
+
+  ##
+  # Adds +mail+ to the Email table.  Only the first From address for +mail+ is
+  # used.
+
+  def perform_delivery_activerecord(mail)
+    mail.destinations.each do |destination|
+      @@email_class.create :mail => mail.encoded, :to => destination,
+                           :from => mail.from.first
+    end
+  end
+
+end
+

data/lib/action_mailer/ar_sendmail.rb

@@ -0,0 +1,522 @@
+require 'optparse'
+require 'net/smtp'
+require 'smtp_tls'
+require 'rubygems'
+
+class Object # :nodoc:
+  unless respond_to? :path2class then
+    def self.path2class(path)
+      path.split(/::/).inject self do |k,n| k.const_get n end
+    end
+  end
+end
+
+##
+# Hack in RSET
+
+module Net # :nodoc:
+class SMTP # :nodoc:
+
+  unless instance_methods.include? 'reset' then
+    ##
+    # Resets the SMTP connection.
+
+    def reset
+      getok 'RSET'
+    end
+  end
+
+end
+end
+
+module ActionMailer; end # :nodoc:
+
+##
+# ActionMailer::ARSendmail delivers email from the email table to the
+# SMTP server configured in your application's config/environment.rb.
+# ar_sendmail does not work with sendmail delivery.
+#
+# ar_mailer can deliver to SMTP with TLS using smtp_tls.rb borrowed from Kyle
+# Maxwell's action_mailer_optional_tls plugin.  Simply set the :tls option in
+# ActionMailer::Base's smtp_settings to true to enable TLS.
+#
+# See ar_sendmail -h for the full list of supported options.
+#
+# The interesting options are:
+# * --daemon
+# * --mailq
+# * --create-migration
+# * --create-model
+# * --table-name
+
+class ActionMailer::ARSendmail
+
+  ##
+  # The version of ActionMailer::ARSendmail you are running.
+
+  VERSION = '1.3.2'
+
+  ##
+  # Maximum number of times authentication will be consecutively retried
+
+  MAX_AUTH_FAILURES = 2
+
+  ##
+  # Email delivery attempts per run
+
+  attr_accessor :batch_size
+
+  ##
+  # Seconds to delay between runs
+
+  attr_accessor :delay
+
+  ##
+  # Maximum age of emails in seconds before they are removed from the queue.
+
+  attr_accessor :max_age
+
+  ##
+  # Be verbose
+
+  attr_accessor :verbose
+
+  ##
+  # ActiveRecord class that holds emails
+
+  attr_reader :email_class
+
+  ##
+  # True if only one delivery attempt will be made per call to run
+
+  attr_reader :once
+
+  ##
+  # Times authentication has failed
+
+  attr_accessor :failed_auth_count
+
+  ##
+  # Creates a new migration using +table_name+ and prints it on stdout.
+
+  def self.create_migration(table_name)
+    require 'active_support'
+    puts <<-EOF
+class Add#{table_name.classify} < ActiveRecord::Migration
+  def self.up
+    create_table :#{table_name.tableize} do |t|
+      t.column :from, :string
+      t.column :to, :string
+      t.column :last_send_attempt, :integer, :default => 0
+      t.column :deliver_after, :datetime
+      t.column :mail, :text
+      t.column :created_on, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :#{table_name.tableize}
+  end
+end
+    EOF
+  end
+
+  ##
+  # Creates a new model using +table_name+ and prints it on stdout.
+
+  def self.create_model(table_name)
+    require 'active_support'
+    puts <<-EOF
+class #{table_name.classify} < ActiveRecord::Base
+end
+    EOF
+  end
+
+  ##
+  # Prints a list of unsent emails and the last delivery attempt, if any.
+  #
+  # If ActiveRecord::Timestamp is not being used the arrival time will not be
+  # known.  See http://api.rubyonrails.org/classes/ActiveRecord/Timestamp.html
+  # to learn how to enable ActiveRecord::Timestamp.
+
+  def self.mailq(table_name)
+    klass = table_name.split('::').inject(Object) { |k,n| k.const_get n }
+    emails = klass.find :all, :conditions => ["deliver_after > ?", Time.now]
+
+    if emails.empty? then
+      puts "Mail queue is empty"
+      return
+    end
+
+    total_size = 0
+
+    puts "-Queue ID- --Size-- ----Arrival Time---- -Sender/Recipient-------"
+    emails.each do |email|
+      size = email.mail.length
+      total_size += size
+
+      create_timestamp = email.created_on rescue
+                         email.created_at rescue
+                         Time.at(email.created_date) rescue # for Robot Co-op
+                         nil
+
+      created = if create_timestamp.nil? then
+                  '             Unknown'
+                else
+                  create_timestamp.strftime '%a %b %d %H:%M:%S'
+                end
+
+      puts "%10d %8d %s  %s" % [email.id, size, created, email.from]
+      if email.last_send_attempt > 0 then
+        puts "Last send attempt: #{Time.at email.last_send_attempt}"
+      end
+      puts "                                         #{email.to}"
+      puts
+    end
+
+    puts "-- #{total_size/1024} Kbytes in #{emails.length} Requests."
+  end
+
+  ##
+  # Processes command line options in +args+
+
+  def self.process_args(args)
+    name = File.basename $0
+
+    options = {}
+    options[:Chdir] = '.'
+    options[:Daemon] = false
+    options[:Delay] = 60
+    options[:MaxAge] = 86400 * 7
+    options[:Once] = false
+    options[:RailsEnv] = ENV['RAILS_ENV']
+    options[:TableName] = 'Email'
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{name} [options]"
+      opts.separator ''
+
+      opts.separator "#{name} scans the email table for new messages and sends them to the"
+      opts.separator "website's configured SMTP host."
+      opts.separator ''
+      opts.separator "#{name} must be run from a Rails application's root."
+
+      opts.separator ''
+      opts.separator 'Sendmail options:'
+
+      opts.on("-b", "--batch-size BATCH_SIZE",
+              "Maximum number of emails to send per delay",
+              "Default: Deliver all available emails", Integer) do |batch_size|
+        options[:BatchSize] = batch_size
+      end
+
+      opts.on(      "--delay DELAY",
+              "Delay between checks for new mail",
+              "in the database",
+              "Default: #{options[:Delay]}", Integer) do |delay|
+        options[:Delay] = delay
+      end
+
+      opts.on(      "--max-age MAX_AGE",
+              "Maxmimum age for an email. After this",
+              "it will be removed from the queue.",
+              "Set to 0 to disable queue cleanup.",
+              "Default: #{options[:MaxAge]} seconds", Integer) do |max_age|
+        options[:MaxAge] = max_age
+      end
+
+      opts.on("-o", "--once",
+              "Only check for new mail and deliver once",
+              "Default: #{options[:Once]}") do |once|
+        options[:Once] = once
+      end
+
+      opts.on("-d", "--daemonize",
+              "Run as a daemon process",
+              "Default: #{options[:Daemon]}") do |daemon|
+        options[:Daemon] = true
+      end
+
+      opts.on(      "--mailq",
+              "Display a list of emails waiting to be sent") do |mailq|
+        options[:MailQ] = true
+      end
+
+      opts.separator ''
+      opts.separator 'Setup Options:'
+
+      opts.on(      "--create-migration",
+              "Prints a migration to add an Email table",
+              "to stdout") do |create|
+        options[:Migrate] = true
+      end
+
+      opts.on(      "--create-model",
+              "Prints a model for an Email ActiveRecord",
+              "object to stdout") do |create|
+        options[:Model] = true
+      end
+
+      opts.separator ''
+      opts.separator 'Generic Options:'
+
+      opts.on("-c", "--chdir PATH",
+              "Use PATH for the application path",
+              "Default: #{options[:Chdir]}") do |path|
+        usage opts, "#{path} is not a directory" unless File.directory? path
+        usage opts, "#{path} is not readable" unless File.readable? path
+        options[:Chdir] = path
+      end
+
+      opts.on("-e", "--environment RAILS_ENV",
+              "Set the RAILS_ENV constant",
+              "Default: #{options[:RailsEnv]}") do |env|
+        options[:RailsEnv] = env
+      end
+
+      opts.on("-t", "--table-name TABLE_NAME",
+              "Name of table holding emails",
+              "Used for both sendmail and",
+              "migration creation",
+              "Default: #{options[:TableName]}") do |name|
+        options[:TableName] = name
+      end
+
+      opts.on("-v", "--[no-]verbose",
+              "Be verbose",
+              "Default: #{options[:Verbose]}") do |verbose|
+        options[:Verbose] = verbose
+      end
+
+      opts.on("-h", "--help",
+              "You're looking at it") do
+        usage opts
+      end
+
+      opts.separator ''
+    end
+
+    opts.parse! args
+
+    return options if options.include? :Migrate or options.include? :Model
+
+    ENV['RAILS_ENV'] = options[:RailsEnv]
+
+    Dir.chdir options[:Chdir] do
+      begin
+        require 'config/environment'
+      rescue LoadError
+        usage opts, <<-EOF
+#{name} must be run from a Rails application's root to deliver email.
+#{Dir.pwd} does not appear to be a Rails application root.
+          EOF
+      end
+    end
+
+    return options
+  end
+
+  ##
+  # Processes +args+ and runs as appropriate
+
+  def self.run(args = ARGV)
+    options = process_args args
+
+    if options.include? :Migrate then
+      create_migration options[:TableName]
+      exit
+    elsif options.include? :Model then
+      create_model options[:TableName]
+      exit
+    elsif options.include? :MailQ then
+      mailq options[:TableName]
+      exit
+    end
+
+    if options[:Daemon] then
+      require 'webrick/server'
+      WEBrick::Daemon.start
+    end
+
+    new(options).run
+
+  rescue SystemExit
+    raise
+  rescue SignalException
+    exit
+  rescue Exception => e
+    $stderr.puts "Unhandled exception #{e.message}(#{e.class}):"
+    $stderr.puts "\t#{e.backtrace.join "\n\t"}"
+    exit 1
+  end
+
+  ##
+  # Prints a usage message to $stderr using +opts+ and exits
+
+  def self.usage(opts, message = nil)
+    if message then
+      $stderr.puts message
+      $stderr.puts
+    end
+
+    $stderr.puts opts
+    exit 1
+  end
+
+  ##
+  # Creates a new ARSendmail.
+  #
+  # Valid options are:
+  # <tt>:BatchSize</tt>:: Maximum number of emails to send per delay
+  # <tt>:Delay</tt>:: Delay between deliver attempts
+  # <tt>:TableName</tt>:: Table name that stores the emails
+  # <tt>:Once</tt>:: Only attempt to deliver emails once when run is called
+  # <tt>:Verbose</tt>:: Be verbose.
+
+  def initialize(options = {})
+    options[:Delay] ||= 60
+    options[:TableName] ||= 'Email'
+    options[:MaxAge] ||= 86400 * 7
+
+    @batch_size = options[:BatchSize]
+    @delay = options[:Delay]
+    @email_class = Object.path2class options[:TableName]
+    @once = options[:Once]
+    @verbose = options[:Verbose]
+    @max_age = options[:MaxAge]
+
+    @failed_auth_count = 0
+  end
+
+  ##
+  # Removes emails that have lived in the queue for too long.  If max_age is
+  # set to 0, no emails will be removed.
+
+  def cleanup
+    return if @max_age == 0
+    timeout = Time.now - @max_age
+    conditions = ['last_send_attempt > 0 and created_on < ?', timeout]
+    mail = @email_class.destroy_all conditions
+
+    log "expired #{mail.length} emails from the queue"
+  end
+
+  ##
+  # Delivers +emails+ to ActionMailer's SMTP server and destroys them.
+
+  def deliver(emails)
+    user = smtp_settings[:user] || smtp_settings[:user_name]
+    Net::SMTP.start smtp_settings[:address], smtp_settings[:port],
+                    smtp_settings[:domain], user,
+                    smtp_settings[:password],
+                    smtp_settings[:authentication],
+                    smtp_settings[:tls] do |smtp|
+      @failed_auth_count = 0
+      until emails.empty? do
+        email = emails.shift
+        begin
+          res = smtp.send_message email.mail, email.from, email.to
+          email.destroy
+          log "sent email %011d from %s to %s: %p" %
+                [email.id, email.from, email.to, res]
+        rescue Net::SMTPFatalError => e
+          log "5xx error sending email %d, removing from queue: %p(%s):\n\t%s" %
+                [email.id, e.message, e.class, e.backtrace.join("\n\t")]
+          email.destroy
+          smtp.reset
+        rescue Net::SMTPServerBusy => e
+          log "server too busy, sleeping #{@delay} seconds"
+          sleep delay
+          return
+        rescue Net::SMTPUnknownError, Net::SMTPSyntaxError, TimeoutError => e
+          email.last_send_attempt = Time.now.to_i
+          email.save rescue nil
+          log "error sending email %d: %p(%s):\n\t%s" %
+                [email.id, e.message, e.class, e.backtrace.join("\n\t")]
+          smtp.reset
+        end
+      end
+    end
+  rescue Net::SMTPAuthenticationError => e
+    @failed_auth_count += 1
+    if @failed_auth_count >= MAX_AUTH_FAILURES then
+      log "authentication error, giving up: #{e.message}"
+      raise e
+    else
+      log "authentication error, retrying: #{e.message}"
+    end
+    sleep delay
+  rescue Net::SMTPServerBusy, SystemCallError, OpenSSL::SSL::SSLError
+    # ignore SMTPServerBusy/EPIPE/ECONNRESET from Net::SMTP.start's ensure
+  end
+
+  ##
+  # Prepares ar_sendmail for exiting
+
+  def do_exit
+    log "caught signal, shutting down"
+    exit
+  end
+
+  ##
+  # Returns emails in email_class that haven't had a delivery attempt in the
+  # last 300 seconds.
+
+  def find_emails
+    options = { :conditions => ['last_send_attempt < ? and deliver_after > ?', Time.now.to_i - 300, Time.now] }
+    options[:limit] = batch_size unless batch_size.nil?
+    mail = @email_class.find :all, options
+
+    log "found #{mail.length} emails to send"
+    mail
+  end
+
+  ##
+  # Installs signal handlers to gracefully exit.
+
+  def install_signal_handlers
+    trap 'TERM' do do_exit end
+    trap 'INT'  do do_exit end
+  end
+
+  ##
+  # Logs +message+ if verbose
+
+  def log(message)
+    $stderr.puts message if @verbose
+    ActionMailer::Base.logger.info "ar_sendmail: #{message}"
+  end
+
+  ##
+  # Scans for emails and delivers them every delay seconds.  Only returns if
+  # once is true.
+
+  def run
+    install_signal_handlers
+
+    loop do
+      now = Time.now
+      begin
+        cleanup
+        deliver find_emails
+      rescue ActiveRecord::Transactions::TransactionError
+      end
+      break if @once
+      sleep @delay if now + @delay > Time.now
+    end
+  end
+
+  ##
+  # Proxy to ActionMailer::Base::smtp_settings.  See
+  # http://api.rubyonrails.org/classes/ActionMailer/Base.html
+  # for instructions on how to configure ActionMailer's SMTP server.
+  #
+  # Falls back to ::server_settings if ::smtp_settings doesn't exist for
+  # backwards compatibility.
+
+  def smtp_settings
+    ActionMailer::Base.smtp_settings rescue ActionMailer::Base.server_settings
+  end
+
+end
+