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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
#
# Copyright (c) 2004 SASADA Koichi <ko1 at atdot.net>
#
# This program is free software with ABSOLUTELY NO WARRANTY.
# You can re-distribute and/or modify this program under
# the same terms of the Ruby's lisence.
#
#
# $Id: ndk_bot.rb 83 2004-07-21 10:20:03Z ko1 $
# Create : K.S. 04/04/19 00:39:48
#
#
# To make bot for nadoka, see this code.
#
require 'ndk_manager'
module Nadoka
class NDK_Bot
Cmd = ::Nadoka::Cmd
Rpl = ::Nadoka::Rpl
def initialize manager, config, bot_config
@manager = manager
@config = config
@logger = config.logger
@state = manager.state
@bot_config = bot_config
bot_initialize
end
# To initialize bot insntace, please overide this.
def bot_initialize
# do something
end
# This method will be called when reload configuration.
def bot_destruct
# do something
end
# override me
def bot_state
info = "#<#{self.class}: #{@bot_config.inspect}>"
if info.length > 100
info[0..100] + '...'
else
info
end
end
# To access bot confiuration, please use this.
#
# in configuration file,
# BotConfig = {
# :BotClassName => {
# ... # you can access this value
# }
# }
#
# !! This method is obsoleted. Use @bot_config instead !!
#
def config
@logger.dlog "NDK_Bot#config is obsolete. Use @bot_config instead"
@bot_config
end
# Mostly, you need this method.
def send_notice ch, msg
msg = Cmd.notice(ch, msg)
@manager.send_to_server msg
@manager.send_to_clients_otherwise msg, nil
end
# Usualy, you must not use this
def send_privmsg ch, msg
msg = Cmd.privmsg(ch, msg)
@manager.send_to_server msg
@manager.send_to_clients_otherwise msg, nil
end
# Change user's mode as 'mode' on ch.
def change_mode ch, mode, user
send_msg Cmd.mode(ch, mode, user)
end
# Change your nick to 'nick'.
def change_nick nick
send_msg Cmd.nick(nick)
end
# Send command or reply(?) to server.
def send_msg msg
@manager.send_to_server msg
end
# ccn or canonical_channel_name
def canonical_channel_name ch
@config.canonical_channel_name ch
end
alias ccn canonical_channel_name
=begin
# ...
# def on_[IRC Command or Reply(3 digits)] prefix(nick only), param1, param2, ...
#
# end
#
# like these
def on_privmsg prefix, ch, msg
end
def on_join prefix, ch
end
def on_part prefix, ch, msg=''
end
def on_quit prefix, msg=''
end
def on_xxx prefix, *params
end
In above methods, you can access nick, user, host information
via prefix argument variable like this.
- prefix.nick
- prefix.user
- prefix.host
######
# spcial event
# This method will be called when recieved every message
def on_every_message prefix, command, *args
#
end
# if 'nick' user quit client and part ch, this event is called.
# !! ch is canonicarized channel name !!
def on_quit_from_channel ch, nick, qmsg
# do something
end
# It's special event that will be called about a minute.
def on_timer timeobj
# do something
end
# It's special event that will be called when new client join.
def on_client_login client_count, client
# do something
end
# It's special event that will be called when a client part.
def on_client_logout client_count, client
# do something
end
# undocumented
def on_client_privmsg client, ch, msg
# do something
end
# undocumented
def on_nadoka_command client, command, *params
# do something
end
# on signal 'sigusr[12]' trapped
def on_sigusr[12] # no arguments
# do something
end
You can access your current state on IRC server via @state.
- @state.nick # your current nick
- @state.channels # channels which you are join ['ch1', 'ch2', ...]
# need canonicarized channel name
- @state.channel_users(ch) # channel users ['user1', ...]
- @state.channel_user_mode(ch, nick)
=end
def self.inherited subklass
BotClass << subklass
end
end
end
|
