eventmachine 0.12.4 → 0.12.6

data/.gitignore

@@ -0,0 +1,13 @@
+pkg
+rdoc
+Makefile
+
+*.bundle
+*.dll
+*.so
+*.jar
+*.class
+*.o
+*.log
+*.def
+*.pdb

data/Rakefile

@@ -31,7 +31,7 @@ require 'rubygems'  unless defined?(Gem)
 require 'rake'      unless defined?(Rake)
 require 'rake/gempackagetask'
 
-Package = true # Build zips and tarballs?
+Package = false # Build zips and tarballs?
 Dir.glob('tasks/*.rake').each { |r| Rake.application.add_import r }
 
 # e.g. rake EVENTMACHINE_LIBRARY=java for forcing java build tasks as defaults!
@@ -90,7 +90,7 @@ Spec = Gem::Specification.new do |s|
   s.rdoc_options      = %w(--title EventMachine --main docs/README --line-numbers)
   s.extra_rdoc_files  = Dir['docs/*']
 
-  s.files             = %w(Rakefile) + Dir["{bin,tests,lib,ext,java,tasks}/**/*"]
+  s.files             = `git ls-files`.split("\n")
 
   s.require_path      = 'lib'
 
@@ -98,7 +98,11 @@ Spec = Gem::Specification.new do |s|
   # is broken. What we could do is CI submission, though, and always terminate
   # with a positive code...
   # s.test_file         = "tests/testem.rb"
-  s.extensions        = "Rakefile"
+
+  # XXX Using rake to compile extensions breaks when you have multiple ruby installations
+  # and your path isn't set. We can switch back to this once the Gem.exec patch is merged.
+  # s.extensions        = "Rakefile"
+  s.extensions        = ["ext/extconf.rb", "ext/fastfilereader/extconf.rb"]
 
   s.author            = "Francis Cianfrocca"
   s.email             = "garbagecat10@gmail.com"
@@ -124,6 +128,65 @@ using TCP/IP, especially if custom protocols are required.
   s.version = EventMachine::VERSION
 end
 
+if RUBY_PLATFORM =~ /mswin/
+  Spec.platform = 'x86-mswin32-60'
+  Spec.files += %w[ lib/rubyeventmachine.so lib/fastfilereaderext.so ]
+  Spec.extensions = nil
+end
+
+# this is a hack right now, it requires installing msysgit in the global path so it can use tar/curl/etc.
+namespace :win32 do
+  task :check_git do
+    unless `git` =~ /rebase/
+      raise 'git not found, install msys git into the GLOBAL PATH: http://msysgit.googlecode.com/files/Git-1.6.2-preview20090308.exe'
+    end
+  end
+
+  task :check_vc6 do
+    begin
+      raise unless `nmake 2>&1` =~ /Microsoft/
+    rescue
+      raise 'VC6 not found, please run c:\vc\setvc.bat vc6'
+    end
+  end
+
+  task :check_perl do
+    unless `perl --version` =~ /ActiveState/
+      raise 'ActiveState perl required to build OpenSSL: http://downloads.activestate.com/ActivePerl/Windows/5.10/ActivePerl-5.10.0.1004-MSWin32-x86-287188.msi'
+    end
+  end
+
+  task :build_openssl => [:check_git, :check_perl, :check_vc6] do
+    mkdir_p 'build'
+    chdir 'build' do
+      unless File.exists?('openssl-0.9.8j')
+        sh 'curl http://www.openssl.org/source/openssl-0.9.8j.tar.gz > openssl.tar.gz'
+        sh 'tar zxvf openssl.tar.gz' rescue nil # fails because of symlinks
+      end
+
+      mkdir_p 'local'
+      chdir 'openssl-0.9.8j' do
+        sh "perl Configure VC-WIN32 --prefix=\"../local/\""
+        sh 'ms\do_ms.bat'
+        sh 'nmake -f ms\nt.mak install'
+      end
+
+      chdir '../ext' do
+        sh 'git clean -fd .'
+      end
+
+      mv 'local/include/openssl', '../ext/'
+      mv 'local/lib/ssleay32.lib', '../ext/'
+      mv 'local/lib/libeay32.lib', '../ext/'
+    end
+  end
+
+  task :gem => :build_openssl do
+    Rake::Task['build'].invoke
+    Rake::Task['gem'].invoke
+  end
+end
+
 namespace :ext do
   ext_sources = FileList['ext/*.{h,cpp,rb,c}']
   ffr_sources = FileList['ext/fastfilereader/*.{h,cpp,rb}']

