4 # :title: rbot config management from IRC
6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
8 class ConfigModule < CoreBotModule
11 if $version_timestamp.to_i > 0
12 ago = _(" [%{secs} ago]") % {
13 :secs => Utils.secs_to_string(Time.now.to_i - $version_timestamp.to_i)
18 _("I'm a v. %{version}%{ago} rubybot%{copyright}%{url}") % {
21 :copyright => ", #{Irc::Bot::COPYRIGHT_NOTICE}",
22 :url => " - #{Irc::Bot::SOURCE_URL}"
30 def handle_list(m, params)
33 @bot.config.items.each_key do |key|
34 mod, name = key.to_s.split('.')
35 next unless mod == params[:module]
36 modules.push key unless modules.include?(name)
39 m.reply _("no such module %{module}") % {:module => params[:module]}
41 m.reply modules.join(", ")
44 @bot.config.items.each_key do |key|
45 name = key.to_s.split('.').first
46 modules.push name unless modules.include?(name)
48 m.reply "modules: " + modules.join(", ")
52 def handle_get(m, params)
53 key = params[:key].to_s.intern
54 unless @bot.config.items.has_key?(key)
55 m.reply _("no such config key %{key}") % {:key => key}
58 return if !@bot.auth.allow?(@bot.config.items[key].auth_path, m.source, m.replyto)
59 value = @bot.config.items[key].to_s
60 m.reply "#{key}: #{value}"
63 def handle_desc(m, params)
64 key = params[:key].to_s.intern
65 unless @bot.config.items.has_key?(key)
66 m.reply _("no such config key %{key}") % {:key => key}
68 m.reply "#{key}: #{@bot.config.items[key].desc}"
71 def handle_search(m, params)
72 rx = Regexp.new(params[:rx].to_s, true)
74 @bot.config.items.each do |k, v|
75 cfs << [Bold + k.to_s + Bold, v.desc] if k.to_s.match(rx) or (v.desc.match(rx) rescue false)
78 m.reply _("no config key found matching %{r}") % { :r => params[:rx].to_s}
80 m.reply _("possible keys: %{kl}") % { :kl => cfs.map { |c| c.first}.sort.join(', ') } if cfs.length > 1
81 m.reply cfs.map { |c| c.join(': ') }.join("\n")
85 def handle_unset(m, params)
86 key = params[:key].to_s.intern
87 unless @bot.config.items.has_key?(key)
88 m.reply _("no such config key %{key}") % {:key => key}
90 return if !@bot.auth.allow?(@bot.config.items[key].auth_path, m.source, m.replyto)
91 @bot.config.items[key].unset
93 m.reply _("this config change will take effect on the next restart") if @bot.config.items[key].requires_restart
94 m.reply _("this config change will take effect on the next rescan") if @bot.config.items[key].requires_rescan
97 def handle_set(m, params)
98 key = params[:key].to_s.intern
99 value = params[:value].join(" ")
100 unless @bot.config.items.has_key?(key)
101 m.reply _("no such config key %{key}") % {:key => key} unless params[:silent]
104 return false if !@bot.auth.allow?(@bot.config.items[key].auth_path, m.source, m.replyto)
106 @bot.config.items[key].set_string(value)
107 rescue ArgumentError => e
108 m.reply _("failed to set %{key}: %{error}") % {:key => key, :error => e.message} unless params[:silent]
111 if @bot.config.items[key].requires_restart
112 m.reply _("this config change will take effect on the next restart") unless params[:silent]
114 elsif @bot.config.items[key].requires_rescan
115 m.reply _("this config change will take effect on the next rescan") unless params[:silent]
118 m.okay unless params[:silent]
123 def handle_add(m, params)
124 key = params[:key].to_s.intern
125 value = params[:value]
126 unless @bot.config.items.has_key?(key)
127 m.reply _("no such config key %{key}") % {:key => key}
130 unless @bot.config.items[key].kind_of?(Config::ArrayValue)
131 m.reply _("config key %{key} is not an array") % {:key => key}
134 return if !@bot.auth.allow?(@bot.config.items[key].auth_path, m.source, m.replyto)
136 @bot.config.items[key].add(value)
137 rescue ArgumentError => e
138 m.reply _("failed to add %{value} to %{key}: %{error}") % {:value => value, :key => key, :error => e.message}
141 handle_get(m,{:key => key})
142 m.reply _("this config change will take effect on the next restart") if @bot.config.items[key].requires_restart
143 m.reply _("this config change will take effect on the next rescan") if @bot.config.items[key].requires_rescan
146 def handle_rm(m, params)
147 key = params[:key].to_s.intern
148 value = params[:value]
149 unless @bot.config.items.has_key?(key)
150 m.reply _("no such config key %{key}") % {:key => key}
153 unless @bot.config.items[key].kind_of?(Config::ArrayValue)
154 m.reply _("config key %{key} is not an array") % {:key => key}
157 return if !@bot.auth.allow?(@bot.config.items[key].auth_path, m.source, m.replyto)
159 @bot.config.items[key].rm(value)
160 rescue ArgumentError => e
161 m.reply _("failed to remove %{value} from %{key}: %{error}") % {:value => value, :key => key, :error => e.message}
164 handle_get(m,{:key => key})
165 m.reply _("this config change will take effect on the next restart") if @bot.config.items[key].requires_restart
166 m.reply _("this config change will take effect on the next rescan") if @bot.config.items[key].requires_rescan
169 def bot_save(m, param)
174 def bot_rescan(m, param)
175 m.reply _("saving ...")
177 m.reply _("rescanning ...")
179 m.reply _("done. %{plugin_status}") % {:plugin_status => @bot.plugins.status(true)}
182 def bot_nick(m, param)
183 @bot.nickchg(param[:nick])
184 @bot.wanted_nick = param[:nick]
187 def bot_status(m, param)
191 # TODO is this one of the methods that disappeared when the bot was moved
192 # from the single-file to the multi-file registry?
194 # def bot_reg_stat(m, param)
195 # m.reply @registry.stat.inspect
198 def bot_version(m, param)
199 m.reply version_string
203 who = m.private? ? "me" : m.target
206 m.ctcp_reply version_string
208 m.ctcp_reply Irc::Bot::SOURCE_URL
212 def handle_help(m, params)
213 m.reply help(params[:topic])
216 def help(plugin, topic="")
221 _("config list => list configuration modules, config list <module> => list configuration keys for module <module>")
223 _("config get <key> => get configuration value for key <key>")
225 _("reset key <key> to the default")
227 _("config set <key> <value> => set configuration value for key <key> to <value>")
229 _("config desc <key> => describe what key <key> configures")
231 _("config add <value> to <key> => add value <value> to key <key> if <key> is an array")
233 _("config rm <value> from <key> => remove value <value> from key <key> if <key> is an array")
235 _("config module - bot configuration. usage: list, desc, get, set, unset, add, rm")
237 # "no help for config #{topic}"
240 _("nick <newnick> => change the bot nick to <newnick>, if possible")
242 _("status => display some information on the bot's status")
244 _("save => save current dynamic data and configuration")
246 _("rescan => reload modules and static facts")
248 _("version => describes software version")
250 _("config-related tasks: config, save, rescan, version, nick, status")
256 conf = ConfigModule.new
258 conf.map 'config list :module',
259 :action => 'handle_list',
260 :defaults => {:module => false},
262 # TODO this one is presently a security risk, since the bot
263 # stores the master password in the config. Do we need auth levels
264 # on the Bot::Config keys too?
265 conf.map 'config get :key',
266 :action => 'handle_get',
268 conf.map 'config desc :key',
269 :action => 'handle_desc',
271 conf.map 'config describe :key',
272 :action => 'handle_desc',
273 :auth_path => 'show::desc!'
274 conf.map 'config search *rx',
275 :action => 'handle_search',
279 :action => 'bot_save'
281 :action => 'bot_rescan'
282 conf.map "nick :nick",
283 :action => 'bot_nick'
285 :action => 'bot_status',
286 :auth_path => 'show::status'
289 # conf.map "registry stats",
290 # :action => 'bot_reg_stat',
291 # :auth_path => '!config::status'
293 :action => 'bot_version',
294 :auth_path => 'show::status'
296 conf.map 'config set :key *value',
297 :action => 'handle_set',
299 conf.map 'config add :value to :key',
300 :action => 'handle_add',
302 conf.map 'config rm :value from :key',
303 :action => 'handle_rm',
305 conf.map 'config del :value from :key',
306 :action => 'handle_rm',
308 conf.map 'config delete :value from :key',
309 :action => 'handle_rm',
311 conf.map 'config unset :key',
312 :action => 'handle_unset',
314 conf.map 'config reset :key',
315 :action => 'handle_unset',
318 conf.map 'config help :topic',
319 :action => 'handle_help',
320 :defaults => {:topic => false},
321 :auth_path => '!help!'
323 conf.default_auth('*', false)
324 conf.default_auth('show', true)
325 conf.default_auth('show::get', false)
326 # TODO these shouldn't be set here, we need a way to let the default
327 # permission be specified together with the ConfigValue
328 conf.default_auth('key', true)
329 conf.default_auth('key::auth::password', false)