Better flood control

[rbot] / lib / rbot / botuser.rb

#-- vim:sw=2:et\r
#++\r
# :title: User management\r
#\r
# rbot user management\r
# Author:: Giuseppe Bilotta (giuseppe.bilotta@gmail.com)\r
# Copyright:: Copyright (c) 2006 Giuseppe Bilotta\r
# License:: GPLv2\r
\r
require 'singleton'\r
\r
\r
module Irc\r
\r
\r
  # This module contains the actual Authentication stuff\r
  #\r
  module Auth\r
\r
    BotConfig.register BotConfigStringValue.new( 'auth.password',\r
      :default => 'rbotauth', :wizard => true,\r
      :desc => 'Password for the bot owner' )\r
    BotConfig.register BotConfigBooleanValue.new( 'auth.login_by_mask',\r
      :default => 'true',\r
      :desc => 'Set false to prevent new botusers from logging in without a password when the user netmask is known')\r
    BotConfig.register BotConfigBooleanValue.new( 'auth.autologin',\r
      :default => 'true',\r
      :desc => 'Set false to prevent new botusers from recognizing IRC users without a need to manually login')\r
    # BotConfig.register BotConfigIntegerValue.new( 'auth.default_level',\r
    #   :default => 10, :wizard => true,\r
    #   :desc => 'The default level for new/unknown users' )\r
\r
    # Generate a random password of length _l_\r
    #\r
    def Auth.random_password(l=8)\r
      pwd = ""\r
      8.times do\r
        pwd += (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr\r
      end\r
      return pwd\r
    end\r
\r
\r
    # An Irc::Auth::Command defines a command by its "path":\r
    #\r
    #   base::command::subcommand::subsubcommand::subsubsubcommand\r
    #\r
    class Command\r
\r
      attr_reader :command, :path\r
\r
      # A method that checks if a given _cmd_ is in a form that can be\r
      # reduced into a canonical command path, and if so, returns it\r
      #\r
      def sanitize_command_path(cmd)\r
        pre = cmd.to_s.downcase.gsub(/^\*?(?:::)?/,"").gsub(/::$/,"")\r
        return pre if pre.empty?\r
        return pre if pre =~ /^\S+(::\S+)*$/\r
        raise TypeError, "#{cmd.inspect} is not a valid command"\r
      end\r
\r
      # Creates a new Command from a given string; you can then access\r
      # the command as a symbol with the :command method and the whole\r
      # path as :path\r
      #\r
      #   Command.new("core::auth::save").path => [:"*", :"core", :"core::auth", :"core::auth::save"]\r
      #\r
      #   Command.new("core::auth::save").command => :"core::auth::save"\r
      #\r
      def initialize(cmd)\r
        cmdpath = sanitize_command_path(cmd).split('::')\r
        seq = cmdpath.inject(["*"]) { |list, cmd|\r
          list << (list.length > 1 ? list.last + "::" : "") + cmd\r
        }\r
        @path = seq.map { |k|\r
          k.to_sym\r
        }\r
        @command = path.last\r
        debug "Created command #{@command.inspect} with path #{@path.join(', ')}"\r
      end\r
\r
      # Returs self\r
      def to_irc_auth_command\r
        self\r
      end\r
\r
    end\r
\r
  end\r
\r
end\r
\r
\r
class String\r
\r
  # Returns an Irc::Auth::Comand from the receiver\r
  def to_irc_auth_command\r
    Irc::Auth::Command.new(self)\r
  end\r
\r
end\r
\r
\r
module Irc\r
\r
\r
  module Auth\r
\r
\r
    # This class describes a permission set\r
    class PermissionSet\r
\r
      attr_reader :perm\r
      # Create a new (empty) PermissionSet\r
      #\r
      def initialize\r
        @perm = {}\r
      end\r
\r
      # Inspection simply inspects the internal hash\r
      def inspect\r
        @perm.inspect\r
      end\r
\r
      # Sets the permission for command _cmd_ to _val_,\r
      #\r
      def set_permission(str, val)\r
        cmd = str.to_irc_auth_command\r
        case val\r
        when true, false\r
          @perm[cmd.command] = val\r
        when nil\r
          @perm.delete(cmd.command)\r
        else\r
          raise TypeError, "#{val.inspect} must be true or false" unless [true,false].include?(val)\r
        end\r
      end\r
\r
      # Resets the permission for command _cmd_\r
      #\r
      def reset_permission(cmd)\r
        set_permission(cmd, nil)\r
      end\r
\r
      # Tells if command _cmd_ is permitted. We do this by returning\r
      # the value of the deepest Command#path that matches.\r
      #\r
      def permit?(str)\r
        cmd = str.to_irc_auth_command\r
        allow = nil\r
        cmd.path.reverse.each { |k|\r
          if @perm.has_key?(k)\r
            allow = @perm[k]\r
            break\r
          end\r
        }\r
        return allow\r
      end\r
\r
    end\r
\r
\r
    # This is the error that gets raised when an invalid password is met\r
    #\r
    class InvalidPassword < RuntimeError\r
    end\r
\r
\r
    # This is the basic class for bot users: they have a username, a password,\r
    # a list of netmasks to match against, and a list of permissions.\r
    #\r
    class BotUser\r
\r
      attr_reader :username\r
      attr_reader :password\r
      attr_reader :netmasks\r
      attr_reader :perm\r
      attr_writer :login_by_mask\r
      attr_writer :autologin\r
\r
      # Create a new BotUser with given username\r
      def initialize(username)\r
        @username = BotUser.sanitize_username(username)\r
        @password = nil\r
        @netmasks = NetmaskList.new\r
        @perm = {}\r
        reset_login_by_mask\r
        reset_autologin\r
      end\r
\r
      # Inspection\r
      def inspect\r
        str = "<#{self.class}:#{'0x%08x' % self.object_id}:"\r
        str << " @username=#{@username.inspect}"\r
        str << " @netmasks=#{@netmasks.inspect}"\r
        str << " @perm=#{@perm.inspect}"\r
        str << " @login_by_mask=#{@login_by_mask}"\r
        str << " @autologin=#{@autologin}"\r
        str << ">"\r
      end\r
\r
      # In strings\r
      def to_s\r
        @username\r
      end\r
\r
      # Convert into a hash\r
      def to_hash\r
        {\r
          :username => @username,\r
          :password => @password,\r
          :netmasks => @netmasks,\r
          :perm => @perm,\r
          :login_by_mask => @login_by_mask,\r
          :autologin => @autologin\r
        }\r
      end\r
\r
      # Do we allow logging in without providing the password?\r
      #\r
      def login_by_mask?\r
        @login_by_mask\r
      end\r
\r
      # Reset the login-by-mask option\r
      #\r
      def reset_login_by_mask\r
        @login_by_mask = Auth.authmanager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask)\r
      end\r
