tkellem 0.7.1 → 0.8.0

data/lib/tkellem/tkellem_server.rb

@@ -0,0 +1,114 @@
+require 'eventmachine'
+require 'active_record'
+
+require 'tkellem/bouncer_connection'
+require 'tkellem/bouncer'
+
+require 'tkellem/models/user'
+require 'tkellem/models/network'
+require 'tkellem/models/host'
+require 'tkellem/models/network_user'
+require 'tkellem/models/listen_address'
+
+require 'tkellem/plugins/push_service'
+require 'tkellem/plugins/backlog'
+
+module Tkellem
+
+class TkellemServer
+  include Tkellem::EasyLogger
+
+  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)
+
+    ListenAddress.all.each { |a| listen(a) }
+    NetworkUser.find_each { |nu| add_bouncer(Bouncer.new(nu)) }
+    Observer.forward_to << self
+  end
+
+  # callbacks for AR observer events
+  def after_create(obj)
+    case obj
+    when ListenAddress
+      listen(obj)
+    when NetworkUser
+      add_bouncer(Bouncer.new(obj))
+    end
+  end
+
+  def after_destroy(obj)
+    case obj
+    when ListenAddress
+      stop_listening(obj)
+    # TODO: remove bouncer on NetworkUser.destroy
+    end
+  end
+
+  def listen(listen_address)
+    address = listen_address.address
+    port = listen_address.port
+    ssl = listen_address.ssl
+
+    info "Listening on #{listen_address}"
+
+    @listeners[listen_address.id] = EM.start_server(listen_address.address,
+                                                    listen_address.port,
+                                                    BouncerConnection,
+                                                    self,
+                                                    listen_address.ssl)
+  end
+
+  def stop_listening(listen_address)
+    listener = @listeners[listen_address.id]
+    return unless listener
+    EM.stop_server(listener)
+    info "No longer listening on #{listen_address}"
+  end
+
+  def add_bouncer(bouncer)
+    key = [bouncer.user.id, bouncer.network.name]
+    raise("bouncer already exists: #{key}") if @bouncers.include?(key)
+    @bouncers[key] = bouncer
+  end
+
+  def find_bouncer(user, network_name)
+    key = [user.id, network_name]
+    bouncer = @bouncers[key]
+    if !bouncer
+      # find the public network with this name, and attempt to auto-add this user to it
+      network = Network.first(:conditions => { :user_id => nil, :name => network_name })
+      if network
+        nu = NetworkUser.create!(:user => user, :network => network)
+        # AR callback should create the bouncer in sync
+        bouncer = @bouncers[key]
+      end
+    end
+    bouncer
+  end
+
+  class Observer < ActiveRecord::Observer
+    observe 'Tkellem::ListenAddress', 'Tkellem::NetworkUser'
+    cattr_accessor :forward_to
+    self.forward_to = []
+
+    def after_create(obj)
+      forward_to.each { |f| f.after_create(obj) }
+    end
+
+    def after_destroy(obj)
+      forward_to.each { |f| f.after_destroy(obj) }
+    end
+  end
+
+  ActiveRecord::Base.observers = Observer
+  ActiveRecord::Base.instantiate_observers
+end
+
+end

data/lib/tkellem/version.rb

@@ -0,0 +1,3 @@
+module Tkellem
+  VERSION = "0.8.0"
+end

data/lib/tkellem.rb

@@ -1,11 +1,3 @@
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
-pathname = File.expand_path(File.dirname(__FILE__))
-$LOAD_PATH.push(pathname) unless $LOAD_PATH.include?(pathname)
-
 module Tkellem
   module EasyLogger
     require 'logger'
@@ -24,7 +16,11 @@ module Tkellem
       @trace = val
     end
     def self.trace
-      @trace || @trace = false
+      @trace || @trace = true
+    end
+
+    def log_name
+      ""
     end
 
     def trace(msg)
@@ -42,4 +38,5 @@ module Tkellem
   end
 end
 
-require 'tkellem/bouncer'
+require "tkellem/version"
+require 'tkellem/tkellem_server'

data/resources/bot_command_descriptions.yml

@@ -0,0 +1,36 @@
+--- 
+LISTEN:
+  banner: "Usage: LISTEN [--add|--remove|--list] <uri>"
+  help: |+
+    Manage the address/port combinations for tkellem to accept client
+    connections on.
+
+    Protocol is either `irc`, or `ircs` for an SSL listener.
+
+    Example:
+        LISTEN --add ircs://0.0.0.0:10001
+
+USER:
+  banner: "Usage: USER [--add|--remove|--list] <username> [--admin]"
+  help: |+
+    Manage users.
+
+    Example:
+        USER --add joe admin
+
+PASSWORD:
+  banner: "Usage: PASSWORD [--user <username>] <new-password>"
+  help: |+
+    Change password. If you are an admin, you can change other users passwords as well.
+
+    Example:
+        PASSWORD hunter2
+
+NETWORK:
+  banner: "Usage: NETWORK [--add|--remove|--list] [--public] <network-name> <uri>"
+  help: |+
+    Manage networks. --add will add a new network, or a new connection host to an existing network. Public networks can only be created by admins, and can be joined by anybody.
+
+    Examples:
+        NETWORK --add --public freenode irc://irc.freenode.org:6667
+        NETWORK --add freenode ircs://irc.freenode.org:7000

