apache_log_report 0.9.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6585f8ec0330f9f396aff91cd5f45400e70afd77ab3aee3b780b940bf1fdfb2
-  data.tar.gz: 3c54f1128fb5a407ecd19e12252038ecdc4003fe0dc5ad309eb42e1d4a00126a
+  metadata.gz: f35ffbe99784dc77cbd61bb7b949237b9b380448b4829e442f0ad17513adc7b7
+  data.tar.gz: 1d5030f64425293895b4b1fc84199178971bd34bde0d9b8450e868ec1d427cc3
 SHA512:
-  metadata.gz: bf3705b84a912e7a0d6b8b13a26ae12be6da8cba2effbfa136f899e78c9727295035348eaf2d689ff5772de4b03e26790dc8cb2e7b2c84b2043e2f05028c74f4
-  data.tar.gz: fc87021cff6a8a97666d42477dbbc5236199c9c76b25be31cdf0b378ccdb91e853cbfca2faf7cc2c381ff23e440cb434c48e343a714ae7ead965e93633d7f639
+  metadata.gz: 3eed1f80dec99429d5a3f25a99fd6e7ceca28547df852d97422a7cdb11b5d045592eb1c7e15443aca6c38744a7b62f59422049783f86d9b379039374c1b4ef09
+  data.tar.gz: 7de8e31cc0024d34191b6b70f8716bc4d31e037764e0f776d75a806490fe1f8cb170c8c989c570fb84f0329c0f12298d5a3bc39b32caa3cdcd826775c3ceaaae

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    apache_log_report (1.1.0)
+      apache_log-parser
+      browser
+      sqlite3
+      terminal-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    apache_log-parser (3.1.2)
+    browser (5.3.1)
+    rake (12.3.3)
+    sqlite3 (1.4.2)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apache_log_report!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.2.29

data/exe/apache_log_report

@@ -2,12 +2,13 @@
 
 require 'apache_log_report.rb'
 
+
 #
 # Parse Command Line Arguments
 #
 
 @command  = ARGV.join(" ")
-@options  = ApacheLogReport.options_parse ARGV
+@options  = ApacheLogReport::OptionsParser.parse ARGV
 @log_file = ARGV[0]
 
 if @log_file and not File.exist? @log_file
@@ -20,12 +21,23 @@ end
 #
 
 @started_at = Time.now
-@db = ApacheLogReport.parse @log_file
-ApacheLogReport.analyze_data @db, @options
+
+@db = ApacheLogReport::LogParser.parse @log_file
+@data = ApacheLogReport::DataCruncher.crunch @db, @options
+
 @ended_at = Time.now
 @duration = @ended_at - @started_at
 
+@data = @data.merge({
+                      command: @command,
+                      log_file: @log_file,
+                      started_at: @started_at,
+                      ended_at: @ended_at,
+                      duration: @duration
+                    })
+
 #
 # Emit Output
 #
-puts ApacheLogReport.emit @options, @command, @log_file, @started_at, @ended_at, @duration
+
+puts ApacheLogReport::Emitter.emit @data, @options

data/lib/apache_log_report/apache_log_report.rb

