tomcat.rb

=begin
--------------------------------------------------------------------------------

Info about this Tomcat

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
=end
require 'pathname'
require 'rexml/document'

class Tomcat
  attr_reader :props
  attr_reader :path
  attr_reader :pid
  attr_reader :port
  attr_reader :jpda_port
  attr_reader :max_heap
  attr_reader :version
  def file(filename)
    return File.expand_path(filename, @path)
  end

  def figure_pid()
    RunningTomcats.new().get_pid(self) || "0"
  end
  
  def figure_port()
    begin
      doc = REXML::Document.new(File.open(file('conf/server.xml')))
      doc.get_elements("Server/Service/Connector[@protocol='HTTP/1.1']").each do |e|
        return e.attribute('port').value()
      end
    rescue
      puts $!
    end
    'unknown'
  end

  def figure_jpda_port()
    setenv_file = File.expand_path('bin/setenv.sh', @path)
    return 'none' unless File.exist?(setenv_file)
    return 'none' unless /JPDA_ADDRESS=(\S+)/ =~ File.read(setenv_file)
    return $1
  end

  def figure_max_heap()
    setenv_file = File.expand_path('bin/setenv.sh', @path)
    return 'default' unless File.exist?(setenv_file)
    return 'default' unless /-Xmx(\S+)/ =~ File.read(setenv_file)
    return $1
  end

  def figure_version()
    release_notes = File.expand_path('RELEASE-NOTES', @path)
    return '(unknown)' unless File.exist?(release_notes)
    return '(unknown)' unless /Tomcat Version ([0-9.]+)/ =~ File.read(release_notes)
    return $1
  end

  def set_props()
    @props = {"tomcat_path" => @path,
      "tomcat_port" => @port, 
      "tomcat_pid" => @pid, 
      "tomcat_jpda_port" => @jpda_port, 
      "tomcat_max_heap" => @max_heap,
      "tomcat_version" => @version}
  end

  def running?
    state != :stopped
  end

  def status_line()
    case state()
    when :stopping
      state1 = "running (shutting down)"
      process_id = "pid #{@pid}, "
    when :starting
      state1 = "running (starting up)"
      process_id = "pid #{@pid}, "
    when :running
      state1 = "running"
      process_id = "pid #{@pid}, "
    else
      state1 = "not running"
      process_id = ""
    end
    "Tomcat #{@version} is #{state1}\n   port #{@port}, #{process_id}jpda #{@jpda_port}, -Xmx #{@max_heap}"
  end

  def matches(other)
    if other.path == @path
      true
    else
      begin
        other.path == Pathname.new(@path).realpath.to_s
      rescue
        false
      end
    end
  end

  def state()
    return :stopped unless RunningTomcats.new().is_running(self)

    log_file = File.expand_path('logs/catalina.out', @path)
    return :running unless File.exist?(log_file)

    File.readlines(log_file).reverse_each do |line|
      if line.include?("A valid shutdown command was received")
        return :stopping
      elsif line.include?("Initializing ProtocolHandler") ||
      # if we don't recognize anything since the last shutdown, we are starting.
      line.include?("Destroying ProtocolHandler")
        return :starting
      elsif line.include?("Server startup in ")
        return :running
      end
    end
    return :running
  end

  def confirm()
    raise SettingsError.new("Tomcat directory '#{@path}' does not exist.") unless File.exist?(@path)
    raise SettingsError.new("Tomcat is not valid: unknown port") if $instance.tomcat.port == "unknown"
  end

  def initialize(path, pid = nil)
    @path = path
    @pid = pid || figure_pid()
    @port = figure_port()
    @jpda_port = figure_jpda_port()
    @max_heap = figure_max_heap()
    @version = figure_version()
    @props = set_props()
  end

  def self.create(path)
    if path
      Tomcat.new(path)
    else
      EmptyTomcat.new()
    end
  end
end

class EmptyTomcat < Tomcat
  def status_line()
    "Tomcat is not defined."
  end

  def initialize()
    @path = 'no current instance'
    @pid = "0"
    @port = 'unknown'
    @jpda_port = 'unknown'
    @max_heap = 'unknown'
    @props = set_props()
  end
end