data/spec/irc_message_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'tkellem/irc_message'
+
+include Tkellem
+
+describe IrcMessage, ".parse" do
+  it "should parse complex irc lines" do
+    orig = ":some_long_prefix COMMAND first second :long arg here"
+    line = IrcMessage.parse(orig)
+    line.command.should == 'COMMAND'
+    line.prefix.should == 'some_long_prefix'
+    line.args.size.should == 3
+    line.args.should == ['first', 'second', 'long arg here']
+    line.replay.should == orig
+  end
+
+  it "should parse messages with embedded colons" do
+    orig = "MSG #myroom http://google.com/"
+    line = IrcMessage.parse(orig)
+    line.command.should == "MSG"
+    line.args.should == ["#myroom", "http://google.com/"]
+    line.replay.should == orig
+  end
+end
+
+describe IrcMessage, "#with_timestamp" do
+  it "should prefix a timestamp to the last arg" do
+    line = IrcMessage.parse(":some_long_prefix COMMAND first second :long arg here")
+    require 'time'
+    timestamp = Time.parse("Thu Nov 29 14:33:20 2001")
+    ts_line = line.with_timestamp(timestamp)
+    ts_line.should be_a(IrcMessage)
+    ts_line.to_s.should == ":some_long_prefix COMMAND first second :14:33:20> long arg here"
+  end
+end
+
+describe IrcMessage do
+  it "should know how to find the last arg" do
+    line1 = IrcMessage.parse("TEST one two three")
+    line1.args.should == %w(one two three)
+    line1.args.last.should == "three"
+
+    line2 = IrcMessage.parse("TEST one two :three")
+    line2.args.should == %w(one two three)
+    line2.args.last.should == "three"
+  end
+end

data/spec/irc_server_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'tkellem/irc_server'
+
+include Tkellem
+
+describe IrcServer, "connection" do
+  def make_server
+    Class.new do
+      include IrcServer
+
+      def send_data(*a); end
+    end.new(nil, "spec_server", false, "speccer")
+  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")
+    just_before_last && just_before_last.call
+    s.receive_line("376 :end of MOTD")
+  end
+
+  def connected_server
+    s = make_server
+    s.post_init
+    send_welcome(s)
+    s.connected?.should be_true
+    s
+  end
+
+  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
+  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
+
+    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")
+
+    send_welcome(s) { s.join_room "#test2" }
+
+    s.connected?.should be_true
+  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")
+  end
+end

data/spec/spec_helper.rb

@@ -6,5 +6,3 @@ require 'rspec'
 
 RSpec.configure do |config|
 end
-
-puts "Yeah... not so much right now"

data/tkellem.gemspec

