XDCC-Fetch 1.386

data/src/Network/IRC_User.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2004-2005, Christoph Heindl
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, 
+# are permitted provided that the following conditions are met:
+#
+#    * Redistributions of source code must retain the above copyright notice, this list 
+#      of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright notice, this list 
+#      of conditions and the following disclaimer in the documentation and/or other materials 
+#      provided with the distribution.
+#    * Neither the name of Christoph Heindl nor the names of its contributors may be used to 
+#      endorse or promote products derived from this software without specific prior written 
+#      permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
+# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+require 'src/Network/IRC_Message.rb'
+
+# Represents a user on irc
+class IRC_User
+	attr_accessor :name, :user, :host
+	attr_reader :irc_server
+	
+	def initialize(name, irc_server)
+		@name = name
+		@user = nil
+		@host = nil
+		@irc_server = irc_server
+	end
+	
+	# Send a private message to the user
+	def send(message)
+		@irc_server.send(IRC_Message.new("PRIVMSG", @name, message))
+	end
+	
+	# Send a private notice to the user
+	def notice(message)
+		@irc_server.send(IRC_Message.new("NOTICE", @name, message))
+	end
+	
+	def to_s
+		"#{@name}!#{@user}@#{@host}"
+	end
+	
+	# Equals the nick of this user the given string?
+	def	has_name?(other_name)
+		self.name.downcase == other_name.downcase
+	end
+end

data/src/Network/TCP_Connection.rb

@@ -0,0 +1,168 @@
+# Copyright (c) 2004-2005, Christoph Heindl
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, 
+# are permitted provided that the following conditions are met:
+#
+#    * Redistributions of source code must retain the above copyright notice, this list 
+#      of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright notice, this list 
+#      of conditions and the following disclaimer in the documentation and/or other materials 
+#      provided with the distribution.
+#    * Neither the name of Christoph Heindl nor the names of its contributors may be used to 
+#      endorse or promote products derived from this software without specific prior written 
+#      permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
+# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+require 'socket'
+require 'resolv-replace'
+require 'src/Utilities/Events.rb'
+require 'timeout'
+
+# Provides businesslogic for handling a TCP client connection.
+# Supports text based and binary based connections through wrapping the actual receive 
+# and send procedure.
+class TCP_Connection
+	include Event_Publisher
+	
+	attr_reader :address, :port
+	attr_accessor :proc_recv, :proc_send
+
+	
+	# -- connectable events
+	
+	# On socket connection established. Args: none
+	ON_CONNECTED = Event_Publisher.next_global_eventID
+	# On socket connection closed remotely. Args: none
+	ON_CLOSED = Event_Publisher.next_global_eventID
+	# On socket error. Args: error message
+	ON_ERROR = Event_Publisher.next_global_eventID
+	# On data received. Args: data
+	ON_DATA = Event_Publisher.next_global_eventID
+	# All events packaged in one
+	ON_ALL_EVENTS = ON_CONNECTED + ON_CLOSED + ON_DATA + ON_ERROR
+	
+	def initialize(proc_recv, proc_send)
+		@proc_recv = proc_recv
+		@proc_send = proc_send
+		@socket = nil
+		@recv_thread = nil
+		init_events
+	end
+	
+	# Open connection to the specified server and port
+	def open(address, port)
+		@address = address
+		@port = port
+		
+		if !self.connected?
+			# Spawn a thread responsible for handling initial connection
+			# That way, the the main thread is not blocked if connection cannot be 
+			# established
+			connect_thread = Thread.new do
+				if @address && @port
+					begin
+						timeout($cfg.network.tcp.connect_timeout) {
+							@socket = TCPSocket.new(@address, @port)
+						}
+						self.fire_event(ON_CONNECTED)
+						# Setup the required receive thread which reads from the connection
+						@recv_thread = Thread.new do
+							begin
+								while data = self.proc_recv.call(@socket)
+									self.fire_event(ON_DATA, data) unless data.length == 0
+								end
+							self.close
+							self.fire_event(ON_CLOSED)
+							rescue IOError, Errno::ECONNRESET, Errno::ENOTSOCK, SocketError => err
+								self.fire_event(ON_ERROR, err.to_s)
+							end
+						end
+					rescue TimeoutError => err
+						self.fire_event(ON_ERROR, $cfg.text.network.tcp.err_con_timeout)
+					rescue IOError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ENETUNREACH, Errno::ETIMEDOUT, SocketError => err
+						self.close
+						self.fire_event(ON_ERROR, err.to_s)
+					end
+				else
+					self.fire_event(ON_ERROR, $cfg.text.network.tcp.err_con_no_remote)
+				end
+			end
+		else
+			# Already connected
+			self.fire_event(ON_ERROR, $cfg.text.network.tcp.err_con_active)
+		end
+		# Lower priority of connect thread. This may help higher level applications to increase there response time
+		connect_thread.priority = $cfg.network.tcp.connect_thread_priority
+	end
+	
+	# Send data to socket
+	def send(data)
+		begin
+			@proc_send.call(@socket, data) if self.connected?
+		rescue Exception => err
+			self.fire_event(ON_ERROR, err.to_s)
+			self.close
+		end
+	end
+	
+	# Immediate shutdown the connection
+	def close
+		begin
+			@socket.close
+		rescue Exception
+		end
+	end
+	
+	# Wait for the connection to close
+	def wait
+		if self.connected?
+			@recv_thread.join
+		else
+			self.fire_event(ON_ERROR, $cfg.text.network.tcp.err_con_closed)
+		end
+	end
+	
+	# Is connection established?
+	def connected?
+		@socket && !@socket.closed?
+	end
+		
+	# Generate a line based TCPConnection object. That is, data is received
+	# whenever \r\n is received.
+	def TCP_Connection.text
+		recv_proc = proc do |socket|
+			data = socket.gets("\r\n")
+		end
+		
+		send_proc = proc do |socket, data|
+			socket.puts(data)
+		end	
+		TCP_Connection.new(recv_proc, send_proc)
+	end
+	
+	# Generate a TCPConnection object, capable of handling binary data packets.
+	def TCP_Connection.binary
+		recv_proc = proc do |socket|
+			data = socket.recv(16384)
+			(data.length > 0) ? data : nil
+		end
+		
+		send_proc = proc do |socket, data|
+			socket.print(data)
+		end
+		TCP_Connection.new(recv_proc, send_proc)
+	end
+end
+
+
+

