trinidad 1.4.5.B1 → 1.4.5

data/lib/trinidad/logging.rb

@@ -3,23 +3,23 @@ require 'fileutils'
 
 module Trinidad
   module Logging
-    
+
     JUL = Java::JavaUtilLogging
     LogFactory = Java::OrgApacheJuliLogging::LogFactory
-    
+
     @@configured = nil
-    
+
     # Configure the "global" Trinidad logging.
     def self.configure(log_level = nil)
       return false if @@configured
       @@configured = true
-      
+
       root_logger = JUL::Logger.getLogger('')
       level = parse_log_level(log_level, :INFO)
-      
+
       out_handler = new_console_handler JRuby.runtime.out
       out_handler.formatter = console_formatter
-      
+
       root_logger.synchronized do
         root_logger.handlers.to_a.each do |handler|
           root_logger.remove_handler(handler) if handler.is_a?(JUL::ConsoleHandler)
@@ -33,26 +33,26 @@ module Trinidad
         err_handler.formatter = console_formatter
         err_handler.level = level.intValue > JUL::Level::WARNING.intValue ?
           level : JUL::Level::WARNING # only >= WARNING on STDERR
-        
+
          root_logger.add_handler(err_handler)
         end
         set_log_level(root_logger, level)
       end
       silence_tomcat_loggers
-      
+
       root_logger
     end
-    
+
     # Force logging (re-)configuration.
     # @see #configure
     def self.configure!(log_level = nil)
       ( @@configured = false ) || configure(log_level)
     end
-    
+
     def self.configure_web_app!(web_app, context)
       configure_web_app!(web_app, context, true)
     end
-    
+
     # Configure logging for a web application.
     def self.configure_web_app(web_app, context, reset = nil)
       param_name, param_value = 'jruby.rack.logging', 'JUL'
@@ -70,14 +70,14 @@ module Trinidad
         context.add_parameter(param_name, logger_name = context.send(:logName))
       end
       configure # make sure 'global' logging is configured
-      
+
       logger = JUL::Logger.getLogger(logger_name) # exclusive for web app
       logger.handlers.each { |h| logger.remove_handler(h); h.close } if reset
       # avoid duplicate calls - do not configure (e.g. FileHandler) twice :
       return false unless logger.handlers.empty?
-      
+
       logging = web_app.logging
-      
+
       logger.level = parse_log_level(logging[:level], nil)
       # delegate to root (console) output only in development mode :
       logger.use_parent_handlers = logging[:use_parent_handlers]
@@ -97,31 +97,31 @@ module Trinidad
       end
       logger
     end
-    
+
     protected
-    
+
     def self.console_formatter
       MessageFormatter.new
     end
-    
+
     def self.web_app_formatter(format = nil)
       # format used by Rails "2012-06-13 16:42:21 +0200"
       DefaultFormatter.new(format.nil? ? 'yyyy-MM-dd HH:mm:ss Z' : format)
     end
-    
+
     private
-    
+
     def self.parse_log_level(log_level, default = nil)
       log_level = log_level && log_level.to_s.upcase
       unless JUL::Level.constants.find { |level| level.to_s == log_level }
         log_level = { # try mapping common level names to JUL names
-          'ERROR' => 'SEVERE', 'WARN' => 'WARNING', 'DEBUG' => 'FINE' 
+          'ERROR' => 'SEVERE', 'WARN' => 'WARNING', 'DEBUG' => 'FINE'
         }[log_level]
         log_level = default ? default.to_s.upcase : nil unless log_level
       end
       JUL::Level.parse(log_level) if log_level
     end
-    
+
     def self.set_log_level(logger, level)
       logger.level = level; LogFactory.getLog(logger.name)
     end
@@ -143,16 +143,16 @@ module Trinidad
         set_log_level(logger, level) if logger
       end
     end
-    
+
     def self.web_app_context_param(web_app, context, name)
       context.find_parameter(name) || web_app.web_xml_context_param(name)
     end
-    
+
     JUL::ConsoleHandler.class_eval do
       field_accessor :sealed rescue nil
       field_writer :writer rescue nil
     end
-    
+
     def self.new_console_handler(stream)
       handler = JUL::ConsoleHandler.new # sets output stream to System.err
       handler.writer = nil if handler.respond_to?(:writer=) # avoid writer.close
@@ -165,90 +165,14 @@ module Trinidad
       end
       handler
     end
