Class: Mongrel::Configurator

Inherits:
Object
  • Object
show all
Defined in:
lib/mongrel.rb

Overview

Implements a simple DSL for configuring a Mongrel server for your purposes. More used by framework implementers to setup Mongrel how they like, but could be used by regular folks to add more things to an existing mongrel configuration.

It is used like this:

require 'mongrel'
config = Mongrel::Configurator.new :host => "127.0.0.1" do
  listener :port => 3000 do
    uri "/app", :handler => Mongrel::DirHandler.new(".", load_mime_map("mime.yaml"))
  end
  run
end

This will setup a simple DirHandler at the current directory and load additional mime types from mimy.yaml. The :host => “127.0.0.1” is actually not specific to the servers but just a hash of default parameters that all server or uri calls receive.

When you are inside the block after Mongrel::Configurator.new you can simply call functions that are part of Configurator (like server, uri, daemonize, etc) without having to refer to anything else. You can also call these functions on the resulting object directly for additional configuration.

A major thing about Configurator is that it actually lets you configure multiple listeners for any hosts and ports you want. These are kept in a map config.listeners so you can get to them.

  • :pid_file => Where to write the process ID.

Direct Known Subclasses

Rails::RailsConfigurator

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(defaults = {}, &blk) ⇒ Configurator

You pass in initial defaults and then a block to continue configuring.



741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/mongrel.rb', line 741

def initialize(defaults={}, &blk)
  @listener = nil
  @listener_name = nil
  @listeners = {}
  @defaults = defaults
  @needs_restart = false
  @pid_file = defaults[:pid_file]

  if blk
    cloaker(&blk).bind(self).call
  end
end

Instance Attribute Details

#defaults ⇒ Object (readonly)

Returns the value of attribute defaults.



737
738
739
 
# File 'lib/mongrel.rb', line 737

def defaults
  @defaults
end

#listeners ⇒ Object (readonly)

Returns the value of attribute listeners.



736
737
738
 
# File 'lib/mongrel.rb', line 736

def listeners
  @listeners
end

#needs_restart ⇒ Object (readonly)

Returns the value of attribute needs_restart.



738
739
740
 
# File 'lib/mongrel.rb', line 738

def needs_restart
  @needs_restart
end

Instance Method Details

#change_privilege(user, group) ⇒ Object

Change privilege of the process to specified user and group.



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/mongrel.rb', line 755

def change_privilege(user, group)
  begin
    if group
      log "Changing group to #{group}."
      Process::GID.change_privilege(Etc.getgrnam(group).gid)
    end

    if user
      log "Changing user to #{user}." 
      Process::UID.change_privilege(Etc.getpwnam(user).uid)
    end
  rescue Errno::EPERM
    log "FAILED to change user:group #{user}:#{group}: #$!"
    exit 1
  end
end

#cloaker(&blk) ⇒ Object

Do not call this. You were warned.



787
788
789
790
791
792
793
794
 
# File 'lib/mongrel.rb', line 787

def cloaker(&blk)
  cloaking_class.class_eval do
    define_method :cloaker_, &blk
    meth = instance_method( :cloaker_ )
    remove_method :cloaker_
    meth
  end
end

#cloaking_class ⇒ Object

generates a class for cloaking the current self and making the DSL nicer



780
781
782
783
784
 
# File 'lib/mongrel.rb', line 780

def cloaking_class
  class << self
    self
  end
end

#daemonize(options = {}) ⇒ Object

Daemonizes the current Ruby script turning all the listeners into an actual “server” or detached process. You must call this before frameworks that open files as otherwise the files will be closed by this function.

Does not work for Win32 systems (the call is silently ignored).

Requires the following options or defaults:

  • :cwd => Directory to change to.

  • :log_file => Where to write STDOUT and STDERR.

It is safe to call this on win32 as it will only require the daemons gem/library if NOT win32.



868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/mongrel.rb', line 868

def daemonize(options={})
  ops = resolve_defaults(options)
  # save this for later since daemonize will hose it
  if RUBY_PLATFORM !~ /mswin/
    require 'daemons/daemonize'

    Daemonize.daemonize(log_file=File.join(ops[:cwd], ops[:log_file]))

    # change back to the original starting directory
    Dir.chdir(ops[:cwd])

  else
    log "WARNING: Win32 does not support daemon mode."
  end
end

#debug(location, what = [:objects, :rails, :files, :threads, :params]) ⇒ Object

Calling this before you register your URIs to the given location will setup a set of handlers that log open files, objects, and the parameters for each request. This helps you track common problems found in Rails applications that are either slow or become unresponsive after a little while.