data/src/Network/XDCC_Announcement.rb

@@ -0,0 +1,120 @@
+# Copyright (c) 2004-2005, Christoph Heindl
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, 
+# are permitted provided that the following conditions are met:
+#
+#    * Redistributions of source code must retain the above copyright notice, this list 
+#      of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright notice, this list 
+#      of conditions and the following disclaimer in the documentation and/or other materials 
+#      provided with the distribution.
+#    * Neither the name of Christoph Heindl nor the names of its contributors may be used to 
+#      endorse or promote products derived from this software without specific prior written 
+#      permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
+# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+require 'src/Network/XDCC_Pack.rb'
+require 'src/Network/IRC_Message.rb'
+
+# An XDCC_Announcement represents an complete offering of an xdcc bot. This includes info about the current bot status as
+# well as the offered packs.
+class XDCC_Announcement
+	
+	# The irc_user offering
+	attr_reader :irc_user_bot
+	#nr of packs offered, nr of available slots, nr of slots open and the targets this announcement was found at
+	# Nr of packs in announcement
+	attr_accessor :pack_cnt 
+	# Total number of slots
+	attr_accessor :slot_cnt
+	# Number of slots available
+	attr_accessor :openslot_cnt 
+	# Total number of queue slots
+	attr_accessor :queue_cnt  
+	# Number of open queue positions
+	attr_accessor :openqueue_cnt
+	# Array of channels or nicknames, this announcement was sent to
+	attr_accessor :targets
+	# Type of announcement (FULL or MEDIUM)
+	attr_reader :ann_type
+	# Array of XDCC_Packs belonging to this announcement
+	attr_reader :packs
+	
+	# -- Constants
+	ANN_FULL = 0
+	ANN_MINIMAL = 1
+	
+	# Initialize with the bot which offers
+	def initialize(irc_user_bot, type=ANN_FULL)
+		@pack_cnt = -1
+		@irc_user_bot = irc_user_bot
+		@packs = Array.new
+		@openslot_cnt = -1
+		@slot_cnt = -1
+		@queue_cnt = -1
+		@openqueue_cnt = -1
+		@ann_type = type
+	end
+	
+	# Has parsing completed
+	def completed?
+		@packs.length == @pack_cnt
+	end
+	
+	# Does this announcement contain queue information
+	def has_queue_info?
+		@queue_cnt != -1
+	end
+	
+	# Returns a human readable representation of this announcement as string
+	def to_s
+		s  = "XDCC_Announcement: #{@irc_user_bot.name} | nr of packs: #{@pack_cnt} | open slots: #{@openslot_cnt}/#{@slot_cnt} | queue: #{@openqueue_cnt}/#{@queue_cnt}\r\n"
+		@packs.each do |pack|
+			s += "#{pack}\r\n"
+		end
+		s
+	end
+	
+	# Returns a xdcc representation of this announcement as array of irc_messages.
+	# If channel is not given, the channelname is taken from the targets.
+	def to_irc(channel=nil)
+		channel = @targets[0] unless channel
+		a = []
+		a << IRC_Message.new("PRIVMSG", channel, "\002**\002 #{@pack_cnt} packs \002\002  #{@openslot_cnt} of #{@slot_cnt} slots open")
+		a << IRC_Message.new("PRIVMSG", channel, "\002**\002 Bandwidth usage ...")
+		a << IRC_Message.new("PRIVMSG", channel, "\002**\002 To request a file, type \"/msg ....")
+		@packs.each do |pack|
+			a << pack.to_irc(channel)
+		end
+		a << IRC_Message.new("PRIVMSG", channel, "Total Offered: 1.1 MB  Total Transferred: 2.13 MB")
+	end
+	
+	# Determines equality of this xdcc_announcement and the given xdcc_announcement.
+	def ==(ann)
+		@irc_user_bot == ann.irc_user_bot &&
+		@pack_cnt == ann.pack_cnt &&
+		@slot_cnt == ann.pack_cnt &&
+		@openslot_cnt == ann.openslot_cnt &&
+		@packs == ann.packs
+	end
+end
+
+#<mybotDCC> ** 4 packs **  20 of 20 slots open, Record: 3543.1KB/s
+#<mybotDCC> ** Bandwidth Usage ** Current: 0.0KB/s, Record: 9.5KB/s
+#<mybotDCC> ** To request a file, type "/msg mybotDCC xdcc send #x" **
+#<mybotDCC> ** To request details, type "/msg mybotDCC xdcc info #x" **
+#<mybotDCC> #1  2x [1.0M] Setup-NettalkIRCD.exe
+#<mybotDCC> #2  1x [ 93K] XDCC-FetchGUI-nightly.zip
+#<mybotDCC> #3  1x [ <1K] wscite162.zip
+#<mybotDCC> #4  0x [ <1K] sometext.txt
+#<mybotDCC> Total Offered: 1.1 MB  Total Transferred: 2.13 MB

