1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
#!/usr/bin/env ruby
#--
# Copyright (C) 2001, 2002, 2003 Matt Armstrong. All rights reserved.
#
# 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. The name of the author may not be used to endorse or promote
# products derived from this software without specific prior
# written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
#
#++
# This script serves as an example of how you can use the
# RFilter::DeliveryAgent class to perform mail delivery. You can also
# use this script as a fully functioning mail filter.
#
# This script is a basic mail local delivery agent (DeliveryAgent)
# that can be used in place of procmail, maildrop, etc. in a user's
# .forward or .qmail file. The user supplies a delivery script that
# is written in Ruby, which avoids the limitations of the crippled
# mini-languages so often used in other DeliveryAgent programs.
#
# === Usage
#
# rdeliver is invoked from the command line using:
#
# % rdeliver <options> [script]
#
# The script argument is optional. If omitted the script will look
# for a file called .rdeliver in the home directory.
#
# Options are:
#
# <tt>--load-path</tt>:: Prepend the given directory to ruby's
# load path.
#
# <tt>--log</tt> <i>filename</i>:: Log to the given <i>filename</i>. If no
# log is specified, no logging occurs.
#
# <tt>--home</tt> <i>directory</i>:: Specify the home <i>directory</i>.
# rdeliver will change to this directory
# before reading and writing any files.
# The home directory defaults to
# the value of the +HOME+ or +LOGDIR+
# environment variable.
# === Delivery Script
#
# The delivery script runs in the context of a class called Deliver
# (in contrast, most ruby scripts run in the context of the Object
# class). So any methods added with +def+ will be added to the
# Deliver class.
#
# A minimal delivery script would be:
#
# def main
# agent.save('inbox')
# end
#
# This code defines a Deliver#main method that saves the mail into an
# mbox style mailbox.
#
# The only API the Deliver script has is the #agent method. This
# retrieves the RFilter::DeliveryAgent object associated with the current
# message. Using the API of the RFilter::DeliveryAgent object, you can
# access and modify the message body and headers, defer or reject the
# message delivery, and deliver into various mailbox formats.
#
# See also RFilter::DeliveryAgent and Deliver.
#
# === Installation
#
# Assuming you have the RubyMail mail classes installed, you typically
# have to put something like this in your .forward file:
#
# |"/usr/local/bin/rdeliver --log /home/you/.rlog"
#
# This will call rdeliver for each new message you get, and log to
# <tt>/home/you/.rlog</tt>.
#
# === Catastrophic Errors
#
# The rdeliver script is very careful with errors. If there is any
# problem, it logs the error to the log file you specify. But if you
# do not specify a log file, or the error occurs before the log file
# is opened, a record of the error is placed in a file called
# CATASTROPHIC_DELIVERY_FAILURE in the home directory. If that fails,
# the error information is printed to the standard output in the hopes
# that it will be part of a bounce message. In all cases, the exit
# code 75 is returned, which tells the MTA to re-try the delivery
# again.
def print_exception(file, exception) # :nodoc:
file.puts("Exception:\n " +
exception.inspect + "\n")
file.puts "Backtrace:\n"
exception.backtrace.each { |line|
file.puts " " + line + "\n"
}
end
# Try to get to home dir, in prep for possibly writing
# CATASTROPHIC_DELIVERY_FAILURE
not_in_home_dir_exception = nil
begin
Dir.chdir
rescue Exception
not_in_home_dir_exception = $!
end
begin
$SAFE = 1
require 'getoptlong'
parser = GetoptLong.new(['--load-path', '-I', GetoptLong::REQUIRED_ARGUMENT],
['--log', '-l', GetoptLong::REQUIRED_ARGUMENT],
['--home', '-h', GetoptLong::REQUIRED_ARGUMENT])
parser.quiet = true
log = nil
parser.each_option do |name, arg|
case name
when '--home'
Dir.chdir(arg.dup.untaint)
not_in_home_dir_exception = nil
when '--log'
log = arg.dup.untaint
when '--load-path'
$LOAD_PATH.unshift(arg.dup.untaint)
else
raise "don't know about argument #{name}"
end
end
config = ARGV.shift
config ||= '.rdeliver'
config = File.expand_path(config).untaint
raise "extra arguments passed to #{$0}: #{ARGV.inspect}" unless ARGV.empty?
require 'rfilter/delivery_agent'
begin
# The Deliver class used by the bin/rdeliver.rb script to provide
# a place for the user's delivery script to run. The user's
# delivery script executes in the context of this class, so
# methods defined with +def+ do not pollute the global namespace.
# The user is expected to define a #main method that will be
# called to deliver the mail.
#
# See also bin/rdeliver.rb
class Deliver
def initialize(agent) # :nodoc:
@__MAIL_DELIVERY_AGENT__ = agent
end
# Return the RFilter::DeliveryAgent object for the current message.
# This is all you need to retrieve, modify, and deliver the
# message.
def agent
@__MAIL_DELIVERY_AGENT__
end
# This method is called by bin/rdeliver.rb after the Deliver
# object is instantiated. A default implementation that merely
# defers the delivery is provided, but the user is expected to
# replace this with a version that delivers the mail to the
# proper location.
def main
agent.defer('no deliver method specified in configuration file')
end
end
RFilter::DeliveryAgent.process(STDIN, log) { |agent|
# IO.readlines used this way seems to have crapped out as of
# ruby 1.8.1.
# input = IO.readlines(config, nil)[0].untaint,
input = File.new(config).read.untaint
eval(input,
Deliver.module_eval('binding()'),
config)
Deliver.new(agent).main
}
rescue RFilter::DeliveryAgent::DeliveryComplete => exception
if (exception.is_a?(RFilter::DeliveryAgent::DeliveryDefer) ||
exception.is_a?(RFilter::DeliveryAgent::DeliveryReject)) &&
exception.message && exception.message.length > 0
puts exception.message
end
exit(RFilter::DeliveryAgent.exitcode(exception))
end
raise "Script should never get here."
rescue Exception => exception
# The only way to get here is if something goes very wrong and
# probably indicates a serious bug or configuration problem.
if exception.class <= SystemExit
raise exception # normal exit
else
# Be nice and stick the last delivery failure due to a
# catastrophic situation in home/CATASTROPHIC_DELIVERY_FAILURE
begin
unless not_in_home_dir_exception.nil?
raise not_in_home_dir_exception
end
File.open("CATASTROPHIC_DELIVERY_FAILURE", "w") { |file|
print_exception(file, exception)
case exception
when LoadError
file.puts("Current $LOAD_PATH: %s" % $LOAD_PATH.inspect)
end
}
rescue Exception => another_exception
# In the event that the above doesn't happen, we write the error
# to stdout and hope the mailer includes it in the bounce that
# will eventually occur.
print_exception(STDOUT, exception)
puts "Failed writing CATASTROPHIC_DELIVERY_FAILURE because:"
print_exception(STDOUT, another_exception)
ensure
exit 75 # EX_TMPFAIL
end
end
end
|