@@ -1,57 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tkellem/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{tkellem}
-  s.version = "0.7.1"
+  s.name        = %q{tkellem}
+  s.version     = Tkellem::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brian Palmer"]
+  s.email       = ["brian@codekitchen.net"]
+  s.homepage    = %q{http://github.com/codekitchen/tkellem}
+  s.summary     = %q{IRC bouncer with multi-client support}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Brian Palmer"]
-  s.date = %q{2010-11-18}
+  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.default_executable = %q{tkellem}
-  s.email = %q{brian@codekitchen.net}
-  s.executables = ["tkellem"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "bin/tkellem",
-    "examples/config.yml",
-    "lib/tkellem.rb",
-    "lib/tkellem/backlog.rb",
-    "lib/tkellem/bouncer.rb",
-    "lib/tkellem/bouncer_connection.rb",
-    "lib/tkellem/irc_line.rb",
-    "lib/tkellem/irc_server.rb",
-    "spec/spec_helper.rb",
-    "tkellem.gemspec"
-  ]
-  s.homepage = %q{http://github.com/codekitchen/tkellem}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{IRC bouncer with multi-client support}
-  s.test_files = [
-    "spec/spec_helper.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_dependency "eventmachine", "~> 0.12.10"
+  s.add_dependency "daemons", "~> 1.1.0"
+  s.add_dependency "json"
+  s.add_dependency "activerecord", "~> 3.0.0"
+  s.add_dependency "sqlite3", "~> 1.3.3"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
-    else
-      s.add_dependency(%q<eventmachine>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<eventmachine>, [">= 0"])
-  end
+  s.add_development_dependency "rspec", "~> 2.5"
+  s.add_development_dependency "rcov"
+  s.add_development_dependency "yard"
 end
 

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: tkellem
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 7
-  - 1
-  version: 0.7.1
+  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors: 
 - Brian Palmer
@@ -14,44 +10,146 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-18 00:00:00 -07:00
+date: 2011-06-13 00:00:00 -06:00
 default_executable: tkellem
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.12.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.5"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id008
 description: 
-email: brian@codekitchen.net
+email: 
+- brian@codekitchen.net
 executables: 
 - tkellem
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.md
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
 - bin/tkellem
+- debian/changelog
+- debian/compat
+- debian/control
+- debian/copyright
+- debian/docs
+- debian/examples
+- debian/install
+- debian/manpages
+- debian/rules
+- debian/source/format
+- debian/tkellem.1
 - examples/config.yml
 - lib/tkellem.rb
-- lib/tkellem/backlog.rb
 - lib/tkellem/bouncer.rb
 - lib/tkellem/bouncer_connection.rb
-- lib/tkellem/irc_line.rb
+- lib/tkellem/daemon.rb
+- lib/tkellem/irc_message.rb
 - lib/tkellem/irc_server.rb
+- lib/tkellem/migrations/001_init_db.rb
+- lib/tkellem/models/host.rb
+- lib/tkellem/models/listen_address.rb
+- lib/tkellem/models/network.rb
+- lib/tkellem/models/network_user.rb
+- lib/tkellem/models/user.rb
+- lib/tkellem/plugins/backlog.rb
+- lib/tkellem/plugins/push_service.rb
+- lib/tkellem/socket_server.rb
+- lib/tkellem/tkellem_bot.rb
+- lib/tkellem/tkellem_server.rb
+- lib/tkellem/version.rb
+- resources/bot_command_descriptions.yml
+- spec/irc_message_spec.rb
+- spec/irc_server_spec.rb
 - spec/spec_helper.rb
 - tkellem.gemspec
 has_rdoc: true
@@ -68,23 +166,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: IRC bouncer with multi-client support
 test_files: 
+- spec/irc_message_spec.rb
+- spec/irc_server_spec.rb
 - spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-0.7.1

data/lib/tkellem/backlog.rb

@@ -1,85 +0,0 @@
-require 'tkellem/irc_line'
-
-module Tkellem
-
-# Normally there will be one client per backlog, but there can be more than one
-# connection for the same backlog, if two or more IRC clients connect with the
-# same client name. That situation is equivalent to how most multi-connection
-# bouncers like bip work.
-
-class Backlog
-
-  class BacklogLine < Struct.new(:irc_line, :time)
-  end
-
-  def initialize(name, max_backlog = nil)
-    @name = name
-    @backlog = []
-    @pm_backlogs = Hash.new { |h,k| h[k] = [] }
-    @active_conns = []
-    @max_backlog = max_backlog
-  end
-  attr_reader :name, :backlog, :active_conns, :pm_backlogs, :max_backlog
-
-  def handle_message(msg)
-    # TODO: only send back response messages like WHO, NAMES, etc. to the
-    # BouncerConnection that requested it.
-    if !active_conns.empty?
-      case msg.command
-      when /3\d\d/, /join/i, /part/i
-        # transient response -- we want to forward these, but not backlog
-        active_conns.each { |conn| conn.transient_response(msg) }
-      when /privmsg/i
-        active_conns.each { |conn| conn.send_msg(msg) }
-      else
-        # do nothing?
-      end
-    elsif msg.command.match(/privmsg/i)
-      if msg.args.first.match(/^#/)
-        # room privmsg always goes in a specific backlog
-        pm_target = msg.args.first
-        bl = pm_backlogs[pm_target]
-      else
-        # other messages go in the general backlog
-        bl = backlog
-      end
-      bl.push(BacklogLine.new(msg, Time.now))
-      limit_backlog(bl)
-    end
-  end
-
-  def limit_backlog(bl)
-    bl.shift until !max_backlog || bl.size <= max_backlog
-  end
-
-  def max_backlog=(new_val)
-    @max_backlog = new_val
-    limit_backlog(backlog)
-    pm_backlogs.each { |k,bl| limit_backlog(bl) }
-  end
-
-  def add_conn(bouncer_conn)
-    active_conns << bouncer_conn
-  end
-
-  def remove_conn(bouncer_conn)
-    active_conns.delete(bouncer_conn)
-  end
-
-  def send_backlog(conn, pm_target = nil)
-    if pm_target
-      # send room-specific backlog
-      msgs = pm_backlogs.key?(pm_target) ? pm_backlogs[pm_target] : []
-    else
-      # send the general backlog
-      msgs = backlog
-    end
-
-    until msgs.empty?
-      backlog_line = msgs.shift
-      conn.send_msg(backlog_line.irc_line.with_timestamp(backlog_line.time))
-    end
-  end
-end
-
-end