-    
-    if ( Java::JavaClass.for_name('rb.trinidad.logging.FileHandler') rescue nil )
-      FileHandler = Java::RbTrinidadLogging::FileHandler # recent trinidad_jars
-    else
-      # we'd achieve logging to a production.log file while rotating it (daily)
-      class FileHandler < Java::OrgApacheJuli::FileHandler # :nodoc
-
-        field_reader :directory, :prefix, :suffix
-        field_accessor :rotatable, :bufferSize => :buffer_size
-
-        # JULI::FileHandler internals :
-        field_accessor :date => :_date # current date string e.g. 2012-06-26
-
-        def initialize(directory, prefix, suffix)
-          super(directory, prefix, suffix)
-          self._date = nil # to openWriter on first #publish(record)
-        end
-
-        def openWriter
-          # NOTE: following code is heavily based on super's internals !
-          synchronized do
-            # we're normally in the lock here (from #publish) 
-            # thus we do not perform any more synchronization
-            prev_rotatable = self.rotatable
-            begin
-              self.rotatable = false
-              # thus current file name will be always {prefix}{suffix} :
-              # due super's `prefix + (rotatable ? _date : "") + suffix`
-              super
-            ensure
-              self.rotatable = prev_rotatable
-            end
-          end
-        end
 
-        def close
-          @_close = true
-          super
-          @_close = nil
-        end
-
-        def closeWriter
-          date = _date
-          super # sets `date = null`
-          # the additional trick here is to rotate the closed file
-          synchronized do
-            # we're normally in the lock here (from #publish) 
-            # thus we do not perform any more synchronization
-            dir = java.io.File.new(directory).getAbsoluteFile
-            log = java.io.File.new(dir, prefix + "" + suffix)
-            if log.exists
-              if ! date || date.empty?
-                date = log.lastModified
-                # we abuse Timestamp to get a date formatted !
-                # just like super does internally (just in case)
-                date = java.sql.Timestamp.new(date).toString[0, 10]
-              end
-              today = java.lang.System.currentTimeMillis
-              today = java.sql.Timestamp.new(today).toString[0, 10]
-              return if date == today # no need to rotate just yet
-              to_file = java.io.File.new(dir, prefix + date + suffix)
-              if to_file.exists
-                file = java.io.RandomAccessFile.new(to_file, 'rw')
-                file.seek(file.length)
-                log_channel = java.io.FileInputStream.new(log).getChannel
-                log_channel.transferTo(0, log_channel.size, file.getChannel)
-                file.close
-                log_channel.close
-                log.delete
-              else
-                log.renameTo(to_file)
-              end
-            end
-          end if rotatable && ! @_close
-        end
+    FileHandler = Java::RbTrinidadLogging::FileHandler
 
-      end
-    end
-    
     # We're truly missing a #formatThrown exception helper method.
-    JUL::Formatter.class_eval do
-      
+    JUL::Formatter.class_eval do # :nodoc:
+
       LINE_SEP = java.lang.System.getProperty("line.separator")
-      
+
       protected
       def formatThrown(record)
         if record.thrown
@@ -260,12 +184,12 @@ module Trinidad
           return writer.toString
         end
       end
-      
+
     end
-    
+
     # A message formatter only prints the log message (and the thrown value).
-    class MessageFormatter < JUL::Formatter # :nodoc
-      
+    class MessageFormatter < JUL::Formatter # :nodoc:
+
       def format(record)
         msg = formatMessage(record)
         msg << formatThrown(record).to_s
@@ -277,64 +201,20 @@ module Trinidad
           msg << LINE_SEP
         end
       end
-      
+
       # e.g. org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[/foo]
       # or org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[default]
       WEB_APP_LOGGER_NAME = /^org\.apache\.catalina\.core\.ContainerBase.*?\[(.*?)\]$/
-      
+
       private
       def context_name(name)
         ( match = (name || '').match(WEB_APP_LOGGER_NAME) ) && match[1]
       end
