X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fbotuser.rb;h=f2c48421eb93e540e335e363810bea29c2e0c60c;hb=eb997017eb87a93233c539ded826a6669b5df868;hp=76785be8a9626b9019da3f25f199a551b2e1fda1;hpb=c2f8deb3bbf44b4bb2996a883c3b7eaef7e52c63;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/botuser.rb b/lib/rbot/botuser.rb index 76785be8..f2c48421 100644 --- a/lib/rbot/botuser.rb +++ b/lib/rbot/botuser.rb @@ -9,6 +9,7 @@ require 'singleton' require 'set' +require 'rbot/maskdb' # This would be a good idea if it was failproof, but the truth # is that other methods can indirectly modify the hash. *sigh* @@ -19,7 +20,7 @@ require 'set' # class_eval { # define_method(m) { |*a| # r = super(*a) -# Irc::Auth.authmanager.set_changed +# Irc::Bot::Auth.manager.set_changed # r # } # } @@ -28,26 +29,27 @@ require 'set' # module Irc +class Bot # This module contains the actual Authentication stuff # module Auth - BotConfig.register BotConfigStringValue.new( 'auth.password', + Config.register Config::StringValue.new( 'auth.password', :default => 'rbotauth', :wizard => true, :on_change => Proc.new {|bot, v| bot.auth.botowner.password = v}, :desc => _('Password for the bot owner')) - BotConfig.register BotConfigBooleanValue.new( 'auth.login_by_mask', + Config.register Config::BooleanValue.new( 'auth.login_by_mask', :default => 'true', :desc => _('Set false to prevent new botusers from logging in without a password when the user netmask is known')) - BotConfig.register BotConfigBooleanValue.new( 'auth.autologin', + Config.register Config::BooleanValue.new( 'auth.autologin', :default => 'true', :desc => _('Set false to prevent new botusers from recognizing IRC users without a need to manually login')) - BotConfig.register BotConfigBooleanValue.new( 'auth.autouser', + Config.register Config::BooleanValue.new( 'auth.autouser', :default => 'false', :desc => _('Set true to allow new botusers to be created automatically')) - # BotConfig.register BotConfigIntegerValue.new( 'auth.default_level', + # Config.register Config::IntegerValue.new( 'auth.default_level', # :default => 10, :wizard => true, # :desc => 'The default level for new/unknown users' ) @@ -62,7 +64,7 @@ module Irc end - # An Irc::Auth::Command defines a command by its "path": + # An Irc::Bot::Auth::Command defines a command by its "path": # # base::command::subcommand::subsubcommand::subsubsubcommand # @@ -110,13 +112,14 @@ module Irc end end +end class String - # Returns an Irc::Auth::Comand from the receiver + # Returns an Irc::Bot::Auth::Comand from the receiver def to_irc_auth_command - Irc::Auth::Command.new(self) + Irc::Bot::Auth::Command.new(self) end end @@ -124,15 +127,16 @@ end class Symbol - # Returns an Irc::Auth::Comand from the receiver + # Returns an Irc::Bot::Auth::Comand from the receiver def to_irc_auth_command - Irc::Auth::Command.new(self) + Irc::Bot::Auth::Command.new(self) end end module Irc +class Bot module Auth @@ -233,11 +237,19 @@ module Irc attr_reader :password attr_reader :netmasks attr_reader :perm - attr_reader :data attr_writer :login_by_mask - attr_writer :autologin attr_writer :transient + def autologin=(vnew) + vold = @autologin + @autologin = vnew + if vold && !vnew + @netmasks.each { |n| Auth.manager.maskdb.remove(self, n) } + elsif vnew && !vold + @netmasks.each { |n| Auth.manager.maskdb.add(self, n) } + end + end + # Checks if the BotUser is transient def transient? @transient @@ -245,7 +257,7 @@ module Irc # Checks if the BotUser is permanent (not transient) def permanent? - !@permanent + !@transient end # Sets if the BotUser is permanent or not @@ -253,6 +265,19 @@ module Irc @transient=!bool end + # Make the BotUser permanent + def make_permanent(name) + raise TypError, "permanent already" if permanent? + @username = BotUser.sanitize_username(name) + @transient = false + reset_autologin + reset_password # or not? + @netmasks.dup.each do |m| + delete_netmask(m) + add_netmask(m.generalize) + end + end + # Create a new BotUser with given username def initialize(username, options={}) opts = {:transient => false}.merge(options) @@ -289,9 +314,6 @@ module Irc raise "must provide a usable mask for transient BotUser #{@username}" if @transient and @netmasks.empty? @perm = {} - - # @data = AuthNotifyingHash.new - @data = {} end # Inspection @@ -304,11 +326,6 @@ module Irc str << " @perm=#{@perm.inspect}" str << " @login_by_mask=#{@login_by_mask}" str << " @autologin=#{@autologin}" - if @data.empty? - str << " no data" - else - str << " data for #{@data.keys.join(', ')}" - end str << ">" end @@ -326,7 +343,6 @@ module Irc :perm => @perm, :login_by_mask => @login_by_mask, :autologin => @autologin, - :data => @data } end @@ -339,13 +355,13 @@ module Irc # Reset the login-by-mask option # def reset_login_by_mask - @login_by_mask = Auth.authmanager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask) + @login_by_mask = Auth.manager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask) end # Reset the autologin option # def reset_autologin - @autologin = Auth.authmanager.bot.config['auth.autologin'] unless defined?(@autologin) + @autologin = Auth.manager.bot.config['auth.autologin'] unless defined?(@autologin) end # Do we allow automatic logging in? @@ -358,11 +374,13 @@ module Irc def from_hash(h) @username = h[:username] if h.has_key?(:username) @password = h[:password] if h.has_key?(:password) - @netmasks = h[:netmasks] if h.has_key?(:netmasks) - @perm = h[:perm] if h.has_key?(:perm) @login_by_mask = h[:login_by_mask] if h.has_key?(:login_by_mask) @autologin = h[:autologin] if h.has_key?(:autologin) - @data.replace(h[:data]) if h.has_key?(:data) + if h.has_key?(:netmasks) + @netmasks = h[:netmasks] + @netmasks.each { |n| Auth.manager.maskdb.add(self, n) } if @autologin + end + @perm = h[:perm] if h.has_key?(:perm) end # This method sets the password if the proposed new password @@ -422,7 +440,12 @@ module Irc # Adds a Netmask # def add_netmask(mask) - @netmasks << mask.to_irc_netmask + m = mask.to_irc_netmask + @netmasks << m + if self.autologin? + Auth.manager.maskdb.add(self, m) + Auth.manager.logout_transients(m) if self.permanent? + end end # Removes a Netmask @@ -430,26 +453,14 @@ module Irc def delete_netmask(mask) m = mask.to_irc_netmask @netmasks.delete(m) - end - - # Removes all Netmasks - # - def reset_netmasks - @netmasks = NetmaskList.new + Auth.manager.maskdb.remove(self, m) if self.autologin? end # This method checks if BotUser has a Netmask that matches _user_ # def knows?(usr) user = usr.to_irc_user - known = false - @netmasks.each { |n| - if user.matches?(n) - known = true - break - end - } - return known + !!@netmasks.find { |n| user.matches? n } end # This method gets called when User _user_ wants to log in. @@ -545,12 +556,6 @@ module Irc return true end - # Resets the NetmaskList - def reset_netmasks - super - add_netmask("*!*@*") - end - # DefaultBotUser will check the default_perm after checking # the global ones # or on all channels if _chan_ is nil @@ -596,13 +601,27 @@ module Irc end - # This is the AuthManagerClass singleton, used to manage User/BotUser connections and - # everything + class BotUser + # Check if the current BotUser is the default one + def default? + return DefaultBotUserClass === self + end + + # Check if the current BotUser is the owner + def owner? + return BotOwnerClass === self + end + end + + + # This is the ManagerClass singleton, used to manage + # Irc::User/Irc::Bot::Auth::BotUser connections and everything # - class AuthManagerClass + class ManagerClass include Singleton + attr_reader :maskdb attr_reader :everyone attr_reader :botowner attr_reader :bot @@ -644,11 +663,11 @@ module Irc # resets the hashes def reset_hashes @botusers = Hash.new + @maskdb = NetmaskDb.new @allbotusers = Hash.new - [everyone, botowner].each { |x| + [everyone, botowner].each do |x| @allbotusers[x.username.to_sym] = x - } - @transients = Set.new + end end def load_array(ary, forced) @@ -735,33 +754,80 @@ module Irc ircuser = user.to_irc_user debug "Trying to autologin #{ircuser}" return @botusers[ircuser] if @botusers.has_key?(ircuser) - @allbotusers.each { |n, bu| - debug "Checking with #{n}" - return bu if bu.autologin? and login(ircuser, n) - } - # Check with transient users - @transients.each { |bu| - return bu if bu.login(ircuser) - } + bu = maskdb.find(ircuser) + if bu + debug "trying #{bu}" + bu.login(ircuser) or raise '...what?!' + @botusers[ircuser] = bu + return bu + end # Finally, create a transient if we're set to allow it if @bot.config['auth.autouser'] bu = create_transient_botuser(ircuser) + @botusers[ircuser] = bu return bu end return everyone end # Creates a new transient BotUser associated with Irc::User _user_, - # automatically logging him in + # automatically logging him in. Note that transient botuser creation can + # fail, typically if we don't have the complete user netmask (e.g. for + # messages coming in from a linkbot) # def create_transient_botuser(user) ircuser = user.to_irc_user - bu = BotUser.new(ircuser, :transient => true, :masks => ircuser) - bu.login(ircuser) - @transients << bu + bu = everyone + begin + bu = BotUser.new(ircuser, :transient => true, :masks => ircuser) + bu.login(ircuser) + rescue + warning "failed to create transient for #{user}" + error $! + end return bu end + # Logs out any Irc::User matching Irc::Netmask _m_ and logged in + # to a transient BotUser + # + def logout_transients(m) + debug "to check: #{@botusers.keys.join ' '}" + @botusers.keys.each do |iu| + debug "checking #{iu.fullform} against #{m.fullform}" + bu = @botusers[iu] + bu.transient? or next + iu.matches?(m) or next + @botusers.delete(iu).autologin = false + end + end + + # Makes transient BotUser _user_ into a permanent BotUser + # named _name_; if _user_ is an Irc::User, act on the transient + # BotUser (if any) it's logged in as + # + def make_permanent(user, name) + # TODO merge BotUser instead? + raise "there's already a BotUser called #{name}" if include?(name) + + tuser = nil + case user + when String, Irc::User + tuser = irc_to_botuser(user) + when BotUser + tuser = user + else + raise TypeError, "sorry, don't know how to make #{user.class} into a permanent BotUser" + end + return nil unless tuser + raise TypeError, "#{tuser} is not transient" unless tuser.transient? + + tuser.make_permanent(name) + @allbotusers[tuser.username.to_sym] = tuser + + return tuser + end + # Checks if User _user_ can do _cmd_ on _chan_. # # Permission are checked in this order, until a true or false @@ -821,13 +887,14 @@ module Irc end - # Returns the only instance of AuthManagerClass + # Returns the only instance of ManagerClass # - def Auth.authmanager - return AuthManagerClass.instance + def Auth.manager + return ManagerClass.instance end end +end class User @@ -835,14 +902,7 @@ module Irc # associated with the receiver # def botuser - Irc::Auth.authmanager.irc_to_botuser(self) - end - - # The botuser is used to store data associated with the - # given Irc::User - # - def data - self.botuser.data + Irc::Bot::Auth.manager.irc_to_botuser(self) end end