data/docs/ChangeLog

@@ -1,12 +1,6 @@
-# $Id$
-#
-#
-
-#-------------------------------------------------------------
-01Oct06: Replaced EventMachine#open_datagram_server with a version that can take
-a Class or a Module, instead of just a Module. Thanks to Tobias Gustafsson for
-pointing out the missing case.
-
+01Oct06: Replaced EventMachine#open_datagram_server with a version that can
+  take a Class or a Module, instead of just a Module. Thanks to Tobias
+  Gustafsson for pointing out the missing case.
 04Oct06: Supported subsecond timer resolutions, per request by Jason Roelofs.
 05Oct06: Added EventMachine#set_quantum, which sets the timer resolution.
 15Nov06: Added Connection#set_comm_inactivity_timeout.
@@ -180,4 +174,38 @@ danielaquino, macournoyer.
  - Fixes in EM.defer under start/stop conditions. Reduced scope of threads.
 23Sep08: Added patch from tmm1 to avoid popen errors on exit.
 30Sep08: Added File.exists? checks in the args for start_tls, as suggested by
-  Brian Lopez (brianmario).
+  Brian Lopez (brianmario).
+10Nov08: ruby 1.9 compatibility enhancements
+28Nov08: Allow for older ruby builds where RARRAY_LEN is not defined
+03Dec08: allow passing arguments to popen handlers
+13Jan09: SSL support for httpclient2 (David Smalley)
+22Jan09: Fixed errors on OSX with the kqueue reactor, fixed errors in the pure
+  ruby reactor. Added EM.current_time. Added EM.epoll? and EM.kqueue?
+27Jan09: Reactor errors are now raised as ruby RuntimeErrors.
+28Jan09: Documentation patch from alloy
+29Jan09: (Late sign-off) Use a longer timeout for connect_server (Ilya
+  Grigorik)
+07Feb09: Fix signal handling issues with threads+epoll
+07Feb09: Use rb_thread_schedule in the epoll reactor
+07Feb09: Use TRAP_BEG/END and rb_thread_schedule in kqueue reactor
+08Feb09: Added fastfilereader from swiftiply
+08Feb09: 1.9 fix for rb_trap_immediate
+08Feb09: Enable rb_thread_blocking_region for 1.9.0 and 1.9.1
+10Feb09: Support win32 builds for fastfilereader
+10Feb09: Added a new event to indicate completion of SSL handshake on TCP
+  connections
+10Feb09: Working get_peer_cert method. Returns the certificate as a Ruby
+  String in PEM format. (Jake Douglas)
+10Feb09: Added EM.get_max_timers
+11Feb09: Fix compile options for sun compiler (Alasdairrr)
+11Feb09: get_status returns a Process::Status object
+12Feb09: Add EM::Protocols::Memcache with simple get/set functionality
+19Feb09: Add catch-all EM.error_handler
+20Feb09: Support miniunit (1.9)
+20Feb09: Return success on content-length = 0 instead of start waiting forever
+  (Ugo Riboni)
+25Feb09: Allow next_tick to be used to pre-schedule reactor operations before
+  EM.run
+26Feb09: Added EM.get_connection_count
+01Mar09: Switch back to extconf for compiling gem extensions
+01Mar09: fixed a small bug with basic auth (mmmurf)