-      
-    end
-    
-    if ( Java::JavaClass.for_name('rb.trinidad.logging.DefaultFormatter') rescue nil )
-      DefaultFormatter = Java::RbTrinidadLogging::DefaultFormatter # recent trinidad_jars
-    else
-      # A formatter that formats application file logs (e.g. production.log).
-      class DefaultFormatter < JUL::Formatter # :nodoc
-
-        # Allows customizing the date format + the time zone to be used.
-        def initialize(format = nil, time_zone = nil)
-          super()
-          @format = format ? 
-            Java::JavaText::SimpleDateFormat.new(format) : 
-              Java::JavaText::SimpleDateFormat.new
-          case time_zone
-          when Java::JavaUtil::Calendar then
-            @format.calendar = time_zone
-          when Java::JavaUtil::TimeZone then
-            @format.time_zone = time_zone
-          when String then
-            time_zone = Java::JavaUtil::TimeZone.getTimeZone(time_zone)
-            @format.time_zone = time_zone
-          when Numeric then
-            time_zones = Java::JavaUtil::TimeZone.getAvailableIDs(time_zone)
-            if time_zones.length > 0
-              time_zone = Java::JavaUtil::TimeZone.getTimeZone(time_zones[0])
-              @format.time_zone = time_zone
-            end
-          end if time_zone
-        end
 
-        JDate = Java::JavaUtil::Date
-
-        def format(record)
-          timestamp = @format.synchronized do 
-            @format.format JDate.new(record.millis)
-          end
-          level = record.level.name
-          message = formatMessage(record)
+    end
 
-          out = "#{timestamp} #{level}: #{message}"
-          out << formatThrown(record).to_s
-          (lns = "\n") == out[-1, 1] ? out : out << lns
-        end
+    DefaultFormatter = Java::RbTrinidadLogging::DefaultFormatter
 
-      end
-    end
-    
   end
   LogFormatter = Logging::DefaultFormatter # backwards compatibility
 end

data/lib/trinidad/server.rb

@@ -20,7 +20,7 @@ module Trinidad
       @hosts ||= @config[:hosts]
     end
     attr_writer :hosts
-    
+
     def app_base
       @app_base ||= @config[:app_base] || @config[:apps_base]
     end
@@ -30,16 +30,16 @@ module Trinidad
       @web_apps ||= @config[:web_apps] || @config[:webapps]
     end
     attr_writer :web_apps
-    
+
     def trap?
-      @trap ||= @config[:trap] if ! defined?(@trap) || @trap.nil?
+      @trap = !! @config[:trap] if ! defined?(@trap) || @trap.nil?
       @trap
     end
     attr_writer :trap
 
     def ssl_enabled?
       if ! defined?(@ssl_enabled) || @ssl_enabled.nil?
-        @ssl_enabled ||= ( !! @config[:ssl] && ! @config[:ssl].empty? )
+        @ssl_enabled = ( !! @config[:ssl] && ! @config[:ssl].empty? )
       end
       @ssl_enabled
     end
@@ -47,7 +47,8 @@ module Trinidad
 
     def ajp_enabled?
       if ! defined?(@ajp_enabled) || @ajp_enabled.nil?
-        @ajp_enabled ||= ( !! @config[:ajp] && ! @config[:ajp].empty? )
+        ajp = @config[:ajp]
+        @ajp_enabled = ( !! ajp && ( ! ajp.respond_to?(:empty?) || ! ajp.empty? ) )
       end
       @ajp_enabled
     end
@@ -55,30 +56,40 @@ module Trinidad
 
     def http_configured?
       if ! defined?(@http_configured) || @http_configured.nil?
-        @http_configured ||= 
-        ( ( !! @config[:http] && ! @config[:http].empty? ) || @config[:address] != 'localhost' )
+        http = @config[:http]
+        @http_configured = ( !! http && ( ! http.respond_to?(:empty?) || ! http.empty? ) )
       end
       @http_configured
     end
     attr_writer :http_configured
-    
+
     def tomcat; @tomcat ||= initialize_tomcat; end
 
+    LOCALHOST = 'localhost'.freeze # :nodoc:
+
     def initialize_tomcat
       set_system_properties
 
       tomcat = Trinidad::Tomcat::Tomcat.new
       tomcat.base_dir = config[:base_dir] || Dir.pwd
-      tomcat.hostname = config[:address] || 'localhost'
+      tomcat.hostname = config[:address] || LOCALHOST
       tomcat.server.address = config[:address]
       tomcat.port = config[:port].to_i
       default_host(tomcat)
       create_hosts(tomcat)
       tomcat.enable_naming
 
