# License:: GPLv2\r
\r
require 'singleton'\r
+require 'set'\r
+require 'rbot/maskdb'\r
\r
+# This would be a good idea if it was failproof, but the truth\r
+# is that other methods can indirectly modify the hash. *sigh*\r
+#\r
+# class AuthNotifyingHash < Hash\r
+# %w(clear default= delete delete_if replace invert\r
+# merge! update rehash reject! replace shift []= store).each { |m|\r
+# class_eval {\r
+# define_method(m) { |*a|\r
+# r = super(*a)\r
+# Irc::Bot::Auth.manager.set_changed\r
+# r\r
+# }\r
+# }\r
+# }\r
+# end\r
+# \r
\r
module Irc\r
+class Bot\r
\r
\r
# This module contains the actual Authentication stuff\r
#\r
module Auth\r
\r
- BotConfig.register BotConfigStringValue.new( 'auth.password',\r
+ Config.register Config::StringValue.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
+ :on_change => Proc.new {|bot, v| bot.auth.botowner.password = v},\r
+ :desc => _('Password for the bot owner'))\r
+ Config.register Config::BooleanValue.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
+ :desc => _('Set false to prevent new botusers from logging in without a password when the user netmask is known'))\r
+ Config.register Config::BooleanValue.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
+ :desc => _('Set false to prevent new botusers from recognizing IRC users without a need to manually login'))\r
+ Config.register Config::BooleanValue.new( 'auth.autouser',\r
+ :default => 'false',\r
+ :desc => _('Set true to allow new botusers to be created automatically'))\r
+ # Config.register Config::IntegerValue.new( 'auth.default_level',\r
# :default => 10, :wizard => true,\r
# :desc => 'The default level for new/unknown users' )\r
\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
+ l.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
+ # An Irc::Bot::Auth::Command defines a command by its "path":\r
#\r
# base::command::subcommand::subsubcommand::subsubsubcommand\r
#\r
k.to_sym\r
}\r
@command = path.last\r
- debug "Created command #{@command.inspect} with path #{@path.join(', ')}"\r
+ debug "Created command #{@command.inspect} with path #{@path.pretty_inspect}"\r
end\r
\r
# Returs self\r
end\r
\r
end\r
+end\r
\r
\r
class String\r
\r
- # Returns an Irc::Auth::Comand from the receiver\r
+ # Returns an Irc::Bot::Auth::Comand from the receiver\r
def to_irc_auth_command\r
- Irc::Auth::Command.new(self)\r
+ Irc::Bot::Auth::Command.new(self)\r
end\r
\r
end\r
\r
class Symbol\r
\r
- # Returns an Irc::Auth::Comand from the receiver\r
+ # Returns an Irc::Bot::Auth::Comand from the receiver\r
def to_irc_auth_command\r
- Irc::Auth::Command.new(self)\r
+ Irc::Bot::Auth::Command.new(self)\r
end\r
\r
end\r
\r
\r
module Irc\r
+class Bot\r
\r
\r
module Auth\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
+ # This is the basic class for bot users: they have a username, a\r
+ # password, a list of netmasks to match against, and a list of\r
+ # permissions. A BotUser can be marked as 'transient', usually meaning\r
+ # it's not intended for permanent storage. Transient BotUsers have lower\r
+ # priority than nontransient ones for autologin purposes.\r
+ #\r
+ # To initialize a BotUser, you pass a _username_ and an optional\r
+ # hash of options. Currently, only two options are recognized:\r
+ #\r
+ # transient:: true or false, determines if the BotUser is transient or\r
+ # permanent (default is false, permanent BotUser).\r
+ #\r
+ # Transient BotUsers are initialized by prepending an\r
+ # asterisk (*) to the username, and appending a sanitized\r
+ # version of the object_id. The username can be empty.\r
+ # A random password is generated.\r
+ #\r
+ # Permanent Botusers need the username as is, and no\r
+ # password is generated.\r
+ #\r
+ # masks:: an array of Netmasks to initialize the NetmaskList. This\r
+ # list is used as-is for permanent BotUsers.\r
+ #\r
+ # Transient BotUsers will alter the list elements which are\r
+ # Irc::User by globbing the nick and any initial nonletter\r
+ # part of the ident.\r
+ #\r
+ # The masks option is optional for permanent BotUsers, but\r
+ # obligatory (non-empty) for transients.\r
#\r
class BotUser\r
\r
attr_reader :netmasks\r
attr_reader :perm\r
attr_writer :login_by_mask\r
- attr_writer :autologin\r
+ attr_writer :transient\r
+\r
+ def autologin=(vnew)\r
+ vold = @autologin\r
+ @autologin = vnew\r
+ if vold && !vnew\r
+ @netmasks.each { |n| Auth.manager.maskdb.remove(self, n) }\r
+ elsif vnew && !vold\r
+ @netmasks.each { |n| Auth.manager.maskdb.add(self, n) }\r
+ end\r
+ end\r
+\r
+ # Checks if the BotUser is transient\r
+ def transient?\r
+ @transient\r
+ end\r
+\r
+ # Checks if the BotUser is permanent (not transient)\r
+ def permanent?\r
+ !@transient\r
+ end\r
+\r
+ # Sets if the BotUser is permanent or not\r
+ def permanent=(bool)\r
+ @transient=!bool\r
+ end\r
+\r
+ # Make the BotUser permanent\r
+ def make_permanent(name)\r
+ raise TypError, "permanent already" if permanent?\r
+ @username = BotUser.sanitize_username(name)\r
+ @transient = false\r
+ reset_autologin\r
+ reset_password # or not?\r
+ @netmasks.dup.each do |m|\r
+ delete_netmask(m)\r
+ add_netmask(m.generalize)\r
+ end\r
+ end\r
\r
# Create a new BotUser with given username\r
- def initialize(username)\r
- @username = BotUser.sanitize_username(username)\r
- @password = nil\r
+ def initialize(username, options={})\r
+ opts = {:transient => false}.merge(options)\r
+ @transient = opts[:transient]\r
+\r
+ if @transient\r
+ @username = "*"\r
+ @username << BotUser.sanitize_username(username) if username and not username.to_s.empty?\r
+ @username << BotUser.sanitize_username(object_id)\r
+ reset_password\r
+ @login_by_mask=true\r
+ @autologin=true\r
+ else\r
+ @username = BotUser.sanitize_username(username)\r
+ @password = nil\r
+ reset_login_by_mask\r
+ reset_autologin\r
+ end\r
+\r
@netmasks = NetmaskList.new\r
+ if opts.key?(:masks) and opts[:masks]\r
+ masks = opts[:masks]\r
+ masks = [masks] unless masks.respond_to?(:each)\r
+ masks.each { |m|\r
+ mask = m.to_irc_netmask\r
+ if @transient and User === m\r
+ mask.nick = "*"\r
+ mask.host = m.host.dup\r
+ mask.user = "*" + m.user.sub(/^\w?[^\w]+/,'')\r
+ end\r
+ add_netmask(mask) unless mask.to_s == "*"\r
+ }\r
+ end\r
+ raise "must provide a usable mask for transient BotUser #{@username}" if @transient and @netmasks.empty?\r
+\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 = "<#{self.class}:#{'0x%08x' % self.object_id}"\r
+ str << " (transient)" if @transient\r
+ str << ":"\r
str << " @username=#{@username.inspect}"\r
str << " @netmasks=#{@netmasks.inspect}"\r
str << " @perm=#{@perm.inspect}"\r
:netmasks => @netmasks,\r
:perm => @perm,\r
:login_by_mask => @login_by_mask,\r
- :autologin => @autologin\r
+ :autologin => @autologin,\r
}\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
+ @login_by_mask = Auth.manager.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
+ @autologin = Auth.manager.bot.config['auth.autologin'] unless defined?(@autologin)\r
end\r
\r
# Do we allow automatic logging in?\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
+ if h.has_key?(:netmasks)\r
+ @netmasks = h[:netmasks]\r
+ @netmasks.each { |n| Auth.manager.maskdb.add(self, n) } if @autologin\r
+ end\r
+ @perm = h[:perm] if h.has_key?(:perm)\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
+ pass = pwd.to_s\r
+ if pass.empty?\r
+ reset_password\r
+ else\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
+ raise InvalidPassword, "#{pass} contains invalid characters" if pass !~ /^[\x21-\x7e]+$/\r
+ raise InvalidPassword, "#{pass} too short" if pass.length < 4\r
+ @password = pass\r
rescue InvalidPassword => e\r
raise e\r
rescue => e\r
- raise InvalidPassword, "Exception #{e.inspect} while checking #{pwd}"\r
+ raise InvalidPassword, "Exception #{e.inspect} while checking #{pass.inspect} (#{pwd.inspect})"\r
end\r
- else\r
- reset_password\r
end\r
end\r
\r
# Adds a Netmask\r
#\r
def add_netmask(mask)\r
- @netmasks << mask.to_irc_netmask\r
+ m = mask.to_irc_netmask\r
+ @netmasks << m\r
+ if self.autologin?\r
+ Auth.manager.maskdb.add(self, m)\r
+ Auth.manager.logout_transients(m) if self.permanent?\r
+ end\r
end\r
\r
# Removes a Netmask\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
+ Auth.manager.maskdb.remove(self, m) if self.autologin?\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
+ !!@netmasks.find { |n| user.matches? n }\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
+ def login(user, password=nil)\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
\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
#\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
+ debug "Default permissions now: #{@default_perm.pretty_inspect}"\r
end\r
\r
# default knows everybody\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
end\r
\r
\r
- # This is the AuthManagerClass singleton, used to manage User/BotUser connections and\r
- # everything\r
+ class BotUser\r
+ # Check if the current BotUser is the default one\r
+ def default?\r
+ return DefaultBotUserClass === self\r
+ end\r
+\r
+ # Check if the current BotUser is the owner\r
+ def owner?\r
+ return BotOwnerClass === self\r
+ end\r
+ end\r
+\r
+\r
+ # This is the ManagerClass singleton, used to manage\r
+ # Irc::User/Irc::Bot::Auth::BotUser connections and everything\r
#\r
- class AuthManagerClass\r
+ class ManagerClass\r
\r
include Singleton\r
\r
+ attr_reader :maskdb\r
attr_reader :everyone\r
attr_reader :botowner\r
attr_reader :bot\r
# resets the hashes\r
def reset_hashes\r
@botusers = Hash.new\r
+ @maskdb = NetmaskDb.new\r
@allbotusers = Hash.new\r
- [everyone, botowner].each { |x|\r
+ [everyone, botowner].each do |x|\r
@allbotusers[x.username.to_sym] = x\r
- }\r
+ end\r
end\r
\r
def load_array(ary, forced)\r
+ unless ary\r
+ warning "Tried to load an empty array"\r
+ return\r
+ end\r
raise "Won't load with unsaved changes" if @has_changes and not forced\r
reset_hashes\r
ary.each { |x|\r
create_botuser(u)\r
end\r
get_botuser(u).from_hash(x)\r
+ get_botuser(u).transient = false\r
}\r
@has_changes=false\r
end\r
\r
def save_array\r
@allbotusers.values.map { |x|\r
- x.to_hash\r
- }\r
+ x.transient? ? nil : x.to_hash\r
+ }.compact\r
end\r
\r
# checks if we know about a certain BotUser username\r
#\r
def autologin(user)\r
ircuser = user.to_irc_user\r
- debug "Trying to autlogin #{ircuser}"\r
+ debug "Trying to autologin #{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
+ bu = maskdb.find(ircuser)\r
+ if bu\r
+ debug "trying #{bu}"\r
+ bu.login(ircuser) or raise '...what?!'\r
+ @botusers[ircuser] = bu\r
+ return bu\r
+ end\r
+ # Finally, create a transient if we're set to allow it\r
+ if @bot.config['auth.autouser']\r
+ bu = create_transient_botuser(ircuser)\r
+ @botusers[ircuser] = bu\r
+ return bu\r
+ end\r
return everyone\r
end\r
\r
+ # Creates a new transient BotUser associated with Irc::User _user_,\r
+ # automatically logging him in. Note that transient botuser creation can\r
+ # fail, typically if we don't have the complete user netmask (e.g. for\r
+ # messages coming in from a linkbot)\r
+ #\r
+ def create_transient_botuser(user)\r
+ ircuser = user.to_irc_user\r
+ bu = everyone\r
+ begin\r
+ bu = BotUser.new(ircuser, :transient => true, :masks => ircuser)\r
+ bu.login(ircuser)\r
+ rescue\r
+ warning "failed to create transient for #{user}"\r
+ error $!\r
+ end\r
+ return bu\r
+ end\r
+\r
+ # Logs out any Irc::User matching Irc::Netmask _m_ and logged in\r
+ # to a transient BotUser\r
+ #\r
+ def logout_transients(m)\r
+ debug "to check: #{@botusers.keys.join ' '}"\r
+ @botusers.keys.each do |iu|\r
+ debug "checking #{iu.fullform} against #{m.fullform}"\r
+ bu = @botusers[iu]\r
+ bu.transient? or next\r
+ iu.matches?(m) or next\r
+ @botusers.delete(iu).autologin = false\r
+ end\r
+ end\r
+\r
+ # Makes transient BotUser _user_ into a permanent BotUser\r
+ # named _name_; if _user_ is an Irc::User, act on the transient\r
+ # BotUser (if any) it's logged in as\r
+ #\r
+ def make_permanent(user, name)\r
+ # TODO merge BotUser instead?\r
+ raise "there's already a BotUser called #{name}" if include?(name)\r
+\r
+ tuser = nil\r
+ case user\r
+ when String, Irc::User\r
+ tuser = irc_to_botuser(user)\r
+ when BotUser\r
+ tuser = user\r
+ else\r
+ raise TypeError, "sorry, don't know how to make #{user.class} into a permanent BotUser"\r
+ end\r
+ return nil unless tuser\r
+ raise TypeError, "#{tuser} is not transient" unless tuser.transient?\r
+\r
+ tuser.make_permanent(name)\r
+ @allbotusers[tuser.username.to_sym] = tuser\r
+\r
+ return tuser\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
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
+ @bot.say chan, _("%{user}, you don't have '%{command}' permissions here") %\r
+ {:user=>user, :command=>cmdtxt} if chan\r
return false\r
end\r
end\r
\r
end\r
\r
- # Returns the only instance of AuthManagerClass\r
+ # Returns the only instance of ManagerClass\r
#\r
- def Auth.authmanager\r
- return AuthManagerClass.instance\r
+ def Auth.manager\r
+ return ManagerClass.instance\r
end\r
\r
end\r
+end\r
+\r
+ class User\r
+\r
+ # A convenience method to automatically found the botuser\r
+ # associated with the receiver\r
+ #\r
+ def botuser\r
+ Irc::Bot::Auth.manager.irc_to_botuser(self)\r
+ end\r
+ end\r
\r
end\r
projects / user / henk / code / ruby / rbot.git / blobdiff