2 # Calculate the penalty which will be assigned to this message
5 # According to eggrdop, the initial penalty is
6 penalty = 1 + self.size/100
7 # on everything but UnderNET where it's
8 # penalty = 2 + self.size/120
10 cmd, pars = self.split($;,2)
11 debug "cmd: #{cmd}, pars: #{pars.inspect}"
14 chan, nick, msg = pars.split
15 chan = chan.split(',')
16 nick = nick.split(',')
20 chan, modes, argument = pars.split
25 extra += modes.split(/\+|-/).size
27 extra += 3 * modes.split(/\+|-/).size
31 extra += 2 * argument.split.size
33 penalty += extra * chan.split.size
36 penalty += 2 unless pars.split.size < 2
37 when :PRIVMSG, :NOTICE
38 dests = pars.split($;,2).first
39 penalty += dests.split(',').size
41 # I'm too lazy to implement this one correctly
43 when :AWAY, :JOIN, :VERSION, :TIME, :TRACE, :WHOIS, :DNS
49 else # Unknown messages
53 debug "Wow, more than 99 secs of penalty!"
57 debug "Wow, less than 2 secs of penalty!"
60 debug "penalty: #{penalty}"
72 # A QueueRing is implemented as an array with elements in the form
73 # [chan, [message1, message2, ...]
74 # Note that the channel +chan+ has no actual bearing with the channels
75 # to which messages will be sent
101 cmess = @storage.assoc(chan)
103 idx = @storage.index(cmess)
105 @storage[idx] = cmess
107 @storage << [chan, [mess]]
113 warning "trying to access empty ring"
117 @last_idx = (@last_idx + 1) % @storage.size
118 mess = @storage[@last_idx][1].first
125 warning "trying to access empty ring"
128 @last_idx = (@last_idx + 1) % @storage.size
129 mess = @storage[@last_idx][1].shift
130 @storage.delete(@storage[@last_idx]) if @storage[@last_idx][1] == []
138 # a MessageQueue is an array of QueueRings
139 # rings have decreasing priority, so messages in ring 0
140 # are more important than messages in ring 1, and so on
141 @rings = Array.new(3) { |i|
145 # ring 0 is special in that if it's not empty, it will
146 # be popped. IOW, ring 0 can starve the other rings
147 # ring 0 is strictly FIFO and is therefore implemented
152 # the other rings are satisfied round-robin
163 def push(mess, chan=nil, cring=0)
166 warning "message #{mess} at ring 0 has channel #{chan}: channel will be ignored" if !chan.nil?
169 error "message #{mess} at ring #{ring} must have a channel" if chan.nil?
170 @rings[ring].push mess, chan
176 return false unless r.empty?
192 warning "trying to access empty ring"
197 mess = @rings[0].first
199 save_ring = @last_ring
200 (@rings.size - 1).times {
201 @last_ring = (@last_ring % (@rings.size - 1)) + 1
202 if !@rings[@last_ring].empty?
203 mess = @rings[@last_ring].next
207 @last_ring = save_ring
209 error "nil message" if mess.nil?
215 warning "trying to access empty ring"
220 return @rings[0].shift
222 (@rings.size - 1).times {
223 @last_ring = (@last_ring % (@rings.size - 1)) + 1
224 if !@rings[@last_ring].empty?
225 return @rings[@last_ring].shift
228 error "nil message" if mess.nil?
234 # wrapped TCPSocket for communication with the server.
235 # emulates a subset of TCPSocket functionality
238 MAX_IRC_SEND_PENALTY = 10
240 # total number of lines sent to the irc server
241 attr_reader :lines_sent
243 # total number of lines received from the irc server
244 attr_reader :lines_received
246 # total number of bytes sent to the irc server
247 attr_reader :bytes_sent
249 # total number of bytes received from the irc server
250 attr_reader :bytes_received
252 # accumulator for the throttle
253 attr_reader :throttle_bytes
255 # delay between lines sent
256 attr_reader :sendq_delay
259 attr_reader :sendq_burst
261 # an optional filter object. we call @filter.in(data) for
262 # all incoming data and @filter.out(data) for all outgoing data
265 # default trivial filter class
276 # set filter to identity, not to nil
278 @filter = f || IdentityFilter.new
281 # server:: server to connect to
283 # host:: optional local host to bind to (ruby 1.7+ required)
284 # create a new IrcSocket
285 def initialize(server, port, host, sendq_delay=2, sendq_burst=4, opts={})
286 @timer = Timer::Timer.new
294 @filter = IdentityFilter.new
298 if opts.kind_of?(Hash) and opts.key?(:ssl)
305 @sendq_delay = sendq_delay.to_f
309 @last_send = Time.new - @sendq_delay
310 @flood_send = Time.new
311 @last_throttle = Time.new
314 @sendq_burst = sendq_burst.to_i
324 # open a TCP connection to the server
327 warning "reconnecting while connected"
332 @sock=TCPSocket.new(@server, @port, @host)
333 rescue ArgumentError => e
334 error "Your version of ruby does not support binding to a "
335 error "specific local address, please upgrade if you wish "
336 error "to use HOST = foo"
337 error "(this option has been disabled in order to continue)"
338 @sock=TCPSocket.new(@server, @port)
341 @sock=TCPSocket.new(@server, @port)
345 ssl_context = OpenSSL::SSL::SSLContext.new()
346 ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
348 @sock = OpenSSL::SSL::SSLSocket.new(@rawsock, ssl_context)
349 @sock.sync_close = true
354 @sendq = MessageQueue.new
357 def sendq_delay=(newfreq)
358 debug "changing sendq frequency to #{newfreq}"
359 @qmutex.synchronize do
360 @sendq_delay = newfreq
370 def sendq_burst=(newburst)
371 @qmutex.synchronize do
372 @sendq_burst = newburst
376 # used to send lines to the remote IRCd by skipping the queue
377 # message: IRC message to send
378 # it should only be used for stuff that *must not* be queued,
379 # i.e. the initial PASS, NICK and USER command
380 # or the final QUIT message
381 def emergency_puts(message)
382 @qmutex.synchronize do
383 # debug "In puts - got mutex"
384 puts_critical(message)
388 def handle_socket_error(string, err)
389 error "#{string} failed: #{err.inspect}"
390 debug err.backtrace.join("\n")
391 # We assume that an error means that there are connection
392 # problems and that we should reconnect, so we
394 raise SocketError.new(err.inspect)
397 # get the next line from the server (blocks)
400 warning "socket get attempted while closed"
404 reply = @filter.in(@sock.gets)
406 reply.strip! if reply
407 debug "RECV: #{reply.inspect}"
410 handle_socket_error(:RECV, e)
414 def queue(msg, chan=nil, ring=0)
416 @qmutex.synchronize do
417 @sendq.push msg, chan, ring
421 # just send it if queueing is disabled
422 self.emergency_puts(msg)
426 # pop a message off the queue, send it
428 @qmutex.synchronize do
436 if (now >= (@last_send + @sendq_delay))
437 debug "resetting @burst"
439 elsif (@burst > @sendq_burst)
440 # nope. can't send anything, come back to us next tick...
441 debug "can't send yet"
445 @flood_send = now if @flood_send < now
446 debug "can send #{@sendq_burst - @burst} lines, there are #{@sendq.size} to send"
447 while !@sendq.empty? and @burst < @sendq_burst and @flood_send - now < MAX_IRC_SEND_PENALTY
448 debug "sending message (#{@flood_send - now} < #{MAX_IRC_SEND_PENALTY})"
449 puts_critical(@sendq.shift, true)
455 error "Spooling failed: #{e.inspect}"
456 error e.backtrace.join("\n")
463 @qmutex.synchronize do
469 warning "Clearing socket while disconnected"
473 # flush the TCPSocket
478 # Wraps Kernel.select on the socket
479 def select(timeout=nil)
480 Kernel.select([@sock], nil, nil, timeout)
483 # shutdown the connection to the server
485 return unless connected?
489 error "error while shutting down: #{err.inspect}"
490 debug err.backtrace.join("\n")
492 @rawsock = nil if @ssl
499 # same as puts, but expects to be called with a mutex held on @qmutex
500 def puts_critical(message, penalty=false)
501 # debug "in puts_critical"
503 debug "SEND: #{message.inspect}"
505 error "SEND attempted on closed socket"
507 @sock.puts(@filter.out(message))
508 @last_send = Time.new
509 @flood_send += message.irc_send_penalty if penalty
514 handle_socket_error(:SEND, e)