tkellem 0.9.0.beta5 → 0.9.0.beta6

data/lib/backwards_file_reader.rb

@@ -0,0 +1,47 @@
+class BackwardsFileReader
+	def self.scan(stream)
+		scanner = new(stream)
+		while line = scanner.readline
+			break unless yield(line)
+		end
+		scanner.sync
+	end
+
+	def initialize(stream)
+		@stream = stream
+		@stream.seek 0, IO::SEEK_END
+		@pos = @stream.pos
+		@offset = 0
+
+		@read_size = [4096, @pos].min
+		@line_buffer = []
+	end
+
+	def readline
+		if @line_buffer.size > 2 || @pos == 0
+			line = @line_buffer.pop
+			if line
+				@offset += line.length
+			end
+			return line
+		end
+
+		@pos -= @read_size
+		@stream.seek(@pos, IO::SEEK_SET)
+		@offset = 0
+
+		@line_buffer[0] = "#{@stream.read(@read_size)}#{@line_buffer[0]}"
+		@line_buffer[0] = @line_buffer[0].scan(%r{.*\n})
+		@line_buffer.flatten!
+
+		readline
+	end
+
+	def sync
+		if @offset > 0
+			@stream.seek(-@offset, IO::SEEK_CUR)
+		end
+		@offset = 0
+		@stream
+	end
+end

data/lib/tkellem/bouncer_connection.rb

@@ -78,7 +78,7 @@ module BouncerConnection
       end
     else
       if @user
-        TkellemBot.run_command(msg.args.join(' '), @user, @bouncer.try(:network_user)) do |response|
+        TkellemBot.run_command(msg.args.join(' '), @bouncer, self) do |response|
           say_as_tkellem(response)
         end
       end

data/lib/tkellem/daemon.rb

@@ -53,7 +53,7 @@ class Tkellem::Daemon
     when 'admin'
       admin
     when nil
-      puts opts
+      puts op
     else
       raise("Unknown command: #{command.inspect}")
     end

data/lib/tkellem/migrations/004_add_backlog_positions.rb

@@ -0,0 +1,11 @@
+class AddBacklogPositions < ActiveRecord::Migration
+  def self.up
+    create_table 'backlog_positions' do |t|
+      t.integer :network_user_id
+      t.string  :context_name
+      t.string  :device_name
+      t.integer :position, :default => 0
+    end
+  end
+end
+

data/lib/tkellem/models/backlog_position.rb

@@ -0,0 +1,3 @@
+class BacklogPosition < ActiveRecord::Base
+  belongs_to :network_user
+end

data/lib/tkellem/plugins/backlog.rb

@@ -1,9 +1,12 @@
+require 'backwards_file_reader'
 require 'fileutils'
+require 'pathname'
 require 'time'
 
 require 'active_support/core_ext/class/attribute_accessors'
 
 require 'tkellem/irc_message'
+require 'tkellem/tkellem_bot'
 
 module Tkellem
 
@@ -40,44 +43,94 @@ class Backlog
     true
   end
 
+
+  #### IMPL
+
+  class Device < Struct.new(:network_user, :device_name, :positions)
+    def initialize(*a)
+      super
+      self.positions = {}
+    end
+
+    def update_pos(ctx_name, pos)
+      # TODO: it'd be a good idea to throttle these updates to once every few seconds per ctx
+      # right now we're kind of harsh on the sqlite db
+      self.position(ctx_name).first_or_create.update_attribute(:position, pos)
+    end
+
+    def pos(ctx_name, pos_for_new = 0)
+      backlog_pos = self.position(ctx_name).first_or_initialize
+      if backlog_pos.new_record?
+        backlog_pos.position = pos_for_new
+        backlog_pos.save
+      end
+      backlog_pos.position
+    end
+
+    protected
+
+    def position(ctx_name)
+      self.positions[ctx_name] ||=
+        BacklogPosition.where(:network_user_id => network_user.id,
+                              :context_name    => ctx_name,
+                              :device_name     => device_name)
+    end
+  end
+
   def initialize(bouncer)
     @bouncer = bouncer
+    @network_user = bouncer.network_user
     @devices = {}
-    @streams = {}
-    @starting_pos = {}
-    @dir = File.expand_path("~/.tkellem/logs/#{bouncer.user.username}/#{bouncer.network.name}")
-    FileUtils.mkdir_p(@dir)
+    @dir = Pathname.new(File.expand_path("~/.tkellem/logs/#{bouncer.user.username}/#{bouncer.network.name}"))
+    @dir.mkpath()
+  end
+
+  def stream_path(ctx)
+    @dir + "#{ctx}.log"
+  end
+
+  def all_existing_ctxs
+    @dir.entries.select { |e| e.extname == ".log" }.map { |e| e.basename(".log").to_s }
   end
 
