fonte 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: bundle exec rspec -bfd spec
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fonte.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# Fonte
+Fonte is a Valve Source engine log parser. Currently supporting only the basic HL Engine commands.
+
+More info can be found at [HL Engine Log Standard documentation](https://developer.valvesoftware.com/wiki/HL_Log_Standard)
+
+[![Build Status](https://secure.travis-ci.org/reu/fonte.png)](http://travis-ci.org/reu/fonte)
+
+## Examples
+
+Fonte comes with a bunch of parsers that can be used individually. Also, there is the `LogParser` which will then includes all the other `_*Parser_` to parse a full log file.
+
+For example, if you wish to parse only a player informaton, you could use the PlayerParser:
+
+```ruby
+player = Fonte::Parsers::PlayerParser.new.parse("Reu<2><STEAM_1:1:24968171><Red>")
+
+player.nickname.value                   # => "Reu"
+player.steam_id.value                   # => "STEAM_1:1:24968171"
+player.steam_id.account_number.value    # => 24968171
+player.team.value                       # => "Red"
+```
+
+Or you could parse a rcon authentication individually or within a log:
+
+```ruby
+rcon_authentication = Fonte::Parsers::PlayerParser.new.parse('Rcon: "rcon challenge "super secret" command" from "192.168.10.1:17015"')
+rcon_authentication.password.value      # => "super secret"
+```
+
+```ruby
+log = Fonte::Parsers::LogParser.new.parse('L 12/26/2011 - 02:14:33: Rcon: "rcon challenge "super secret" command" from "192.168.10.1:17015"')
+
+log.command.password.value              # => "super secret"
+log.date_time.day                       # => 26
+```
+
+## Disclaimer
+
+This is a very early approach and can be a considered a proof of concept in the current version. Lots of things should (and will) be changed. For instance, I am not quite happy with the forced _".value"_ API, but for now, it was the easiest way to implement. Also, it doesn't support real games log yet, so, there should be a way to easily "plug" specific game "log commands".

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fonte.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fonte/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fonte"
+  s.version     = Fonte::VERSION
+  s.authors     = ["Rodrigo Navarro"]
+  s.email       = ["rnavarro1@gmail.com"]
+  s.homepage    = "https://github.com/reu/fonte"
+  s.summary     = "Valve Source Engine log parser"
+
+  s.rubyforge_project = "fonte"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "treetop"
+end

data/lib/fonte/nodes/date_time_node.rb

@@ -0,0 +1,14 @@
+module Fonte
+  module Nodes
+    class DateTimeNode < Treetop::Runtime::SyntaxNode
+      def value
+        DateTime.new date.year.value,
+                     date.month.value,
+                     date.day.value,
+                     time.hours.value,
+                     time.minutes.value,
+                     time.seconds.value
+      end
+    end
+  end
+end

data/lib/fonte/nodes/integer_node.rb

@@ -0,0 +1,9 @@
+module Fonte
+  module Nodes
+    class IntegerNode < Treetop::Runtime::SyntaxNode
+      def value
+        Integer(text_value)
+      end
+    end
+  end
+end

data/lib/fonte/nodes/ip_node.rb

@@ -0,0 +1,9 @@
+module Fonte
+  module Nodes
+    class IpNode < Treetop::Runtime::SyntaxNode
+      def value
+        URI.parse("//" + text_value)
+      end
+    end
+  end
+end

data/lib/fonte/nodes/rcon_command_node.rb

@@ -0,0 +1,13 @@
+module Fonte
+  module Nodes
+    class RconCommandNode < Treetop::Runtime::SyntaxNode
+      def password
+        rcon_challenge.rcon_password
+      end
+
+      def origin
+        rcon_challenge.rcon_origin
+      end
+    end
+  end
+end

data/lib/fonte/nodes/single_word_node.rb

@@ -0,0 +1,9 @@
+module Fonte
+  module Nodes
+    class SingleWordNode < Treetop::Runtime::SyntaxNode
+      def value
+        quoted_word.value
+      end
+    end
+  end
+end

data/lib/fonte/nodes/steam_id_node.rb

@@ -0,0 +1,29 @@
+module Fonte
+  module Nodes
+    class SteamIDNode < Treetop::Runtime::SyntaxNode
+      def value
+        nil
+      end
+
+      def real_player?
+        !unknown? && !bot? && !pending? && !console?
+      end
+
+      def unknown?
+        false
+      end
+
+      def bot?
+        false
+      end
+
+      def pending?
+        false
+      end
+
+      def console?
+        false
+      end
+    end
+  end
+end

data/lib/fonte/nodes/steam_id_universe_node.rb

@@ -0,0 +1,46 @@
+module Fonte
+  module Nodes
+    class SteamIDUniverseNode < Treetop::Runtime::SyntaxNode
+      def value
+        case universe.text_value.to_i
+          when 0
+            "Unspecified"
+          when 1
+            "Public"
+          when 2
+            "Beta"
+          when 3
+            "Internal"
+          when 4
+            "Dev"
+          when 5
+            "RC"
+          end
+      end
+
+      def unspecified?
+        value == "Unspecified"
+      end
+
+      def public?
+        value == "Public"
+      end
+
+      def beta?
+        value == "Beta"
+      end
+
+      def internal?
+        value == "Internal"
+      end
+
+      def developer?
+        value = "Dev"
+      end
+
+      def rc?
+        value == "RC"
+      end
+    end
+  end
+end

data/lib/fonte/nodes.rb

@@ -0,0 +1,11 @@
+module Fonte
+  module Nodes
+    autoload :IntegerNode,         "fonte/nodes/integer_node"
+    autoload :SingleWordNode,      "fonte/nodes/single_word_node"
+    autoload :DateTimeNode,        "fonte/nodes/date_time_node"
+    autoload :IpNode,              "fonte/nodes/ip_node"
+    autoload :SteamIDNode,         "fonte/nodes/steam_id_node"
+    autoload :SteamIDUniverseNode, "fonte/nodes/steam_id_universe_node"
+    autoload :RconCommandNode,     "fonte/nodes/rcon_command_node"
+  end
+end

data/lib/fonte/parsers/address.treetop

@@ -0,0 +1,23 @@
+module Fonte
+  module Parsers
+    grammar Address
+      include Number
+
+      rule ip
+        octet "." octet "." octet "." octet port:port? <Fonte::Nodes::IpNode>
+      end
+
+      rule octet
+        [0-9] 1..3
+      end
+
+      rule port
+        ":" integer {
+          def value
+            integer.value
+          end
+        }
+      end
+    end
+  end
+end

data/lib/fonte/parsers/log.treetop

@@ -0,0 +1,90 @@
+module Fonte
+  module Parsers
+    grammar Log
+      include Word
+      include Temporal
+      include Rcon
+
+      rule entry
+        "L" SPACE date_time ":" SPACE command
+      end
+
+      rule command
+          log_started
+        / log_ended
+        / cvar_start
+        / cvar_end
+        / cvar_set
+        / map_loading
+        / map_started
+        / server_name
+        / server_say
+        / rcon_command
+      end
+
+      rule log_ended
+        "Log file closed"
+      end
+
+      rule log_started
+        "Log file started" SPACE log_filename SPACE log_game_path SPACE log_game_version
+      end
+
+      rule log_filename
+        "(file" SPACE quoted_word ")" <Fonte::Nodes::SingleWordNode>
+      end
+
+      rule log_game_path
+        "(game" SPACE quoted_word ")" <Fonte::Nodes::SingleWordNode>
+      end
+
+      rule log_game_version
+        "(version" SPACE quoted_word ")" <Fonte::Nodes::SingleWordNode>
+      end
+
+      rule cvar_start
+        [Ss] "erver cvars start"
+      end
+
+      rule cvar_end
+        [Ss] "erver cvars end"
+      end
+
+      rule cvar_set
+        ([Ss] "erver cvar" SPACE)? key:quoted_word SPACE "=" SPACE val:quoted_word {
+          def name
+            key.value
+          end
+
+          def value
+            val.value
+          end
+        }
+      end
+
+      rule map_loading
+        "Loading map" SPACE map_name
+      end
+
+      rule map_started
+        "Started map" SPACE map_name SPACE "(" map_crc ")"
+      end
+
+      rule map_name
+        quoted_word
+      end
+
+      rule map_crc
+        "CRC" SPACE quoted_word <Fonte::Nodes::SingleWordNode>
+      end
+
+      rule server_name
+        "Server name is" SPACE server_name:quoted_word <Fonte::Nodes::SingleWordNode>
+      end
+
+      rule server_say
+        "Server say" SPACE server_say:quoted_word <Fonte::Nodes::SingleWordNode>
+      end
+    end
+  end
+end

data/lib/fonte/parsers/number.treetop

@@ -0,0 +1,40 @@
+module Fonte
+  module Parsers
+    grammar Number
+      rule number
+        float / integer
+      end
+
+      rule float
+        (
+        # Scientific notation (eg 5e7, 2.2E-4)
+        [+-]? ([0-9]* '.')? [0-9]+ [eE] [+-]? [0-9]+
+        /
+        # Standard float (eg -43.21, .05)
+        [+-]? [0-9]* '.' [0-9]+
+        ) {
+          def value
+            Float(text_value)
+          end
+        }
+      end
+
+      rule integer
+        (
+        # Binary (eg 0b101, -0B0010)
+        [+-]? '0' [bB] [01]+
+        /
+        # Hex (eg 0xfff, +0XA30)
+        [+-]? '0' [xX] [0-9a-fA-F]+
+        /
+        # Decimal (eg 27, -421)
+        [+-]? [0-9]+
+        ) {
+          def value
+            Integer(text_value)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/fonte/parsers/player.treetop

@@ -0,0 +1,33 @@
+module Fonte
+  module Parsers
+    grammar Player
+      include Number
+      include Word
+      include SteamID
+
+      rule player
+        nickname "<" uid ">" "<" steam_id ">" "<" team ">"
+      end
+
+      rule nickname
+        (![<>] .)* {
+          def value
+            text_value
+          end
+        }
+      end
+
+      rule uid
+        integer
+      end
+
+      rule team
+        (![<>] .)* {
+          def value
+            text_value == "Unassigned" || text_value == "Console" || text_value == "" ? nil : text_value
+          end
+        }
+      end
+    end
+  end
+end

data/lib/fonte/parsers/rcon.treetop

@@ -0,0 +1,36 @@
+module Fonte
+  module Parsers
+    grammar Rcon
+      include Word
+      include Address
+
+      rule rcon_command
+        rcon_failure / rcon_success
+      end
+
+      rule rcon_success
+        "Rcon:" SPACE rcon_challenge <Fonte::Nodes::RconCommandNode>
+      end
+
+      rule rcon_failure
+        "Bad Rcon:" SPACE rcon_challenge <Fonte::Nodes::RconCommandNode>
+      end
+
+      rule rcon_challenge
+        QUOTE "rcon challenge" SPACE rcon_password SPACE "command" QUOTE SPACE rcon_origin
+      end
+
+      rule rcon_password
+        quoted_word
+      end
+
+      rule rcon_origin
+        "from" SPACE QUOTE ip QUOTE {
+          def value
+            ip.value
+          end
+        }
+      end
+    end
+  end
+end

data/lib/fonte/parsers/steam_id.treetop

@@ -0,0 +1,67 @@
+module Fonte
+  module Parsers
+    grammar SteamID
+      include Number
+
+      rule steam_id
+          steam_id_pending
+        / steam_id_bot
+        / steam_id_console
+        / steam_id_invalid
+        / universe:steam_universe ":" id_part:steam_id_part ":" account_number:steam_account_number <Fonte::Nodes::SteamIDNode> {
+          def value
+            text_value
+          end
+        }
+      end
+
+      rule steam_id_pending
+        "STEAM_ID_PENDING" <Fonte::Nodes::SteamIDNode> {
+          def pending?
+            true
+          end
+        }
+      end
+
+      rule steam_id_bot
+        "Bot" <Fonte::Nodes::SteamIDNode> {
+          def bot?
+            true
+          end
+        }
+      end
+
+      rule steam_id_console
+        "Console" <Fonte::Nodes::SteamIDNode> {
+          def console?
+            true
+          end
+        }
+      end
+
+      rule steam_id_invalid
+        "UNKNOWN" <Fonte::Nodes::SteamIDNode> {
+          def unknown?
+            true
+          end
+        }
+      end
+
+      rule steam_universe
+        "STEAM_" universe:[0-9] <Fonte::Nodes::SteamIDUniverseNode>
+      end
+
+      rule steam_id_part
+        [01] {
+          def value
+            text_value.to_i
+          end
+        }
+      end
+
+      rule steam_account_number
+        integer
+      end
+    end
+  end
+end

data/lib/fonte/parsers/temporal.treetop

@@ -0,0 +1,43 @@
+module Fonte
+  module Parsers
+    grammar Temporal
+      include Word
+
+      rule date_time
+        date SPACE "-" SPACE time <Fonte::Nodes::DateTimeNode>
+      end
+
+      rule date
+        month "/" day "/" year
+      end
+
+      rule day
+        [0-3] [0-9] <Fonte::Nodes::IntegerNode>
+      end
+
+      rule month
+        [0-1] [0-9] <Fonte::Nodes::IntegerNode>
+      end
+
+      rule year
+        [0-9] [0-9] [0-9] [0-9] <Fonte::Nodes::IntegerNode>
+      end
+
+      rule time
+        hours ":" minutes ":" seconds
+      end
+
+      rule hours
+        [0-9] [0-9] <Fonte::Nodes::IntegerNode>
+      end
+
+      rule minutes
+        [0-9] [0-9] <Fonte::Nodes::IntegerNode>
+      end
+
+      rule seconds
+        [0-9] [0-9] <Fonte::Nodes::IntegerNode>
+      end
+    end
+  end
+end

data/lib/fonte/parsers/word.treetop

@@ -0,0 +1,33 @@
+module Fonte
+  module Parsers
+    grammar Word
+      rule quoted_word
+        QUOTE word:word? QUOTE {
+          def value
+            word.value
+          end
+        }
+      end
+
+      rule word
+        (ESCAPED_QUOTE / !QUOTE .)* {
+          def value
+            text_value
+          end
+        }
+      end
+
+      rule SPACE
+        " "+
+      end
+
+      rule QUOTE
+        '"'
+      end
+
+      rule ESCAPED_QUOTE
+        '\"'
+      end
+    end
+  end
+end

data/lib/fonte/parsers.rb

@@ -0,0 +1,7 @@
+module Fonte
+  module Parsers
+    %w(number word temporal address rcon steam_id player log).each do |parser|
+      Treetop.load File.join(File.dirname(__FILE__), "parsers", parser)
+    end
+  end
+end

data/lib/fonte/version.rb

@@ -0,0 +1,3 @@
+module Fonte
+  VERSION = "0.0.1"
+end

data/lib/fonte.rb

@@ -0,0 +1,8 @@
+require "fonte/version"
+require "treetop"
+require "polyglot"
+require "fonte/nodes"
+require "fonte/parsers"
+
+module Fonte
+end

data/spec/parsers/address_parser_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+module Fonte
+  module Parsers
+    describe AddressParser do
+      let(:parser) { described_class.new }
+
+      subject { parser.parse(ip) }
+
+      context "with a valid ip number" do
+        let(:ip) { "192.168.10.1" }
+        it { should be }
+      end
+
+      context "with a valid ip number and port" do
+        let(:ip) { "192.168.10.1:3000" }
+        it { should be }
+        its(:"port.value") { should == 3000 }
+      end
+
+      context "with a missing octet" do
+        let(:ip) { "192.10.1" }
+        it { should_not be }
+      end
+
+      context "first octet with more than 8 bits" do
+        let(:ip) { "1929.10.1.1" }
+        it { should_not be }
+      end
+
+      context "second octet with more than 8 bits" do
+        let(:ip) { "192.1110.1.1" }
+        it { should_not be }
+      end
+
+      context "first octet with more than 8 bits" do
+        let(:ip) { "192.10.1212.1" }
+        it { should_not be }
+      end
+
+      context "first octet with more than 8 bits" do
+        let(:ip) { "192.10.1.1123" }
+        it { should_not be }
+      end
+    end
+  end
+end