Google

"DTD/xhtml1-strict.dtd">
Class Irc::IrcAuth
In: rbot/auth.rb
Parent: Object
Class: JoinMessage Class: PartMessage Class: Plugins Class: KickMessage Class: IrcAuth Class: IRCChannel Class: IrcSocket Class: BotConfig Class: Keywords Class: BotRegistryAccessor Class: IrcClient Class: DBHash Class: Language Class: TopicMessage Class: QuitMessage Class: PrivMessage Class: UserMessage Class: NoticeMessage Class: IrcBot Class: BasicUserMessage Class: NickMessage Class: Plugin Class: BotRegistry Class: Keyword Class: DBTree Module: Irc

User-level authentication to allow/disallow access to bot commands based on hostmask and userlevel.

Methods
allow?    help    new    privmsg    save    setlevel    showlevels    showusers    useradd    userdel    userlevel   
Public Class methods
new(bot)

create a new IrcAuth instance.

bot:associated bot class
Public Instance methods
save()

save current users and levels to files. levels are written to #{botclass}/levels.rbot users are written to #{botclass}/users.rbot

allow?(command, mask, tell=nil)
command:command user wishes to perform
mask:hostmask of user
tell:optional recipient for "insufficient auth" message

returns true if user with hostmask mask is permitted to perform command optionally pass tell as the target for the "insufficient auth" message, if the user is not authorised

useradd(mask, level)

add user with hostmask matching mask with initial auth level level

userdel(mask)
mask:mask of user to remove

remove user with mask mask

setlevel(command, level)
command:command to adjust
level:new auth level for the command

set required auth level of command to level

userlevel(mask)

specific users.

mask:mask of user

returns the authlevel of user with mask mask finds the matching user which has the highest authlevel (so you can have a default level of 5 for *!*@*, and yet still give higher levels to

showlevels()

return all currently defined commands (for which auth is required) and their required authlevels

showusers()

return all currently defined users and their authlevels

help(topic="")

module help

privmsg(m)

privmsg handler