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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers

#Channel, #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.



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

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

Instance Attribute Details

#bot ⇒ Bot (readonly)

Returns:



18
19
20
 
# File 'lib/cinch/irc.rb', line 18

def bot
  @bot
end

#isupport ⇒ ISupport (readonly)

Returns:



15
16
17
 
# File 'lib/cinch/irc.rb', line 15

def isupport
  @isupport
end

#network ⇒ Network (readonly)

Returns The detected network.

Returns:

  • (Network) —

    The detected network



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

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



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

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 StandardError => 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)

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.



231
232
233
234
235
236
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
 
# File 'lib/cinch/irc.rb', line 231

def parse(input)
  return if input.chomp.empty?

  @bot.loggers.incoming(input)

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

  if %w[001 002 003 004 422].include?(msg.command)
    @registration << msg.command
    if registered?
      events << [:connect]
      @bot.last_connection_was_successful = true
      on_connect(msg, events)
    end
  end

  if %w[PRIVMSG NOTICE].include?(msg.command)
    events << [:ctcp] if msg.ctcp?
    events << if msg.channel?
                [:channel]
              else
                [:private]
              end

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

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

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

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

  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



275
276
277
 
# File 'lib/cinch/irc.rb', line 275

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

#send(msg)

This method returns an undefined value.

Send a message to the server.

Parameters:



282
283
284
 
# File 'lib/cinch/irc.rb', line 282

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

#send_cap_end

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



131
132
133
 
# File 'lib/cinch/irc.rb', line 131

def send_cap_end
  send "CAP END"
end

#send_cap_ls

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



109
110
111
 
# File 'lib/cinch/irc.rb', line 109

def send_cap_ls
  send "CAP LS"
end

#send_cap_req

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



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/cinch/irc.rb', line 116

def send_cap_req
  caps = %i[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.empty?
    send "CAP REQ :" + caps.join(" ")
  else
    send_cap_end
  end
end

#send_login

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



138
139
140
141
142
 
# File 'lib/cinch/irc.rb', line 138

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



199
200
201
202
203
204
205
206
 
# File 'lib/cinch/irc.rb', line 199

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

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



38
39
40
41
42
43
 
# File 'lib/cinch/irc.rb', line 38

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

#setup_ssl(socket)

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cinch/irc.rb', line 81

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



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

def socket
  @socket.io
end

#start

This method returns an undefined value.

Establish a connection.

Since:

  • 2.0.0



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/cinch/irc.rb', line 212

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



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/cinch/irc.rb', line 187

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



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

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 StandardError => 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



176
177
178
179
180
181
182
 
# File 'lib/cinch/irc.rb', line 176

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