lib/rbot/core/userdata.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: rbot user data management from IRC
   5 #
   6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   7 # Copyright:: (C) 2006,2007 Giuseppe Bilotta
   8 # License:: GPL v2
   9
  10 module ::Irc
  11   class User
  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.
  15     #
  16     def botdata(key=nil)
  17       Irc::Utils.bot.plugins['userdata'].get_data(self,key)
  18     end
  19     alias :get_botdata :botdata
  20
  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.
  27     #
  28     # If you have to do large-scale editing of the Bot data Hash,
  29     # please use with_botdata.
  30     #
  31     def set_botdata(key, value=nil, &block)
  32       Irc::Utils.bot.plugins['userdata'].set_data(self, key, value, &block)
  33     end
  34
  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.
  38     #
  39     def with_botdata(&block)
  40       Irc::Utils.bot.plugins['userdata'].with_data(self, &block)
  41     end
  42
  43   end
  44 end
  45
  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.
  49 #
  50 class UserDataModule < CoreBotModule
  51
  52   def initialize
  53     super
  54     @ircuser = @registry.sub_registry('ircuser')
  55     @botuser = @registry.sub_registry('botuser')
  56   end
  57
  58   def get_data_hash(user)
  59     iu = user.to_irc_user
  60     bu = iu.botuser
  61
  62     ih = @ircuser[iu.nick] || {}
  63
  64     if bu.transient? or bu.default?
  65       return ih
  66     else
  67       bh = @botuser[bu.username] || {}
  68       return ih.merge! bh
  69     end
  70   end
  71
  72   def get_data(user, key=nil)
  73     h = get_data_hash(user)
  74     debug h
  75     return h if key.nil?
  76     return h[key]
  77   end
  78
  79   def set_data_hash(user, h)
  80     iu = user.to_irc_user
  81     bu = iu.botuser
  82
  83     @ircuser[iu.nick] = h
  84     unless bu.transient? or bu.default?
  85       @botuser[bu.username] = h
  86     end
  87   end
  88
  89   def set_data(user, key, value=nil, &block)
  90     h = get_data_hash(user)
  91     debug h
  92
  93     ret = value
  94
  95     if not block_given?
  96       h[key] = value
  97     else
  98       if value and not h.has_key?(key)
  99         h[key] = value
 100       end
 101       ret = yield h[key]
 102     end
 103     debug ret
 104
 105     set_data_hash(user, h)
 106
 107     return ret
 108   end
 109
 110   def with_data(user, &block)
 111     h = get_data_hash(user)
 112     debug h
 113     yield h
 114
 115     set_data_hash(user, h)
 116
 117     return h
 118   end
 119
 120   def handle_get(m, params)
 121     user = m.server.get_user(params[:nick]) || m.source
 122     key = params[:key].intern
 123     data = get_data(user, key)
 124     if data
 125       m.reply (_("%{key} data for %{user}: %{data}") % {
 126         :key => key,
 127         :user => user.nick,
 128         :data => data
 129       })
 130     else
 131       m.reply (_("sorry, no %{key} data for %{user}") % {
 132         :key => key,
 133         :user => user.nick,
 134       })
 135     end
 136   end
 137
 138   ### TODO FIXME not yet: are we going to allow non-string
 139   ### values for data? if so, this can't work ...
 140   #
 141   # def handle_set(m, params)
 142   #   user = m.server.get_user(params[:nick]) || m.source
 143   #   key = params[:key].intern
 144   #   data = params[:data].to_s
 145   # end
 146
 147 end
 148
 149 plugin = UserDataModule.new
 150
 151 plugin.map "get [:nick's] :key [data]",   :action => 'handle_get'
 152 plugin.map "get :key [data] [for :nick]", :action => 'handle_get'
 153 plugin.map "get :key [data] [of :nick]",  :action => 'handle_get'
 154
 155 # plugin.map "set [:nick's] :key [data] to :data", :action => handle_get
 156 # plugin.map "set :key [data] [for :nick] to :data", :action => handle_get
 157 # plugin.map "set :key [data] [of :nick] to :data", :action => handle_get