edouard-clarity 0.9.9

data/lib/clarity/renderers/log_renderer.rb

@@ -0,0 +1,36 @@
+require 'uri'
+require 'erb'
+
+class LogRenderer  
+  
+  # Thank you to http://daringfireball.net/2009/11/liberal_regex_for_matching_urls
+  #
+  UrlParser = %r{\b(([\w-]+://?|www[.])[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|/)))}
+  Prefix   = ""
+  Suffix   = "<br/>\n"
+  
+  def render(line = {})
+    # Escape
+    output = ERB::Util.h(line)
+    
+    # Transform urls into html links
+    output.gsub!(UrlParser) do |match|
+      html_link(match)
+    end
+        
+    # Return with formatting
+    "#{Prefix}#{output}#{Suffix}"
+  end
+  
+  def finalize
+    '</div><hr><p id="done">Done</p></body></html>'
+  end
+  
+  private
+    
+  def html_link(url)
+    uri = URI.parse(url) rescue url
+    "<a href='#{uri}'>#{url}</a>"
+  end
+  
+end

data/lib/clarity/server.rb

@@ -0,0 +1,139 @@
+require 'cgi'
+require File.dirname(__FILE__) + '/server/basic_auth'
+require File.dirname(__FILE__) + '/server/mime_types'
+require File.dirname(__FILE__) + '/server/chunk_http'
+require File.dirname(__FILE__) + '/grep_renderer'
+require File.dirname(__FILE__) + '/process_tree'
+
+module Clarity
+  class NotFoundError < StandardError; end
+  class NotAuthenticatedError < StandardError; end
+  class InvalidParameterError < StandardError; end
+
+  module Server
+    include EventMachine::HttpServer
+    include Clarity::BasicAuth
+    include Clarity::ChunkHttp
+
+    attr_accessor :required_username, :required_password, :relative_root
+    attr_accessor :log_files
+
+    def self.run(options)
+
+      EventMachine::run do
+        EventMachine.epoll
+        EventMachine::start_server(options[:address], options[:port], self) do |a|
+          a.log_files = options[:log_files]
+          a.required_username = options[:username]
+          a.required_password = options[:password]
+          a.relative_root = options[:relative_root] || ""
+        end
+
+        STDERR.puts "Clarity #{Clarity::VERSION} starting up."
+        STDERR.puts " * listening on #{options[:address]}:#{options[:port]}"
+
+        if options[:user]
+          STDERR.puts " * Running as user #{options[:user]}"
+          EventMachine.set_effective_user(options[:user])
+        end
+
+        STDERR.puts " * Log mask(s): #{options[:log_files].join(', ')}"
+
+        if options[:username].nil? or options[:password].nil?
+          STDERR.puts " * WARNING: No username/password specified. This is VERY insecure."
+        end
+
+        STDERR.puts
+
+
+      end
+    end
+
+    def process_http_request
+      authenticate!
+
+      puts "action: #{path}"
+      puts "params: #{params.inspect}"
+
+      @hostname = HostnameCommandBuilder.command
+
+      case path
+      when '/'
+        respond_with(200, welcome_page)
+
+      when '/perform'
+        if params.empty?
+          respond_with(200, welcome_page)
+        else
+          # get command
+          command = case params['tool']
+            when 'grep' then GrepCommandBuilder.new(params).command
+            when 'tail' then TailCommandBuilder.new(params).command
+            else raise InvalidParameterError, "Invalid Tool parameter"
+          end
+          response = respond_with_chunks
+          response.chunk results_page # display page header
+
+          puts "Running: #{command}"
+
+          EventMachine::popen(command, GrepRenderer) do |grepper|
+            @grepper = grepper
+            @grepper.response = response
+          end
+        end
+
+      when '/test'
+        response = respond_with_chunks
+        EventMachine::add_periodic_timer(1) do
+          response.chunk "Lorem ipsum dolor sit amet<br/>"
+          response.send_chunks
+        end
+
+      else
+        respond_with(200, public_file(path), :content_type => Mime.for(path))
+      end
+
+    rescue InvalidParameterError => e
+      respond_with(500, error_page(e))
+    rescue NotFoundError => e
+      respond_with(404, "<h1>Not Found</h1>")
+    rescue NotAuthenticatedError => e
+      puts "Could not authenticate user"
+      headers = { "WWW-Authenticate" => %(Basic realm="Clarity")}
+      respond_with(401, "HTTP Basic: Access denied.\n", :content_type => 'text/plain', :headers => headers)
+    end
+
+    def error_page(error)
+      @error = error
+      render "error.html.erb"
+    end
+
+    def welcome_page
+      render "index.html.erb"
+    end
+
+    def results_page
+      render "index.html.erb"
+    end
+
+    def unbind
+      @grepper.close_connection if @grepper
+      close_connection
+    end
+
+    private
+
+    def authenticate!
+      login, pass = authentication_data
+
+      if (required_username && required_username != login) || (required_password && required_password != pass)
+        raise NotAuthenticatedError
+      end
+
+      true
+    end
+
+  end
+
+
+end

data/lib/clarity/server/basic_auth.rb

@@ -0,0 +1,24 @@
+module Clarity
+  module BasicAuth
+
+    def decode_credentials(request)
+      Base64.decode64(request).split.last
+    end
+    
+    def user_name_and_password(request)
+      decode_credentials(request).split(/:/, 2)
+    end
+  
+    def authentication_data
+      headers = @http_headers.split("\000")
+      auth_header = headers.detect {|head| head =~ /Authorization: / }
+      header = auth_header.nil? ? "" : auth_header.split("Authorization: Basic ").last    
+      return (user_name_and_password(header) rescue ['', ''])
+    end
+  
+    def authenticate!(http_header)
+      raise NotAuthenticatedError unless authenticate(http_header)
+    end
+  
+  end
+end

data/lib/clarity/server/chunk_http.rb

@@ -0,0 +1,59 @@
+require 'erb'
+
+module Clarity
+  
+  module ChunkHttp
+    
+    LeadIn    = ' ' * 1024    
+    
+    def respond_with_chunks
+      response = EventMachine::DelegatedHttpResponse.new( self )
+      response.status = 200
+      response.headers['Content-Type'] = 'text/html'
+      response.chunk LeadIn
+      response
+    end
+
+    def respond_with(status, content, options = {})
+      response = EventMachine::DelegatedHttpResponse.new( self )
+      response.headers['Content-Type'] = options.fetch(:content_type, 'text/html')
+      response.headers['Cache-Control'] = 'private, max-age=0'
+      headers = options.fetch(:headers, {})
+      headers.each_pair {|h, v| response.headers[h] = v }
+      response.status  = status
+      response.content = content
+      response.send_response
+    end    
+
+    def render(view)
+      @toolbar = template("_toolbar.html.erb")
+      @content_for_header = template("_header.html.erb")
+      template(view)
+    end
+
+    def template(filename)
+      content = File.read( File.join(Clarity::Templates, filename) ) 
+      ERB.new(content).result(binding)
+    end
+
+    def public_file(filename)
+      File.read( File.join(Clarity::Public, filename) ) 
+    rescue Errno::ENOENT
+      raise NotFoundError
+    end
+
+    def logfiles
+      log_files.map {|f| Dir[f] }.flatten.compact.uniq.select{|f| File.file?(f) }.sort
+    end
+        
+    def params
+      ENV['QUERY_STRING'].split('&').inject({}) {|p,s| k,v = s.split('=');p[k.to_s] = CGI.unescape(v.to_s);p}
+    end  
+
+    def path
+      ENV["PATH_INFO"]
+    end
+    
+  end
+  
+end

data/lib/clarity/server/mime_types.rb

@@ -0,0 +1,23 @@
+module Clarity
+  module Mime
+    def self.for(filename)
+      
+      content_type = TYPES[File.extname(filename)] 
+      content_type || 'text/plain'
+    end
+    
+    TYPES = {
+      '.jpg'    =>  'image/jpg', 
+      '.jpeg'   =>  'image/jpeg',
+      '.gif'    =>  'image/gif', 
+      '.png'    =>  'image/png',
+      '.bmp'    =>  'image/bmp',
+      '.bitmap' =>  'image/x-ms-bmp',
+      '.js'     => 'application/javascript',
+      '.txt'    => 'text/plain',
+      '.css'    => 'text/css',
+      '.html'   => 'text/html',
+      '.htm'    => 'text/html'
+    }
+  end
+end

data/public/javascripts/app.js

@@ -0,0 +1,154 @@
+/* ----------------------------------------------------------------------------
+ * Log Search Server JS
+ * by John Tajima
+ * requires jQuery 1.3.2
+ * ----------------------------------------------------------------------------
+ */
+
+
+var Search = {
+  search_form  : 'search',                        // domId of the form
+  resultsId    : 'results',
+  search_fields: [ 'term1', 'term2', 'term3' ],   // domIds of search term fields
+  file_list    : 'file-list',                     // domId of select for logfiles
+  logfiles     : {},                              // hash of log files
+  past_params  : null,                            // recent request
+  url          : '/perform',  
+  scroll_fnId  : null,                    
+
+  // initialize Search form
+  // { 'grep': [ log, files, for, grep], 'tail': [ 'log', 'files', 'for', 'tail']}
+  init: function(logfiles, params) {
+    this.logfiles    = logfiles;
+    this.past_params = params;
+    
+    this.bind_grep_tool();
+    this.bind_tail_tool();
+    this.bind_options();
+    
+    if (!this.past_params) return; // return if no prev settings, nothing to set
+
+    // init tool selector
+    (this.past_params['tool'] == 'grep') ? $('#grep-label').trigger('click') :  $('#tail-tool').trigger('click'); 
+    
+    // init log file selector
+    $('#'+this.file_list).val(this.past_params['file']);
+
+    // init search fields
+    jQuery.each(this.search_fields, function(){
+      $('#'+this).val(Search.past_params[this]);
+    }); 
+    
+    // advanced options usd?
+    // time was set - so show advanced options
+    if ((this.past_params['sh']) || (this.past_params['eh'])) {
+      this.showAdvanced();
+      if (this.past_params['sh']) {
+        jQuery.each(['sh', 'sm', 'ss'], function(){ $('#'+this).val(Search.past_params[this])  });        
+      }
+      if (this.past_params['eh']) {
+        jQuery.each(['eh', 'em', 'es'], function(){ $('#'+this).val(Search.past_params[this])  });        
+      }      
+    }
+       
+  },
+
+  // bind option selectors
+  bind_options: function() {
+    $('#auto-scroll').bind('change', function(){
+        Search.autoScroll(this.checked);
+    });
+    $('#auto-scroll').attr('checked', true).trigger('change'); // by default, turn on
+  },
+  
+  // bind change grep tool
+  bind_grep_tool: function() {
+    $('#grep-tool').bind('change', function(e){
+      var newlist = ""
+      jQuery.each(Search.logfiles['grep'], function(){
+        newlist += "<option value='" + this + "'>" + this + "</option>\n"
+      });
+      $('#'+Search.file_list).html(newlist);
+    });
+    // watch clicking label as well
+    $('#grep-label').bind('click', function(e){ 
+      $('#grep-tool').attr('checked', 'checked').val('grep').trigger('change');
+    });
+  },
+  
+  
+  // bind change tail tool
+  bind_tail_tool: function() {
+    $('#tail-tool').bind('change', function(e){
+      var newlist = ""
+      jQuery.each(Search.logfiles['tail'], function(){
+        newlist += "<option value='" + this + "'>" + this + "</option>\n"
+      });
+      $('#'+ Search.file_list).html(newlist);
+    });
+    // watch clicking label as well
+    $('#tail-label').bind('click', function(e){ 
+      $('#tail-tool').attr('checked', 'checked').val('tail').trigger('change');
+    });
+  },
+  
+  
+  // clears the terms fields
+  clear: function() {
+    jQuery.each(this.search_fields, function(){
+      $('#'+this).val("");
+    });
+  },
+  
+  showAdvanced: function() {
+    $('#enable-advanced').hide();
+    $('#disable-advanced').show();
+    $('.advanced-options').show();
+  },
+  
+  hideAdvanced: function() {
+    this.clearAdvanced();
+    $('#enable-advanced').show();
+    $('#disable-advanced').hide();
+    $('.advanced-options').hide();
+  },
+  
+  clearAdvanced: function() {
+    $('#advanced-options input').val("");
+  },
+  
+  // gathers form elements and submits to proper url
+  submit: function() {
+    $('#'+this.search_form).submit();
+    $('#'+this.resultsId).html("Sending new query..."); 
+  },
+  
+  //
+  // Misc utitilies
+  //
+
+  autoScroll: function(enabled) {    
+    if (enabled == true) {
+      if (this.scroll_fnId) return; // already running
+
+      //console.log("scroll ON!")
+      window._currPos = 0; // init pos
+      this.scroll_fnId = setInterval( function(){
+        if (window._currPos < document.height) {
+          window.scrollTo(0, document.height);
+          window._currPos = document.height;
+        }
+      }, 100 );
+    } else {
+      if (!this.scroll_fnId) return; 
+      //console.log("scroll off")
+      if (this.scroll_fnId) {
+        clearInterval(this.scroll_fnId);
+        window._currPost = 0;
+        this.scroll_fnId = null;
+      }
+    }    
+  }
+  
+};
+

data/public/stylesheets/app.css

@@ -0,0 +1,55 @@
+/* ----------------------------------------------------------------------------
+ * Log Search Server CSS
+ * by John Tajima
+ * ----------------------------------------------------------------------------
+ */
+
+/* 960 reset */
+html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,font,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td{margin:0;padding:0;border:0;outline:0;font-size:100%;vertical-align:baseline;background:transparent}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:'';content:none}:focus{outline:0}ins{text-decoration:none}del{text-decoration:line-through}table{border-collapse:collapse;border-spacing:0}
+/* 960 text */
+body{font:13px/1.5 'Helvetica Neue',Arial,'Liberation Sans',FreeSans,sans-serif}a:focus{outline:1px dotted invert}hr{border:0 #ccc solid;border-top-width:1px;clear:both;height:0}h1{font-size:25px}h2{font-size:23px}h3{font-size:21px}h4{font-size:19px}h5{font-size:17px}h6{font-size:15px}ol{list-style:decimal}ul{list-style:disc}li{margin-left:30px}p,dl,hr,h1,h2,h3,h4,h5,h6,ol,ul,pre,table,address,fieldset{margin-bottom:20px}
+
+/*
+ * Toolbar Styling
+ *
+ */
+
+
+#toolbar { color: #333; font-size: 12px; min-width: 980px; height: 130px;
+           padding: 0 10px; background: #f0f0f0; border-bottom: 2px solid #000;
+           position:fixed; top: 0; margin: 0 -10px; width: 100%;
+           font-family: 'Helvetica Neue',Arial,'Liberation Sans',FreeSans,sans-serif;
+           }
+#toolbar a { color: blue; background: none; }
+#toolbar a:hover { background: none; }
+
+#toolbar #header { height: 20px; padding: 3px 5px; margin: 0 -10px 10px; overflow:hidden; background: #333; border-bottom: 2px solid #222; color: #eee; }
+#toolbar #header h1 { font-size: 16px; line-height: 20px; }
+#toolbar #header h1 span { color: #aaa; }
+#toolbar #header a { text-decoration: none; color: #eee; }
+#toolbar #header a:hover { text-decoration: none; color: #fff;}
+#toolbar .small { font-size: 11px; color: #333; font-weight: bold;}
+#toolbar input.time { width: 20px;}
+
+table.actions { width: auto; border-collapse: collapse; }
+table.actions th { font-size: 11px; color: #333; text-align: left; min-width: 100px; padding: 0 5px; }
+table.actions td { padding: 2px 5px; text-align: left; vertical-align: middle;}
+table.actions span.note { font-weight: normal; color: #999; }
+table.actions span.and { font-size: 11px; color: red; font-weight: bold; }
+table.actions span.label { font-weight: bold; cursor:pointer;}
+table.actions input[type=text] { width: 200px; padding: 2px; border: 1px solid #aaa;}
+
+
+div#option-ctrl { position: fixed; z-index: 100; bottom: 0; right: 0; min-width: 60px; min-height: 20px; height: 20px; padding: 5px; border: 1px solid #ddd; background: #f0f0f0; font-size: 11px; color: #000;
+                             font-family: 'Helvetica Neue',Arial,'Liberation Sans',FreeSans,sans-serif; }
+div#option-ctrl ul { list-style:none; margin: 0; padding: 0;}
+div#option-ctrl ul li { list-style:none; margin: 0 5px 0 0; float:left; }
+
+
+
+/* output */
+body {  margin: 10px; padding-top: 130px; font-family: 'Monaco', 'Deja Vu Sans Mono', 'Inconsolata' ,'Consolas',monospace; background:#111 none repeat scroll 0 0; color:#fff; font-size:10px;}
+a { color: #0f0; }
+a:hover { background-color: #03c; color: white; text-decoration: none; }
+
+