\r
      # Reset the autologin option\r
      #\r
      def reset_autologin\r
        @autologin = Auth.authmanager.bot.config['auth.autologin'] unless defined?(@autologin)\r
      end\r
\r
      # Do we allow automatic logging in?\r
      #\r
      def autologin?\r
        @autologin\r
      end\r
\r
      # Restore from hash\r
      def from_hash(h)\r
        @username = h[:username] if h.has_key?(:username)\r
        @password = h[:password] if h.has_key?(:password)\r
        @netmasks = h[:netmasks] if h.has_key?(:netmasks)\r
        @perm = h[:perm] if h.has_key?(:perm)\r
        @login_by_mask = h[:login_by_mask] if h.has_key?(:login_by_mask)\r
        @autologin = h[:autologin] if h.has_key?(:autologin)\r
      end\r
\r
      # This method sets the password if the proposed new password\r
      # is valid\r
      def password=(pwd=nil)\r
        if pwd\r
          begin\r
            raise InvalidPassword, "#{pwd} contains invalid characters" if pwd !~ /^[A-Za-z0-9]+$/\r
            raise InvalidPassword, "#{pwd} too short" if pwd.length < 4\r
            @password = pwd\r
          rescue InvalidPassword => e\r
            raise e\r
          rescue => e\r
            raise InvalidPassword, "Exception #{e.inspect} while checking #{pwd}"\r
          end\r
        else\r
          reset_password\r
        end\r
      end\r
