tkellem 0.8.3 → 0.8.4

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 coverage/*
 doc/*
 .yardoc/*
+test.log

data/lib/tkellem/bouncer.rb

@@ -58,6 +58,8 @@ class Bouncer
       return
     end
 
+    # force the client nick
+    client.send_msg(":#{client.connecting_nick} NICK #{nick}") if client.connecting_nick != nick
     send_welcome(client)
     # make the client join all the rooms that we're in
     @rooms.each { |room| client.simulate_join(room) }
@@ -155,9 +157,10 @@ class Bouncer
     @conn.send_data("#{msg}\r\n")
   end
 
-  def connection_established
+  def connection_established(conn)
+    @conn = conn
     # TODO: support sending a real username, realname, etc
-    send_msg("USER #{@nick} localhost blah :#{@nick}")
+    send_msg("USER #{@user.username} somehost tkellem :#{@user.name}")
     change_nick(@nick, true)
     check_away_status
   end
@@ -193,7 +196,7 @@ class Bouncer
     @last_connect = Time.now
     @cur_host = (@cur_host || 0) % hosts.length
     host = hosts[@cur_host]
-    @conn = EM.connect(host.address, host.port, IrcServerConnection, self, host.ssl)
+    EM.connect(host.address, host.port, IrcServerConnection, self, host.ssl)
   end
 
   def ready!

data/lib/tkellem/bouncer_connection.rb

@@ -19,11 +19,11 @@ module BouncerConnection
     @name = 'new-conn'
     @data = {}
   end
-  attr_reader :ssl, :bouncer, :name, :device_name
+  attr_reader :ssl, :bouncer, :name, :device_name, :connecting_nick
   alias_method :log_name, :name
 
   def nick
-    @bouncer ? @bouncer.nick : @nick
+    @bouncer ? @bouncer.nick : @connecting_nick
   end
 
   def data(key)
@@ -79,16 +79,18 @@ module BouncerConnection
       if msg.args.first =~ /req/i
         send_msg("CAP NAK")
       end
-    elsif command == 'PASS'
-      unless @password
-        @password = msg.args.first
-      end
+    elsif command == 'PASS' && @state == :auth
+      @password = msg.args.first
     elsif command == 'NICK' && @state == :auth
-      @nick = msg.args.first
+      @connecting_nick = msg.args.first
+      maybe_connect
     elsif command == 'QUIT'
       close_connection
-    elsif command == 'USER'
-      msg_user(msg)
+    elsif command == 'USER' && @state == :auth
+      unless @username
+        @username, @conn_info = msg.args.first.strip.split('@', 2).map { |a| a.downcase }
+      end
+      maybe_connect
     elsif @state == :auth
       error!("Protocol error. You must authenticate first.")
     elsif @state == :connected
@@ -106,15 +108,14 @@ module BouncerConnection
     end
   end
 
-  def msg_user(msg)
-    unless @user
-      @username, rest = msg.args.first.strip.split('@', 2).map { |a| a.downcase }
+  def maybe_connect
+    if @connecting_nick && @username && @password && !@user
       @name = @username
       @user = User.authenticate(@username, @password)
       return error!("Unknown username: #{@username} or bad password.") unless @user
 
-      if rest && !rest.empty?
-        @conn_name, @device_name = rest.split(':', 2)
+      if @conn_info && !@conn_info.empty?
+        @conn_name, @device_name = @conn_info.split(':', 2)
         # 'default' or missing device_name to use the default backlog
         # pass a device_name to have device-independent backlogs
         @device_name = @device_name.presence || 'default'
@@ -135,7 +136,7 @@ module BouncerConnection
   end
 
   def simulate_join(room)
-    send_msg(":#{nick}!#{name}@tkellem JOIN #{room}")
+    send_msg(":#{nick} JOIN #{room}")
     # TODO: intercept the NAMES response so that only this bouncer gets it
     # Otherwise other clients might show an "in this room" line.
     @bouncer.send_msg("NAMES #{room}\r\n")

data/lib/tkellem/irc_message.rb

@@ -1,6 +1,6 @@
 module Tkellem
 
-class IrcMessage < Struct.new(:prefix, :command, :args)
+class IrcMessage < Struct.new(:prefix, :command, :args, :ctcp)
   RE = %r{(:[^ ]+ )?([^ ]*)(.*)}i
 
   def self.parse(line)
@@ -18,7 +18,22 @@ class IrcMessage < Struct.new(:prefix, :command, :args)
       args = args.split(' ')
     end
 
-    self.new(prefix, command, args)
+    msg = self.new(prefix, command, args)
+
+    if args.last.match(%r{#{"\x01"}([^ ]+)([^\1]*)#{"\x01"}})
+      msg.ctcp = $1.upcase
+      msg.args[-1] = $2.strip
+    end
+
+    msg
+  end
+
+  def ctcp?
+    self.ctcp.present?
+  end
+
+  def action?
+    self.ctcp == 'ACTION'
   end
 
   def command?(cmd)
@@ -31,7 +46,11 @@ class IrcMessage < Struct.new(:prefix, :command, :args)
     line << command
     ext_arg = args.last if args.last && args.last.match(%r{\s})
     line += ext_arg ? args[0...-1] : args
-    line << ":#{ext_arg}" unless ext_arg.nil?
+    if ctcp?
+      line << ":\x01#{ctcp} #{ext_arg}\x01"
+    else
+      line << ":#{ext_arg}" unless ext_arg.nil?
+    end
     line.join ' '
   end
   alias_method :to_s, :replay
@@ -50,7 +69,7 @@ class IrcMessage < Struct.new(:prefix, :command, :args)
       args = args.dup
       args[-1] = "#{timestamp.strftime("%H:%M:%S")}> #{args[-1]}"
     end
-    IrcMessage.new(prefix, command, args)
+    IrcMessage.new(prefix, command, args, ctcp)
   end
 
 end

data/lib/tkellem/irc_server.rb

@@ -26,7 +26,7 @@ module IrcServerConnection
   end
 
   def ssl_handshake_completed
-    EM.next_tick { @bouncer.connection_established }
+    EM.next_tick { @bouncer.connection_established(self) }
   end
 
   def receive_line(line)

data/lib/tkellem/models/network_user.rb

@@ -13,7 +13,7 @@ class NetworkUser < ActiveRecord::Base
   # we use the network's at_connect until it is modified and overwritten for
   # this specific network user
   def at_connect
-    read_attribute(:at_connect).presence || network.at_connect.presence || []
+    network.at_connect + (read_attribute(:at_connect) || [])
   end
 end
 

data/lib/tkellem/models/user.rb

@@ -44,10 +44,14 @@ class User < ActiveRecord::Base
   end
 
   def set_password!(password)
-    self.password = OpenSSL::Digest::SHA1.hexdigest(password)
+    self.password = password
     self.save!
   end
 
+  def password=(password)
+    write_attribute(:password, password ? OpenSSL::Digest::SHA1.hexdigest(password) : nil)
+  end
+
   def admin?
     role == 'admin'
   end

data/lib/tkellem/plugins/backlog.rb

@@ -45,7 +45,7 @@ class Backlog
     @devices = {}
     @streams = {}
     @starting_pos = {}
-    @dir = File.expand_path("~/.tkellem/logs/#{bouncer.user.name}/#{bouncer.network.name}")
+    @dir = File.expand_path("~/.tkellem/logs/#{bouncer.user.username}/#{bouncer.network.name}")
     FileUtils.mkdir_p(@dir)
   end
 
@@ -57,6 +57,7 @@ class Backlog
     # open stream in append-only mode
     return @streams[ctx] if @streams[ctx]
     stream = @streams[ctx] = File.open(stream_filename(ctx), 'ab')
+    stream.seek(0, IO::SEEK_END)
     @starting_pos[ctx] = stream.pos
     stream
   end
@@ -90,13 +91,14 @@ class Backlog
       # transient messages
       return
     when 'PRIVMSG'
+      return if msg.ctcp? && !msg.action?
       ctx = msg.args.first
       if ctx == @bouncer.nick
         # incoming pm, fake ctx to be the sender's nick
         ctx = msg.prefix.split(/[!~@]/, 2).first
       end
       stream = get_stream(ctx)
-      stream.puts(Time.now.strftime("%d-%m-%Y %H:%M:%S < #{msg.prefix}: #{msg.args.last}"))
+      stream.puts(Time.now.strftime("%d-%m-%Y %H:%M:%S < #{'* ' if msg.action?}#{msg.prefix}: #{msg.args.last}"))
       update_pos(ctx, stream.pos)
     end
   end
@@ -104,9 +106,10 @@ class Backlog
   def client_msg(msg)
     case msg.command
     when 'PRIVMSG'
+      return if msg.ctcp? && !msg.action?
       ctx = msg.args.first
       stream = get_stream(ctx)
-      stream.puts(Time.now.strftime("%d-%m-%Y %H:%M:%S > #{msg.args.last}"))
+      stream.puts(Time.now.strftime("%d-%m-%Y %H:%M:%S > #{'* ' if msg.action?}#{msg.args.last}"))
       update_pos(ctx, stream.pos)
     end
   end
@@ -145,11 +148,17 @@ class Backlog
   def parse_line(line, ctx_name)
     timestamp = Time.parse(line[0, 19])
     case line[20..-1]
-    when %r{^> (.+)$}
-      msg = IrcMessage.new(nil, 'PRIVMSG', [ctx_name, $1])
+    when %r{^> (\* )?(.+)$}
+      msg = IrcMessage.new(nil, 'PRIVMSG', [ctx_name, $2])
+      if $1 == '* '
+        msg.ctcp = 'ACTION'
+      end
       return timestamp, msg
-    when %r{^< ([^:]+): (.+)$}
-      msg = IrcMessage.new($1, 'PRIVMSG', [ctx_name, $2])
+    when %r{^< (\* )?([^:]+): (.+)$}
+      msg = IrcMessage.new($2, 'PRIVMSG', [ctx_name, $3])
+      if $1 == '* '
+        msg.ctcp = 'ACTION'
+      end
       return timestamp, msg
     else
       nil

data/lib/tkellem/tkellem_server.rb

@@ -18,15 +18,19 @@ module Tkellem
 class TkellemServer
   include Tkellem::EasyLogger
 
+  attr_reader :bouncers
+
   def initialize
     @listeners = {}
     @bouncers = {}
 
-    ActiveRecord::Base.establish_connection({
-      :adapter => 'sqlite3',
-      :database => File.expand_path("~/.tkellem/tkellem.sqlite3"),
-    })
-    ActiveRecord::Migrator.migrate(File.expand_path("../migrations", __FILE__), nil)
+    unless ActiveRecord::Base.connected?
+      ActiveRecord::Base.establish_connection({
+        :adapter => 'sqlite3',
+        :database => File.expand_path("~/.tkellem/tkellem.sqlite3"),
+      })
+      ActiveRecord::Migrator.migrate(File.expand_path("../migrations", __FILE__), nil)
+    end
 
     ListenAddress.all.each { |a| listen(a) }
     NetworkUser.find_each { |nu| add_bouncer(Bouncer.new(nu)) }

data/lib/tkellem/version.rb

@@ -1,3 +1,3 @@
 module Tkellem
-  VERSION = "0.8.3"
+  VERSION = "0.8.4"
 end

data/spec/bouncer_connection_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'tkellem/bouncer_connection'
+
+include Tkellem
+
+describe BouncerConnection, "connect" do
+  before do
+    u = User.create(:username => 'speccer')
+    u.set_password!('test123')
+    tk = mock(TkellemServer)
+    @b = mock(Bouncer)
+    tk.should_receive(:find_bouncer).with(u, 'testhost').and_return(@b)
+    @bc = em(BouncerConnection).new(tk, false)
+  end
+
+  it "should connect after receiving credentials" do
+    @bc.receive_line("NICK speccer")
+    @bc.receive_line("PASS test123")
+    @b.should_receive(:connect_client).with(@bc)
+    @bc.receive_line("USER speccer@testhost")
+  end
+
+  it "should connect when receiving user before pass" do
+    @bc.receive_line("USER speccer@testhost")
+    @bc.receive_line("PASS test123")
+    @b.should_receive(:connect_client).with(@bc)
+    @bc.receive_line("NICK speccer")
+  end
+end
+

data/spec/irc_message_spec.rb

@@ -45,3 +45,14 @@ describe IrcMessage do
     line2.args.last.should == "three"
   end
 end
+
+describe IrcMessage, "CTCP" do
+  it "should parse basic ACTION messages" do
+    msg = IrcMessage.parse(":user1 PRIVMSG #room :\1ACTION is a loser on IRC\1")
+    msg.command.should == 'PRIVMSG'
+    msg.args.should == ['#room', 'is a loser on IRC']
+    msg.ctcp?.should == true
+    msg.action?.should == true
+    msg.to_s.should == ":user1 PRIVMSG #room :\1ACTION is a loser on IRC\1"
+  end
+end

data/spec/irc_server_spec.rb

@@ -3,26 +3,30 @@ require 'tkellem/irc_server'
 
 include Tkellem
 
-describe IrcServer, "connection" do
-  def make_server
-    Class.new do
-      include IrcServer
+describe Bouncer, "connection" do
+  before do
+    EM.stub!(:add_timer).and_return(nil)
+  end
 
-      def send_data(*a); end
-    end.new(nil, "spec_server", false, "speccer")
+  def make_server
+    b = Bouncer.new(NetworkUser.new(:user => User.new(:username => 'speccer'), :network => Network.new))
+    b
   end
 
   def send_welcome(s, &just_before_last)
-    s.receive_line("001 blah blah")
-    s.receive_line("002 more blah")
-    s.receive_line("003 even more blah")
+    s.should_receive(:send_msg).with("USER speccer somehost tkellem :speccer")
+    s.should_receive(:send_msg).with("NICK speccer")
+    s.should_receive(:send_msg).with("AWAY :Away")
+    s.connection_established(nil)
+    s.server_msg(IrcMessage.parse("001 blah blah"))
+    s.server_msg(IrcMessage.parse("002 more blah"))
+    s.server_msg(IrcMessage.parse("003 even more blah"))
     just_before_last && just_before_last.call
-    s.receive_line("376 :end of MOTD")
+    s.server_msg(IrcMessage.parse("376 :end of MOTD"))
   end
 
   def connected_server
     s = make_server
-    s.post_init
     send_welcome(s)
     s.connected?.should be_true
     s
@@ -31,30 +35,57 @@ describe IrcServer, "connection" do
   it "should connect to the server on creation" do
     s = make_server
     s.connected?.should_not be_true
-    s.should_receive(:send_data).with("USER speccer localhost blah :speccer\r\n")
-    s.should_receive(:send_data).with("NICK speccer\r\n")
-    s.post_init
+    s.should_receive(:send_msg).with("USER speccer somehost tkellem :speccer")
+    s.should_receive(:send_msg).with("NICK speccer")
+    s.should_receive(:send_msg).with("AWAY :Away")
+    s.connection_established(nil)
   end
 
-  it "should join pending rooms once the connection is established" do
-    s = make_server
-    s.post_init
-    s.connected?.should_not be_true # still haven't received the welcome
+  it "should pong" do
+    s = connected_server
+    s.should_receive(:send_msg).with("PONG tkellem!tkellem :HAI")
+    s.server_msg(IrcMessage.parse(":speccer!test@host ping :HAI"))
+  end
 
-    s.join_room "#test1"
-    # as soon as the end of MOTD is received, the IrcServer will consider itself
-    # connected and try to join the rooms.
-    s.should_receive(:send_data).with("JOIN #test1\r\n")
-    s.should_receive(:send_data).with("JOIN #test2\r\n")
+  def tk_server
+    @tk_server ||= TkellemServer.new
+  end
 
-    send_welcome(s) { s.join_room "#test2" }
+  def network_user(opts = {})
+    opts[:user] ||= @user ||= User.create!(:username => 'speccer', :password => 'test123')
+    opts[:network] ||= @network ||= Network.create!(:name => 'localhost')
+    @network_user ||= NetworkUser.create!(opts)
+  end
 
-    s.connected?.should be_true
+  def bouncer(opts = {})
+    tk_server
+    network_user
+    @bouncer = @tk_server.bouncers.values.last
+    if opts[:connect]
+      @server_conn = em(IrcServerConnection).new(@bouncer, false)
+      @server_conn.stub!(:send_data)
+      @bouncer.connection_established(@server_conn)
+      @bouncer.send :ready!
+    end
+    @bouncer
   end
 
-  it "should pong" do
-    s = connected_server
-    s.should_receive(:send_data).with("PONG speccer!tkellem :HAI\r\n")
-    s.receive_line(":speccer!test@host ping :HAI")
+  def client_connection(opts = {})
+    @client ||= em(BouncerConnection).new(tk_server, false)
+    if opts[:connect]
+    end
+    @client
+  end
+
+  it "should force the client nick on connect" do
+    network_user(:nick => 'mynick')
+    bouncer(:connect => true)
+    @bouncer.server_msg(m ":mynick JOIN #t1")
+    client_connection
+    @client.should_receive(:send_msg).with(":some_other_nick NICK mynick")
+    @client.should_receive(:send_msg).with(":mynick JOIN #t1")
+    @client.receive_line("PASS test123")
+    @client.receive_line("NICK some_other_nick")
+    @client.receive_line("USER #{@user.username}@#{@network.name} a b :c")
   end
 end

data/spec/spec_helper.rb

@@ -4,5 +4,31 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'tkellem'
 require 'rspec'
 
+Tkellem::EasyLogger.logger = Logger.new("test.log")
+ActiveRecord::Base.logger = Tkellem::EasyLogger.logger
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Migrator.migrate(File.expand_path("../../lib/tkellem/migrations", __FILE__), nil)
+
 RSpec.configure do |config|
+  config.before(:each) do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+  end
+
+  config.after(:each) do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+
+  def m(line)
+    IrcMessage.parse(line)
+  end
+
+  def em(mod)
+    c = Class.new
+    c.send(:include, mod)
+    c
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: tkellem
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors: 
 - Brian Palmer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-14 00:00:00 -06:00
+date: 2011-06-17 00:00:00 -06:00
 default_executable: tkellem
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -149,6 +149,7 @@ files:
 - lib/tkellem/tkellem_server.rb
 - lib/tkellem/version.rb
 - resources/bot_command_descriptions.yml
+- spec/bouncer_connection_spec.rb
 - spec/irc_message_spec.rb
 - spec/irc_server_spec.rb
 - spec/spec_helper.rb
@@ -182,6 +183,7 @@ signing_key:
 specification_version: 3
 summary: IRC bouncer with multi-client support
 test_files: 
+- spec/bouncer_connection_spec.rb
 - spec/irc_message_spec.rb
 - spec/irc_server_spec.rb
 - spec/spec_helper.rb