@@ -0,0 +1,245 @@
+module ApacheLogReport
+
+  #
+  # parse command line options
+  #
+  require 'optparse'
+  require 'optparse/date'
+  require 'apache_log_report/version'
+
+  def self.options_parse options
+    limit = 30
+    args = {} 
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: apache_log_report [options] [logfile]"
+
+      opts.on("-lN", "--limit=N", Integer, "Number of entries to show (defaults to #{limit})") do |n|
+        args[:limit] = n
+      end
+
+      opts.on("-bDATE", "--begin=DATE", DateTime, "Consider entries after or on DATE") do |n|
+        args[:from_date] = n
+      end
+
+      opts.on("-eDATE", "--end=DATE", DateTime, "Consider entries before or on DATE") do |n|
+        args[:to_date] = n
+      end
+
+      opts.on("-i", "--ignore-crawlers", "Ignore crawlers") do
+        args[:ignore_crawlers] = true
+      end
+
+      opts.on("-p", "--ignore-selfpoll", "Ignore apaches self poll entries (from ::1)") do
+        args[:no_selfpoll] = true
+      end
+
+      opts.on("-c", "--only-crawlers", "Perform analysis on crawlers only") do
+        args[:only_crawlers] = true
+      end
+
+      opts.on("-uPREFIX", "--prefix=PREFIX", String, "Prefix to add to all plots (used to run multiple analyses in the same dir)") do |n|
+        args[:prefix] = n
+      end
+
+      opts.on("-wSUFFIX", "--suffix=SUFFIX", String, "Suffix to add to all plots (used to run multiple analyses in the same dir)") do |n|
+        args[:suffix] = n
+      end
+
+      opts.on("-cWHAT", "--code-export=WHAT", String, "Control :export directive in code blocks (code, results, *both*, none)") do |n|
+        args[:code_export] = n
+      end
+      
+      opts.on("-v", "--version", "Prints version information") do
+        puts "apache_log_report version #{ApacheLogReport::VERSION}"
+        puts "Copyright (C) 2020 Adolfo Villafiorita"
+        puts "Distributed under the terms of the MIT license"
+        puts ""
+        puts "Written by Adolfo Villafiorita"
+        exit
+      end
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        puts "This is version #{ApacheLogReport::VERSION}"
+        exit
+      end
+    end
+
+    opt_parser.parse!(options)
+
+    args[:limit] ||= limit
+    args[:ignore_crawlers] ||= false
+    args[:no_selfpoll] ||= false
+    args[:only_crawlers] ||= false
+    args[:prefix] ||= ""
+    args[:suffix] ||= ""
+    args[:code_export] ||= "both"
+
+    return args
+  end
+
+  #
+  # parse an Apache log file and return a SQLite3 DB
+  #
+  require 'apache_log/parser'
+  require 'sqlite3'
+  require 'browser'
+
+  def self.parse filename, options = {}
+    content = filename ? File.readlines(filename) : ARGF.readlines
+
+    db = SQLite3::Database.new ":memory:"
+    db.execute "CREATE TABLE IF NOT EXISTS LogLine(
+      id INTEGER PRIMARY KEY AUTOINCREMENT,
+      datetime TEXT,
+      ip TEXT,
+      user TEXT,
+      unique_visitor TEXT,
+      method TEXT,
+      path TEXT,
+      extension TEXT,
+      status TEXT,
+      size INTEGER,
+      referer TEXT,
+      user_agent TEXT,
+      bot INTEGER,
+      browser TEXT,
+      browser_version TEXT,
+      platform TEXT,
+      platform_version TEXT)"
+    
+    ins = db.prepare('insert into LogLine (
+                datetime, 
+                ip,
+                user,
+                unique_visitor,
+                method,
+                path, 
+                extension,
+                status,
+                size,
+                referer,
+                user_agent,
+                bot,
+                browser,
+                browser_version,
+                platform,
+                platform_version)
+              values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)')
+
+    parser = ApacheLog::Parser.new(options[:format] || 'combined')
+    
+    content.each do |line|
+      begin
+        hash = parser.parse line
+
+        ua = Browser.new(hash[:user_agent], accept_language: "en-us")
+        ins.execute(
+          hash[:datetime].iso8601,
+          hash[:remote_host],
+          hash[:user],
+          hash[:datetime].strftime("%Y-%m-%d") + " " + hash[:remote_host] + " " + hash[:user_agent],
+          hash[:request][:method],
+          hash[:request][:path],
+          (hash[:request][:path] ? File.extname(hash[:request][:path]) : ""),
+          hash[:status],
+          hash[:size].to_i,
+          hash[:referer],
+          hash[:user_agent],
+          ua.bot? ? 1 : 0,
+          (ua.name || ""),
+          (ua.version || ""),
+          (ua.platform.name || ""),
+          (ua.platform.version || "")
+        )
+      rescue
+        STDERR.puts "Apache Log parser error: could not parse #{line}"
+      end
+    end
+    
+    db
+  end
+
+  #
+  # take a sqlite3 database and analyze data
+  #
+  def self.analyze_data db, options = {}
+
+    @first_day      = db.execute "SELECT datetime from LogLine order by datetime limit 1"
+    @last_day       = db.execute "SELECT datetime from LogLine order by datetime desc limit 1"
+    @log_size       = db.execute "SELECT count(datetime) from LogLine"
+    @crawlers_size  = db.execute "SELECT count(datetime) from LogLine where bot == 1"
+    @selfpolls_size = db.execute "SELECT count(datetime) from LogLine where ip == '::1'"
+
+    #
+    # generate the where clause corresponding to the command line options to filter data
+    #
+    @filter = [
+      (options[:from_date] ? "date(datetime) >= '#{options[:from_date]}'" : nil),
+      (options[:to_date] ? "date(datetime) <= '#{options[:to_date]}'" : nil),
+      (options[:only_crawlers] ? "bot == 1" : nil),
+      (options[:ignore_crawlers] ? "bot == 0" : nil),
+      (options[:no_selfpolls] ? "ip != '::1'" : nil),
+      "true"
+    ].compact.join " and "
+
+    # in alternative to sum(size)
+    human_readable_size = <<-EOS
+    CASE 
+    WHEN sum(size) < 1024 THEN sum(size) || ' B' 
+    WHEN sum(size) >=  1024 AND sum(size) < (1024 * 1024) THEN ROUND((CAST(sum(size) AS REAL) / 1024),2) || ' KB' 
+    WHEN sum(size) >= (1024 * 1024)  AND sum(size) < (1024 * 1024 * 1024) THEN ROUND((CAST(sum(size) AS REAL) / (1024 * 1024)),2) || ' MB' 
+    WHEN sum(size) >= (1024 * 1024 * 1024) AND sum(size) < (1024 * 1024 * 1024 * 1024) THEN ROUND((CAST(sum(size) AS REAL) / (1024 * 1024 * 1024)),2) || ' GB' 
+    WHEN sum(size) >= (1024 * 1024 * 1024 * 1024) THEN ROUND((CAST(sum(size) AS REAL) / (1024 * 1024 * 1024 * 1024)),2) || ' TB' 
+    END AS size
+    EOS
+
+    @total_hits = db.execute "SELECT count(datetime) from LogLine where #{@filter}"
+    @total_unique_visitors = db.execute "SELECT count(distinct(unique_visitor)) from LogLine where #{@filter}"
+    @total_size = db.execute "SELECT #{human_readable_size} from LogLine where #{@filter}"
+    @total_days = (Date.parse(@last_day[0][0]) - Date.parse(@first_day[0][0])).to_i
+
+    @daily_distribution = db.execute "SELECT date(datetime), count(datetime), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{@filter} group by date(datetime)"
+
+    @time_distribution = db.execute "SELECT strftime('%H', datetime), count(datetime), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{@filter} group by strftime('%H', datetime)"
+
+    @most_requested_pages = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where extension == '.html' and #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
+
+    @most_requested_resources = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
+
+    @missed_pages = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and extension == '.html' and #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
+
+    @missed_resources = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and #{@filter} group by path order by count(path) desc limit #{options[:limit]}"
+
+    @reasonable_requests_exts = [ ".html", ".css", ".js", ".jpg", ".svg", ".png", ".woff", ".xml", ".ttf", ".ico", ".pdf", ".htm", ".txt", ".org" ].map {  |x|
+      "extension != '#{x}'"
+    }.join " and "
+
+    @attacks = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and #{@filter} and (#{@reasonable_requests_exts}) group by path order by count(path) desc  limit #{options[:limit]}"
+
+    @statuses = db.execute "SELECT status, count(status) from LogLine where #{@filter} group by status order by status"
+
+    @by_day_4xx = db.execute "SELECT date(datetime), count(datetime) from LogLine where substr(status, 1,1) == '4' and #{@filter} group by date(datetime)"
+    @by_day_3xx = db.execute "SELECT date(datetime), count(datetime) from LogLine where substr(status, 1,1) == '3' and #{@filter} group by date(datetime)"
+    @by_day_2xx = db.execute "SELECT date(datetime), count(datetime) from LogLine where substr(status, 1,1) == '2' and #{@filter} group by date(datetime)"
+
+    @statuses_by_day = (@by_day_2xx + @by_day_3xx + @by_day_4xx).group_by { |x| x[0] }.to_a.map { |x|
+      [x[0], x[1].map { |y| y[1] }].flatten
+    }
+
+    @browsers = db.execute "SELECT browser, count(browser), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by browser order by count(browser) desc"
+
+    @platforms = db.execute "SELECT platform, count(platform), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by platform order by count(platform) desc"
+
+    @ips =  db.execute "SELECT ip, count(ip), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by ip order by count(ip) desc limit #{options[:limit]}"
+
+    @referers =  db.execute "SELECT referer, count(referer), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{@filter} group by referer order by count(referer) desc limit #{options[:limit]}"
+
+
+  end
+
+
+end
+
+