\r
      # Resets the password by creating a new onw\r
      def reset_password\r
        @password = Auth.random_password\r
      end\r
\r
      # Sets the permission for command _cmd_ to _val_ on channel _chan_\r
      #\r
      def set_permission(cmd, val, chan="*")\r
        k = chan.to_s.to_sym\r
        @perm[k] = PermissionSet.new unless @perm.has_key?(k)\r
        @perm[k].set_permission(cmd, val)\r
      end\r
\r
      # Resets the permission for command _cmd_ on channel _chan_\r
      #\r
      def reset_permission(cmd, chan ="*")\r
        set_permission(cmd, nil, chan)\r
      end\r
\r
      # Checks if BotUser is allowed to do something on channel _chan_,\r
      # or on all channels if _chan_ is nil\r
      #\r
      def permit?(cmd, chan=nil)\r
        if chan\r
          k = chan.to_s.to_sym\r
        else\r
          k = :*\r
        end\r
        allow = nil\r
        if @perm.has_key?(k)\r
          allow = @perm[k].permit?(cmd)\r
        end\r
        return allow\r
      end\r
\r
      # Adds a Netmask\r
      #\r
      def add_netmask(mask)\r
        @netmasks << mask.to_irc_netmask\r
      end\r
\r
      # Removes a Netmask\r
      #\r
      def delete_netmask(mask)\r
        m = mask.to_irc_netmask\r
        @netmasks.delete(m)\r
      end\r
\r
      # Removes all <code>Netmask</code>s\r
      #\r
      def reset_netmasks\r
        @netmasks = NetmaskList.new\r
      end\r
\r
      # This method checks if BotUser has a Netmask that matches _user_\r
      #\r
      def knows?(usr)\r
        user = usr.to_irc_user\r
        known = false\r
        @netmasks.each { |n|\r
          if user.matches?(n)\r
            known = true\r
            break\r
          end\r
        }\r
        return known\r
      end\r
\r
      # This method gets called when User _user_ wants to log in.\r
      # It returns true or false depending on whether the password\r
      # is right. If it is, the Netmask of the user is added to the\r
      # list of acceptable Netmask unless it's already matched.\r
      def login(user, password)\r
        if password == @password or (password.nil? and (@login_by_mask || @autologin) and knows?(user))\r
          add_netmask(user) unless knows?(user)\r
          debug "#{user} logged in as #{self.inspect}"\r
          return true\r
        else\r
          return false\r
        end\r
      end\r
\r
      # # This method gets called when User _user_ has logged out as this BotUser\r
      # def logout(user)\r
      #   delete_netmask(user) if knows?(user)\r
      # end\r
\r
      # This method sanitizes a username by chomping, downcasing\r
      # and replacing any nonalphanumeric character with _\r
      #\r
      def BotUser.sanitize_username(name)\r
        candidate = name.to_s.chomp.downcase.gsub(/[^a-z0-9]/,"_")\r
        raise "sanitized botusername #{candidate} too short" if candidate.length < 3\r
        return candidate\r
      end\r
\r
    end\r
\r
\r
    # This is the default BotUser: it's used for all users which haven't\r
    # identified with the bot\r
    #\r
    class DefaultBotUserClass < BotUser\r
\r
      private :add_netmask, :delete_netmask\r
\r
      include Singleton\r
\r
      # The default BotUser is named 'everyone'\r
      #\r
      def initialize\r
        reset_login_by_mask\r
        reset_autologin\r
        super("everyone")\r
        @default_perm = PermissionSet.new\r
      end\r
\r
      # This method returns without changing anything\r
      #\r
      def login_by_mask=(val)\r
        debug "Tried to change the login-by-mask for default bot user, ignoring"\r
        return @login_by_mask\r
      end\r
\r
      # The default botuser allows logins by mask\r
      #\r
      def reset_login_by_mask\r
        @login_by_mask = true\r
      end\r
\r
      # This method returns without changing anything\r
      #\r
      def autologin=(val)\r
        debug "Tried to change the autologin for default bot user, ignoring"\r
        return\r
      end\r
\r
      # The default botuser doesn't allow autologin (meaningless)\r
      #\r
      def reset_autologin\r
        @autologin = false\r
      end\r