data/eventmachine.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eventmachine}
+  s.version = "0.12.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Francis Cianfrocca"]
+  s.date = %q{2009-03-07}
+  s.description = %q{EventMachine implements a fast, single-threaded engine for arbitrary network communications. It's extremely easy to use in Ruby. EventMachine wraps all interactions with IP sockets, allowing programs to concentrate on the implementation of network protocols. It can be used to create both network servers and clients. To create a server or client, a Ruby program only needs to specify the IP address and port, and provide a Module that implements the communications protocol. Implementations of several standard network protocols are provided with the package, primarily to serve as examples. The real goal of EventMachine is to enable programs to easily interface with other programs using TCP/IP, especially if custom protocols are required.}
+  s.email = %q{garbagecat10@gmail.com}
+  s.extensions = ["ext/extconf.rb", "ext/fastfilereader/extconf.rb"]
+  s.extra_rdoc_files = ["docs/ChangeLog", "docs/COPYING", "docs/DEFERRABLES", "docs/EPOLL", "docs/GNU", "docs/INSTALL", "docs/KEYBOARD", "docs/LEGAL", "docs/LIGHTWEIGHT_CONCURRENCY", "docs/PURE_RUBY", "docs/README", "docs/RELEASE_NOTES", "docs/SMTP", "docs/SPAWNED_PROCESSES", "docs/TODO"]
+  s.files = [".gitignore", "Rakefile", "docs/COPYING", "docs/ChangeLog", "docs/DEFERRABLES", "docs/EPOLL", "docs/GNU", "docs/INSTALL", "docs/KEYBOARD", "docs/LEGAL", "docs/LIGHTWEIGHT_CONCURRENCY", "docs/PURE_RUBY", "docs/README", "docs/RELEASE_NOTES", "docs/SMTP", "docs/SPAWNED_PROCESSES", "docs/TODO", "eventmachine.gemspec", "ext/binder.cpp", "ext/binder.h", "ext/cmain.cpp", "ext/cplusplus.cpp", "ext/ed.cpp", "ext/ed.h", "ext/em.cpp", "ext/em.h", "ext/emwin.cpp", "ext/emwin.h", "ext/epoll.cpp", "ext/epoll.h", "ext/eventmachine.h", "ext/eventmachine_cpp.h", "ext/extconf.rb", "ext/fastfilereader/extconf.rb", "ext/fastfilereader/mapper.cpp", "ext/fastfilereader/mapper.h", "ext/fastfilereader/rubymain.cpp", "ext/files.cpp", "ext/files.h", "ext/kb.cpp", "ext/page.cpp", "ext/page.h", "ext/pipe.cpp", "ext/project.h", "ext/rubymain.cpp", "ext/sigs.cpp", "ext/sigs.h", "ext/ssl.cpp", "ext/ssl.h", "java/.classpath", "java/.project", "java/src/com/rubyeventmachine/Application.java", "java/src/com/rubyeventmachine/Connection.java", "java/src/com/rubyeventmachine/ConnectionFactory.java", "java/src/com/rubyeventmachine/DefaultConnectionFactory.java", "java/src/com/rubyeventmachine/EmReactor.java", "java/src/com/rubyeventmachine/EmReactorException.java", "java/src/com/rubyeventmachine/EventableChannel.java", "java/src/com/rubyeventmachine/EventableDatagramChannel.java", "java/src/com/rubyeventmachine/EventableSocketChannel.java", "java/src/com/rubyeventmachine/PeriodicTimer.java", "java/src/com/rubyeventmachine/Timer.java", "java/src/com/rubyeventmachine/tests/ApplicationTest.java", "java/src/com/rubyeventmachine/tests/ConnectTest.java", "java/src/com/rubyeventmachine/tests/EMTest.java", "java/src/com/rubyeventmachine/tests/TestDatagrams.java", "java/src/com/rubyeventmachine/tests/TestServers.java", "java/src/com/rubyeventmachine/tests/TestTimers.java", "lib/em/deferrable.rb", "lib/em/eventable.rb", "lib/em/future.rb", "lib/em/messages.rb", "lib/em/processes.rb", "lib/em/spawnable.rb", "lib/em/streamer.rb", "lib/eventmachine.rb", "lib/eventmachine_version.rb", "lib/evma.rb", "lib/evma/callback.rb", "lib/evma/container.rb", "lib/evma/factory.rb", "lib/evma/protocol.rb", "lib/evma/reactor.rb", "lib/jeventmachine.rb", "lib/pr_eventmachine.rb", "lib/protocols/buftok.rb", "lib/protocols/header_and_content.rb", "lib/protocols/httpcli2.rb", "lib/protocols/httpclient.rb", "lib/protocols/line_and_text.rb", "lib/protocols/linetext2.rb", "lib/protocols/memcache.rb", "lib/protocols/postgres.rb", "lib/protocols/saslauth.rb", "lib/protocols/smtpclient.rb", "lib/protocols/smtpserver.rb", "lib/protocols/stomp.rb", "lib/protocols/tcptest.rb", "setup.rb", "tasks/cpp.rake", "tasks/project.rake", "tasks/tests.rake", "tests/test_attach.rb", "tests/test_basic.rb", "tests/test_connection_count.rb", "tests/test_defer.rb", "tests/test_epoll.rb", "tests/test_error_handler.rb", "tests/test_errors.rb", "tests/test_eventables.rb", "tests/test_exc.rb", "tests/test_futures.rb", "tests/test_handler_check.rb", "tests/test_hc.rb", "tests/test_httpclient.rb", "tests/test_httpclient2.rb", "tests/test_kb.rb", "tests/test_ltp.rb", "tests/test_ltp2.rb", "tests/test_next_tick.rb", "tests/test_processes.rb", "tests/test_pure.rb", "tests/test_running.rb", "tests/test_sasl.rb", "tests/test_send_file.rb", "tests/test_servers.rb", "tests/test_smtpclient.rb", "tests/test_smtpserver.rb", "tests/test_spawn.rb", "tests/test_ssl_args.rb", "tests/test_ssl_methods.rb", "tests/test_timers.rb", "tests/test_ud.rb", "tests/testem.rb", "web/whatis"]
+  s.has_rdoc = true
+  s.homepage = %q{http://rubyeventmachine.com}
+  s.rdoc_options = ["--title", "EventMachine", "--main", "docs/README", "--line-numbers"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{eventmachine}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby/EventMachine library}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/ext/cmain.cpp

@@ -272,6 +272,20 @@ extern "C" void evma_set_tls_parms (const char *binding, const char *privatekey_
 		ed->SetTlsParms (privatekey_filename, certchain_filename);
 }
 
+/**************
+evma_get_peer_cert
+**************/
+
+#ifdef WITH_SSL
+extern "C" X509 *evma_get_peer_cert (const char *binding)
+{
+	ensure_eventmachine("evma_get_peer_cert");
+	EventableDescriptor *ed = dynamic_cast <EventableDescriptor*> (Bindable_t::GetObject (binding));
+	if (ed)
+		return ed->GetPeerCert();
+	return NULL;
+}
+#endif
 
 /*****************
 evma_get_peername
@@ -310,12 +324,20 @@ evma_get_subprocess_pid
 extern "C" int evma_get_subprocess_pid (const char *binding, pid_t *pid)
 {
 	ensure_eventmachine("evma_get_subprocess_pid");
-	EventableDescriptor *ed = dynamic_cast <EventableDescriptor*> (Bindable_t::GetObject (binding));
-	if (ed) {
-		return ed->GetSubprocessPid (pid) ? 1 : 0;
+	#ifdef OS_UNIX
+	PipeDescriptor *pd = dynamic_cast <PipeDescriptor*> (Bindable_t::GetObject (binding));
+	if (pd) {
+		return pd->GetSubprocessPid (pid) ? 1 : 0;
+	}
+	else if (pid && EventMachine->SubprocessPid) {
+		*pid = EventMachine->SubprocessPid;
+		return 1;
 	}
 	else
 		return 0;
+	#else
+	return 0;
+	#endif
 }
 
 /**************************
@@ -333,6 +355,15 @@ extern "C" int evma_get_subprocess_status (const char *binding, int *status)
 		return 0;
 }
 
+/*************************
+evma_get_connection_count
+*************************/
+
+extern "C" int evma_get_connection_count()
+{
+	ensure_eventmachine("evma_get_connection_count");
+	return EventMachine->GetConnectionCount();
+}
 
 /*********************
 evma_signal_loopbreak
@@ -398,6 +429,17 @@ extern "C" void evma_set_timer_quantum (int interval)
 	EventMachine->SetTimerQuantum (interval);
 }
 
+
+/************************
+evma_get_max_timer_count
+************************/
+
+extern "C" int evma_get_max_timer_count()
+{
+	return EventMachine_t::GetMaxTimerCount();
+}
+
+
 /************************
 evma_set_max_timer_count
 ************************/

data/ext/cplusplus.cpp

@@ -49,7 +49,11 @@ void EM::AddTimer (int milliseconds, void (*func)())
 {
 	if (func) {
 		const char *sig = evma_install_oneshot_timer (milliseconds);
+		#ifdef OS_SOLARIS8
+		Timers.insert (map<string, void(*)()>::value_type (sig, func));
+		#else
 		Timers.insert (make_pair (sig, func));
+		#endif
 	}
 }
 
@@ -72,7 +76,11 @@ void EM::Acceptor::Accept (const char *signature)
 {
 	Connection *c = MakeConnection();
 	c->Signature = signature;
+	#ifdef OS_SOLARIS8
+	Eventables.insert (std::map<std::string,EM::Eventable*>::value_type (c->Signature, c));
+	#else
 	Eventables.insert (make_pair (c->Signature, c));
+	#endif
 	c->PostInit();
 }
 
@@ -114,7 +122,11 @@ EM::Connection::Connect
 void EM::Connection::Connect (const char *host, int port)
 {
 	Signature = evma_connect_to_server (host, port);
+	#ifdef OS_SOLARIS8
+	Eventables.insert( std::map<std::string,EM::Eventable*>::value_type (Signature, this));
+	#else
 	Eventables.insert( make_pair (Signature, this));
+	#endif
 }
 
 /*******************
@@ -124,7 +136,11 @@ EM::Acceptor::Start
 void EM::Acceptor::Start (const char *host, int port)
 {
 	Signature = evma_create_tcp_server (host, port);
+	#ifdef OS_SOLARIS8
+	Eventables.insert( std::map<std::string,EM::Eventable*>::value_type (Signature, this));
+	#else
 	Eventables.insert( make_pair (Signature, this));
+	#endif
 }
 
 
@@ -167,6 +183,11 @@ void EM::Callback (const char *sig, int ev, const char *data, int length)
 			EM::Eventables.erase (sig);
 			delete e;
 			break;
+
+		case EM_SSL_HANDSHAKE_COMPLETED:
+			e = EM::Eventables [sig];
+			e->SslHandshakeCompleted();
+			break;
 	}
 }
 

data/ext/ed.cpp

@@ -51,6 +51,7 @@ EventableDescriptor::EventableDescriptor (int sd, EventMachine_t *em):
 	LastRead (0),
 	LastWritten (0),
 	bCallbackUnbind (true),
+	UnbindReasonCode (0),
 	MyEventMachine (em)
 {
 	/* There are three ways to close a socket, all of which should
@@ -93,7 +94,7 @@ EventableDescriptor::~EventableDescriptor
 EventableDescriptor::~EventableDescriptor()
 {
 	if (EventCallback && bCallbackUnbind)
-		(*EventCallback)(GetBinding().c_str(), EM_CONNECTION_UNBOUND, NULL, 0);
+		(*EventCallback)(GetBinding().c_str(), EM_CONNECTION_UNBOUND, NULL, UnbindReasonCode);
 	Close();
 }
 
@@ -181,6 +182,7 @@ ConnectionDescriptor::ConnectionDescriptor (int sd, EventMachine_t *em):
 	OutboundDataSize (0),
 	#ifdef WITH_SSL
 	SslBox (NULL),
+	bHandshakeSignaled (false),
 	#endif
 	bIsServer (false),
 	LastIo (gCurrentLoopTime),
@@ -495,10 +497,12 @@ void ConnectionDescriptor::_DispatchInboundData (const char *buffer, int size)
 		int s;
 		char B [2048];
 		while ((s = SslBox->GetPlaintext (B, sizeof(B) - 1)) > 0) {
+			_CheckHandshakeStatus();
 			B [s] = 0;
 			if (EventCallback)
 				(*EventCallback)(GetBinding().c_str(), EM_CONNECTION_READ, B, s);
 		}
+		_CheckHandshakeStatus();
 		// INCOMPLETE, s may indicate an SSL error that would force the connection down.
 		_DispatchCiphertext();
 	}
@@ -516,6 +520,21 @@ void ConnectionDescriptor::_DispatchInboundData (const char *buffer, int size)
 
 
 
+/*******************************************
+ConnectionDescriptor::_CheckHandshakeStatus
+*******************************************/
+
+void ConnectionDescriptor::_CheckHandshakeStatus()
+{
+	#ifdef WITH_SSL
+	if (SslBox && (!bHandshakeSignaled) && SslBox->IsHandshakeCompleted()) {
+		bHandshakeSignaled = true;
+		if (EventCallback)
+			(*EventCallback)(GetBinding().c_str(), EM_SSL_HANDSHAKE_COMPLETED, NULL, 0);
+	}
+	#endif
+}
+
 
 
 /***************************
@@ -737,10 +756,24 @@ void ConnectionDescriptor::SetTlsParms (const char *privkey_filename, const char
 }
 
 
+/*********************************
+ConnectionDescriptor::GetPeerCert
+*********************************/
+
+#ifdef WITH_SSL
+X509 *ConnectionDescriptor::GetPeerCert()
+{
+	if (!SslBox)
+		throw std::runtime_error ("SSL/TLS not running on this connection");
+	return SslBox->GetPeerCert();
+}
+#endif
+
 
 /*****************************************
 ConnectionDescriptor::_DispatchCiphertext
 *****************************************/
+
 #ifdef WITH_SSL
 void ConnectionDescriptor::_DispatchCiphertext()
 {

data/ext/ed.h

@@ -69,6 +69,10 @@ class EventableDescriptor: public Bindable_t
 		virtual void StartTls() {}
 		virtual void SetTlsParms (const char *privkey_filename, const char *certchain_filename) {}
 
+		#ifdef WITH_SSL
+		virtual X509 *GetPeerCert() {return NULL;}
+		#endif
+
 		// Properties: return 0/1 to signify T/F, and handle the values
 		// through arguments.
 		virtual int GetCommInactivityTimeout (int *value) {return 0;}
@@ -101,6 +105,7 @@ class EventableDescriptor: public Bindable_t
 		time_t LastRead;
 		time_t LastWritten;
 		bool bCallbackUnbind;
+		int UnbindReasonCode;
 
 		#ifdef HAVE_EPOLL
 		struct epoll_event EpollEvent;
@@ -163,6 +168,11 @@ class ConnectionDescriptor: public EventableDescriptor
 
 		virtual void StartTls();
 		virtual void SetTlsParms (const char *privkey_filename, const char *certchain_filename);
+
+		#ifdef WITH_SSL
+		virtual X509 *GetPeerCert();
+		#endif
+
 		void SetServerMode() {bIsServer = true;}
 
 		virtual bool GetPeername (struct sockaddr*);
@@ -197,6 +207,7 @@ class ConnectionDescriptor: public EventableDescriptor
 		SslBox_t *SslBox;
 		std::string CertChainFilename;
 		std::string PrivateKeyFilename;
+		bool bHandshakeSignaled;
 		#endif
 		bool bIsServer;
 
@@ -209,6 +220,7 @@ class ConnectionDescriptor: public EventableDescriptor
 		void _DispatchCiphertext();
 		int _SendRawOutboundData (const char*, int);
 		int _ReportErrorStatus();
+		void _CheckHandshakeStatus();
 
 };