-  def stream_filename(ctx)
-    File.join(@dir, "#{ctx}.log")
+  def get_stream(ctx, for_reading = false)
+    mode = for_reading ? 'rb' : 'ab'
+    stream_path(ctx).open(mode) do |stream|
+      if !for_reading
+        stream.seek(0, IO::SEEK_END)
+      end
+      yield stream
+    end
   end
 
-  def get_stream(ctx)
-    # 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
+  def stream_size(ctx)
+    stream_path(ctx).size
   end
 
   def get_device(conn)
-    @devices[conn.device_name] ||= Hash.new { |h,k| h[k] = @starting_pos[k] }
+    @devices[conn.device_name] ||= Device.new(@network_user, conn.device_name)
   end
 
   def client_connected(conn)
     device = get_device(conn)
-    if @streams.any? { |ctx_name, stream| device[ctx_name] < stream.pos }
-      # this device has missed messages, replay all the backlogs
-      send_backlog(conn, device)
+    behind = all_existing_ctxs.select do |ctx_name|
+      eof = stream_size(ctx_name)
+      # default to the end of file, rather than the beginning, for new devices
+      # that way they don't get flooded the first time they connect
+      device.pos(ctx_name, eof) < eof
+    end
+    if !behind.empty?
+      # this device has missed messages, replay all the relevant backlogs
+      send_connect_backlogs(conn, device, behind)
     end
   end
 
   def update_pos(ctx_name, pos)
+    # don't just iterate @devices here, because that may contain devices that
+    # have since been disconnected
     @bouncer.active_conns.each do |conn|
       device = get_device(conn)
-      device[ctx_name] = pos
+      device.update_pos(ctx_name, pos)
     end
   end
 
@@ -97,9 +150,7 @@ class Backlog
         # 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") + " < #{'* ' if msg.action?}#{msg.prefix}: #{msg.args.last}")
-      update_pos(ctx, stream.pos)
+      write_msg(ctx, Time.now.strftime("%d-%m-%Y %H:%M:%S") + " < #{'* ' if msg.action?}#{msg.prefix}: #{msg.args.last}")
     end
   end
 
@@ -108,46 +159,67 @@ class Backlog
     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") + " > #{'* ' if msg.action?}#{msg.args.last}")
+      write_msg(ctx, Time.now.strftime("%d-%m-%Y %H:%M:%S") + " > #{'* ' if msg.action?}#{msg.args.last}")
+    end
+  end
+
+  def write_msg(ctx, processed_msg)
+    get_stream(ctx) do |stream|
+      stream.puts(processed_msg)
       update_pos(ctx, stream.pos)
     end
   end
 
-  def send_backlog(conn, device)
-    device.each do |ctx_name, pos|
-      stream = File.open(stream_filename(ctx_name), 'rb')
-      stream.seek(pos)
+  def send_connect_backlogs(conn, device, contexts)
+    contexts.each do |ctx_name|
+      start_pos = device.pos(ctx_name)
+      get_stream(ctx_name, true) do |stream|
+        stream.seek(start_pos)
+        send_backlog(conn, ctx_name, stream)
+        device.update_pos(ctx_name, stream.pos)
+      end
+    end
+  end
+
+  def send_backlog_since(conn, start_time, contexts)
+    debug "scanning for backlog from #{start_time.inspect}"
+    contexts.each do |ctx_name|
+      get_stream(ctx_name, true) do |stream|
+        last_line_len = 0
+        BackwardsFileReader.scan(stream) { |line| last_line_len = line.length; Time.parse(line[0,19]) >= start_time }
+        stream.seek(last_line_len, IO::SEEK_CUR)
+        send_backlog(conn, ctx_name, stream)
+      end
+    end
+  end
 
-      while line = stream.gets
-        timestamp, msg = parse_line(line, ctx_name)
-        next unless msg
-        privmsg = msg.args.first[0] != '#'[0]
-        if msg.prefix
-          # to this user
-          if privmsg
-            msg.args[0] = @bouncer.nick
-          else
-            # do nothing, it's good to send
-          end
+  def send_backlog(conn, ctx_name, stream)
+    while line = stream.gets
+      timestamp, msg = parse_line(line, ctx_name)
+      next unless msg
+      privmsg = msg.args.first[0] != '#'[0]
+      if msg.prefix
+        # to this user
+        if privmsg
+          msg.args[0] = @bouncer.nick
         else