-      add_http_connector(tomcat) if http_configured?
-      add_ssl_connector(tomcat)  if ssl_enabled?
-      add_ajp_connector(tomcat)  if ajp_enabled?
+      http_connector = http_configured? ||
+        ( ! ajp_enabled? && config[:address] && config[:address] != LOCALHOST )
+
+      if http_connector
+        tomcat.connector = add_http_connector(tomcat)
+      end
+      if ajp_enabled?
+        connector = add_ajp_connector(tomcat)
+        tomcat.connector = connector unless http_connector
+      end
+      add_ssl_connector(tomcat) if ssl_enabled?
 
       Trinidad::Extensions.configure_server_extensions(config[:extensions], tomcat)
     end
@@ -97,52 +108,60 @@ module Trinidad
     def load_host_monitor(web_apps); add_host_monitor(web_apps); end
 
     def add_ajp_connector(tomcat = @tomcat)
-      add_service_connector(@config[:ajp], 'AJP/1.3', tomcat)
+      options = config[:ajp]
+      options = {
+        :address => @config[:address], :port => @config[:port]
+      }.merge!( options.respond_to?(:[]) ? options : {} )
+
+      add_service_connector(options, options[:protocol_handler] || 'AJP/1.3', tomcat)
     end
 
     def add_http_connector(tomcat = @tomcat)
-      options = config[:http] || {}
-      options[:address] ||= @config[:address] if @config[:address] != 'localhost'
-      options[:port] = @config[:port]
-      options[:protocol_handler] = 'org.apache.coyote.http11.Http11NioProtocol' if options[:nio]
+      options = config[:http]
+      options = {
+        :address => @config[:address], :port => @config[:port]
+      }.merge!( options.respond_to?(:[]) ? options : {} )
+
+      if options.delete(:nio)
+        options[:protocol_handler] ||= 'org.apache.coyote.http11.Http11NioProtocol'
+      end
 
-      if options[:apr]
+      if options.delete(:apr)
         tomcat.server.add_lifecycle_listener(Trinidad::Tomcat::AprLifecycleListener.new)
       end
 
-      connector = add_service_connector(options, options[:protocol_handler] || 'HTTP/1.1', tomcat)
-      tomcat.connector = connector
+      add_service_connector(options, options[:protocol_handler] || 'HTTP/1.1', tomcat)
     end
-    
+
     def add_ssl_connector(tomcat = @tomcat)
-      options = config[:ssl].merge({
-        :scheme => 'https',
-        :secure => true,
-        :SSLEnabled => 'true'
-      })
+      options = config[:ssl]
+      options = {
+        :scheme => 'https', :secure => true, :SSLEnabled => 'true'
+      }.merge!( options.respond_to?(:[]) ? options : {} )
 
       options[:keystoreFile] ||= options.delete(:keystore)
 
       if ! options[:keystoreFile] && ! options[:SSLCertificateFile]
-        options[:keystoreFile] = 'ssl/keystore'
-        options[:keystorePass] = 'waduswadus42'
+        options[:keystoreFile] ||= 'ssl/keystore'
+        options[:keystorePass] ||= 'waduswadus42'
         generate_default_keystore(options)
       end
 
       add_service_connector(options, nil, tomcat)
     end
-    
-    def add_service_connector(options, protocol = nil, tomcat = @tomcat)
-      opts = options.dup
 
+    # NOTE: make sure to pass an options Hash that might be changed !
+    def add_service_connector(options, protocol = nil, tomcat = @tomcat)
       connector = Trinidad::Tomcat::Connector.new(protocol)
-      connector.scheme = opts.delete(:scheme) if opts[:scheme]
-      connector.secure = opts.delete(:secure) || false
-      connector.port = opts.delete(:port).to_i
+      connector.scheme = options.delete(:scheme) if options[:scheme]
+      connector.secure = options.delete(:secure) || false
+      connector.port = options.delete(:port).to_i if options[:port]
 
-      connector.protocol_handler_class_name = opts.delete(:protocol_handler) if opts[:protocol_handler]
+      if handler = options.delete(:protocol_handler)
+        connector.protocol_handler_class_name = handler
+      end
 
-      opts.each { |key, value| connector.setProperty(key.to_s, value.to_s) }
+      options.each { |key, value| connector.setProperty(key.to_s, value.to_s) }
 
       tomcat.service.add_connector(connector)
       connector
@@ -150,7 +169,7 @@ module Trinidad
     private :add_service_connector
 
     def add_web_app(web_app, host = nil, start = nil)
