# License:: GPLv2\r
\r
require 'singleton'\r
+require 'set'\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
:on_change => Proc.new {|bot, v| bot.auth.botowner.password = v},\r
:desc => _('Password for the bot owner'))\r
- BotConfig.register BotConfigBooleanValue.new( 'auth.login_by_mask',\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
+ 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
+ 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
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
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 :password\r
attr_reader :netmasks\r
attr_reader :perm\r
+ # Please remember to #set_changed() the Auth.manager\r
+ # when modifying data\r
+ attr_reader :data\r
attr_writer :login_by_mask\r
attr_writer :autologin\r
+ attr_writer :transient\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
+ !@permanent\r
+ end\r
+\r
+ # Sets if the BotUser is permanent or not\r
+ def permanent=(bool)\r
+ @transient=!bool\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
+\r
+ # @data = AuthNotifyingHash.new\r
+ @data = {}\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
str << " @login_by_mask=#{@login_by_mask}"\r
str << " @autologin=#{@autologin}"\r
+ if @data.empty?\r
+ str << " no data"\r
+ else\r
+ str << " data for #{@data.keys.join(', ')}"\r
+ end\r
str << ">"\r
end\r
\r
:netmasks => @netmasks,\r
:perm => @perm,\r
:login_by_mask => @login_by_mask,\r
- :autologin => @autologin\r
+ :autologin => @autologin,\r
+ :data => @data\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
@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
+ @data.replace(h[:data]) if h.has_key?(:data)\r
end\r
\r
# This method sets the password if the proposed new password\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
end\r
\r
\r
- # This is the AuthManagerClass singleton, used to manage User/BotUser connections and\r
- # everything\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
[everyone, botowner].each { |x|\r
@allbotusers[x.username.to_sym] = x\r
}\r
+ @transients = Set.new\r
end\r
\r
def load_array(ary, forced)\r
unless ary\r
- warn "Tried to load an empty array"\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
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
+ # Check with transient users\r
+ @transients.each { |bu|\r
+ return bu if bu.login(ircuser)\r
+ }\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
+ 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
+ @transients << bu\r
+ rescue\r
+ warning "failed to create transient for #{user}"\r
+ error $!\r
+ end\r
+ return bu\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
\r
end\r
\r
- # Returns the only instance of AuthManagerClass\r
+ # Returns the only instance of ManagerClass\r
+ #\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
+\r
+ # Bot-specific data can be stored with Irc::Users. This is\r
+ # internally obtained by storing data to the associated BotUser,\r
+ # but this is a detail plugin writers shouldn't care about.\r
+ # bot_data(:key) can be used to retrieve a particular data set.\r
+ # This method is intended for data retrieval, and if the retrieved\r
+ # data is modified directly there is no guarantee the changes will\r
+ # be saved back. Use #set_bot_data() for that.\r
#\r
- def Auth.authmanager\r
- return AuthManagerClass.instance\r
+ def bot_data(key=nil)\r
+ return self.botuser.data if key.nil?\r
+ return self.botuser.data[key]\r
end\r
\r
+ # This method is used to store bot-specific data for the receiver.\r
+ # If no block is passed, _value_ is stored for the key _key_;\r
+ # if a block is passed, it will be called with the previous\r
+ # _key_ value as parameter, and its return value will be stored\r
+ # as the new value. If _value_ is present in the block form, it\r
+ # will be used to initialize _key_ if it's missing\r
+ # \r
+ def set_bot_data(key,value=nil,&block)\r
+ if not block_given?\r
+ self.botuser.data[key]=value\r
+ Irc::Bot::Auth.manager.set_changed\r
+ return value\r
+ end\r
+ if value and not bot_data.has_key?(key)\r
+ set_bot_data(key, value)\r
+ end\r
+ r = value\r
+ begin\r
+ r = yield bot_data(key)\r
+ ensure\r
+ Irc::Bot::Auth.manager.set_changed\r
+ end\r
+ return r\r
+ end\r
end\r
\r
end\r
projects / user / henk / code / ruby / rbot.git / blobdiff