\r
      # Sets the default permission for the default user (i.e. the ones\r
      # set by the BotModule writers) on all channels\r
      #\r
      def set_default_permission(cmd, val)\r
        @default_perm.set_permission(Command.new(cmd), val)\r
        debug "Default permissions now:\n#{@default_perm.inspect}"\r
      end\r
\r
      # default knows everybody\r
      #\r
      def knows?(user)\r
        return true if user.to_irc_user\r
      end\r
\r
      # We always allow logging in as the default user\r
      def login(user, password)\r
        return true\r
      end\r
\r
      # Resets the NetmaskList\r
      def reset_netmasks\r
        super\r
        add_netmask("*!*@*")\r
      end\r
\r
      # DefaultBotUser will check the default_perm after checking\r
      # the global ones\r
      # or on all channels if _chan_ is nil\r
      #\r
      def permit?(cmd, chan=nil)\r
        allow = super(cmd, chan)\r
        if allow.nil? && chan.nil?\r
          allow = @default_perm.permit?(cmd)\r
        end\r
        return allow\r
      end\r
\r
    end\r
\r
    # Returns the only instance of DefaultBotUserClass\r
    #\r
    def Auth.defaultbotuser\r
      return DefaultBotUserClass.instance\r
    end\r
\r
    # This is the BotOwner: he can do everything\r
    #\r
    class BotOwnerClass < BotUser\r
\r
      include Singleton\r
\r
      def initialize\r
        @login_by_mask = false\r
        @autologin = true\r
        super("owner")\r
      end\r
\r
      def permit?(cmd, chan=nil)\r
        return true\r
      end\r
\r
    end\r
\r
    # Returns the only instance of BotOwnerClass\r
    #\r
    def Auth.botowner\r
      return BotOwnerClass.instance\r
    end\r
\r
\r
    # This is the AuthManagerClass singleton, used to manage User/BotUser connections and\r
    # everything\r
    #\r
    class AuthManagerClass\r
\r
      include Singleton\r
\r
      attr_reader :everyone\r
      attr_reader :botowner\r
      attr_reader :bot\r
\r
      # The instance manages two <code>Hash</code>es: one that maps\r
      # <code>Irc::User</code>s onto <code>BotUser</code>s, and the other that maps\r
      # usernames onto <code>BotUser</code>\r
      def initialize\r
        @everyone = Auth::defaultbotuser\r
        @botowner = Auth::botowner\r
        bot_associate(nil)\r
      end\r
\r
      def bot_associate(bot)\r
        raise "Cannot associate with a new bot! Save first" if defined?(@has_changes) && @has_changes\r
\r
        reset_hashes\r
\r
        # Associated bot\r
        @bot = bot\r
\r
        # This variable is set to true when there have been changes\r
        # to the botusers list, so that we know when to save\r
        @has_changes = false\r
      end\r
\r
      def set_changed\r
        @has_changes = true\r
      end\r
\r
      def reset_changed\r
        @has_changes = false\r
      end\r
\r
      def changed?\r
        @has_changes\r
      end\r
\r
      # resets the hashes\r
      def reset_hashes\r
        @botusers = Hash.new\r
        @allbotusers = Hash.new\r
        [everyone, botowner].each { |x|\r
          @allbotusers[x.username.to_sym] = x\r
        }\r
      end\r
\r
      def load_array(ary, forced)\r
        raise "Won't load with unsaved changes" if @has_changes and not forced\r
        reset_hashes\r
        ary.each { |x|\r
          raise TypeError, "#{x} should be a Hash" unless x.kind_of?(Hash)\r
          u = x[:username]\r
          unless include?(u)\r
            create_botuser(u)\r
          end\r
          get_botuser(u).from_hash(x)\r
        }\r
        @has_changes=false\r
      end\r
\r
      def save_array\r
        @allbotusers.values.map { |x|\r
          x.to_hash\r
        }\r
      end\r
\r
      # checks if we know about a certain BotUser username\r
      def include?(botusername)\r
        @allbotusers.has_key?(botusername.to_sym)\r
      end\r
\r
      # Maps <code>Irc::User</code> to BotUser\r
      def irc_to_botuser(ircuser)\r
        logged = @botusers[ircuser.to_irc_user]\r
        return logged if logged\r
        return autologin(ircuser)\r
      end\r
