Class: Cinch::IRC

Inherits:
Object
  • Object
show all
Includes:
Helpers
Defined in:
lib/cinch/irc.rb

Overview

This class manages the connection to the IRC server. That includes processing incoming and outgoing messages, creating Ruby objects and invoking plugins.

Constant Summary collapse

REGISTRATION_COMMANDS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

%w[001 002 003 004 376 422].freeze
PRIVMSG_NOTICE_COMMANDS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

%w[PRIVMSG NOTICE].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers

#Channel, #Color, #Format, #Sanitize, #Target, #Timer, #Unformat, #User, #debug, #error, #exception, #fatal, #incoming, #info, #log, #outgoing, #rescue_exception, sanitize, #warn

Constructor Details

#initialize(bot) ⇒ IRC

Returns a new instance of IRC.



29
30
31
32
 
# File 'lib/cinch/irc.rb', line 29

def initialize(bot)
  @bot = bot
  @isupport = ISupport.new
end

Instance Attribute Details

#bot ⇒ Bot (readonly)

Returns:



24
25
26
 
# File 'lib/cinch/irc.rb', line 24

def bot
  @bot
end

#isupport ⇒ ISupport (readonly)

Returns:



21
22
23
 
# File 'lib/cinch/irc.rb', line 21

def isupport
  @isupport
end

#network ⇒ Network (readonly)

Returns The detected network.

Returns:

  • (Network) —

    The detected network



27
28
29
 
# File 'lib/cinch/irc.rb', line 27

def network
  @network
end

Instance Method Details

#connect ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns True if the connection could be established.

Returns:

  • (Boolean) —

    True if the connection could be established



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
 
# File 'lib/cinch/irc.rb', line 53

def connect
  tcp_socket = nil

  begin
    Timeout.timeout(@bot.config.timeouts.connect) do
      tcp_socket = TCPSocket.new(@bot.config.server, @bot.config.port, @bot.config.local_host)
    end
  rescue Timeout::Error
    @bot.loggers.warn("Timed out while connecting")
    return false
  rescue SocketError => e
    @bot.loggers.warn("Could not connect to the IRC server. Please check your network: #{e.message}")
    return false
  rescue => e
    @bot.loggers.exception(e)
    return false
  end

  if @bot.config.ssl.use
    setup_ssl(tcp_socket)
  else
    @socket = tcp_socket
  end

  @socket = Net::BufferedIO.new(@socket)
  @socket.read_timeout = @bot.config.timeouts.read
  @queue = MessageQueue.new(@socket, @bot)

  true
end

#parse(input) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cinch/irc.rb', line 237

def parse(input)
  return if input.chomp.empty?
  @bot.loggers.incoming(input)

  msg = Message.new(input, @bot)
  events = [[:catchall]]

  if REGISTRATION_COMMANDS.include?(msg.command)
    @registration << msg.command
    if registered?
      events << [:connect]
      @bot.last_connection_was_successful = true
      on_connect(msg, events)
    end
  end

  if PRIVMSG_NOTICE_COMMANDS.include?(msg.command)
    events << [:ctcp] if msg.ctcp?
    events << if msg.channel?
      [:channel]
    else
      [:private]
    end

    if msg.command == "PRIVMSG"
      events << [:message]
    end

    if msg.action?
      events << [:action]
    end
  end

  meth = "on_#{msg.command.downcase}"
  __send__(meth, msg, events) if respond_to?(meth, true)

  if msg.error?
    events << [:error]
  end

  events << [msg.command.downcase.to_sym]

  msg.events = events.map(&:first)
  events.each do |event, *args|
    @bot.handlers.dispatch(event, msg, *args)
  end
end

#registered? ⇒ Boolean

Returns true if we successfully registered yet.

Returns:

  • (Boolean) —

    true if we successfully registered yet



286
287
288
 
# File 'lib/cinch/irc.rb', line 286

def registered?
  (("001".."004").to_a - @registration).empty? || @registration.include?("376") || @registration.include?("422")
end

#send(msg) ⇒ void

This method returns an undefined value.

Send a message to the server.

Parameters:



293
294
295
 
# File 'lib/cinch/irc.rb', line 293

def send(msg)
  @queue.queue(msg)
end

#send_cap_end ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Since:

  • 2.0.0



137
138
139
 
# File 'lib/cinch/irc.rb', line 137

def send_cap_end
  send "CAP END"
end

#send_cap_ls ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Since:

  • 2.0.0



115
116
117
 
# File 'lib/cinch/irc.rb', line 115

def send_cap_ls
  send "CAP LS"
end

#send_cap_req ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Since:

  • 2.0.0



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cinch/irc.rb', line 122