-          # from this user
-          if privmsg
-            # a one-on-one chat -- every client i've seen doesn't know how to
-            # display messages from themselves here, so we fake it by just
-            # adding an arrow and pretending the other user said it. shame.
-            msg.prefix = msg.args.first
-            msg.args[0] = @bouncer.nick
-            msg.args[-1] = "-> #{msg.args.last}"
-          else
-            # it's a room, we can just replay
-            msg.prefix = @bouncer.nick
-          end
+          # do nothing, it's good to send
+        end
+      else
+        # from this user
+        if privmsg
+          # a one-on-one chat -- every client i've seen doesn't know how to
+          # display messages from themselves here, so we fake it by just
+          # adding an arrow and pretending the other user said it. shame.
+          msg.prefix = msg.args.first
+          msg.args[0] = @bouncer.nick
+          msg.args[-1] = "-> #{msg.args.last}"
+        else
+          # it's a room, we can just replay
+          msg.prefix = @bouncer.nick
         end
-        conn.send_msg(msg.with_timestamp(timestamp))
       end
-
-      device[ctx_name] = get_stream(ctx_name).pos
+      conn.send_msg(msg.with_timestamp(timestamp))
     end
   end
 
@@ -172,4 +244,24 @@ class Backlog
   end
 end
 
+class BacklogCommand < TkellemBot::Command
+  register 'backlog'
+
+  def self.admin_only?
+    false
+  end
+
+  def execute
+    hours = args.pop.to_f
+    hours = 1 if hours <= 0 || hours >= (24*31)
+    cutoff = hours.hours.ago
+    backlog = Backlog.get_instance(bouncer)
+    rooms = [args.pop].compact
+    if rooms.empty?
+      rooms = backlog.all_existing_ctxs
+    end
+    backlog.send_backlog_since(conn, cutoff, rooms)
+  end
+end
+
 end

data/lib/tkellem/tkellem_bot.rb

@@ -4,9 +4,9 @@ require 'yaml'
 module Tkellem
 
 class TkellemBot
-  # careful here -- if no user is given, it's assumed the command is running as
+  # careful here -- if no bouncer is given, it's assumed the command is running as
   # an admin
-  def self.run_command(line, user, network_user, &block)
+  def self.run_command(line, bouncer, conn, &block)
     args = Shellwords.shellwords(line)
     command_name = args.shift.upcase
     command = commands[command_name]
@@ -16,11 +16,11 @@ class TkellemBot
       return
     end
 
-    command.run(args, user, network_user, block)
+    command.run(args, bouncer, conn, block)
   end
 
   class Command
-    attr_accessor :args, :user, :network_user, :opts, :options
+    attr_accessor :args, :bouncer, :conn, :opts, :options
 
     def self.option(name, *args)
       @options ||= {}
@@ -62,18 +62,18 @@ class TkellemBot
       end
     end
 
-    def self.run(args_arr, user, network_user, block)
-      if admin_only? && !admin_user?(user)
+    def self.run(args_arr, bouncer, conn, block)
+      if admin_only? && !admin_user?(bouncer.try(:user))
         block.call "You can only run #{name} as an admin."
         return
       end
       cmd = self.new(block)
 
       cmd.args = args_arr
-      cmd.user = user
-      cmd.network_user = network_user
+      cmd.bouncer = bouncer
+      cmd.conn = conn
 
-      cmd.options = build_options(user, cmd)
+      cmd.options = build_options(bouncer.try(:user), cmd)
       cmd.options.parse!(args_arr)
 
       cmd.execute
@@ -86,6 +86,10 @@ class TkellemBot
       @opts = {}
     end
 
+    def user
+      bouncer.try(:user)
+    end
+
     def show_help
       respond(options)
     end
@@ -156,7 +160,7 @@ class TkellemBot
     end
 
     def modify
-      instance = model.first(:conditions => find_attributes)
+      instance = model.where(find_attributes).first
       new_record = false
       if instance
         instance.attributes = attributes
@@ -181,7 +185,7 @@ class TkellemBot
     end
 
     def remove
-      instance = model.first(:conditions => find_attributes)
+      instance = model.where(find_attributes).first
       if instance
         instance.destroy
         respond "Removed #{show(instance)}"
@@ -258,7 +262,7 @@ class TkellemBot
 
       if opts['username']
         if Command.admin_user?(user)
-          user = User.first(:conditions => { :username => opts['username'] })
+          user = User.where({ :username => opts['username'] }).first
         else
           raise Command::ArgumentError, "Only admins can change other passwords"
         end
@@ -303,9 +307,9 @@ class TkellemBot
 
     def execute
       if opts['network'].present? # only settable by admins