You can pass an extra parameter what to indicate what you want to debug. For example, if you just want to dump rails stuff then do:

debug "/", what = [:rails]

And it will only produce the log/mongrel_debug/rails.log file. Available options are: :objects, :rails, :files, :threads, :params

NOTE: Use [:files] to get accesses dumped to stderr like with WEBrick.



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
 
# File 'lib/mongrel.rb', line 1001

def debug(location, what = [:objects, :rails, :files, :threads, :params])
  require 'mongrel/debug'
  handlers = {
    :files => "/handlers/requestlog::access", 
    :rails => "/handlers/requestlog::files", 
    :objects => "/handlers/requestlog::objects", 
    :threads => "/handlers/requestlog::threads",
    :params => "/handlers/requestlog::params"
  }

  # turn on the debugging infrastructure, and ObjectTracker is a pig
  ObjectTracker.configure if what.include? :objects
  MongrelDbg.configure

  # now we roll through each requested debug type, turn it on and load that plugin
  what.each do |type| 
    MongrelDbg.begin_trace type 
    uri location, :handler => plugin(handlers[type])
  end
end

#join ⇒ Object

This method should actually be called outside of the Configurator block so that you can control it. In other words do it like: config.join.



981
982
983
 
# File 'lib/mongrel.rb', line 981

def join
  @listeners.values.each {|s| s.acceptor.join }
end

#listener(options = {}, &blk) ⇒ Object

Starts a listener block. This is the only one that actually takes a block and then you make Configurator.uri calls in order to setup your URIs and handlers. If you write your Handlers as GemPlugins then you can use load_plugins and plugin to load them.

It expects the following options (or defaults):

  • :host => Host name to bind.

  • :port => Port to bind.

  • :num_processors => The maximum number of concurrent threads allowed. (950 default)

  • :timeout => 1/100th of a second timeout between requests. (10 is 1/10th, 0 is timeout)

  • :user => User to change to, must have :group as well.

  • :group => Group to change to, must have :user as well.



816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/mongrel.rb', line 816

def listener(options={},&blk)
  raise "Cannot call listener inside another listener block." if (@listener or @listener_name)
  ops = resolve_defaults(options)
  ops[:num_processors] ||= 950
  ops[:timeout] ||= 0

  @listener = Mongrel::HttpServer.new(ops[:host], ops[:port].to_i, ops[:num_processors].to_i, ops[:timeout].to_i)
  @listener_name = "#{ops[:host]}:#{ops[:port]}"
  @listeners[@listener_name] = @listener

  if ops[:user] and ops[:group]
    change_privilege(ops[:user], ops[:group])
  end

  # Does the actual cloaking operation to give the new implicit self.
  if blk
    cloaker(&blk).bind(self).call
  end

  # all done processing this listener setup, reset implicit variables
  @listener = nil
  @listener_name = nil
end

#load_mime_map(file, mime = {}) ⇒ Object

Loads the MIME map file and checks that it is correct on loading. This is commonly passed to Mongrel::DirHandler or any framework handler that uses DirHandler to serve files. You can also include a set of default MIME types as additional settings. See Mongrel::DirHandler for how the MIME types map is organized.



921
922
923
924
925
926
927
928
929
 
# File 'lib/mongrel.rb', line 921

def load_mime_map(file, mime={})
  # configure any requested mime map
  mime = load_yaml(file, mime)

  # check all the mime types to make sure they are the right format
  mime.each {|k,v| log "WARNING: MIME type #{k} must start with '.'" if k.index(".") != 0 }

  return mime
end

#load_plugins(options = {}) ⇒ Object

Uses the GemPlugin system to easily load plugins based on their gem dependencies. You pass in either an :includes => [] or :excludes => [] setting listing the names of plugins to include or exclude from the when determining the dependencies.



889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/mongrel.rb', line 889

def load_plugins(options={})
  ops = resolve_defaults(options)

  load_settings = {}
  if ops[:includes]
    ops[:includes].each do |plugin|
      load_settings[plugin] = GemPlugin::INCLUDE
    end
  end

  if ops[:excludes]
    ops[:excludes].each do |plugin|
      load_settings[plugin] = GemPlugin::EXCLUDE
    end
  end

  GemPlugin::Manager.instance.load(load_settings)
end

#load_yaml(file, default = {}) ⇒ Object

Easy way to load a YAML file and apply default settings.



910
911
912
 
# File 'lib/mongrel.rb', line 910

def load_yaml(file, default={})
  default.merge(YAML.load_file(file))
end

#log(msg) ⇒ Object

Logs a simple message to STDERR (or the mongrel log if in daemon mode).



1060
1061
1062
 
