MattHulse-eventmachine 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (156) hide show
  1. data/.gitignore +14 -0
  2. data/README +82 -0
  3. data/Rakefile +279 -0
  4. data/docs/COPYING +60 -0
  5. data/docs/ChangeLog +211 -0
  6. data/docs/DEFERRABLES +133 -0
  7. data/docs/EPOLL +141 -0
  8. data/docs/GNU +281 -0
  9. data/docs/INSTALL +13 -0
  10. data/docs/KEYBOARD +38 -0
  11. data/docs/LEGAL +25 -0
  12. data/docs/LIGHTWEIGHT_CONCURRENCY +70 -0
  13. data/docs/PURE_RUBY +75 -0
  14. data/docs/RELEASE_NOTES +94 -0
  15. data/docs/SMTP +2 -0
  16. data/docs/SPAWNED_PROCESSES +89 -0
  17. data/docs/TODO +8 -0
  18. data/eventmachine.gemspec +41 -0
  19. data/examples/ex_channel.rb +43 -0
  20. data/examples/ex_queue.rb +2 -0
  21. data/examples/helper.rb +2 -0
  22. data/ext/binder.cpp +125 -0
  23. data/ext/binder.h +46 -0
  24. data/ext/cmain.cpp +821 -0
  25. data/ext/cplusplus.cpp +202 -0
  26. data/ext/ed.cpp +1868 -0
  27. data/ext/ed.h +416 -0
  28. data/ext/em.cpp +2270 -0
  29. data/ext/em.h +228 -0
  30. data/ext/emwin.cpp +300 -0
  31. data/ext/emwin.h +94 -0
  32. data/ext/epoll.cpp +26 -0
  33. data/ext/epoll.h +25 -0
  34. data/ext/eventmachine.h +122 -0
  35. data/ext/eventmachine_cpp.h +96 -0
  36. data/ext/extconf.rb +138 -0
  37. data/ext/fastfilereader/extconf.rb +84 -0
  38. data/ext/fastfilereader/mapper.cpp +214 -0
  39. data/ext/fastfilereader/mapper.h +59 -0
  40. data/ext/fastfilereader/rubymain.cpp +127 -0
  41. data/ext/files.cpp +94 -0
  42. data/ext/files.h +65 -0
  43. data/ext/kb.cpp +81 -0
  44. data/ext/page.cpp +107 -0
  45. data/ext/page.h +51 -0
  46. data/ext/pipe.cpp +349 -0
  47. data/ext/project.h +147 -0
  48. data/ext/rubymain.cpp +1152 -0
  49. data/ext/sigs.cpp +89 -0
  50. data/ext/sigs.h +32 -0
  51. data/ext/ssl.cpp +460 -0
  52. data/ext/ssl.h +94 -0
  53. data/java/.classpath +8 -0
  54. data/java/.project +17 -0
  55. data/java/src/com/rubyeventmachine/Application.java +192 -0
  56. data/java/src/com/rubyeventmachine/Connection.java +74 -0
  57. data/java/src/com/rubyeventmachine/ConnectionFactory.java +37 -0
  58. data/java/src/com/rubyeventmachine/DefaultConnectionFactory.java +46 -0
  59. data/java/src/com/rubyeventmachine/EmReactor.java +557 -0
  60. data/java/src/com/rubyeventmachine/EmReactorException.java +40 -0
  61. data/java/src/com/rubyeventmachine/EventableChannel.java +69 -0
  62. data/java/src/com/rubyeventmachine/EventableDatagramChannel.java +189 -0
  63. data/java/src/com/rubyeventmachine/EventableSocketChannel.java +364 -0
  64. data/java/src/com/rubyeventmachine/PeriodicTimer.java +38 -0
  65. data/java/src/com/rubyeventmachine/Timer.java +54 -0
  66. data/java/src/com/rubyeventmachine/tests/ApplicationTest.java +108 -0
  67. data/java/src/com/rubyeventmachine/tests/ConnectTest.java +146 -0
  68. data/java/src/com/rubyeventmachine/tests/EMTest.java +80 -0
  69. data/java/src/com/rubyeventmachine/tests/TestDatagrams.java +53 -0
  70. data/java/src/com/rubyeventmachine/tests/TestServers.java +74 -0
  71. data/java/src/com/rubyeventmachine/tests/TestTimers.java +89 -0
  72. data/lib/em/buftok.rb +138 -0
  73. data/lib/em/callback.rb +26 -0
  74. data/lib/em/channel.rb +57 -0
  75. data/lib/em/connection.rb +564 -0
  76. data/lib/em/deferrable.rb +187 -0
  77. data/lib/em/file_watch.rb +54 -0
  78. data/lib/em/future.rb +61 -0
  79. data/lib/em/messages.rb +66 -0
  80. data/lib/em/process_watch.rb +44 -0
  81. data/lib/em/processes.rb +119 -0
  82. data/lib/em/protocols.rb +35 -0
  83. data/lib/em/protocols/header_and_content.rb +138 -0
  84. data/lib/em/protocols/httpclient.rb +263 -0
  85. data/lib/em/protocols/httpclient2.rb +582 -0
  86. data/lib/em/protocols/line_and_text.rb +126 -0
  87. data/lib/em/protocols/linetext2.rb +160 -0
  88. data/lib/em/protocols/memcache.rb +323 -0
  89. data/lib/em/protocols/object_protocol.rb +45 -0
  90. data/lib/em/protocols/postgres3.rb +247 -0
  91. data/lib/em/protocols/saslauth.rb +175 -0
  92. data/lib/em/protocols/smtpclient.rb +350 -0
  93. data/lib/em/protocols/smtpserver.rb +547 -0
  94. data/lib/em/protocols/stomp.rb +200 -0
  95. data/lib/em/protocols/tcptest.rb +53 -0
  96. data/lib/em/queue.rb +61 -0
  97. data/lib/em/spawnable.rb +85 -0
  98. data/lib/em/streamer.rb +130 -0
  99. data/lib/em/timers.rb +55 -0
  100. data/lib/em/version.rb +3 -0
  101. data/lib/eventmachine.rb +1698 -0
  102. data/lib/evma.rb +32 -0
  103. data/lib/evma/callback.rb +32 -0
  104. data/lib/evma/container.rb +75 -0
  105. data/lib/evma/factory.rb +77 -0
  106. data/lib/evma/protocol.rb +87 -0
  107. data/lib/evma/reactor.rb +48 -0
  108. data/lib/jeventmachine.rb +246 -0
  109. data/lib/pr_eventmachine.rb +1022 -0
  110. data/setup.rb +1585 -0
  111. data/tasks/cpp.rake +77 -0
  112. data/tasks/project.rake +79 -0
  113. data/tasks/tests.rake +193 -0
  114. data/tests/client.crt +31 -0
  115. data/tests/client.key +51 -0
  116. data/tests/test_attach.rb +126 -0
  117. data/tests/test_basic.rb +284 -0
  118. data/tests/test_channel.rb +63 -0
  119. data/tests/test_connection_count.rb +35 -0
  120. data/tests/test_defer.rb +47 -0
  121. data/tests/test_epoll.rb +160 -0
  122. data/tests/test_error_handler.rb +35 -0
  123. data/tests/test_errors.rb +82 -0
  124. data/tests/test_exc.rb +55 -0
  125. data/tests/test_file_watch.rb +49 -0
  126. data/tests/test_futures.rb +198 -0
  127. data/tests/test_handler_check.rb +37 -0
  128. data/tests/test_hc.rb +218 -0
  129. data/tests/test_httpclient.rb +218 -0
  130. data/tests/test_httpclient2.rb +153 -0
  131. data/tests/test_inactivity_timeout.rb +50 -0
  132. data/tests/test_kb.rb +60 -0
  133. data/tests/test_ltp.rb +182 -0
  134. data/tests/test_ltp2.rb +317 -0
  135. data/tests/test_next_tick.rb +133 -0
  136. data/tests/test_object_protocol.rb +37 -0
  137. data/tests/test_process_watch.rb +48 -0
  138. data/tests/test_processes.rb +128 -0
  139. data/tests/test_proxy_connection.rb +92 -0
  140. data/tests/test_pure.rb +125 -0
  141. data/tests/test_queue.rb +44 -0
  142. data/tests/test_running.rb +42 -0
  143. data/tests/test_sasl.rb +72 -0
  144. data/tests/test_send_file.rb +242 -0
  145. data/tests/test_servers.rb +76 -0
  146. data/tests/test_smtpclient.rb +83 -0
  147. data/tests/test_smtpserver.rb +85 -0
  148. data/tests/test_spawn.rb +322 -0
  149. data/tests/test_ssl_args.rb +68 -0
  150. data/tests/test_ssl_methods.rb +50 -0
  151. data/tests/test_ssl_verify.rb +82 -0
  152. data/tests/test_timers.rb +162 -0
  153. data/tests/test_ud.rb +36 -0
  154. data/tests/testem.rb +31 -0
  155. data/web/whatis +7 -0
  156. metadata +223 -0
