symbiosis-generate-stats

#!/usr/bin/ruby1.8
#
# NAME
#   symbiosis-generate-stats - Generate statistics for domains.
#
#
# SYNOPSIS
#  symbiosis-generate-stats [ --template | -t <filename> ] [ --force | -f ]
#       [ -h | --help ] [-m | --manual] [ -v | --verbose ]
#
#
# OPTIONS
#  -t, --template <file>   Set the webalizer config template file. Defaults to
#                          /etc/symbiosis/apache.d/webalizer.conf.erb.
#
#  -f, --force             Force regeneration of the webalizer configuration
#                          snippet for all domains.
#
#  -h, --help              Show a help message, and exit.
#
#  -m, --manual            Show this manual, and exit.
#
#  -v, --verbose           Show verbose errors
#
#
# USAGE
#
# This script is designed to be invoked once per day and update the
# web-visible access statistics for each hosted Symbiosis domain.
#
# The script is assumed to be invoked once per day, via /etc/cron.daily/.
#
# AUTHOR
#
#   Steve Kemp <steve@bytemark.co.uk>
#


#
# Standard ruby
#
require 'getoptlong'



#
#  The options set by the command line.
#
template     = '/etc/symbiosis/apache.d/webalizer.conf.erb'
help         = false
manual       = false
$VERBOSE     = false
$FORCE       = false


opts = GetoptLong.new(
                      [ '--help',       '-h', GetoptLong::NO_ARGUMENT ],
                      [ '--manual',     '-m', GetoptLong::NO_ARGUMENT ],
                      [ '--verbose',    '-v', GetoptLong::NO_ARGUMENT ],
                      [ '--force',      '-f', GetoptLong::NO_ARGUMENT ],
                      [ '--template',   '-t', GetoptLong::REQUIRED_ARGUMENT ]
                      )


begin
  opts.each do |opt,arg|
    case opt
    when '--help'
      help = true
    when '--manual'
      manual = true
    when '--verbose'
      $VERBOSE = true
    when '--force'
      $FORCE = true
    when '--template'
      template = arg
    end
  end
rescue
  # any errors, show the help
  help = true
end


#
# CAUTION! Here be quality kode.
#
if manual or help

  # Open the file, stripping the shebang line
  lines = File.open(__FILE__){|fh| fh.readlines}[1..-1]

  found_synopsis = false

  lines.each do |line|

    line.chomp!
    break if line.empty?

    if help and !found_synopsis
      found_synopsis = (line =~ /^#\s+SYNOPSIS\s*$/)
      next
    end

    puts line[2..-1].to_s

    break if help and found_synopsis and line =~ /^#\s*$/

  end

  exit 0
end

#
# Symbiosis libraries -- required here so they're not needed during the build
# process for manpage generation.
#
require 'symbiosis/domains'
require 'symbiosis/domain/http'
require 'symbiosis/config_files/webalizer'

def verbose(s) ; puts s if $VERBOSE ; end

#
#  Potentially we process each domain.
#
Symbiosis::Domains.each do |domain|
  verbose "Considering domain: #{domain}"

  #
  # Are statistics disabled for this domain?
  #
  unless ( domain.should_have_stats? )
    verbose "\tSkipping as stats have been disabled."
    next
  end

  #
  # Skip symlinks
  #
  if ( domain.is_alias? )
    verbose "\tSkipping as it is an symlink to #{domain.directory}."
    next
  end

  #
  # OK now we need to look for a logfile, or two.
  #
  #  access.log     for HTTP accesses.
  #  ssl_access.log for HTTPS accesses.
  #
  process = Array.new()

  %w( access.log.1 ssl_access.log.1 ).each do |name|
    log = File.join( domain.log_dir, name ) 
    process.push(log) if File.exists?(log) 
  end

  #
  # If we didn't find a logfile we're done.
  #
  if ( process.empty? )
    verbose "\tSkipping this domain, no suitable logfiles found"
    next
  end

  #
  #  Create a configuration file, if one wasn't found.
  #
  webalizer_conf = File.join( domain.config_dir, "webalizer.conf" )

  config          = Symbiosis::ConfigFiles::Webalizer.new(webalizer_conf, "#")
  config.template = template 
  config.domain   = domain

  write_config = false

  #
  # This is taken from symbiosis-create-stes
  #
  if ( $FORCE )
    verbose "\tForcing re-creation of configuration due to --force."
    write_config = true

  elsif config.exists?

    if config.changed?
      verbose "\tNot updating configuration, as it has been edited by hand."
      write_config = false

    elsif config.outdated?
      verbose "\tRe-creating configuration as it is out of date."
      write_config = true

    else
      verbose "\tConfiguring already present and up-to date."
      write_config = false

    end

  else
    verbose "\tConfiguring site for the first time"
    write_config = true

  end

  #
  # Write the config if we need to.
  #
  config.write if write_config


  #
  #  If we don't have a statistics directory then we need to create it,
  # and we need to create it with the domains' UID/GID.  This method will not
  # error if the directory already exists.
  #
  domain.create_dir( domain.stats_dir )

  #
  #  Now process each logfile.
  #
  puts "\tRunning webalizer against #{process.join(" ")}" if $VERBOSE

  #
  #  Now run it under sudo, as the user ID of the domain.
  #
  system( "cd #{domain.config_dir} && sudo -u '\##{domain.uid}' -- webalizer -q #{process.join(" ")} >/dev/null 2>/dev/null" )

end