swiftiply 0.6.1.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41ffdd88a623bd6b34c2cb105d8e34286a4f226a
+  data.tar.gz: 2fe4a945f3b6008882f52e6e16174fd77603182f
+SHA512:
+  metadata.gz: fdbe79598ec795b05ed861a7fe446da09a7c00f510d468f62c2e1473980f964acaaee63c26919509da5fad293de5bc2f19348ccad22e79d58f4b9c5948d8b1ed
+  data.tar.gz: efe8bf53cf9756435a9924cc08eb5b8eef01d4ea5e69b899648be187ed26bfb5dbdbf2fab3edd4daf9702398d4cb74affc5cc0eb7d4df8b63ad20bd4d5d032ed

data/CONTRIBUTORS

@@ -4,3 +4,5 @@ The fastfilereader extension was contributed by Francis Cianfrocca.
 
 Ezra Zygmuntowicz contributed swiftiply_mongrel_rails and edits to
 mongrel_rails.
+
+Flip Sasser contributed the original version of the swiftiplyctl.

data/README.md

@@ -0,0 +1,62 @@
+# Swiftiply v1.0.0 (http://github.com/wyhaines/swiftiply)
+
+Swiftiply is a backend agnostic clustering proxy for web applications that is
+specifically designed to support HTTP traffic from web frameworks. It is a targeted
+proxy, intended specifically for use in front of web frameworks, and is not a
+general purpose proxy.
+
+What it is, though, is a very fast, narrowly targeted clustering proxy, with the
+current implementation being written in Ruby.
+
+Swiftiply works differently from a traditional proxy. In Swiftiply, the
+backend processes are clients of the Swiftiply server -- they make persistent
+socket connections to Swiftiply. One of the major advantages to this
+architecture is that it allows one to start or stop backend processes at will,
+with no configuration of the proxy. The proxy always knows exactly what resources
+it has available to handle a given request. The obvious disadvantage is that this is
+not behavior that web applications typically expect.
+
+Swiftiply was originally written in an era when Mongrel was the preferred deployment
+method for most Ruby frameworks. Swiftiply includes a version of Mongrel(found in
+swiftcore/swiftiplied_mongrel.rb) that has been modified to work as a swiftiply client.
+This should be transparent to any existing Mongrel handlers, allowing them all to with
+Swiftiply.
+
+Swiftiply also provides a traditional proxy model, allowing it to be used as a proxy
+in front of any web application.
+
+TODO: Provide an implementation of a swiftiply access proxy. This is a Swiftiply
+TODO: "client" that maintains N connections into Swiftiply, but that operates as
+TODO: a traditional proxy on the web application facing side. This lets an individual
+TODO: server modulate the total number of connections that it is willing to handle
+TODO: simultaneously, while not requiring the applications themselves to know anything
+TODO: about it.
+
+CONFIGURATION
+
+Swiftiply takes a single configuration file which defines for it where it
+should listen for incoming connections, whether it should daemonize itself,
+and then provides a map of incoming domain names and the address/port to
+proxy that traffic to. That outgoing address/port is where the backends for
+that site will connect to.
+
+Here's an example:
+
+cluster_address: swiftcore.org
+cluster_port: 80
+daemonize: true
+map:
+ - incoming:
+  - swiftcore.org
+  - www.swiftcore.org
+  outgoing: 127.0.0.1:30000
+  default: true
+ - incoming: iowa.swiftcore.org
+  outgoing: 127.0.0.1:30010
+ - incoming: analogger.swiftcore.org
+  outgoing: 127.0.0.1:30020
+ - incoming:
+  - swiftiply.com
+  - www.swiftiply.com
+  - swiftiply.swiftcore.org
+  outgoing: 127.0.0.1:30030

data/bin/{mongrel_rails → evented_mongrel_rails}

@@ -1,21 +1,13 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2005 Zed A. Shaw 
-# You can redistribute it and/or modify it under the same terms as Ruby.
-#
-# Additional work donated by contributors.  See http://mongrel.rubyforge.org/attributions.html 
-# for more information.
+
+# No more mucking with event variables.  Run swiftiplied_mongrel_rails to run
+# a mongrel_rails setup for Swiftiply.
 
 require 'rubygems'
 require 'yaml'
