summaryrefslogtreecommitdiff
path: root/data/rbot/plugins/command.rb
blob: 80ed40190917a58aecae5e77c0b54cae5cc98562 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# Plugin for the Ruby IRC bot (http://linuxbrit.co.uk/rbot/)
#
# Create mini plugins on IRC.
#
# Commands are little Ruby programs that run in the context of the command plugin. You 
# can create them directly in an IRC channel, and invoke them just like normal rbot plugins. 
#
# (c) 2006 Mark Kretschmann <markey@web.de>
# Licensed under GPL V2.


Command = Struct.new( "Command", :code, :nick, :created, :channel )


class CommandPlugin < Plugin

  def initialize
    super
    if @registry.has_key?(:commands)
      @commands = @registry[:commands]
    else
      @commands = Hash.new
    end

    # Migrate old Hash to new:
    @commands.each_pair do |name, cmd|
      unless cmd.instance_of?( Command )
        @commands[name] = Command.new( cmd, 'unknown hacker', 'somedate', '#somechan' )
      end
    end
  end


  def save
    @registry[:commands] = @commands
  end


  def help( plugin, topic="" )
    if topic == "add"
      "Commands are little Ruby programs that run in the context of the command plugin. You can access @bot (class IrcBot), m (class PrivMessage), user (class String, either the first argument, or if missing the sourcenick), and args (class Array, an array of arguments). Example: 'command add greet m.reply( 'Hello ' + user )'. Invoke the command just like a plugin: '<botnick>: greet'."
    else  
      "Create mini plugins on IRC. 'command add <name> <code>' => Create command named <name> with the code <source>. 'command list' => Show a list of all known commands. 'command show <name>' => Show the source code for <name>. 'command del <name>' => Delete command <name>."
    end
  end


  def listen( m )
    name = m.message.split.first

    if m.address? and @commands.has_key?( name )
      code = @commands[name].code.dup.untaint

      # Convenience variables, can be accessed by commands:
      args = m.message.split
      args.delete_at( 0 ) 
      user = args.empty? ? m.sourcenick : args.first  

      Thread.start {
        $SAFE = 3

        begin
          eval( code )
        rescue => e
          m.reply( "Command '#{name}' crapped out :(" )
          m.reply( e.inspect )
        end
      }
    end
  end


  def handle_add( m, params, force = false )
    name    = params[:name]
    if !force and @commands.has_key?( name )
      m.reply( "#{m.sourcenick}: #{name} already exists. Use 'add -f' if you really want to overwrite it." )
      return
    end

    code    = params[:code].join( " " )
    nick    = m.sourcenick
    created = Time.new.strftime '%Y/%m/%d %H:%m'
    channel = m.target

    command = Command.new( code, nick, created, channel )
    @commands[name] = command

    m.reply( "done" )
  end


  def handle_add_force( m, params )
    handle_add( m, params, true )
  end
    

  def handle_del( m, params )
    name = params[:name]
    unless @commands.has_key?( name )
      m.reply( "Command does not exist." ); return
    end

    @commands.delete( name )
    m.reply( "done" )
  end


  def handle_list( m, params )
    if @commands.length == 0
      m.reply( "No commands available." ); return
    end

    cmds_per_page = 30
    cmds = @commands.keys.sort
    num_pages = cmds.length / cmds_per_page
    page = params[:page].to_i
    page = [page, 1].max
    page = [page, num_pages].min
    str = cmds[(page-1)*cmds_per_page, cmds_per_page].join(', ') 

    m.reply "Available commands (page #{page}/#{num_pages}): #{str}" 
  end


  def handle_show( m, params )
    name = params[:name]
    unless @commands.has_key?( name )
      m.reply( "Command does not exist." ); return
    end

    cmd = @commands[name]
    m.reply( "#{cmd.code} [#{cmd.nick}, #{cmd.created} in #{cmd.channel}]" )
 end

end


plugin = CommandPlugin.new
plugin.register( "command" )

plugin.map 'command add -f :name *code', :action => 'handle_add_force', :auth => 'commandedit'
plugin.map 'command add :name *code',    :action => 'handle_add',       :auth => 'commandedit'
plugin.map 'command del :name',          :action => 'handle_del',       :auth => 'commandedit'
plugin.map 'command list :page',         :action => 'handle_list',      :defaults => { :page => '1' }
plugin.map 'command show :name',         :action => 'handle_show'