def send_cap_req
  caps = [:"away-notify", :"multi-prefix", :sasl, :"twitch.tv/tags"] & @network.capabilities

  # InspIRCd doesn't respond to empty REQs, so send an END in that
  # case.
  if caps.size > 0
    send "CAP REQ :" + caps.join(" ")
  else
    send_cap_end
  end
end

#send_login ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Since:

  • 2.0.0



144
145
146
147
148
 
# File 'lib/cinch/irc.rb', line 144

def 
  send "PASS #{@bot.config.password}" if @bot.config.password
  send "NICK #{@bot.generate_next_nick!}"
  send "USER #{@bot.config.user} 0 * :#{@bot.config.realname}"
end

#send_sasl ⇒ Object

Since:

  • 2.0.0



205
206
207
208
209
210
211
212
 
# File 'lib/cinch/irc.rb', line 205

def send_sasl
  if @bot.config.sasl.username && (@sasl_current_method = @sasl_remaining_methods.pop)
    @bot.loggers.info "[SASL] Trying to authenticate with #{@sasl_current_method.mechanism_name}"
    send "AUTHENTICATE #{@sasl_current_method.mechanism_name}"
  else
    send_cap_end
  end
end

#setup ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Since:

  • 2.0.0



44
45
46
47
48
49
 
# File 'lib/cinch/irc.rb', line 44

def setup
  @registration = []
  @network = Network.new(:unknown, :unknown)
  @whois_updates = {}
  @in_lists = Set.new
end

#setup_ssl(socket) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Since:

  • 2.0.0



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/cinch/irc.rb', line 87

def setup_ssl(socket)
  # require openssl in this method so the bot doesn't break for
  # people who don't have SSL but don't want to use SSL anyway.
  require "openssl"

  ssl_context = OpenSSL::SSL::SSLContext.new

  if @bot.config.ssl.is_a?(Configuration::SSL)
    if @bot.config.ssl.client_cert
      ssl_context.cert = OpenSSL::X509::Certificate.new(File.read(@bot.config.ssl.client_cert))
      ssl_context.key = OpenSSL::PKey::RSA.new(File.read(@bot.config.ssl.client_cert))
    end

    ssl_context.ca_path = @bot.config.ssl.ca_path
    ssl_context.verify_mode = @bot.config.ssl.verify ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
  else
    ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end
  @bot.loggers.info "Using SSL with #{@bot.config.server}:#{@bot.config.port}"

  @socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
  @socket.sync = true
  @socket.connect
end

#socket ⇒ TCPSocket

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (TCPSocket)

Since:

  • 2.0.0



37
38
39
 
# File 'lib/cinch/irc.rb', line 37

def socket
  @socket.io
end

#start ⇒ void

This method returns an undefined value.

Establish a connection.

Since:

  • 2.0.0



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/cinch/irc.rb', line 218

def start
  setup
  if connect
    @sasl_remaining_methods = @bot.config.sasl.mechanisms.reverse
    send_cap_ls
    

    reading_thread = start_reading_thread
    sending_thread = start_sending_thread
    ping_thread = start_ping_thread

    reading_thread.join
    sending_thread.kill
    ping_thread.kill
  end
end

#start_ping_thread ⇒ Thread

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The ping thread.

Returns:

  • (Thread) —

    The ping thread.

Since:

  • 2.0.0



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/cinch/irc.rb', line 193

def start_ping_thread
  Thread.new do
    loop do
      sleep @bot.config.ping_interval
      # PING requires a single argument. In our case the value
      # doesn't matter though.
      send("PING 0")
    end
  end
end

#start_reading_thread ⇒ Thread

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the reading thread.

Returns:

  • (Thread) —

    the reading thread

Since:

  • 2.0.0



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
 
# File 'lib/cinch/irc.rb', line 153

def start_reading_thread
  Thread.new do
    begin
      while (line = @socket.readline)
        rescue_exception do
          line = Cinch::Utilities::Encoding.encode_incoming(line, @bot.config.encoding)
          parse line
        end
      end
    rescue Timeout::Error
      @bot.loggers.warn "Connection timed out."
    rescue EOFError
      @bot.loggers.warn "Lost connection."
    rescue => e
      @bot.loggers.exception(e)
    end

    @socket.close
    @bot.handlers.dispatch(:disconnect)
    # FIXME won't we kill all :disconnect handlers here? prolly
    # not, as they have 10 seconds to finish. that should be
    # plenty of time
    @bot.handlers.stop_all
  end
end

#start_sending_thread ⇒ Thread

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the sending thread.

Returns:

  • (Thread) —

    the sending thread

Since:

  • 2.0.0



182
183
184
185
186
187
188
 
# File 'lib/cinch/irc.rb', line 182

def start_sending_thread
  Thread.new do
    rescue_exception do
      @queue.process!
    end
  end
end