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     @transient = @registry.sub_registry('transient')
  56     @botuser = @registry.sub_registry('botuser')
  57   end
  58
  59   def get_data_hash(user)
  60     iu = user.to_irc_user
  61     bu = iu.botuser
  62
  63     ih = @ircuser[iu.nick] || {}
  64
  65     if bu.default?
  66       return ih
  67     elsif bu.transient?
  68       bh = @transient[bu.netmasks.first.fullform] || {}
  69     else
  70       bh = @botuser[bu.username] || {}
  71     end
  72     ih.merge!(bh)
  73
  74     class << ih
  75       alias :single_retrieve :[]
  76       alias :single_assign :[]=
  77       include DottedIndex
  78     end
  79
  80     return ih
  81   end
  82
  83   def get_data(user, key=nil)
  84     h = get_data_hash(user)
  85     debug h
  86     return h if key.nil?
  87     return h[key]
  88   end
  89
  90   def set_data_hash(user, h)
  91     iu = user.to_irc_user
  92     bu = iu.botuser
  93
  94     @ircuser[iu.nick] = h
  95     return h if bu.default?
  96
  97     if bu.transient?
  98       @transient[bu.netmasks.first.fullform] = h
  99     else
 100       @botuser[bu.username] = h
 101     end
 102     return h
 103   end
 104
 105   def set_data(user, key, value=nil, &block)
 106     h = get_data_hash(user)
 107     debug h
 108
 109     ret = value
 110
 111     if not block_given?
 112       h[key] = value
 113     else
 114       if value and not h.has_key?(key)
 115         h[key] = value
 116       end
 117       ret = yield h[key]
 118     end
 119     debug ret
 120
 121     set_data_hash(user, h)
 122
 123     return ret
 124   end
 125
 126   def with_data(user, &block)
 127     h = get_data_hash(user)
 128     debug h
 129     yield h
 130
 131     set_data_hash(user, h)
 132
 133     return h
 134   end
 135
 136   def handle_get(m, params)
 137     user = m.server.get_user(params[:nick]) || m.source
 138     key = params[:key].intern
 139     data = get_data(user, key)
 140     if data
 141       m.reply(_("%{key} data for %{user}: %{data}") % {
 142         :key => key,
 143         :user => user.nick,
 144         :data => data
 145       })
 146     else
 147       m.reply(_("sorry, no %{key} data for %{user}") % {
 148         :key => key,
 149         :user => user.nick,
 150       })
 151     end
 152   end
 153
 154   ### TODO FIXME not yet: are we going to allow non-string
 155   ### values for data? if so, this can't work ...
 156   #
 157   # def handle_set(m, params)
 158   #   user = m.server.get_user(params[:nick]) || m.source
 159   #   key = params[:key].intern
 160   #   data = params[:data].to_s
 161   # end
 162
 163   def event_botuser(action, opts={})
 164     case action
 165     when :copy, :rename
 166       source = opts[:source]
 167       return unless @botuser.key?(source)
 168       dest = opts[:dest]
 169       @botuser[dest] = @botuser[source].dup
 170       @botuser.delete(source) if action == :rename
 171     when :pre_perm
 172       @permification ||= {}
 173       k = [opts[:irc_user], opts[:bot_user]]
 174       @permification[k] = get_data_hash(opts[:irc_user])
 175     when :post_perm
 176       @permification ||= {}
 177       k = [opts[:irc_user], opts[:bot_user]]
 178       if @permification.has_key?(k)
 179         @botuser[opts[:bot_user]] = @permification[k]
 180         @permification.delete(k)
 181       end
 182     end
 183   end
 184
 185 end
 186
 187 plugin = UserDataModule.new
 188
 189 plugin.map "get [:nick's] :key [data]",   :action => 'handle_get'
 190 plugin.map "get :key [data] [for :nick]", :action => 'handle_get'
 191 plugin.map "get :key [data] [of :nick]",  :action => 'handle_get'
 192
 193 # plugin.map "set [:nick's] :key [data] to :data", :action => handle_get
 194 # plugin.map "set :key [data] [for :nick] to :data", :action => handle_get
 195 # plugin.map "set :key [data] [of :nick] to :data", :action => handle_get