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 :perm\r
attr_writer :login_by_mask\r
attr_writer :autologin\r
- attr_accessor :transient\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, options={})\r
opts = {:transient => false}.merge(options)\r
@transient = opts[:transient]\r
- @username = @transient ? "*" : ""\r
- @username << BotUser.sanitize_username(username)\r
- @password = nil\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
\r
end\r
\r
- # A TransientBotUser is a BotUser that is not intended\r
- # for permanent storage. A TransientBotUser must be\r
- # created with an associated Netmask or User. In the former\r
- # case the Netmask is added to BotUser's known masks, in the\r
- # latter the nick part is gobbled and so are the initial\r
- # nonletter parts of the user.\r
- #\r
- class TransientBotUser < BotUser\r
- def initialize(mask_or_user)\r
- super(object_id, :transient => true)\r
- reset_password\r
- mask = mask_or_user.to_irc_netmask\r
- if User === mask_or_user\r
- mask.nick = "*"\r
- mask.host = mask_or_user.host.dup\r
- mask.user = "*" + mask_or_user.user.sub(/^[^\w]+/,'')\r
- end\r
- add_netmask(mask)\r
- login_by_mask=true\r
- autologin=true\r
- end\r
- end\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 save_array\r
@allbotusers.values.map { |x|\r
- x.transient ? nil : x.to_hash\r
+ x.transient? ? nil : x.to_hash\r
}.compact\r
end\r
\r
#\r
def create_transient_botuser(user)\r
ircuser = user.to_irc_user\r
- bu = TransientBotUser.new(ircuser)\r
+ bu = BotUser.new(ircuser, :transient => true, :masks => ircuser)\r
bu.login(ircuser)\r
@transients << bu\r
return bu\r
projects / user / henk / code / ruby / rbot.git / blobdiff