data/lib/apache_log_report/data_cruncher.rb

@@ -0,0 +1,84 @@
+module ApacheLogReport
+  module DataCruncher
+
+    #
+    # take a sqlite3 database and analyze data
+    #
+
+    def self.crunch db, options = {}
+      @first_day      = db.execute "SELECT datetime from LogLine order by datetime limit 1"
+      @last_day       = db.execute "SELECT datetime from LogLine order by datetime desc limit 1"
+      @log_size       = db.execute "SELECT count(datetime) from LogLine"
+      @crawlers_size  = db.execute "SELECT count(datetime) from LogLine where bot == 1"
+      @selfpolls_size = db.execute "SELECT count(datetime) from LogLine where ip == '::1'"
+
+      #
+      # generate the where clause corresponding to the command line options to filter data
+      #
+      filter = [
+        (options[:from_date] ? "date(datetime) >= '#{options[:from_date]}'" : nil),
+        (options[:to_date] ? "date(datetime) <= '#{options[:to_date]}'" : nil),
+        (options[:only_crawlers] ? "bot == 1" : nil),
+        (options[:ignore_crawlers] ? "bot == 0" : nil),
+        (options[:no_selfpolls] ? "ip != '::1'" : nil),
+        "true"
+      ].compact.join " and "
+
+      mega = 1024 * 1024
+      giga = mega * 1024
+      tera = giga * 1024
+      
+      # in alternative to sum(size)
+      human_readable_size = <<-EOS
+      CASE 
+      WHEN sum(size) <  1024 THEN sum(size) || ' B' 
+      WHEN sum(size) >= 1024 AND sum(size) < (#{mega}) THEN ROUND((CAST(sum(size) AS REAL) / 1024), 2) || ' KB' 
+      WHEN sum(size) >= (#{mega})  AND sum(size) < (#{giga}) THEN ROUND((CAST(sum(size) AS REAL) / (#{mega})), 2) || ' MB' 
+      WHEN sum(size) >= (#{giga}) AND sum(size) < (#{tera}) THEN ROUND((CAST(sum(size) AS REAL) / (#{giga})), 2) || ' GB' 
+      WHEN sum(size) >= (#{tera}) THEN ROUND((CAST(sum(size) AS REAL) / (#{tera})), 2) || ' TB' 
+      END AS size
+      EOS
+
+      @total_hits = db.execute "SELECT count(datetime) from LogLine where #{filter}"
+      @total_unique_visitors = db.execute "SELECT count(distinct(unique_visitor)) from LogLine where #{filter}"
+      @total_size = db.execute "SELECT #{human_readable_size} from LogLine where #{filter}"
+      @total_days = (Date.parse(@last_day[0][0]) - Date.parse(@first_day[0][0])).to_i
+
+      @daily_distribution = db.execute "SELECT date(datetime), count(datetime), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{filter} group by date(datetime)"
+      @time_distribution = db.execute "SELECT strftime('%H', datetime), count(datetime), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{filter} group by strftime('%H', datetime)"
+      @most_requested_pages = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where extension == '.html' and #{filter} group by path order by count(path) desc limit #{options[:limit]}"
+      @most_requested_resources = db.execute "SELECT path, count(path), count(distinct(unique_visitor)), #{human_readable_size} from LogLine  where #{filter} group by path order by count(path) desc limit #{options[:limit]}"
+      @missed_pages = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and extension == '.html' and #{filter} group by path order by count(path) desc limit #{options[:limit]}"
+      @missed_resources = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and #{filter} group by path order by count(path) desc limit #{options[:limit]}"
+
+      @reasonable_requests_exts = [ ".html", ".css", ".js", ".jpg", ".svg", ".png", ".woff", ".xml", ".ttf", ".ico", ".pdf", ".htm", ".txt", ".org" ].map {  |x|
+        "extension != '#{x}'"
+      }.join " and "
+
+      @attacks = db.execute "SELECT path, count(path), count(distinct(unique_visitor)) from LogLine where status == '404' and #{filter} and (#{@reasonable_requests_exts}) group by path order by count(path) desc  limit #{options[:limit]}"
+      @statuses = db.execute "SELECT status, count(status) from LogLine where #{filter} group by status order by status"
+
+      @by_day_4xx = db.execute "SELECT date(datetime), count(datetime) from LogLine where substr(status, 1,1) == '4' and #{filter} group by date(datetime)"
+      @by_day_3xx = db.execute "SELECT date(datetime), count(datetime) from LogLine where substr(status, 1,1) == '3' and #{filter} group by date(datetime)"
+      @by_day_2xx = db.execute "SELECT date(datetime), count(datetime) from LogLine where substr(status, 1,1) == '2' and #{filter} group by date(datetime)"
+
+      @statuses_by_day = (@by_day_2xx + @by_day_3xx + @by_day_4xx).group_by { |x| x[0] }.to_a.map { |x|
+        [x[0], x[1].map { |y| y[1] }].flatten
+      }
+
+      @browsers = db.execute "SELECT browser, count(browser), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{filter} group by browser order by count(browser) desc"
+      @platforms = db.execute "SELECT platform, count(platform), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{filter} group by platform order by count(platform) desc"
+      @ips = db.execute "SELECT ip, count(ip), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{filter} group by ip order by count(ip) desc limit #{options[:limit]}"
+      @referers = db.execute "SELECT referer, count(referer), count(distinct(unique_visitor)), #{human_readable_size} from LogLine where #{filter} group by referer order by count(referer) desc limit #{options[:limit]}"
+      
+      data = {}
+      self.instance_variables.each do |variable|
+        var_as_symbol = variable.to_s[1..-1].to_sym
+        data[var_as_symbol] = eval(variable.to_s)
+      end
+      data
+    end
+  end
+
+end
+

data/lib/apache_log_report/emitter.rb

@@ -0,0 +1,50 @@
+require 'terminal-table'
+require 'erb'
+require 'ostruct'
+require 'byebug'
+
+module ApacheLogReport
+  module Emitter
+
+    #
+    # Emit Data
+    #
+    def self.emit data = {}, options = {}
+      @prefix = options[:prefix]
+      @suffix = options[:suffix]
+      @export = options[:code_export]
+      @mode = options[:output_format] || "org"
+      
+      # for the ERB binding
+      @data = data
+      @options = options
+
+      # determine the main template to read
+      @template = File.join(File.dirname(__FILE__), "templates", "template.#{@mode}.erb")
+      erb_template = File.read @template
+      
+      output = ERB.new(erb_template).result(binding)
+      puts output
+    end
+
+    private
+
+    def self.output_table name, headings, rows
+      name = "#+NAME: #{name}"
+      table = Terminal::Table.new headings: headings, rows: rows, style: { border_x: "-", border_i: "|" }
+
+      #(2..headings.size).each do |i| 
+      #  table.align_column(i, :right)
+      #end
+
+      name + "\n" + table.to_s
+    end
+
+    def self.render(template, vars)
+      @template = File.join(File.dirname(__FILE__), "templates", "_#{template}.html.erb")
+      erb_template = File.read @template
+      ERB.new(erb_template).result(OpenStruct.new(vars).instance_eval { binding })
+    end
+
+  end
+end

data/lib/apache_log_report/log_parser.rb

@@ -0,0 +1,87 @@
+require 'apache_log/parser'
+require 'sqlite3'
+require 'browser'
+
+module ApacheLogReport
+  module LogParser
+    #
+    # parse an Apache log file and return a SQLite3 DB
+    #
+
+    def self.parse filename, options = {}
+      content = filename ? File.readlines(filename) : ARGF.readlines
+
+      db = SQLite3::Database.new ":memory:"
+      db.execute "CREATE TABLE IF NOT EXISTS LogLine(
+      id INTEGER PRIMARY KEY AUTOINCREMENT,
+      datetime TEXT,
+      ip TEXT,
+      user TEXT,
+      unique_visitor TEXT,
+      method TEXT,
+      path TEXT,
+      extension TEXT,
+      status TEXT,
+      size INTEGER,
+      referer TEXT,
+      user_agent TEXT,
+      bot INTEGER,
+      browser TEXT,
+      browser_version TEXT,
+      platform TEXT,
+      platform_version TEXT)"
+      
+      ins = db.prepare('insert into LogLine (
+                datetime, 
+                ip,
+                user,
+                unique_visitor,
+                method,
+                path, 
+                extension,
+                status,
+                size,
+                referer,
+                user_agent,
+                bot,
+                browser,
+                browser_version,
+                platform,
+                platform_version)
+              values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)')
+
+      parser = ApacheLog::Parser.new(options[:format] || 'combined')
+      
+      content.each do |line|
+        begin
+          hash = parser.parse line
+
+          ua = Browser.new(hash[:user_agent], accept_language: "en-us")
+          ins.execute(
+            hash[:datetime].iso8601,
+            hash[:remote_host],
+            hash[:user],
+            hash[:datetime].strftime("%Y-%m-%d") + " " + hash[:remote_host] + " " + hash[:user_agent],
+            hash[:request][:method],
+            hash[:request][:path],
+            (hash[:request][:path] ? File.extname(hash[:request][:path]) : ""),
+            hash[:status],
+            hash[:size].to_i,
+            hash[:referer],
+            hash[:user_agent],
+            ua.bot? ? 1 : 0,
+            (ua.name || ""),
+            (ua.version || ""),
+            (ua.platform.name || ""),
+            (ua.platform.version || "")
+          )
+        rescue
+          STDERR.puts "Apache Log parser error: could not parse #{line}"
+        end
+      end
+      
+      db
+    end
+
+  end
+end

data/lib/apache_log_report/options_parser.rb

@@ -0,0 +1,86 @@
+require 'optparse'
+require 'optparse/date'
+require 'apache_log_report/version'
+
+module ApacheLogReport
+  module OptionsParser
+    #
+    # parse command line options
+    #
+    def self.parse options
+      limit = 30
+      args = {} 
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: apache_log_report [options] [logfile]"
+
+        opts.on("-lN", "--limit=N", Integer, "Number of entries to show (defaults to #{limit})") do |n|
+          args[:limit] = n
+        end
+
+        opts.on("-bDATE", "--begin=DATE", DateTime, "Consider entries after or on DATE") do |n|
+          args[:from_date] = n
+        end
+
+        opts.on("-eDATE", "--end=DATE", DateTime, "Consider entries before or on DATE") do |n|
+          args[:to_date] = n
+        end
+
+        opts.on("-i", "--ignore-crawlers", "Ignore crawlers") do
+          args[:ignore_crawlers] = true
+        end
+
+        opts.on("-p", "--ignore-selfpoll", "Ignore apaches self poll entries (from ::1)") do
+          args[:no_selfpoll] = true
+        end
+
+        opts.on("-c", "--only-crawlers", "Perform analysis on crawlers only") do
+          args[:only_crawlers] = true
+        end
+
+        opts.on("-uPREFIX", "--prefix=PREFIX", String, "Prefix to add to all plots (used to run multiple analyses in the same dir)") do |n|
+          args[:prefix] = n
+        end
+
+        opts.on("-wSUFFIX", "--suffix=SUFFIX", String, "Suffix to add to all plots (used to run multiple analyses in the same dir)") do |n|
+          args[:suffix] = n
+        end
+
+        opts.on("-cWHAT", "--code-export=WHAT", String, "Control :export directive in Org Mode code blocks (code, results, *both*, none)") do |n|
+          args[:code_export] = n
+        end
+        
+        opts.on("-fFORMAT", "--format=FORMAT", String, "Output format: html, org. Defaults to org mode") do |n|
+          args[:output_format] = n
+        end
+
+        opts.on("-v", "--version", "Prints version information") do
+          puts "apache_log_report version #{ApacheLogReport::VERSION}"
+          puts "Copyright (C) 2020 Adolfo Villafiorita"
+          puts "Distributed under the terms of the MIT license"
+          puts ""
+          puts "Written by Adolfo Villafiorita"
+          exit
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          puts "This is version #{ApacheLogReport::VERSION}"
+          exit
+        end
+      end
+
+      opt_parser.parse!(options)
+
+      args[:limit] ||= limit
+      args[:ignore_crawlers] ||= false
+      args[:no_selfpoll] ||= false
+      args[:only_crawlers] ||= false
+      args[:prefix] ||= ""
+      args[:suffix] ||= ""
+      args[:code_export] ||= "both"
+
+      return args
+    end
+  end
+end

data/lib/apache_log_report/templates/_output_table.html.erb

@@ -0,0 +1,25 @@
+<%
+def slugify string
+  string.downcase.gsub(/ +/, '-')
+end
+%>
+
+<table id="<%= slugify(title || "") %>" class="<%= slugify(title || "") %>">
+  <thead>
+    <tr>
+      <% header.each do |heading| %>
+        <th class="<%= slugify(heading) %>"><%= heading %></th>
+      <% end %>
+    </tr>
+  </thead>
+  <tbody>
+    <% rows.each do |row| %>
+      <tr>
+        <% row.each_with_index do |cell, i| %>
+          <td class="<%= slugify (header[i] || "") %>"><%= cell %></td>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+