apache-config-generator/lib/apache/config.rb
2010-05-10 15:57:34 -04:00

249 lines
7.3 KiB
Ruby

require 'fileutils'
Dir[File.join(File.dirname(__FILE__), '*.rb')].each { |f| require f }
module Apache
# The core class of Apache Config Generator.
#
# Configuration is built by calling either build or build_if:
#
# Ex: Build a config file regardless of current environment:
#
# Apache::Config.build('my-config.conf') do
# document_root '/my/document/root'
# ...
# end
#
# Ex: Build a config file only if you're in the development environment:
#
# Apache::Config.build_if('my-config.conf', :development) do
# document_root '/my/document/root'
# ...
# end
#
# By default, methods called within the block are NerdCapsed to match the Apache config directive format:
#
# document_root #=> DocumentRoot
# options #=> Options
# allow_override #=> AllowOverride
#
# Parameters passed into the methods are quoted if they're Strings or Integers, and not quoted if they're Symbols:
#
# document_root '/my/document/root' #=> DocumentRoot "/my/document/root"
# document_root '/my/document/root'.to_sym #=> DocumentRoot /my/document/root
# accept_path_info :off #=> AcceptPathInfo off
#
# Suffixing the method name with an exclamation point turns off quoting for all parameters:
#
# document_root! '/my/document/root' #=> DocumentRoot /my/document/root
#
# Block-level directives work the same as the top-level build method:
#
# directory '/my/site' do
# allow_from_all
# satisfy :any
# end
#
# Directives that require a regular expression take a Regexp:
#
# location_match %r{^/my/site} do
# set_env 'this_is_my_site', 'yes'
# end
class Config
class << self
attr_accessor :line_indent, :rotate_logs_path
include Apache::Master
include Apache::Quoteize
include Apache::Permissions
include Apache::Directories
include Apache::Logging
include Apache::Performance
include Apache::Rewrites
include Apache::MPM
# Build the provided configuration only if the current environment matches one of the conditions
def build_if(target, *conditions, &block)
build(target, &block) if conditions.include? APACHE_ENV
end
# Build the provided configuration
def build(target = nil, &block)
reset!
self.instance_eval(&block)
if target
FileUtils.mkdir_p File.split(target).first
File.open(target, 'w') { |f| f.puts [ "# Generated by apache-config-generator #{Time.now.to_s}", @config ].flatten * "\n" }
end
@config
end
# Reset the current settings
def reset!
@config = []
@line_indent = 0
end
# Indent the string by the current @line_indent level
def indent(string_or_array)
case string_or_array
when Array
string_or_array.collect { |s| indent(s) }
else
" " * (@line_indent * 2) + string_or_array.to_s
end
end
# Add the string to the current config
def <<(string)
@config << indent(string)
end
# Append the array to the current config
def +(other)
@config += other
end
# Get the config
def to_a
@config
end
# Apachify a string
#
# Split the provided name on underscores and capitalize the individual parts
# Certain character strings are capitalized to match Apache directive names:
# * Cgi => CGI
# * Ssl => SSL
# * Ldap => LDAP
def apachify(name)
case name
when String, Symbol
name.to_s.split("_").collect(&:capitalize).join.gsub('Ssl', 'SSL').gsub('Cgi', 'CGI').gsub('Ldap', 'LDAP').gsub('Url', 'URL')
when Array
name.collect { |n| apachify(n) }
end
end
# Handle options that aren't specially handled
#
# Method names are NerdCapsed and paramters are quoted, unless the method ends with !
def method_missing(method, *args)
if method.to_s[-1..-1] == "!"
method = method.to_s[0..-2].to_sym
else
args = *quoteize(*args)
end
self << [ apachify(method), *args ].compact * ' '
end
# Handle creating block methods
#
# Methods created this way are:
# * virtual_host
# * location
# * files
def block_methods(*methods)
methods.each do |method|
self.class.class_eval <<-EOT
def #{method}(*name, &block)
blockify(apachify("#{method}"), name, &block)
end
EOT
end
end
# If the given module is loaded, process the directives within.
#
# The provided module name is converted into Apache module name format:
# if_module(:php5) do #=> <IfModule mod_php5>
def if_module(mod, &block)
blockify(apachify('if_module'), "#{mod}_module".to_sym, &block)
end
# Create a directory block, checking to see if the source directory exists.
def directory(dir, &block)
directory? dir
blockify(apachify('directory'), dir, &block)
end
# Create a LocationMatch block with the provided Regexp:
# location_match %r{^/my/location/[a-z0-9]+\.html} do #=> <LocationMatch "^/my/location/[a-z0-9]+\.html">
def location_match(regexp, &block)
blockify(apachify('location_match'), regexp.source, &block)
end
# Create a FilesMatch block with the provied Regexp:
# files_match %r{\.html$} do #=> FilesMatch "\.html$">
def files_match(regexp, &block)
blockify(apachify('files_match'), regexp.source, &block)
end
# Only execute the provided block if APACHE_ENV matches one of the provided enviroment symbols:
# if_environment(:production) do
def if_environment(*env, &block)
self.instance_eval(&block) if env.include?(APACHE_ENV)
end
# Blockify the second parameter of a block
#
# The name is processed differently based on input object type:
# * String - the name is quoteized
# * Array - all of the array members are quoteized
# * Symbol - the name is to_s
def blockify_name(name)
case name
when String
quoteize(name).first
when Array
(quoteize(*name) * " ")
when Symbol
name.to_s
end
end
# Handle the blockification of a provided block
def blockify(tag_name, name, &block)
self << ""
self << "<#{[ tag_name, blockify_name(name) ].compact * ' '}>"
@line_indent += 1
self.instance_eval(&block)
@line_indent -= 1
self << "</#{tag_name}>"
self << ""
end
# Build a string that invokes Apache's rotatelogs command
def rotatelogs(path, time)
begin
time = time.to_i
rescue
raise "Time should be an integer: #{path} #{time}"
end
"|#{@rotate_logs_path} #{path} #{time}"
end
private
def writable?(path)
puts "[warn] #{path} may not be writable!" if !File.directory? File.split(path).first
end
def directory?(path)
puts "[warn] #{path} does not exist!" if !File.directory? path
end
def exist?(path)
puts "[warn] #{path} does not exist!" if !File.exist?(path)
end
end
block_methods :virtual_host, :location, :files
end
end