data/src/Network/XDCC_Announcement_Storage.rb

@@ -0,0 +1,167 @@
+# Copyright (c) 2004-2005, Christoph Heindl
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, 
+# are permitted provided that the following conditions are met:
+#
+#    * Redistributions of source code must retain the above copyright notice, this list 
+#      of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright notice, this list 
+#      of conditions and the following disclaimer in the documentation and/or other materials 
+#      provided with the distribution.
+#    * Neither the name of Christoph Heindl nor the names of its contributors may be used to 
+#      endorse or promote products derived from this software without specific prior written 
+#      permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
+# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+require 'thread'
+require 'src/Utilities/Events.rb'
+require 'src/Network/IRC_Server.rb'
+require 'src/Network/XDCC_Parser.rb'
+
+class XDCC_Announcement_Storage
+	include Event_Publisher
+	
+	# -- Connectable events
+	
+	# Whenever a new(unknown, updated) announcement is available. Args: xdcc_announcement
+	ON_ANNOUNCEMENT_NEW = Event_Publisher.next_global_eventID
+	# Whenever a known announcement is lost, due to user quit or announcement update. Args: xdcc_announcement
+	ON_ANNOUNCEMENT_LOST = Event_Publisher.next_global_eventID
+	
+	# Initialize with the given XDCC_Parser
+	def initialize(xdcc_parser)
+		@mutex = Mutex.new
+		@bot_announcement = Hash.new
+		@irc_servers = Array.new
+		@parser = xdcc_parser
+		@parser.connect_to_events(XDCC_Parser::ON_ANNOUNCEMENT, self)
+		self.init_events
+	end
+	
+	# Clear up, prepare for deallocation
+	def shutdown
+		@parser.disconnect_from_events(XDCC_Parser::ON_ANNOUNCEMENT, self)
+		self.shutdown_events
+	end
+	
+	# Handle a XDCC_Announcement
+	# Basically decides, if it is unknown or known and based on this, takes the appropriate actions
+	def handle_announcement(ann)
+		@mutex.synchronize do
+			# Check if we've already subsribed at the irc_server the ann was broadcasted on
+			if !@irc_servers.include?(ann.irc_user_bot.irc_server)
+				@irc_servers.push(ann.irc_user_bot.irc_server)
+				ann.irc_user_bot.irc_server.connect_to_events(IRC_Server::ON_USER_QUIT|
+															  IRC_Server::ON_USER_PART|
+															  IRC_Server::ON_USER_KICK|
+															  IRC_Server::ON_SERVER_DISCONNECTED,
+															  self)
+			end
+		
+			# Check if it is an unknown bot
+			if !@bot_announcement.include?(ann.irc_user_bot)
+				self.handle_new_announcement(ann)
+			else
+				self.handle_existing_announcement(ann)
+			end
+		end
+	end
+	
+	# Handles an unknown XDCC_Announcement.
+	# Broadcasts an ON_ANNOUNCEMENT_NEW event
+	def handle_new_announcement(ann)
+		@bot_announcement[ann.irc_user_bot] = ann
+		self.fire_event(ON_ANNOUNCEMENT_NEW, ann)
+	end
+	
+	# Handles a known XDCC_Announcement.
+	# An ON_ANNOUNCEMENT_UPDATE is being broadcasted if the XDCC_Announcement changed.
+	def handle_existing_announcement(ann)
+		# Check if announcement has updated
+		if @bot_announcement[ann.irc_user_bot] != ann
+			self.fire_event(ON_ANNOUNCEMENT_LOST, @bot_announcement[ann.irc_user_bot])
+			self.fire_event(ON_ANNOUNCEMENT_NEW, ann)
+			@bot_announcement[ann.irc_user_bot] = ann
+		end
+	end
+	
+	# Handles a user quit message.
+	# A ON_ANNOUNCEMENT_LOST is thrown, if the user quitting used to offer XDCC_Packs.
+	def handle_user_quit(irc_user)
+		@mutex.synchronize do
+			ann = @bot_announcement.delete(irc_user)
+			self.fire_event(ON_ANNOUNCEMENT_LOST, ann) if ann
+		end
+	end
+	
+	# When disconnected from server, all announcements found on this server
+	# are treated as lost. the server itself is not killed.
+	def handle_server_disconnect(irc_server)
+		@mutex.synchronize do
+			@bot_announcement.delete_if do |bot, ann|
+				ret = (bot.irc_server == irc_server)
+				self.fire_event(ON_ANNOUNCEMENT_LOST, ann) if ret
+				ret
+			end
+		end
+	end
+	
+	# When a user is kicked from a certain channel. Possible announcements
+	# belonging to that user are being treated as lost. If the user is
+	# ourself, all announcements found on that channel are being treated as lost
+	def handle_channel_left(irc_server, channelname, irc_user)
+		if irc_server.me.has_name?(irc_user.name)
+			# We have been forced to leave channel
+			chan = channelname.downcase
+			@mutex.synchronize do
+				@bot_announcement.delete_if do |bot, ann|
+					# Although announcement may be broadcasted in multiple channels,
+					# we only check the first so far
+					# TODO: check if announcement was broadcasted in other chans (we know)
+					# too. If we are in such a chan, don't kill announcement
+					ret = (ann.targets[0].downcase == chan)
+					self.fire_event(ON_ANNOUNCEMENT_LOST, ann) if ret
+					ret
+				end
+			end
+		else
+			# User (potential bot has been kicked)
+			username = irc_user.name.downcase
+			@mutex.synchronize do
+				@bot_announcement.delete_if do |bot, ann|
+					ret = (bot.name.downcase == username)
+					self.fire_event(ON_ANNOUNCEMENT_LOST, ann) if ret
+					ret
+				end
+			end	
+		end
+	end
+	
+	# Handle incoming events
+	def on_event(caller, event, eventargs)
+		case event
+			when XDCC_Parser::ON_ANNOUNCEMENT
+				self.handle_announcement(eventargs[0])
+			
+			when IRC_Server::ON_USER_QUIT 
+				self.handle_user_quit(eventargs[0])
+				
+			when IRC_Server::ON_SERVER_DISCONNECTED
+				self.handle_server_disconnect(caller)
+				
+			when IRC_Server::ON_USER_KICK, IRC_Server::ON_USER_PART
+				self.handle_channel_left(caller, eventargs[1], eventargs[0])
+		end
+	end
+end
+