\r
      # creates a new BotUser\r
      def create_botuser(name, password=nil)\r
        n = BotUser.sanitize_username(name)\r
        k = n.to_sym\r
        raise "botuser #{n} exists" if include?(k)\r
        bu = BotUser.new(n)\r
        bu.password = password\r
        @allbotusers[k] = bu\r
        return bu\r
      end\r
\r
      # returns the botuser with name _name_\r
      def get_botuser(name)\r
        @allbotusers.fetch(BotUser.sanitize_username(name).to_sym)\r
      end\r
\r
      # Logs Irc::User _user_ in to BotUser _botusername_ with password _pwd_\r
      #\r
      # raises an error if _botusername_ is not a known BotUser username\r
      #\r
      # It is possible to autologin by Netmask, on request\r
      #\r
      def login(user, botusername, pwd=nil)\r
        ircuser = user.to_irc_user\r
        n = BotUser.sanitize_username(botusername)\r
        k = n.to_sym\r
        raise "No such BotUser #{n}" unless include?(k)\r
        if @botusers.has_key?(ircuser)\r
          return true if @botusers[ircuser].username == n\r
          # TODO\r
          # @botusers[ircuser].logout(ircuser)\r
        end\r
        bu = @allbotusers[k]\r
        if bu.login(ircuser, pwd)\r
          @botusers[ircuser] = bu\r
          return true\r
        end\r
        return false\r
      end\r
\r
      # Tries to auto-login Irc::User _user_ by looking at the known botusers that allow autologin\r
      # and trying to login without a password\r
      #\r
      def autologin(user)\r
        ircuser = user.to_irc_user\r
        debug "Trying to autlogin #{ircuser}"\r
        return @botusers[ircuser] if @botusers.has_key?(ircuser)\r
        @allbotusers.each { |n, bu|\r
          debug "Checking with #{n}"\r
          return bu if bu.autologin? and login(ircuser, n)\r
        }\r
        return everyone\r
      end\r
\r
      # Checks if User _user_ can do _cmd_ on _chan_.\r
      #\r
      # Permission are checked in this order, until a true or false\r
      # is returned:\r
      # * associated BotUser on _chan_\r
      # * associated BotUser on all channels\r
      # * everyone on _chan_\r
      # * everyone on all channels\r
      #\r
      def permit?(user, cmdtxt, channel=nil)\r
        if user.class <= BotUser\r
          botuser = user\r
        else\r
          botuser = irc_to_botuser(user)\r
        end\r
        cmd = cmdtxt.to_irc_auth_command\r
\r
        chan = channel\r
        case chan\r
        when User\r
          chan = "?"\r
        when Channel\r
          chan = chan.name\r
        end\r
\r
        allow = nil\r
\r
        allow = botuser.permit?(cmd, chan) if chan\r
        return allow unless allow.nil?\r
        allow = botuser.permit?(cmd)\r
        return allow unless allow.nil?\r
\r
        unless botuser == everyone\r
          allow = everyone.permit?(cmd, chan) if chan\r
          return allow unless allow.nil?\r
          allow = everyone.permit?(cmd)\r
          return allow unless allow.nil?\r
        end\r
\r
        raise "Could not check permission for user #{user.inspect} to run #{cmdtxt.inspect} on #{chan.inspect}"\r
      end\r
\r
      # Checks if command _cmd_ is allowed to User _user_ on _chan_, optionally\r
      # telling if the user is authorized\r
      #\r
      def allow?(cmdtxt, user, chan=nil)\r
        if permit?(user, cmdtxt, chan)\r
          return true\r
        else\r
          # cmds = cmdtxt.split('::')\r
          # @bot.say chan, "you don't have #{cmds.last} (#{cmds.first}) permissions here" if chan\r
          @bot.say chan, "#{user}, you don't have '#{cmdtxt}' permissions here" if chan\r
          return false\r
        end\r
      end\r
\r
    end\r
\r
    # Returns the only instance of AuthManagerClass\r
    #\r
    def Auth.authmanager\r
      return AuthManagerClass.instance\r
    end\r
\r
  end\r
\r
end\r