@@ -0,0 +1,350 @@
1
+ #--
2
+ #
3
+ # Author:: Francis Cianfrocca (gmail: blackhedd)
4
+ # Homepage:: http://rubyeventmachine.com
5
+ # Date:: 16 July 2006
6
+ #
7
+ # See EventMachine and EventMachine::Connection for documentation and
8
+ # usage examples.
9
+ #
10
+ #----------------------------------------------------------------------------
11
+ #
12
+ # Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
13
+ # Gmail: blackhedd
14
+ #
15
+ # This program is free software; you can redistribute it and/or modify
16
+ # it under the terms of either: 1) the GNU General Public License
17
+ # as published by the Free Software Foundation; either version 2 of the
18
+ # License, or (at your option) any later version; or 2) Ruby's License.
19
+ #
20
+ # See the file COPYING for complete licensing information.
21
+ #
22
+ #---------------------------------------------------------------------------
23
+ #
24
+ #
25
+
26
+ require 'ostruct'
27
+
28
+ module EventMachine
29
+ module Protocols
30
+
31
+ # Simple SMTP client
32
+ #
33
+ # email = EM::Protocols::SmtpClient.send(
34
+ # :domain=>"example.com",
35
+ # :host=>'localhost',
36
+ # :port=>25, # optional, defaults 25
37
+ # :starttls=>true, # use ssl
38
+ # :from=>"sender@example.com",
39
+ # :to=> ["to_1@example.com", "to_2@example.com"],
40
+ # :header=> {"Subject" => "This is a subject line"},
41
+ # :body=> "This is the body of the email"
42
+ # )
43
+ # email.callback{
44
+ # puts 'Email sent!'
45
+ # }
46
+ # email.errback{ |e|
47
+ # puts 'Email failed!'
48
+ # }
49
+ #
50
+ # Sending generated emails (using mailfactory)
51
+ #
52
+ # mail = MailFactory.new
53
+ # mail.to = 'someone@site.co'
54
+ # mail.from = 'me@site.com'
55
+ # mail.subject = 'hi!'
56
+ # mail.text = 'hello world'
57
+ # mail.html = '<h1>hello world</h1>'
58
+ #
59
+ # email = EM::P::SmtpClient.send(
60
+ # :domain=>'site.com',
61
+ # :from=>mail.from,
62
+ # :to=>mail.to,
63
+ # :content=>"#{mail.to_s}\r\n.\r\n"
64
+ # )
65
+ #
66
+ class SmtpClient < Connection
67
+ include EventMachine::Deferrable
68
+ include EventMachine::Protocols::LineText2
69
+
70
+ # :host => required String
71
+ # a string containing the IP address or host name of the SMTP server to connect to.
72
+ # :port => optional
73
+ # defaults to 25.
74
+ # :domain => required String
75
+ # This is passed as the argument to the EHLO command.
76
+ # :starttls => optional Boolean
77
+ # If it evaluates true, then the client will initiate STARTTLS with
78
+ # the server, and abort the connection if the negotiation doesn't succeed.
79
+ # TODO, need to be able to pass certificate parameters with this option.
80
+ # :auth => optional Hash of auth parameters
81
+ # If not given, then no auth will be attempted.
82
+ # (In that case, the connection will be aborted if the server requires auth.)
83
+ # Specify the hash value :type to determine the auth type, along with additional parameters
84
+ # depending on the type.
85
+ # Currently only :type => :plain is supported. Pass additional parameters :username (String),
86
+ # and :password (either a String or a Proc that will be called at auth-time).
87
+ # Example: :auth => {:type=>:plain, :username=>"mickey@disney.com", :password=>"mouse"}
88
+ # :from => required String
89
+ # Specifies the sender of the message. Will be passed as the argument
90
+ # to the MAIL FROM. Do NOT enclose the argument in angle-bracket (<>) characters.
91
+ # The connection will abort if the server rejects the value.
92
+ # :to => required String or Array of Strings
93
+ # The recipient(s) of the message. Do NOT enclose
94
+ # any of the values in angle-brackets (<>) characters. It's NOT a fatal error if one or more
95
+ # recipients are rejected by the server. (Of course, if ALL of them are, the server will most
96
+ # likely trigger an error when we try to send data.) An array of codes containing the status
97
+ # of each requested recipient is available after the call completes. TODO, we should define
98
+ # an overridable stub that will be called on rejection of a recipient or a sender, giving
99
+ # user code the chance to try again or abort the connection.
100
+ # :header => Required hash of values to be transmitted in the header of the message.
101
+ # The hash keys are the names of the headers (do NOT append a trailing colon), and the values are strings
102
+ # containing the header values. TODO, support Arrays of header values, which would cause us to
103
+ # send that specific header line more than once.
104
+ #
105
+ # Example: :header => {"Subject" => "Bogus", "CC" => "myboss@example.com"}
106
+ # :body => Optional string, defaults blank.
107
+ # This will be passed as the body of the email message.
108
+ # TODO, this needs to be significantly beefed up. As currently written, this requires the caller
109
+ # to properly format the input into CRLF-delimited lines of 7-bit characters in the standard
110
+ # SMTP transmission format. We need to be able to automatically convert binary data, and add
111
+ # correct line-breaks to text data. I think the :body parameter should remain as it is, and we
112
+ # should add a :content parameter that contains autoconversions and/or conversion parameters.
113
+ # Then we can check if either :body or :content is present and do the right thing.
114
+ # :content => Optional array or string
115
+ # Alternative to providing header and body, an array or string of raw data which MUST be in
116
+ # correct SMTP body format, including a trailing dot line
117
+ # :verbose => Optional.
118
+ # If true, will cause a lot of information (including the server-side of the
119
+ # conversation) to be dumped to $>.
120
+ #
121
+ def self.send args={}
122
+ args[:port] ||= 25
123
+ args[:body] ||= ""
124
+
125
+ =begin
126
+ (I don't think it's possible for EM#connect to throw an exception under normal
127
+ circumstances, so this original code is stubbed out. A connect-failure will result
128
+ in the #unbind method being called without calling #connection_completed.)
129
+ begin
130
+ EventMachine.connect( args[:host], args[:port], self) {|c|
131
+ # According to the EM docs, we will get here AFTER post_init is called.
132
+ c.args = args
133
+ c.set_comm_inactivity_timeout 60
134
+ }
135
+ rescue
136
+ # We'll get here on a connect error. This code mimics the effect
137
+ # of a call to invoke_internal_error. Would be great to DRY this up.
138
+ # (Actually, it may be that we never get here, if EM#connect catches
139
+ # its errors internally.)
140
+ d = EM::DefaultDeferrable.new
141
+ d.set_deferred_status(:failed, {:error=>[:connect, 500, "unable to connect to server"]})
142
+ d
143
+ end
144
+ =end
145
+ EventMachine.connect( args[:host], args[:port], self) {|c|
146
+ # According to the EM docs, we will get here AFTER post_init is called.
147
+ c.args = args
148
+ c.set_comm_inactivity_timeout 60
149
+ }
150
+ end
151
+
152
+ # :stopdoc:
153
+
154
+ attr_writer :args
155
+
156
+ def post_init
157
+ @return_values = OpenStruct.new
158
+ @return_values.start_time = Time.now
159
+ end
160
+
161
+ def connection_completed
162
+ @responder = :receive_signon
163
+ @msg = []
164
+ end
165
+
166
+ # We can get here in a variety of ways, all of them being failures unless
167
+ # the @succeeded flag is set. If a protocol success was recorded, then don't
168
+ # set a deferred success because the caller will already have done it
169
+ # (no need to wait until the connection closes to invoke the callbacks).
170
+ #
171
+ def unbind
172
+ unless @succeeded
173
+ @return_values.elapsed_time = Time.now - @return_values.start_time
174
+ @return_values.responder = @responder
175
+ @return_values.code = @code
176
+ @return_values.message = @msg
177
+ set_deferred_status(:failed, @return_values)
178
+ end
179
+ end
180
+
181
+ def receive_line ln
182
+ $>.puts ln if @args[:verbose]
183
+ @range = ln[0...1].to_i
184
+ @code = ln[0...3].to_i
185
+ @msg << ln[4..-1]
186
+ unless ln[3...4] == '-'
187
+ $>.puts @responder if @args[:verbose]
188
+ send @responder
189
+ @msg.clear
190
+ end
191
+ end
192
+
193
+ # We encountered an error from the server and will close the connection.
194
+ # Use the error and message the server returned.
195
+ #
196
+ def invoke_error
197
+ @return_values.elapsed_time = Time.now - @return_values.start_time
198
+ @return_values.responder = @responder
199
+ @return_values.code = @code
200
+ @return_values.message = @msg
201
+ set_deferred_status :failed, @return_values
202
+ send_data "QUIT\r\n"
203
+ close_connection_after_writing
204
+ end
205
+
206
+ # We encountered an error on our side of the protocol and will close the connection.
207
+ # Use an extra-protocol error code (900) and use the message from the caller.
208
+ #
209
+ def invoke_internal_error msg = "???"
210
+ @return_values.elapsed_time = Time.now - @return_values.start_time
211
+ @return_values.responder = @responder
212
+ @return_values.code = 900
213
+ @return_values.message = msg
214
+ set_deferred_status :failed, @return_values
215
+ send_data "QUIT\r\n"
216
+ close_connection_after_writing
217
+ end
218
+
219
+ def receive_signon
220
+ return invoke_error unless @range == 2
221
+ send_data "EHLO #{@args[:domain]}\r\n"
222
+ @responder = :receive_ehlo_response
223
+ end
224
+
225
+ def receive_ehlo_response
226
+ return invoke_error unless @range == 2
227
+ @server_caps = @msg
228
+ invoke_starttls
229
+ end
230
+
231
+ def invoke_starttls
232
+ if @args[:starttls]
233
+ # It would be more sociable to first ask if @server_caps contains
234
+ # the string "STARTTLS" before we invoke it, but hey, life's too short.
235
+ send_data "STARTTLS\r\n"
236
+ @responder = :receive_starttls_response
237
+ else
238
+ invoke_auth
239
+ end
240
+ end
241
+ def receive_starttls_response
242
+ return invoke_error unless @range == 2
243
+ start_tls
244
+ invoke_auth
245
+ end
246
+
247
+ # Perform an authentication. If the caller didn't request one, then fall through
248
+ # to the mail-from state.
249
+ def invoke_auth
250
+ if @args[:auth]
251
+ if @args[:auth][:type] == :plain
252
+ psw = @args[:auth][:password]
253
+ if psw.respond_to?(:call)
254
+ psw = psw.call
255
+ end
256
+ #str = Base64::encode64("\0#{@args[:auth][:username]}\0#{psw}").chomp
257
+ str = ["\0#{@args[:auth][:username]}\0#{psw}"].pack("m").chomp
258
+ send_data "AUTH PLAIN #{str}\r\n"
259
+ @responder = :receive_auth_response
260
+ else
261
+ return invoke_internal_error("unsupported auth type")
262
+ end
263
+ else
264
+ invoke_mail_from
265
+ end
266
+ end
267
+ def receive_auth_response
268
+ return invoke_error unless @range == 2
269
+ invoke_mail_from
270
+ end
271
+
272
+ def invoke_mail_from
273
+ send_data "MAIL FROM: <#{@args[:from]}>\r\n"
274
+ @responder = :receive_mail_from_response
275
+ end
276
+ def receive_mail_from_response
277
+ return invoke_error unless @range == 2
278
+ invoke_rcpt_to
279
+ end
280
+
281
+ def invoke_rcpt_to
282
+ @rcpt_responses ||= []
283
+ l = @rcpt_responses.length
284
+ to = @args[:to].is_a?(Array) ? @args[:to] : [@args[:to].to_s]
285
+ if l < to.length
286
+ send_data "RCPT TO: <#{to[l]}>\r\n"
287
+ @responder = :receive_rcpt_to_response
288
+ else
289
+ e = @rcpt_responses.select {|rr| rr.last == 2}
290
+ if e and e.length > 0
291
+ invoke_data
292
+ else
293
+ invoke_error
294
+ end
295
+ end
296
+ end
297
+ def receive_rcpt_to_response
298
+ @rcpt_responses << [@code, @msg, @range]
299
+ invoke_rcpt_to
300
+ end
301
+
302
+ def invoke_data
303
+ send_data "DATA\r\n"
304
+ @responder = :receive_data_response
305
+ end
306
+ def receive_data_response
307
+ return invoke_error unless @range == 3
308
+
309
+ # The data to send can be given either in @args[:content] (an array or string of raw data
310
+ # which MUST be in correct SMTP body format, including a trailing dot line), or a header and
311
+ # body given in @args[:header] and @args[:body].
312
+ #
313
+ if @args[:content]
314
+ send_data @args[:content].to_s
315
+ else
316
+ # The header can be a hash or an array.
317
+ if @args[:header].is_a?(Hash)
318
+ (@args[:header] || {}).each {|k,v| send_data "#{k}: #{v}\r\n" }
319
+ else
320
+ send_data @args[:header].to_s
321
+ end
322
+ send_data "\r\n"
323
+
324
+ if @args[:body].is_a?(Array)
325
+ @args[:body].each {|e| send_data e}
326
+ else
327
+ send_data @args[:body].to_s
328
+ end
329
+
330
+ send_data "\r\n.\r\n"
331
+ end
332
+
333
+ @responder = :receive_message_response
334
+ end
335
+ def receive_message_response
336
+ return invoke_error unless @range == 2
337
+ send_data "QUIT\r\n"
338
+ close_connection_after_writing
339
+ @succeeded = true
340
+ @return_values.elapsed_time = Time.now - @return_values.start_time
341
+ @return_values.responder = @responder
342
+ @return_values.code = @code
343
+ @return_values.message = @msg
344
+ set_deferred_status :succeeded, @return_values
345
+ end
346
+
347
+ # :startdoc:
348
+ end
349
+ end
350
+ end
@@ -0,0 +1,547 @@
1
+ #--
2
+ #
3
+ # Author:: Francis Cianfrocca (gmail: blackhedd)
4
+ # Homepage:: http://rubyeventmachine.com
5
+ # Date:: 16 July 2006
6
+ #
7
+ # See EventMachine and EventMachine::Connection for documentation and
8
+ # usage examples.
9
+ #
10
+ #----------------------------------------------------------------------------
11
+ #
12
+ # Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
13
+ # Gmail: blackhedd
14
+ #
15
+ # This program is free software; you can redistribute it and/or modify
16
+ # it under the terms of either: 1) the GNU General Public License
17
+ # as published by the Free Software Foundation; either version 2 of the
18
+ # License, or (at your option) any later version; or 2) Ruby's License.
19
+ #
20
+ # See the file COPYING for complete licensing information.
21
+ #
22
+ #---------------------------------------------------------------------------
23
+ #
24
+ #
25
+
26
+ module EventMachine
27
+ module Protocols
28
+
29
+ # This is a protocol handler for the server side of SMTP.
30
+ # It's NOT a complete SMTP server obeying all the semantics of servers conforming to
31
+ # RFC2821. Rather, it uses overridable method stubs to communicate protocol states
32
+ # and data to user code. User code is responsible for doing the right things with the
33
+ # data in order to get complete and correct SMTP server behavior.
34
+ #
35
+ #--
36
+ # Useful paragraphs in RFC-2821:
37
+ # 4.3.2: Concise list of command-reply sequences, in essence a text representation
38
+ # of the command state-machine.
39
+ #
40
+ # STARTTLS is defined in RFC2487.
41
+ # Observe that there are important rules governing whether a publicly-referenced server
42
+ # (meaning one whose Internet address appears in public MX records) may require the
43
+ # non-optional use of TLS.
44
+ # Non-optional TLS does not apply to EHLO, NOOP, QUIT or STARTTLS.
45
+ class SmtpServer < EventMachine::Connection
46
+ include Protocols::LineText2
47
+
48
+ HeloRegex = /\AHELO\s*/i
49
+ EhloRegex = /\AEHLO\s*/i
50
+ QuitRegex = /\AQUIT/i
51
+ MailFromRegex = /\AMAIL FROM:\s*/i
52
+ RcptToRegex = /\ARCPT TO:\s*/i
53
+ DataRegex = /\ADATA/i
54
+ NoopRegex = /\ANOOP/i
55
+ RsetRegex = /\ARSET/i
56
+ VrfyRegex = /\AVRFY\s+/i
57
+ ExpnRegex = /\AEXPN\s+/i
58
+ HelpRegex = /\AHELP/i
59
+ StarttlsRegex = /\ASTARTTLS/i
60
+ AuthRegex = /\AAUTH\s+/i
61
+
62
+
63
+ # Class variable containing default parameters that can be overridden
64
+ # in application code.
65
+ # Individual objects of this class will make an instance-local copy of
66
+ # the class variable, so that they can be reconfigured on a per-instance
67
+ # basis.
68
+ #
69
+ # Chunksize is the number of data lines we'll buffer before
70
+ # sending them to the application. TODO, make this user-configurable.
71
+ #
72
+ @@parms = {
73
+ :chunksize => 4000,
74
+ :verbose => false
75
+ }
76
+ def self.parms= parms={}
77
+ @@parms.merge!(parms)
78
+ end
79
+
80
+
81
+
82
+ def initialize *args
83
+ super
84
+ @parms = @@parms
85
+ init_protocol_state
86
+ end
87
+
88
+ def parms= parms={}
89
+ @parms.merge!(parms)
90
+ end
91
+
92
+ # In SMTP, the server talks first. But by a (perhaps flawed) axiom in EM,
93
+ # #post_init will execute BEFORE the block passed to #start_server, for any
94
+ # given accepted connection. Since in this class we'll probably be getting
95
+ # a lot of initialization parameters, we want the guts of post_init to
96
+ # run AFTER the application has initialized the connection object. So we
97
+ # use a spawn to schedule the post_init to run later.
98
+ # It's a little weird, I admit. A reasonable alternative would be to set
99
+ # parameters as a class variable and to do that before accepting any connections.
100
+ #
101
+ # OBSOLETE, now we have @@parms. But the spawn is nice to keep as an illustration.
102
+ #
103
+ def post_init
104
+ #send_data "220 #{get_server_greeting}\r\n" (ORIGINAL)
105
+ #(EM.spawn {|x| x.send_data "220 #{x.get_server_greeting}\r\n"}).notify(self)
106
+ (EM.spawn {|x| x.send_server_greeting}).notify(self)
107
+ end
108
+
109
+ def send_server_greeting
110
+ send_data "220 #{get_server_greeting}\r\n"
111
+ end
112
+
113
+ def receive_line ln
114
+ @@parms[:verbose] and $>.puts ">>> #{ln}"
115
+
116
+ return process_data_line(ln) if @state.include?(:data)
117
+
118
+ case ln
119
+ when EhloRegex
120
+ process_ehlo $'.dup
121
+ when HeloRegex
122
+ process_helo $'.dup
123
+ when MailFromRegex
124
+ process_mail_from $'.dup
125
+ when RcptToRegex
126
+ process_rcpt_to $'.dup
127
+ when DataRegex
128
+ process_data
129
+ when RsetRegex
130
+ process_rset
131
+ when VrfyRegex
132
+ process_vrfy
133
+ when ExpnRegex
134
+ process_expn
135
+ when HelpRegex
136
+ process_help
137
+ when NoopRegex
138
+ process_noop
139
+ when QuitRegex
140
+ process_quit
141
+ when StarttlsRegex
142
+ process_starttls
143
+ when AuthRegex
144
+ process_auth $'.dup
145
+ else
146
+ process_unknown
147
+ end
148
+ end
149
+
150
+ # TODO - implement this properly, the implementation is a stub!
151
+ def process_vrfy
152
+ send_data "250 Ok, but unimplemented\r\n"
153
+ end
154
+ # TODO - implement this properly, the implementation is a stub!
155
+ def process_help
156
+ send_data "250 Ok, but unimplemented\r\n"
157
+ end
158
+ # TODO - implement this properly, the implementation is a stub!
159
+ def process_expn
160
+ send_data "250 Ok, but unimplemented\r\n"
161
+ end
162
+
163
+ #--
164
+ # This is called at several points to restore the protocol state
165
+ # to a pre-transaction state. In essence, we "forget" having seen
166
+ # any valid command except EHLO and STARTTLS.
167
+ # We also have to callback user code, in case they're keeping track
168
+ # of senders, recipients, and whatnot.
169
+ #
170
+ # We try to follow the convention of avoiding the verb "receive" for
171
+ # internal method names except receive_line (which we inherit), and
172
+ # using only receive_xxx for user-overridable stubs.
173
+ #
174
+ # init_protocol_state is called when we initialize the connection as
175
+ # well as during reset_protocol_state. It does NOT call the user
176
+ # override method. This enables us to promise the users that they
177
+ # won't see the overridable fire except after EHLO and RSET, and
178
+ # after a message has been received. Although the latter may be wrong.
179
+ # The standard may allow multiple DATA segments with the same set of
180
+ # senders and recipients.
181
+ #
182
+ def reset_protocol_state
183
+ init_protocol_state
184
+ s,@state = @state,[]
185
+ @state << :starttls if s.include?(:starttls)
186
+ @state << :ehlo if s.include?(:ehlo)
187
+ receive_transaction
188
+ end
189
+ def init_protocol_state
190
+ @state ||= []
191
+ end
192
+
193
+
194
+ #--
195
+ # EHLO/HELO is always legal, per the standard. On success
196
+ # it always clears buffers and initiates a mail "transaction."
197
+ # Which means that a MAIL FROM must follow.
198
+ #
199
+ # Per the standard, an EHLO/HELO or a RSET "initiates" an email
200
+ # transaction. Thereafter, MAIL FROM must be received before
201
+ # RCPT TO, before DATA. Not sure what this specific ordering
202
+ # achieves semantically, but it does make it easier to
203
+ # implement. We also support user-specified requirements for
204
+ # STARTTLS and AUTH. We make it impossible to proceed to MAIL FROM
205
+ # without fulfilling tls and/or auth, if the user specified either
206
+ # or both as required. We need to check the extension standard
207
+ # for auth to see if a credential is discarded after a RSET along
208
+ # with all the rest of the state. We'll behave as if it is.
209
+ # Now clearly, we can't discard tls after its been negotiated
210
+ # without dropping the connection, so that flag doesn't get cleared.
211
+ #
212
+ def process_ehlo domain
213
+ if receive_ehlo_domain domain
214
+ send_data "250-#{get_server_domain}\r\n"
215
+ if @@parms[:starttls]
216
+ send_data "250-STARTTLS\r\n"
217
+ end
218
+ if @@parms[:auth]
219
+ send_data "250-AUTH PLAIN LOGIN\r\n"
220
+ end
221
+ send_data "250-NO-SOLICITING\r\n"
222
+ # TODO, size needs to be configurable.
223
+ send_data "250 SIZE 20000000\r\n"
224
+ reset_protocol_state
225
+ @state << :ehlo
226
+ else
227
+ send_data "550 Requested action not taken\r\n"
228
+ end
229
+ end
230
+
231
+ def process_helo domain
232
+ if receive_ehlo_domain domain.dup
233
+ send_data "250 #{get_server_domain}\r\n"
234
+ reset_protocol_state
235
+ @state << :ehlo
236
+ else
237
+ send_data "550 Requested action not taken\r\n"
238
+ end
239
+ end
240
+
241
+ def process_quit
242
+ send_data "221 Ok\r\n"
243
+ close_connection_after_writing
244
+ end
245
+
246
+ def process_noop
247
+ send_data "250 Ok\r\n"
248
+ end
249
+
250
+ def process_unknown
251
+ send_data "500 Unknown command\r\n"
252
+ end
253
+
254
+ #--
255
+ # So far, only AUTH PLAIN is supported but we should do at least LOGIN as well.
256
+ # TODO, support clients that send AUTH PLAIN with no parameter, expecting a 3xx
257
+ # response and a continuation of the auth conversation.
258
+ #
259
+ def process_auth str
260
+ if @state.include?(:auth)
261
+ send_data "503 auth already issued\r\n"
262
+ elsif str =~ /\APLAIN\s+/i
263
+ plain = ($'.dup).unpack("m").first # Base64::decode64($'.dup)
264
+ discard,user,psw = plain.split("\000")
265
+ if receive_plain_auth user,psw
266
+ send_data "235 authentication ok\r\n"
267
+ @state << :auth
268
+ else
269
+ send_data "535 invalid authentication\r\n"
270
+ end
271
+ #elsif str =~ /\ALOGIN\s+/i
272
+ else
273
+ send_data "504 auth mechanism not available\r\n"
274
+ end
275
+ end
276
+
277
+ #--
278
+ # Unusually, we can deal with a Deferrable returned from the user application.
279
+ # This was added to deal with a special case in a particular application, but
280
+ # it would be a nice idea to add it to the other user-code callbacks.
281
+ #
282
+ def process_data
283
+ unless @state.include?(:rcpt)
284
+ send_data "503 Operation sequence error\r\n"
285
+ else
286
+ succeeded = proc {
287
+ send_data "354 Send it\r\n"
288
+ @state << :data
289
+ @databuffer = []
290
+ }
291
+ failed = proc {
292
+ send_data "550 Operation failed\r\n"
293
+ }
294
+
295
+ d = receive_data_command
296
+
297
+ if d.respond_to?(:callback)
298
+ d.callback(&succeeded)
299
+ d.errback(&failed)
300
+ else
301
+ (d ? succeeded : failed).call
302
+ end
303
+ end
304
+ end
305
+
306
+ def process_rset
307
+ reset_protocol_state
308
+ receive_reset
309
+ send_data "250 Ok\r\n"
310
+ end
311
+
312
+ def unbind
313
+ connection_ended
314
+ end
315
+
316
+ #--
317
+ # STARTTLS may not be issued before EHLO, or unless the user has chosen
318
+ # to support it.
319
+ # TODO, must support user-supplied certificates.
320
+ #
321
+ def process_starttls
322
+ if @@parms[:starttls]
323
+ if @state.include?(:starttls)
324
+ send_data "503 TLS Already negotiated\r\n"
325
+ elsif ! @state.include?(:ehlo)
326
+ send_data "503 EHLO required before STARTTLS\r\n"
327
+ else
328
+ send_data "220 Start TLS negotiation\r\n"
329
+ start_tls
330
+ @state << :starttls
331
+ end
332
+ else
333
+ process_unknown
334
+ end
335
+ end
336
+
337
+
338
+ #--
339
+ # Requiring TLS is touchy, cf RFC2784.
340
+ # Requiring AUTH seems to be much more reasonable.
341
+ # We don't currently support any notion of deriving an authentication from the TLS
342
+ # negotiation, although that would certainly be reasonable.
343
+ # We DON'T allow MAIL FROM to be given twice.
344
+ # We DON'T enforce all the various rules for validating the sender or
345
+ # the reverse-path (like whether it should be null), and notifying the reverse
346
+ # path in case of delivery problems. All of that is left to the calling application.
347
+ #
348
+ def process_mail_from sender
349
+ if (@@parms[:starttls]==:required and !@state.include?(:starttls))
350
+ send_data "550 This server requires STARTTLS before MAIL FROM\r\n"
351
+ elsif (@@parms[:auth]==:required and !@state.include?(:auth))
352
+ send_data "550 This server requires authentication before MAIL FROM\r\n"
353
+ elsif @state.include?(:mail_from)
354
+ send_data "503 MAIL already given\r\n"
355
+ else
356
+ unless receive_sender sender
357
+ send_data "550 sender is unacceptable\r\n"
358
+ else
359
+ send_data "250 Ok\r\n"
360
+ @state << :mail_from
361
+ end
362
+ end
363
+ end
364
+
365
+ #--
366
+ # Since we require :mail_from to have been seen before we process RCPT TO,
367
+ # we don't need to repeat the tests for TLS and AUTH.
368
+ # Note that we don't remember or do anything else with the recipients.
369
+ # All of that is on the user code.
370
+ # TODO: we should enforce user-definable limits on the total number of
371
+ # recipients per transaction.
372
+ # We might want to make sure that a given recipient is only seen once, but
373
+ # for now we'll let that be the user's problem.
374
+ #
375
+ # User-written code can return a deferrable from receive_recipient.
376
+ #
377
+ def process_rcpt_to rcpt
378
+ unless @state.include?(:mail_from)
379
+ send_data "503 MAIL is required before RCPT\r\n"
380
+ else
381
+ succeeded = proc {
382
+ send_data "250 Ok\r\n"
383
+ @state << :rcpt unless @state.include?(:rcpt)
384
+ }
385
+ failed = proc {
386
+ send_data "550 recipient is unacceptable\r\n"
387
+ }
388
+
389
+ d = receive_recipient rcpt
390
+
391
+ if d.respond_to?(:set_deferred_status)
392
+ d.callback(&succeeded)
393
+ d.errback(&failed)
394
+ else
395
+ (d ? succeeded : failed).call
396
+ end
397
+
398
+ =begin
399
+ unless receive_recipient rcpt
400
+ send_data "550 recipient is unacceptable\r\n"
401
+ else
402
+ send_data "250 Ok\r\n"
403
+ @state << :rcpt unless @state.include?(:rcpt)
404
+ end
405
+ =end
406
+ end
407
+ end
408
+
409
+
410
+ # Send the incoming data to the application one chunk at a time, rather than
411
+ # one line at a time. That lets the application be a little more flexible about
412
+ # storing to disk, etc.
413
+ # Since we clear the chunk array every time we submit it, the caller needs to be
414
+ # aware to do things like dup it if he wants to keep it around across calls.
415
+ #
416
+ # DON'T reset the transaction upon disposition of the incoming message.
417
+ # This means another DATA command can be accepted with the same sender and recipients.
418
+ # If the client wants to reset, he can call RSET.
419
+ # Not sure whether the standard requires a transaction-reset at this point, but it
420
+ # appears not to.
421
+ #
422
+ # User-written code can return a Deferrable as a response from receive_message.
423
+ #
424
+ def process_data_line ln
425
+ if ln == "."
426
+ if @databuffer.length > 0
427
+ receive_data_chunk @databuffer
428
+ @databuffer.clear
429
+ end
430
+
431
+
432
+ succeeded = proc {
433
+ send_data "250 Message accepted\r\n"
434
+ }
435
+ failed = proc {
436
+ send_data "550 Message rejected\r\n"
437
+ }
438
+
439
+ d = receive_message
440
+
441
+ if d.respond_to?(:set_deferred_status)
442
+ d.callback(&succeeded)
443
+ d.errback(&failed)
444
+ else
445
+ (d ? succeeded : failed).call
446
+ end
447
+
448
+ @state.delete :data
449
+ else
450
+ # slice off leading . if any
451
+ ln.slice!(0...1) if ln[0] == 46
452
+ @databuffer << ln
453
+ if @databuffer.length > @@parms[:chunksize]
454
+ receive_data_chunk @databuffer
455
+ @databuffer.clear
456
+ end
457
+ end
458
+ end
459
+
460
+
461
+ #------------------------------------------
462
+ # Everything from here on can be overridden in user code.
463
+
464
+ # The greeting returned in the initial connection message to the client.
465
+ def get_server_greeting
466
+ "EventMachine SMTP Server"
467
+ end
468
+ # The domain name returned in the first line of the response to a
469
+ # successful EHLO or HELO command.
470
+ def get_server_domain
471
+ "Ok EventMachine SMTP Server"
472
+ end
473
+
474
+ # A false response from this user-overridable method will cause a
475
+ # 550 error to be returned to the remote client.
476
+ #
477
+ def receive_ehlo_domain domain
478
+ true
479
+ end
480
+
481
+ # Return true or false to indicate that the authentication is acceptable.
482
+ def receive_plain_auth user, password
483
+ true
484
+ end
485
+
486
+ # Receives the argument of the MAIL FROM command. Return false to
487
+ # indicate to the remote client that the sender is not accepted.
488
+ # This can only be successfully called once per transaction.
489
+ #
490
+ def receive_sender sender
491
+ true
492
+ end
493
+
494
+ # Receives the argument of a RCPT TO command. Can be given multiple
495
+ # times per transaction. Return false to reject the recipient.
496
+ #
497
+ def receive_recipient rcpt
498
+ true
499
+ end
500
+
501
+ # Sent when the remote peer issues the RSET command.
502
+ # Since RSET is not allowed to fail (according to the protocol),
503
+ # we ignore any return value from user overrides of this method.
504
+ #
505
+ def receive_reset
506
+ end
507
+
508
+ # Sent when the remote peer has ended the connection.
509
+ #
510
+ def connection_ended
511
+ end
512
+
513
+ # Called when the remote peer sends the DATA command.
514
+ # Returning false will cause us to send a 550 error to the peer.
515
+ # This can be useful for dealing with problems that arise from processing
516
+ # the whole set of sender and recipients.
517
+ #
518
+ def receive_data_command
519
+ true
520
+ end
521
+
522
+ # Sent when data from the remote peer is available. The size can be controlled
523
+ # by setting the :chunksize parameter. This call can be made multiple times.
524
+ # The goal is to strike a balance between sending the data to the application one
525
+ # line at a time, and holding all of a very large message in memory.
526
+ #
527
+ def receive_data_chunk data
528
+ @smtps_msg_size ||= 0
529
+ @smtps_msg_size += data.join.length
530
+ STDERR.write "<#{@smtps_msg_size}>"
531
+ end
532
+
533
+ # Sent after a message has been completely received. User code
534
+ # must return true or false to indicate whether the message has
535
+ # been accepted for delivery.
536
+ def receive_message
537
+ @@parms[:verbose] and $>.puts "Received complete message"
538
+ true
539
+ end
540
+
541
+ # This is called when the protocol state is reset. It happens
542
+ # when the remote client calls EHLO/HELO or RSET.
543
+ def receive_transaction
544
+ end
545
+ end
546
+ end
547
+ end