-        target = Network.first(:conditions => ["name = ? AND user_id IS NULL", opts['network'].downcase])
+        target = Network.where(["name = ? AND user_id IS NULL", opts['network'].downcase]).first
       else
-        target = network_user
+        target = bouncer.try(:network_user)
       end
       raise(Command::ArgumentError, "No network found") unless target
 
@@ -339,7 +343,7 @@ class TkellemBot
     admin_option('public', '--public', "Create new public network. Once created, public/private status can't be modified.")
 
     def list
-      public_networks = Network.all(:conditions => 'user_id IS NULL')
+      public_networks = Network.where('user_id IS NULL').to_a
       user_networks = user.try(:reload).try(:networks) || []
       if user_networks.present? && public_networks.present?
         r "Public networks are prefixed with [P], user-specific networks with [U]."
@@ -362,10 +366,10 @@ class TkellemBot
       end
 
       if opts['network'].present?
-        target = Network.first(:conditions => ["name = ? AND user_id = ?", opts['network'].downcase, user.try(:id)])
-        target ||= Network.first(:conditions => ["name = ? AND user_id IS NULL", opts['network'].downcase]) if self.class.admin_user?(user)
+        target = Network.where(["name = ? AND user_id = ?", opts['network'].downcase, user.try(:id)]).first
+        target ||= Network.where(["name = ? AND user_id IS NULL", opts['network'].downcase]).first if self.class.admin_user?(user)
       else
-        target = network_user.try(:network)
+        target = bouncer.try(:network)
         if target && target.public? && !self.class.admin_user?(user)
           raise(Command::ArgumentError, "Only admins can modify public networks")
         end
@@ -379,7 +383,7 @@ class TkellemBot
         raise(Command::ArgumentError, "No network found") unless target
         raise(Command::ArgumentError, "You must explicitly specify the network to remove") unless opts['network']
         if uri
-          target.hosts.first(:conditions => addr_args).try(:destroy)
+          target.hosts.where(addr_args).first.try(:destroy)
           respond "    #{show(target)}"
         else
           target.destroy

data/lib/tkellem/tkellem_server.rb

@@ -5,6 +5,7 @@ require 'rails/observers/activerecord/active_record'
 require 'tkellem/bouncer_connection'
 require 'tkellem/bouncer'
 
+require 'tkellem/models/backlog_position'
 require 'tkellem/models/host'
 require 'tkellem/models/listen_address'
 require 'tkellem/models/network'

data/lib/tkellem/version.rb

@@ -1,3 +1,3 @@
 module Tkellem
-  VERSION = "0.9.0.beta5"
+  VERSION = "0.9.0.beta6"
 end

data/resources/bot_command_descriptions.yml

@@ -65,3 +65,16 @@ SETTING:
     Examples:
         SETTING
         SETTING user_registration open
+
+BACKLOG:
+  banner: "BACKLOG [<room or user>] <hours>"
+  help: |+
+
+    View backlog for a given room (or all rooms).
+
+    Examples:
+      view 3 hours of backlog for all rooms:
+        BACKLOG 3
+      view 2 hours of backlog for the #friends room:
+        BACKLOG #friends 2
+

data/tkellem.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency "eventmachine", "~> 1.0.3"
   s.add_dependency "activerecord", "~> 4.0.0.rc2"
   s.add_dependency "sqlite3", "~> 1.3.3"
-  s.add_dependency "rails-observers"
+  s.add_dependency "rails-observers", "~> 0.1.1"
 
   s.add_development_dependency "rspec", "~> 2.5"
   s.add_development_dependency "simplecov"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tkellem
 version: !ruby/object:Gem::Version
-  version: 0.9.0.beta5
+  version: 0.9.0.beta6
   prerelease: 6
 platform: ruby
 authors:
@@ -64,17 +64,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ files:
 - debian/source/format
 - debian/tkellem.1
 - examples/config.yml
+- lib/backwards_file_reader.rb
 - lib/tkellem.rb
 - lib/tkellem/bouncer.rb
 - lib/tkellem/bouncer_connection.rb
@@ -142,6 +143,8 @@ files:
 - lib/tkellem/migrations/001_init_db.rb
 - lib/tkellem/migrations/002_at_connect_columns.rb
 - lib/tkellem/migrations/003_settings.rb
+- lib/tkellem/migrations/004_add_backlog_positions.rb
+- lib/tkellem/models/backlog_position.rb
 - lib/tkellem/models/host.rb
 - lib/tkellem/models/listen_address.rb
 - lib/tkellem/models/network.rb
@@ -176,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1423623197128885287
+      hash: -3227479256214669237
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: