kag-gather 1.3.4 → 1.3.5

data/lib/kag/gather/match.rb

@@ -0,0 +1,159 @@
+require 'cinch'
+require 'symboltable'
+require 'kag/config'
+require 'kag/gather/team'
+
+module KAG
+  module Gather
+    class Match < SymbolTable
+      def self.type_as_string
+        ms = KAG::Config.instance[:match_size].to_i
+        ts = (ms / 2).ceil
+        "#{ts.to_s}v#{ts.to_s} #{KAG::Config.instance[:match_type]}"
+      end
+
+      def setup_teams
+        self[:players].shuffle!
+        match_size = KAG::Config.instance[:match_size].to_i
+        match_size = 2 if match_size < 2
+
+        lb = (match_size / 2).ceil.to_i
+        lb = 1 if lb < 1
+
+        debug "MATCH SIZE #{match_size.to_s}"
+        debug "LOWER BOUND: #{lb.to_s}"
+        debug "PLAYERS: #{self[:players].join(",")}"
+
+        self[:teams] = []
+        self[:teams] << KAG::Gather::Team.new({
+          :players => self[:players].slice(0,lb),
+          :match => self,
+          :color => "\x0312",
+          :name => "Blue"
+        }).setup
+        self[:teams] << KAG::Gather::Team.new({
+          :players => self[:players].slice(lb,match_size),
+          :match => self,
+          :color => "\x0304",
+          :name => "Red"
+        }).setup
+        self[:teams]
+      end
+
+      def start
+        self[:end_votes] = 0 unless self[:end_votes]
+        self[:subs_needed] = []
+        setup_teams
+        restart_map
+      end
+
+      def text_for_match_start
+        msg = "MATCH: #{KAG::Gather::Match.type_as_string} - "
+        self[:teams].each do |team|
+          msg = msg+" "+team.text_for_match_start
+        end
+        msg+" \x0301(!end when done)"
+      end
+
+      def notify_teams_of_match_start
+        messages = {}
+        self[:teams].each do |t|
+          ms = t.notify_of_match_start
+          ms.each do |nick,msg|
+            messages[nick] = msg
+          end
+        end
+        messages
+      end
+
+      def add_end_vote
+        self[:end_votes] = 0 unless self[:end_votes] > 0
+        self[:end_votes] = self[:end_votes] + 1
+      end
+
+      def voted_to_end?
+        evt = KAG::Config.instance[:end_vote_threshold].to_i
+        evt = 3 if evt < 1
+        self[:end_votes] >= evt
+      end
+
+      def get_needed_end_votes_left
+        evt = KAG::Config.instance[:end_vote_threshold].to_i
+        evt - self[:end_votes]
+      end
+
+      def has_player?(nick)
+        playing = false
+        self[:teams].each do |team|
+          playing = true if team.has_player?(nick)
+        end
+        playing
+      end
+
+      def cease
+        if self.server
+          if self.server.has_rcon?
+            self[:teams].each do |team|
+              team.kick_all
+            end
+          else
+            debug "NO RCON, so could not kick!"
+          end
+          self.server.disconnect
+          self.server.delete(:match)
+          true
+        else
+          debug "No server for match defined!"
+          false
+        end
+      end
+
+      def restart_map
+        if self.server.has_rcon?
+          self.server.restart_map
+        else
+          debug "Cannot restart map, no RCON defined"
+        end
+      end
+
+      def remove_player(nick)
+        sub = false
+        self[:teams].each do |team|
+          if team.has_player?(nick)
+            sub = team.remove_player(nick)
+          end
+        end
+        if sub
+          self[:subs_needed] << sub
+        end
+        sub
+      end
+
+      def needs_sub?
+        self[:subs_needed].length > 0
+      end
+
+      def sub_in(nick)
+        placement = false
+        if needs_sub?
+          placement = self[:subs_needed].shift
+        end
+        placement
+      end
+
+      def rename_player(last_nick,new_nick)
+        self[:teams].each do |team|
+          if team.has_player?(last_nick)
+            team.rename_player(last_nick,new_nick)
+          end
+        end
+      end
+
+      def debug(msg)
+        if KAG::Config.instance[:debug]
+          puts msg
+        end
+      end
+    end
+  end
+end

data/lib/kag/gather/plugin.rb

@@ -0,0 +1,354 @@
+require 'cinch'
+require 'kag/common'
+require 'commands/help'
+require 'kag/bot/bot'
+require 'kag/bans/report'
+require 'kag/server'
+require 'kag/gather/match'
+
+module KAG
+  module Gather
+    class Plugin
+      include Cinch::Plugin
+      include Cinch::Commands
+      include KAG::Common
+
+      attr_accessor :queue,:servers
+
+      def initialize(*args)
+        super
+        @queue = {}
+        @matches = {}
+        _load_servers
+      end
+
+      def _load_servers
+        @servers = {}
+        KAG::Config.instance[:servers].each do |k,s|
+          s[:key] = k
+          @servers[k] = KAG::Server.new(s)
+        end
+      end
+
+      #listen_to :channel, method: :channel_listen
+      #def channel_listen(m)
+      #end
+
+      listen_to :leaving, :method => :on_leaving
+      def on_leaving(m,nick)
+        unless is_banned?(m.user)
+          nick = nick.to_s
+          match = get_match_in(nick)
+          if match
+            sub = match.remove_player(nick)
+            if sub
+              m.channel.msg sub[:msg]
+            end
+          elsif @queue.key?(nick)
+            remove_user_from_queue(nick)
+          end
+        end
+      end
+
+      listen_to :nick, :method => :on_nick
+      def on_nick(m)
+        unless is_banned?(m.user)
+          match = get_match_in(m.user.last_nick)
+          if match
+            match.rename_player(m.user.last_nick,m.user.nick)
+          elsif @queue.key?(m.user.last_nick)
+            @queue[m.user.nick] = @queue[m.user.last_nick]
+            @queue.delete(m.user.last_nick)
+          end
+        end
+      end
+
+      match "sub", :method => :evt_sub
+      def evt_sub(m)
+        unless is_banned?(m.user)
+          @matches.each do |k,match|
+            if match.needs_sub?
+              placement = match.sub_in(m.user.nick)
+              if placement
+                reply m,placement[:channel_msg]
+                User(m.user.nick).send placement[:private_msg]
+              end
+            end
+          end
+        end
+      end
+
+      command :add,{},
+        summary: "Add yourself to the active queue for the next match"
+      def add(m)
+        unless is_banned?(m.user)
+          add_user_to_queue(m,m.user.nick)
+        end
+      end
+
+      command :rem,{},
+        summary: "Remove yourself from the active queue for the next match"
+      def rem(m)
+        unless is_banned?(m.user)
+          match = get_match_in(m.user.nick)
+          if match
+            match.remove_player(m.user.nick)
+            send_channels_msg "#{m.user.nick} has left the match at #{match.server[:key]}! You can sub in by typing !sub"
+          elsif @queue.key?(m.user.nick)
+            unless remove_user_from_queue(m.user.nick)
+              debug "#{nick} is not in the queue."
+            end
+          end
+        end
+      end
+
+      command :list,{},
+        summary: "List the users signed up for the next match"
+      def list(m)
+        unless is_banned?(m.user)
+          users = []
+          @queue.each do |n,u|
+            users << n
+          end
+          m.user.send "Queue (#{KAG::Gather::Match.type_as_string}) [#{@queue.length}] #{users.join(", ")}"
+        end
+      end
+
+      command :status,{},
+        summary: "Show the number of ongoing matches"
+      def status(m)
+        unless is_banned?(m.user)
+          reply m,"Matches in progress: #{@matches.length.to_s}"
+        end
+      end
+
+      command :end,{},
+        summary: "End the current match",
+        description: "End the current match. This will only work if you are in the match. After !end is called by 3 different players, the match will end."
+      def end(m)
+        unless is_banned?(m.user)
+          match = get_match_in(m.user.nick)
+          if match
+            match.add_end_vote
+            if match.voted_to_end?
+              match.cease
+              @matches.delete(match.server[:key])
+              send_channels_msg("Match at #{match.server[:key]} finished!")
+            else
+              reply m,"End vote started, #{match.get_needed_end_votes_left} more votes to end match at #{match.server[:key]}"
+            end
+          else
+            reply m,"You're not in a match, silly! Stop trying to hack me."
+          end
+        end
+      end
+
+      def add_user_to_queue(m,nick,send_msg = true)
+        if @queue.key?(nick)
+          reply m,"#{nick} is already in the queue!"
+        elsif get_match_in(nick)
+          reply m,"#{nick} is already in a match!"
+        else
+          @queue[nick] = SymbolTable.new({
+              :user => User(nick),
+              :irc => m.channel,
+              :message => m.message,
+              :joined_at => Time.now
+          })
+          send_channels_msg "Added #{nick} to queue (#{KAG::Gather::Match.type_as_string}) [#{@queue.length}]" if send_msg
+          check_for_new_match
+        end
+      end
+
+      def remove_user_from_queue(nick,send_msg = true)
+        if @queue.key?(nick)
+          @queue.delete(nick)
+          send_channels_msg "Removed #{nick} from queue (#{KAG::Gather::Match.type_as_string}) [#{@queue.length}]" if send_msg
+          true
+        else
+          false
+        end
+      end
+
+      def get_match_in(nick)
+        m = false
+        @matches.each do |k,match|
+          if match.has_player?(nick)
+            m = match
+          end
+        end
+        m
+      end
+
+      def check_for_new_match
+        if @queue.length >= KAG::Config.instance[:match_size]
+          players = []
+          @queue.each do |n,i|
+            players << n
+          end
+
+          server = get_unused_server
+          unless server
+            send_channels_msg "Could not find any available servers!"
+            debug "FAILED TO FIND UNUSED SERVER"
+            return false
+          end
+
+          # reset queue first to prevent 11-player load
+          @queue = {}
+
+          match = KAG::Gather::Match.new(SymbolTable.new({
+            :server => server,
+            :players => players
+          }))
+          match.start # prepare match data
+          messages = match.notify_teams_of_match_start # gather texts for private messages
+          send_channels_msg(match.text_for_match_start,false) # send channel-wide first
+          messages.each do |nick,msg|
+            User(nick.to_s).send(msg) unless nick.to_s.include?("player")
+            sleep(2) # prevent excess flood stuff
+          end
+          @matches[server[:key]] = match
+        end
+      end
+
+      def get_unused_server
+        server = false
+        @servers.shuffle!
+        @servers.each do |k,s|
+          server = s unless s.in_use?
+        end
+        server
+      end
+
+      # admin methods
+
+      command :clear,{},
+        summary: "Clear (empty) the ongoing queue",
+        admin: true
+      def clear(m)
+        if is_admin(m.user)
+          send_channels_msg "Match queue cleared."
+          @queue = {}
+        end
+      end
+
+      command :rem,{nick: :string},
+        summary: "Remove a specific user from the queue",
+        method: :rem_admin,
+        admin: true
+      def rem_admin(m, arg)
+        if is_admin(m.user)
+          arg = arg.split(" ")
+          arg.each do |nick|
+            remove_user_from_queue(nick)
+          end
+        end
+      end
+
+      command :rem_silent,{nick: :string},
+        summary: "Remove a specific user from the queue without pinging the user in the channel",
+        admin: true
+      def rem_silent(m, arg)
+        if is_admin(m.user)
+          arg = arg.split(" ")
+          arg.each do |nick|
+            remove_user_from_queue(nick,false)
+          end
+        end
+      end
+
+      command :add,{nick: :string},
+        summary: "Add a specific user to the queue",
+        method: :add_admin,
+        admin: true
+      def add_admin(m, arg)
+        if is_admin(m.user)
+          arg = arg.split(" ")
+          arg.each do |nick|
+            add_user_to_queue(m,nick)
+          end
+        end
+      end
+
+      command :add_silent,{nick: :string},
+        summary: "Add a specific user to the queue without pinging the user in the channel",
+        admin: true
+      def add_silent(m, arg)
+        if is_admin(m.user)
+          arg = arg.split(" ")
+          arg.each do |nick|
+            add_user_to_queue(m,nick,false)
+          end
+        end
+      end
+
+      command :restart_map,{},
+        summary: "Restart the map of the match you are in",
+        admin: true
+      def restart_map(m)
+        if is_admin(m.user)
+          match = get_match_in(m.user.nick)
+          if match and match.server
+            match.server.restart_map
+          end
+        end
+      end
+
+      command :restart_map,{server: :string},
+        summary: "Restart the map of a given server",
+        method: :restart_map_specify,
+        admin: true
+      def restart_map_specify(m,server)
+        if is_admin(m.user)
+          if @servers[server.to_sym]
+            @servers[server.to_sym].restart_map
+          else
+            m.reply "No server found with key #{server.to_s}"
+          end
+        end
+      end
+
+      command :restart_map,{},
+        summary: "Next map the match of the server you are in",
+        admin: true
+      def next_map(m)
+        if is_admin(m.user)
+          match = get_match_in(m.user.nick)
+          if match and match.server
+            match.server.next_map
+          end
+        end
+      end
+
+      command :next_map,{server: :string},
+        summary: "Next map a given server",
+        method: :next_map_specify,
+        admin: true
+      def next_map_specify(m,arg)
+        if is_admin(m.user)
+          if @servers[key]
+            @servers[key].next_map
+          else
+            m.reply "No server found with key #{arg}"
+          end
+        end
+      end
+
+      command :kick_from_match,{nick: :string},
+        summary: "Actually kick a user from a match",
+        admin: true
+      def kick_from_match(m,nick)
+        if is_admin(m.user)
+          match = get_match_in(nick)
+          if match
+            match.remove_player(nick)
+            m.reply "#{nick} has been kicked from the match"
+          else
+            m.reply "#{nick} is not in a match!"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kag/gather/team.rb

@@ -0,0 +1,84 @@
+require 'cinch'
+require 'cinch/user'
+require 'symboltable'
+require 'kag/config'
+
+module KAG
+  module Gather
+    class Team < SymbolTable
+
+      def setup
+        setup_classes
+        self
+      end
+
+      def setup_classes
+        classes = KAG::Config.instance[:classes].clone
+        classes.shuffle!
+        players = self[:players].clone
+        self[:players] = {}
+        players.each do |p|
+          self[:players][p.to_sym] = classes.shift
+        end
+        self
+      end
+
+      def notify_of_match_start
+        server = self.match.server
+        msg = "Join \x0305#{server[:key]} - #{server[:ip]}:#{server[:port]} \x0306password #{server[:password]}\x0301 | Visit kag://#{server[:ip]}/#{server[:password]} | "
+        msg = msg + " \x0303Class: " if KAG::Config.instance[:pick_classes]
+
+        messages = {}
+        self[:players].each do |nick,cls|
+          player_msg = msg.clone
+          player_msg = player_msg+cls if KAG::Config.instance[:pick_classes] and cls and !cls.empty?
+          player_msg = player_msg+" #{self[:color]}#{self[:name]} with: #{self[:players].keys.join(", ")}"
+          messages[nick] = player_msg
+        end
+        messages
+      end
+
+      def text_for_match_start
+        "#{self[:color]}#{self[:players].keys.join(", ")} (#{self[:name]})"
+      end
+
+      def has_player?(nick)
+        self[:players].keys.include?(nick.to_sym)
+      end
+
+      def rename_player(last_nick,new_nick)
+        if has_player?(nick)
+          cls = self[:players][last_nick.to_sym]
+          self[:players].delete(last_nick.to_sym)
+          self[:players][new_nick.to_sym] = cls
+        end
+      end
+
+      def remove_player(nick)
+        if has_player?(nick)
+          sub = {}
+          sub[:cls] = self[:players][nick]
+          sub[:team] = self.clone
+          sub[:msg] = "Sub needed at #{self.match.server[:ip]} for #{sub[:team][:name]}, #{sub[:cls]} Class! Type !sub to claim it!"
+          sub[:channel_msg] = "#{nick} is now subbing in for #{self[:name]} at #{self.match.server[:key]}. Subs still needed: #{self.match[:subs_needed].length}"
+          sub[:private_msg] = "Please #{self.match.server.text_join} | #{sub[:cls]} on the #{self[:name]} Team"
+          self[:players].delete(nick)
+
+          if self.match and self.match.server
+            self.match.server.kick(nick)
+          end
+
+          sub
+        else
+          false
+        end
+      end
+
+      def kick_all
+        self[:players].each do |nick,cls|
+          self.match.server.kick(nick.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/kag/irc/plugin.rb

@@ -0,0 +1,101 @@
+require 'cinch'
+require 'kag/common'
+require 'commands/help'
+
+module KAG
+  module IRC
+    class Plugin
+      include Cinch::Plugin
+      include Cinch::Commands
+      include KAG::Common
+
+      command :hostname,{nick: :string},
+        summary: "Get the hostname for a user",
+        admin: true
+      def hostname(m,nick)
+        if is_admin(m.user)
+          user = User(nick)
+          if user and !user.unknown
+            reply m,"Hostname for #{nick} is #{user.host}"
+          else
+            reply m,"Could not find user #{nick}"
+          end
+        end
+      end
+
+      command :authname,{nick: :string},
+        summary: "Get the AUTH name of a user",
+        admin: true
+      def authname(m,nick)
+        if is_admin(m.user)
+          user = User(nick)
+          if user and !user.unknown
+            reply m,"Authname for #{nick} is #{user.authname}"
+          else
+            reply m,"Could not find user #{nick}"
+          end
+        end
+      end
+
+      command :idle,{nick: :string},
+        summary: "Return how long a user has been idle",
+        admin: true
+      def idle(m,nick)
+        if is_admin(m.user)
+          user = User(nick)
+          if user and !user.unknown
+            s = user.idle.to_i / 60
+            reply m,"#{nick} has been idle #{s} minutes"
+          else
+            reply m,"Could not find user #{nick}"
+          end
+        end
+      end
+
+      command :op,{nick: :string},
+        summary: "Op a user",
+        admin: true
+      def op(m,nick)
+        if is_admin(m.user)
+          m.channel.op(nick)
+        end
+      end
+
+      command :deop,{nick: :string},
+        summary: "Deop a user",
+        admin: true
+      def deop(m,nick)
+        if is_admin(m.user)
+          m.channel.deop(nick)
+        end
+      end
+
+      command :voice,{nick: :string},
+        summary: "Voice a user",
+        admin: true
+      def voice(m,nick)
+        if is_admin(m.user)
+          m.channel.voice(nick)
+        end
+      end
+
+      command :devoice,{nick: :string,reason: :string},
+        summary: "Devoice a user",
+        admin: true
+      def devoice(m,nick,reason = '')
+        if is_admin(m.user)
+          m.channel.devoice(nick)
+        end
+      end
+
+      command :kick,{nick: :string,reason: :string},
+        summary: "Kick a user",
+        admin: true
+      def kick(m,nick,reason)
+        if is_admin(m.user)
+          m.channel.kick(nick,reason)
+        end
+      end
+    end
+  end
+end

data/lib/kag/version.rb

@@ -1,5 +1,5 @@
 module KAG
-  VERSION = '1.3.4'
+  VERSION = '1.3.5'
   def self.version
     VERSION
   end

data/readme.md

@@ -8,4 +8,4 @@ First setup config file by copying config/config.sample.json to config/config.js
 
 Then run:
 
-`ruby gather.rb`
+`sh gather.sh`