-if ENV['EVENT']
-  require 'swiftcore/evented_mongrel' 
-  puts "Using Evented Mongrel"
-elsif ENV['SWIFT']
-  require 'swiftcore/swiftiplied_mongrel' 
-  puts "Using Evented Mongrel"  
-else
- require 'mongrel'
-end
+
+require 'swiftcore/evented_mongrel' 
+
 require 'mongrel/rails'
 require 'etc'
 require 'cgi_multipart_eof_fix' rescue nil

data/bin/swiftiplied_mongrel_rails

@@ -0,0 +1,246 @@
+#!/usr/bin/env ruby
+
+# No more mucking with event variables.  Run swiftiplied_mongrel_rails to run
+# a mongrel_rails setup for Swiftiply.
+
+require 'rubygems'
+require 'yaml'
+
+require 'swiftcore/swiftiplied_mongrel' 
+  
+require 'mongrel/rails'
+require 'etc'
+require 'cgi_multipart_eof_fix' rescue nil
+
+module Mongrel
+  class Start < GemPlugin::Plugin "/commands"
+    include Mongrel::Command::Base
+
+    def configure
+      options [
+        ["-e", "--environment ENV", "Rails environment to run as", :@environment, ENV['RAILS_ENV'] || "development"],
+        ["-d", "--daemonize", "Run daemonized in the background", :@daemon, false],
+        ['-p', '--port PORT', "Which port to bind to", :@port, 3000],
+        ['-a', '--address ADDR', "Address to bind to", :@address, "0.0.0.0"],
+        ['-l', '--log FILE', "Where to write log messages", :@log_file, "log/mongrel.log"],
+        ['-P', '--pid FILE', "Where to write the PID", :@pid_file, "log/mongrel.pid"],
+        ['-n', '--num-procs INT', "Number of processors active before clients denied", :@num_procs, 1024],
+        ['-t', '--timeout TIME', "Timeout all requests after 100th seconds time", :@timeout, 0],
+        ['-m', '--mime PATH', "A YAML file that lists additional MIME types", :@mime_map, nil],
+        ['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, Dir.pwd],
+        ['-r', '--root PATH', "Set the document root (default 'public')", :@docroot, "public"],
+        ['-B', '--debug', "Enable debugging mode", :@debug, false],
+        ['-C', '--config PATH', "Use a config file", :@config_file, nil],
+        ['-S', '--script PATH', "Load the given file as an extra config script", :@config_script, nil],
+        ['-G', '--generate PATH', "Generate a config file for use with -C", :@generate, nil],
+        ['', '--user USER', "User to run as", :@user, nil],
+        ['', '--group GROUP', "Group to run as", :@group, nil],
+        ['', '--prefix PATH', "URL prefix for Rails app", :@prefix, nil]
+      ]
+    end
+
+    def validate
+      @cwd = File.expand_path(@cwd)
+      valid_dir? @cwd, "Invalid path to change to during daemon mode: #@cwd"
+
+      # Change there to start, then we'll have to come back after daemonize
+      Dir.chdir(@cwd)
+
+      valid?(@prefix[0].chr == "/" && @prefix[-1].chr != "/", "Prefix must begin with / and not end in /") if @prefix
+      valid_dir? File.dirname(@log_file), "Path to log file not valid: #@log_file"
+      valid_dir? File.dirname(@pid_file), "Path to pid file not valid: #@pid_file"
+      valid_dir? @docroot, "Path to docroot not valid: #@docroot"
+      valid_exists? @mime_map, "MIME mapping file does not exist: #@mime_map" if @mime_map
+      valid_exists? @config_file, "Config file not there: #@config_file" if @config_file
+      valid_dir? File.dirname(@generate), "Problem accessing directory to #@generate" if @generate
+      valid_user? @user if @user
+      valid_group? @group if @group
+
+      return @valid
+    end
+
+    def run
+      # Config file settings will override command line settings
+      settings = { :host => @address,  :port => @port, :cwd => @cwd,
+        :log_file => @log_file, :pid_file => @pid_file, :environment => @environment,
+        :docroot => @docroot, :mime_map => @mime_map, :daemon => @daemon,
+        :debug => @debug, :includes => ["mongrel"], :config_script => @config_script,
+        :num_processors => @num_procs, :timeout => @timeout,
+        :user => @user, :group => @group, :prefix => @prefix, :config_file => @config_file
+      }
+
+      if @generate
+        STDERR.puts "** Writing config to \"#@generate\"."
+        open(@generate, "w") {|f| f.write(settings.to_yaml) }
+        STDERR.puts "** Finished.  Run \"mongrel_rails -C #@generate\" to use the config file."
+        exit 0
+      end
+
+      if @config_file
+        settings.merge! YAML.load_file(@config_file)
+        STDERR.puts "** Loading settings from #{@config_file} (they override command line)." unless settings[:daemon]
+      end
+
+      config = Mongrel::Rails::RailsConfigurator.new(settings) do
+        if defaults[:daemon]
+          if File.exist? defaults[:pid_file]
+            log "!!! PID file #{defaults[:pid_file]} already exists.  Mongrel could be running already.  Check your #{defaults[:log_file]} for errors."
+            log "!!! Exiting with error.  You must stop mongrel and clear the .pid before I'll attempt a start."
+            exit 1
+          end
+
+          daemonize
+          log "Daemonized, any open files are closed.  Look at #{defaults[:pid_file]} and #{defaults[:log_file]} for info."
+          log "Settings loaded from #{@config_file} (they override command line)." if @config_file
+        end
+
+        log "Starting Mongrel listening at #{defaults[:host]}:#{defaults[:port]}"
+
+        listener do
+          mime = {}
+          if defaults[:mime_map]
+            log "Loading additional MIME types from #{defaults[:mime_map]}"
+            mime = load_mime_map(defaults[:mime_map], mime)
+          end
+
+          if defaults[:debug]
+            log "Installing debugging prefixed filters. Look in log/mongrel_debug for the files."
+            debug "/"
+          end
+
+          log "Starting Rails with #{defaults[:environment]} environment..."
+          log "Mounting Rails at #{defaults[:prefix]}..." if defaults[:prefix]
+          uri defaults[:prefix] || "/", :handler => rails(:mime => mime, :prefix => defaults[:prefix])
+          log "Rails loaded."
+
+          log "Loading any Rails specific GemPlugins"
+          load_plugins
+
+          if defaults[:config_script]
+            log "Loading #{defaults[:config_script]} external config script"
+            run_config(defaults[:config_script])
+          end
+
+          setup_rails_signals
+        end
+      end
+
+      config.run
+      config.log "Mongrel available at #{settings[:host]}:#{settings[:port]}"
+
+      if config.defaults[:daemon]
+        config.write_pid_file
+      else
+        config.log "Use CTRL-C to stop." 
+      end
+
+      config.join
+
+      if config.needs_restart
+        if RUBY_PLATFORM !~ /mswin/
+          cmd = "ruby #{__FILE__} start #{original_args.join(' ')}"
+          config.log "Restarting with arguments:  #{cmd}"
+          config.stop
+          config.remove_pid_file
+
+          if config.defaults[:daemon]
+            system cmd
+          else
+            STDERR.puts "Can't restart unless in daemon mode."
+            exit 1
+          end
+        else
+          config.log "Win32 does not support restarts. Exiting."
+        end
+      end
+    end
+  end
+
+  def Mongrel::send_signal(signal, pid_file)
+    pid = open(pid_file).read.to_i
+    print "Sending #{signal} to Mongrel at PID #{pid}..."
+    begin
+      Process.kill(signal, pid)
+    rescue Errno::ESRCH
+      puts "Process does not exist.  Not running."
+    end
+
+    puts "Done."
+  end
+
+
+  class Stop < GemPlugin::Plugin "/commands"
+    include Mongrel::Command::Base
+
+    def configure 
+      options [ 
+        ['-c', '--chdir PATH', "Change to dir before starting (will be expanded).", :@cwd, "."],
+        ['-f', '--force', "Force the shutdown (kill -9).", :@force, false],
+        ['-w', '--wait SECONDS', "Wait SECONDS before forcing shutdown", :@wait, "0"], 
+        ['-P', '--pid FILE', "Where the PID file is located.", :@pid_file, "log/mongrel.pid"]
+      ]
+    end
+
+    def validate
+      @cwd = File.expand_path(@cwd)
+      valid_dir? @cwd, "Invalid path to change to during daemon mode: #@cwd"
+
+      Dir.chdir @cwd
+
+      valid_exists? @pid_file, "PID file #@pid_file does not exist.  Not running?"
+      return @valid
+    end
+
+    def run
+      if @force
+        @wait.to_i.times do |waiting|
+          exit(0) if not File.exist? @pid_file
+          sleep 1
+        end
+
+        Mongrel::send_signal("KILL", @pid_file) if File.exist? @pid_file
+      else
+        Mongrel::send_signal("TERM", @pid_file)
+      end
+    end
+  end
+
+
+  class Restart < GemPlugin::Plugin "/commands"
+    include Mongrel::Command::Base
+
+    def configure 
+      options [ 
+        ['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, '.'],
+        ['-s', '--soft', "Do a soft restart rather than a process exit restart", :@soft, false],
+        ['-P', '--pid FILE', "Where the PID file is located", :@pid_file, "log/mongrel.pid"]
+      ]
+    end
+
+    def validate
+      @cwd = File.expand_path(@cwd)
+      valid_dir? @cwd, "Invalid path to change to during daemon mode: #@cwd"
+
+      Dir.chdir @cwd
+
+      valid_exists? @pid_file, "PID file #@pid_file does not exist.  Not running?"
+      return @valid
+    end
+
+    def run
+      if @soft
+        Mongrel::send_signal("HUP", @pid_file)
+      else
+        Mongrel::send_signal("USR2", @pid_file)
+      end
+    end
+  end
+end
+
+
+GemPlugin::Manager.instance.load "mongrel" => GemPlugin::INCLUDE, "rails" => GemPlugin::EXCLUDE
+
+
+if not Mongrel::Command::Registry.instance.run ARGV
+  exit 1
+end

data/bin/swiftiply

@@ -4,33 +4,33 @@ require 'optparse'
 require 'yaml'
 
 begin
-	load_attempted ||= false
-	require 'swiftcore/Swiftiply'
+  load_attempted ||= false
+  require 'swiftcore/Swiftiply'
 rescue LoadError => e
-	unless load_attempted
-		load_attempted = true
-		require 'rubygems'
-		retry
-	end
-	raise e
+  unless load_attempted
+    load_attempted = true
+    require 'rubygems'
+    retry
+  end
+  raise e
 end
 
 module Swiftcore
-	class SwiftiplyExec
-		Ccluster_address = 'cluster_address'.freeze
-		Ccluster_port = 'cluster_port'.freeze
-		Cconfig_file = 'config_file'.freeze
-		Cbackend_address = 'backend_address'.freeze
-		Cbackend_port = 'backend_port'.freeze
-		Cmap = 'map'.freeze
-		Cincoming = 'incoming'.freeze
-		Coutgoing = 'outgoing'.freeze
-		Ckeepalive = 'keepalive'.freeze
-		Cdaemonize = 'daemonize'.freeze
-		Curl = 'url'.freeze
-		Chost = 'host'.freeze
-		Cport = 'port'.freeze
-		Ctimeout = 'timeout'.freeze
+  class SwiftiplyExec
+    Ccluster_address = 'cluster_address'.freeze
+    Ccluster_port = 'cluster_port'.freeze
+    Cconfig_file = 'config_file'.freeze
+    Cbackend_address = 'backend_address'.freeze
+    Cbackend_port = 'backend_port'.freeze
+    Cmap = 'map'.freeze
+    Cincoming = 'incoming'.freeze
+    Coutgoing = 'outgoing'.freeze
+    Ckeepalive = 'keepalive'.freeze
+    Cdaemonize = 'daemonize'.freeze
+    Curl = 'url'.freeze
+    Chost = 'host'.freeze
+    Cport = 'port'.freeze
+    Ctimeout = 'timeout'.freeze
 
 #####
 #
@@ -49,101 +49,121 @@ module Swiftcore
 #     - 127.0.0.1:8080
 #     - foo.bar.com:8090
 #     url:
-#			keepalive:
-#			outgoing:
+#     keepalive:
+#     outgoing:
 # 
 #####
-		def self.parse_options
-			config = @cliconfig || {}
-			@print = false
-			
-			OptionParser.new do |opts|
-				opts.banner = 'Usage: swiftiply.rb [options]'
-				opts.separator ''
-				opts.on('-c','--config CONFFILE',"The configuration file to read.") do |conf|
-					config[Cconfig_file] = conf
-				end
-				opts.on('--cluster-address [ADDRESS]',String,'The hostname/IP address that swiftiply will listen for connections on.') do |address|
-					config[Ccluster_address] = address
-				end
-				opts.on('--cluster-port [PORT]',Integer,'The port that swiftiply will listen for connections on.') do |port|
-					config[Ccluster_port] = port
-				end
-				opts.on('--backend-address [ADDRESS]',String,'The hostname/IP address that swiftiply will listen for backend connections on.') do |address|
-					config[Cbackend_address] = address
-				end
-				opts.on('--backend-port [PORT]',Integer,'The port that swiftiply will listen for backend connections on.') do |port|
-					config[Cbackend_port] = port
-				end
-				opts.on('-d','--daemonize [YN]',[:y,:yes,:n,:no],'Whether swiftiply should put itself into the background.') do |yn|
-					config[Cdaemonize] = yn.to_s =~ /^y/i
-				end
-				opts.on('-t','--timeout [SECONDS]',Integer,'The server unavailable timeout.  Defaults to 3 seconds.') do |timeout|
-					config[Ctimeout] = timeout
-				end
-				opts.on('-p','--print-config','Print the full configuration.') do
-					@print = true
-				end
-
-			end.parse!
-			@cliconfig ||= config
-			
-			fileconfig = {}
-			fileconfig = YAML.load(File.open(config['config_file'])) if config['config_file']
-			config = fileconfig.merge(@cliconfig)
-			postprocess_config_load(config)
-			puts("Configuration failed validation; exiting.") && exit unless verify_config(config)
-
-			if @print
-				require 'pp'
-				pp config
-				exit
-			end
-			
-			config
-		end
-
-		def self.daemonize
-			if (child_pid = fork)
-				puts "PID #{child_pid}"
-				exit!
-			end
-
-			Process.setsid
-
-		rescue Exception
-			puts "Platform (#{RUBY_PLATFORM}) does not appear to support fork/setsid; skipping"
-		end
-
-		def self.postprocess_config_load(config)
-			config[Cmap] = [] unless Array === config[Cmap]
-			config[Ctimeout] ||= 3
-			config[Cmap].each do |m|
-				m[Ckeepalive] = true unless m.has_key?(Ckeepalive)
-				m[Ckeepalive] = !!m[Ckeepalive]
-				m[Coutgoing] = [m[Coutgoing]] unless Array === m[Coutgoing]
-				m[Cincoming] = [m[Cincoming]] unless Array === m[Cincoming]
-			end
-		end
-
-		def self.verify_config(config)
-			if config[Cbackend_address] and config[Cbackend_port]
-				config[Cmap] << {Cincoming => nil, Curl => nil, Coutgoing => "#{config[Cbackend_address]}:#{config[Cbackend_port]}", Ckeepalive => true}
-			end
-			true
-		end
-
-		def self.run
-			config = parse_options
-			daemonize if config[Cdaemonize]
-			Swiftcore::Swiftiply.run(config)
-		end
-
-		def self.on_windows?
-			return @on_windows unless @on_windows.nil?
-			@on_windows = !![/mswin/i, /cygwin/i, /mingw/i, /bccwin/i, /wince/i].find {|p| RUBY_PLATFORM =~ p}
-		end
-	end
+    def self.parse_options
+      config = @cliconfig || {}
+      @print = false
+      
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: swiftiply.rb [options]'
+        opts.separator ''
+        opts.on('-c','--config CONFFILE',"The configuration file to read.") do |conf|
+          config[Cconfig_file] = conf
+        end
+        opts.on('--cluster-address [ADDRESS]',String,'The hostname/IP address that swiftiply will listen for connections on.') do |address|
+          config[Ccluster_address] = address
+        end
+        opts.on('--cluster-port [PORT]',Integer,'The port that swiftiply will listen for connections on.') do |port|
+          config[Ccluster_port] = port
+        end
+        opts.on('--backend-address [ADDRESS]',String,'The hostname/IP address that swiftiply will listen for backend connections on.') do |address|
+          config[Cbackend_address] = address
+        end
+        opts.on('--backend-port [PORT]',Integer,'The port that swiftiply will listen for backend connections on.') do |port|
+          config[Cbackend_port] = port
+        end
+        opts.on('-d','--daemonize [YN]',[:y,:yes,:n,:no],'Whether swiftiply should put itself into the background.') do |yn|
+          config[Cdaemonize] = yn.to_s =~ /^y/i
+        end
+        opts.on('-t','--timeout [SECONDS]',Integer,'The server unavailable timeout.  Defaults to 3 seconds.') do |timeout|
+          config[Ctimeout] = timeout
+        end
+        opts.on('-p','--print-config','Print the full configuration.') do
+          @print = true
+        end
+        opts.on('-v','--version','Show the version number, then exit.') do
+          puts "Swiftiply v. #{Swiftcore::Swiftiply::VERSION}"
+          exit 0
+        end
+        opts.on('-f','--pid PIDFILE',"Path of the pid file to write.") do |pidfile|
+          config['pidfile'] = pidfile
+        end
+
+      end.parse!
+      @cliconfig ||= config
+      
+      fileconfig = {}
+      fileconfig = YAML.load(File.open(config['config_file'])) if config['config_file']
+      config = fileconfig.merge(@cliconfig)
+      postprocess_config_load(config)
+      (puts("Configuration failed validation; exiting.") && exit(1)) unless verify_config(config)
+
+      if @print
+        require 'pp'
+        pp config
+        exit 0
+      end
+      
+      config
+    end
+
+    def self.daemonize(pidfile = nil)
+      if (child_pid = fork)
+        if pidfile
+          begin
+            File.open(pidfile,"w+") {|fh| fh.puts "#{child_pid}"}
+          rescue Exception => e
+            puts "Failed to write PID file #{pidfile}\n#{e}\n\nPID #{child_pid}"
+          end
+        else
+          puts "PID #{child_pid}"
+        end
+
+        exit! 0
+      end
+
+      Process.setsid
+
+    rescue Exception
+      puts "Platform (#{RUBY_PLATFORM}) does not appear to support fork/setsid; skipping"
+    end
+
+    def self.postprocess_config_load(config)
+      config[Cmap] = [] unless Array === config[Cmap]
+      config[Ctimeout] ||= 3
+      config[Cmap].each do |m|
+        m[Ckeepalive] = true unless m.has_key?(Ckeepalive)
+        m[Ckeepalive] = !!m[Ckeepalive]
+        m[Coutgoing] = [m[Coutgoing]] unless Array === m[Coutgoing]
+        m[Cincoming] = [m[Cincoming]] unless Array === m[Cincoming]
+      end
+    end
+
+    def self.verify_config(config)
+      return nil if config[Ccluster_address].nil?
+      return nil if config[Ccluster_port].nil?
+
+      if config[Cbackend_address] and config[Cbackend_port]
+        config[Cmap] << {Cincoming => nil, Curl => nil, Coutgoing => "#{config[Cbackend_address]}:#{config[Cbackend_port]}", Ckeepalive => true}
+      end
+      true
+    end
+
+    def self.run
+      config = parse_options
+      daemonize(config['pidfile']) if config[Cdaemonize]
+      Swiftcore::Swiftiply.run(config)
+    end
+
+    def self.on_windows?
+      return @on_windows unless @on_windows.nil?
+      @on_windows = !![/mswin/i, /cygwin/i, /mingw/i, /bccwin/i, /wince/i].find {|p| RUBY_PLATFORM =~ p}
+    end
+  end
 end
 
 Swiftcore::SwiftiplyExec.run
+exit 0