# File 'lib/mongrel.rb', line 1060

def log(msg)
  STDERR.print "** ", msg, "\n"
end

#plugin(name, options = {}) ⇒ Object

Loads and creates a plugin for you based on the given name and configured with the selected options. The options are merged with the defaults prior to passing them in.



935
936
937
938
 
# File 'lib/mongrel.rb', line 935

def plugin(name, options={})
  ops = resolve_defaults(options)
  GemPlugin::Manager.instance.create(name, ops)
end

#redirect(from, pattern, replacement = nil, &block) ⇒ Object

Let’s you do redirects easily as described in Mongrel::RedirectHandler. You use it inside the configurator like this:

redirect("/test", "/to/there") # simple
redirect("/to", /t/, 'w') # regexp
redirect("/hey", /(w+)/) {|match| ...}  # block



947
948
949
 
# File 'lib/mongrel.rb', line 947

def redirect(from, pattern, replacement = nil, &block)
  uri from, :handler => Mongrel::RedirectHandler.new(pattern, replacement, &block)
end

#resolve_defaults(options) ⇒ Object

This will resolve the given options against the defaults. Normally just used internally.



798
799
800
 
# File 'lib/mongrel.rb', line 798

def resolve_defaults(options)
  options.merge(@defaults)
end

#run ⇒ Object

Works like a meta run method which goes through all the configured listeners. Use the Configurator.join method to prevent Ruby from exiting until each one is done.



954
955
956
957
958
959
960
 
# File 'lib/mongrel.rb', line 954

def run
  @listeners.each {|name,s| 
    s.run 
  }

  $mongrel_sleeper_thread = Thread.new { loop { sleep 1 } }
end

#run_config(script) ⇒ Object

Used to allow you to let users specify their own configurations inside your Configurator setup. You pass it a script name and it reads it in and does an eval on the contents passing in the right binding so they can put their own Configurator statements.



1026
1027
1028
 
# File 'lib/mongrel.rb', line 1026

def run_config(script)
  open(script) {|f| eval(f.read, proc {self}) }
end

#setup_signals(options = {}) ⇒ Object

Sets up the standard signal handlers that are used on most Ruby It only configures if the platform is not win32 and doesn’t do a HUP signal since this is typically framework specific.

Requires a :pid_file option given to Configurator.new to indicate a file to delete.

It sets the MongrelConfig.needs_restart attribute if the start command should reload. It’s up to you to detect this and do whatever is needed for a “restart”.

This command is safely ignored if the platform is win32 (with a warning)



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/mongrel.rb', line 1040

def setup_signals(options={})
  ops = resolve_defaults(options)

  # forced shutdown, even if previously restarted (actually just like TERM but for CTRL-C)
  trap("INT") { log "INT signal received."; stop(need_restart=false) }

  if RUBY_PLATFORM !~ /mswin/
    # graceful shutdown
    trap("TERM") { log "TERM signal received."; stop }

    # restart
    trap("USR2") { log "USR2 signal received."; stop(need_restart=true) }

    log "Signals ready.  TERM => stop.  USR2 => restart.  INT => stop (no restart)."
  else
    log "Signals ready.  INT => stop (no restart)."
  end
end

#stop(needs_restart = false, unlink_pid_file = true) ⇒ Object

Calls .stop on all the configured listeners so they stop processing requests (gracefully). By default it assumes that you don’t want to restart and that the pid file should be unlinked on exit.



966
967
968
969
970
971
972
973
974
975
 
# File 'lib/mongrel.rb', line 966

def stop(needs_restart=false, unlink_pid_file=true)
  @listeners.each {|name,s| 
    s.stop 
  }

  @needs_restart = needs_restart
  if unlink_pid_file
    File.unlink @pid_file if (@pid_file and File.exist?(@pid_file))
  end 
end

#uri(location, options = {}) ⇒ Object

Called inside a Configurator.listener block in order to add URI->handler mappings for that listener. Use this as many times as you like. It expects the following options or defaults:

  • :handler => HttpHandler – Handler to use for this location.

  • :in_front => true/false – Rather than appending, it prepends this handler.



848
849
850
851
 
# File 'lib/mongrel.rb', line 848

def uri(location, options={})
  ops = resolve_defaults(options)
  @listener.register(location, ops[:handler], in_front=ops[:in_front])
end

#write_pid_file ⇒ Object

Writes the PID file but only if we’re on windows.



773
774
775
776
777
 
# File 'lib/mongrel.rb', line 773

def write_pid_file
  if RUBY_PLATFORM !~ /mswin/
    open(@pid_file,"w") {|f| f.write(Process.pid) }
  end
end