-      host ||= begin 
+      host ||= begin
         name = web_app.host_name
         name ? find_host(name, tomcat) : tomcat.host
       end
@@ -176,7 +195,7 @@ module Trinidad
       end
       context
     end
-    
+
     def deploy_web_apps(tomcat = self.tomcat)
       add_host_monitor web_apps = create_web_apps
       web_apps
@@ -207,7 +226,7 @@ module Trinidad
     def stop!
       (@tomcat.destroy; true) if stop
     end
-    
+
     protected
 
     def create_web_apps
@@ -254,13 +273,13 @@ module Trinidad
           if File.directory?(app_root) || ( app_root[-4..-1] == '.war' )
             app_base_name = File.basename(app_root)
             deployed = apps.find do |app_holder|; web_app = app_holder.web_app
-              web_app.root_dir == app_root || 
+              web_app.root_dir == app_root ||
                 web_app.context_path == Trinidad::Tomcat::ContextName.new(app_base_name).path
             end
             if deployed
               logger.debug "Skipping auto-deploy from #{app_root} (already deployed)"
             else
-              apps << ( app_holder = create_web_app({ 
+              apps << ( app_holder = create_web_app({
                 :context_name => path, :root_dir => app_root, :host_name => host.name
               }) ); app = app_holder.web_app
               logger.info "Auto-Deploying from #{app.root_dir} as #{app.context_path}"
@@ -293,7 +312,7 @@ module Trinidad
 
       default_host = tomcat.host
       default_app_base = ( default_host.app_base == DEFAULT_HOST_APP_BASE )
-      if self.app_base || 
+      if self.app_base ||
         ( default_app_base && ! File.exists?(DEFAULT_HOST_APP_BASE) )
         tomcat.host.app_base = self.app_base || Dir.pwd
       end
@@ -328,7 +347,7 @@ module Trinidad
       tomcat.engine.add_child host if tomcat
       host
     end
-    
+
     def setup_host(app_base, host_config, host)
       if host_config.is_a?(Array)
         name = host_config.shift
@@ -346,9 +365,9 @@ module Trinidad
           host.app_base = value if default_host_base?(host)
         when :aliases
           aliases = host.find_aliases || []
-          value.each do |name|
-            next if (name = name.to_s) == host.name
-            host.add_alias(name) unless aliases.include?(name)
+          value.each do |aliaz|
+            next if (aliaz = aliaz.to_s) == host.name
+            host.add_alias(aliaz) unless aliases.include?(aliaz)
           end if host_config[:aliases]
         else
           value = value.to_s if value.is_a?(Symbol)
@@ -362,7 +381,7 @@ module Trinidad
     end
     # @deprecated renamed to {#set_system_properties}
     def load_default_system_properties; set_system_properties; end
-    
+
     def configure_logging(log_level)
       Trinidad::Logging.configure(log_level)
     end
@@ -379,7 +398,11 @@ module Trinidad
       host = tomcat.host # make sure we initialize default host
       host.deployXML = false
       host_config = @config[:host] || ( @config[:hosts] && @config[:hosts][:default] )
-      host_config.each { |name, value| host.send("#{name}=", value) } if host_config
+      if host_config.is_a?(String)
+        host.name = host_config
+      elsif host_config
+        host_config.each { |name, value| host.send("#{name}=", value) }
+      end
       host
     end
 
@@ -403,7 +426,9 @@ module Trinidad
         base_parent = false
         2.times do
           begin
-            break if base_parent = ( app_real_path.index(base_path.realpath.to_s) == 0 )
+            if app_real_path.index(base_path.realpath.to_s) == 0
+              base_parent = true; break
+            end
           rescue => e
             logger.warn "Host #{host.name.inspect} app_base does not exist," <<
             " try configuring an absolute path or create it\n (#{e.message})"
@@ -480,7 +505,7 @@ module Trinidad
         path
       end
     end
-    
+
     def generate_default_keystore(config)
       keystore_file = java.io.File.new(config[:keystoreFile])
 
@@ -501,11 +526,11 @@ module Trinidad
       key_tool = Java::SunSecurityTools::KeyTool
       key_tool.main key_tool_args.to_java(:string)
     end
-    
+
     def trap_signals
       trap('INT') { stop! }
       trap('TERM') { stop! }
     end
-    
+
   end
 end