4 # :title: rbot user data management from IRC
6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
7 # Copyright:: (C) 2006,2007 Giuseppe Bilotta
12 # Retrive Bot data associated with the receiver. This method is
13 # intended for data retrieval only. See #set_bot_data() if you
14 # need to alter User data.
17 Irc::Utils.bot.plugins['userdata'].get_data(self,key)
19 alias :get_botdata :botdata
21 # This method is used to store Bot data associated with the
22 # receiver. If no block is passed, _value_ is stored for the key
23 # _key_; if a block is passed, it will be called with the previous
24 # _key_ value as parameter, and its return value will be stored as
25 # the new value. If _value_ is present in the block form, it will
26 # be used to initialize _key_ if it's missing.
28 # If you have to do large-scale editing of the Bot data Hash,
29 # please use with_botdata.
31 def set_botdata(key, value=nil, &block)
32 Irc::Utils.bot.plugins['userdata'].set_data(self, key, value, &block)
35 # This method yields the entire Bot data Hash to the block,
36 # and stores any changes done to it, returning a copy
37 # of the (changed) Hash.
39 def with_botdata(&block)
40 Irc::Utils.bot.plugins['userdata'].with_data(self, &block)
46 # User data is stored in registries indexed by BotUser
47 # name and Irc::User nick. This core module takes care
48 # of handling its usage.
50 class UserDataModule < CoreBotModule
54 @ircuser = @registry.sub_registry('ircuser')
55 @botuser = @registry.sub_registry('botuser')
58 def get_data_hash(user)
62 ih = @ircuser[iu.nick] || {}
64 if bu.transient? or bu.default?
67 bh = @botuser[bu.username] || {}
72 def get_data(user, key=nil)
73 h = get_data_hash(user)
79 def set_data_hash(user, h)
83 if bu.transient? or bu.default?
86 @botuser[bu.username] = h
90 def set_data(user, key, value=nil, &block)
91 h = get_data_hash(user)
99 if value and not h.has_key?(key)
106 set_data_hash(user, h)
111 def with_data(user, &block)
112 h = get_data_hash(user)
116 set_data_hash(user, h)
121 def handle_get(m, params)
122 user = m.server.get_user(params[:nick]) || m.source
123 key = params[:key].intern
124 data = get_data(user, key)
126 m.reply (_("%{key} data for %{user}: %{data}") % {
132 m.reply (_("sorry, no %{key} data for %{user}") % {
139 ### TODO FIXME not yet: are we going to allow non-string
140 ### values for data? if so, this can't work ...
142 # def handle_set(m, params)
143 # user = m.server.get_user(params[:nick]) || m.source
144 # key = params[:key].intern
145 # data = params[:data].to_s
150 plugin = UserDataModule.new
152 plugin.map "get [:nick's] :key [data]", :action => 'handle_get'
153 plugin.map "get :key [data] [for :nick]", :action => 'handle_get'
154 plugin.map "get :key [data] [of :nick]", :action => 'handle_get'
156 # plugin.map "set [:nick's] :key [data] to :data", :action => handle_get
157 # plugin.map "set :key [data] [for :nick] to :data", :action => handle_get
158 # plugin.map "set :key [data] [of :nick] to :data", :action => handle_get