XDCC-Fetch 1.386

data/src/Network/DCC_File.rb

@@ -0,0 +1,323 @@
+# Copyright (c) 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.
+
+DCC_Resume_Verification = Struct.new("DCC_Resume_Verification", 
+									 :verified, 
+									 :bytes_mine, 
+									 :md5_mine,
+									 :bytes_their,
+									 :md5_their)
+						  
+DCC_File_Info = Struct.new("DCC_File_Info",
+						   :status,					# Status of DCC
+						   :irc_user,				# Remote irc user
+						   :address,				# Remote address and port
+						   :file,					# File handle
+						   :joined_filename,		# path to file
+						   :filename,				# filename originally sent by user
+						   :md5,					# MD5 checksom of file
+						   :verification,			# DCC_Resume_Verification struct
+						   :skip_download,			# Should this download be skipped
+						   :skip_status,			# Whats the status to be broadcasted after skip succeeds
+						   :skip_reason,			# Whats the message to be broadcasted after skip succeeds
+						   :bytes_total,			# Total number of bytes to receive
+						   :bytes_received,			# Number of bytes received so far
+						   :progress_timestamp,		# Last progress timestamp
+						   :progress_bytes)			# Number of bytes since last progress event
+						   
+						  
+# Handles dcc file transactions  
+class DCC_File
+	include Event_Publisher
+	
+	# -- Connectable events
+	
+	# Connection to remote dcc host successful. Args: none
+	ON_DCC_ESTABLISHED = Event_Publisher.next_global_eventID
+	# Transfer complete. Args: md5 checksum or nil
+	ON_DCC_COMPLETED = Event_Publisher.next_global_eventID
+	# Download/upload progress. 
+	# Percent completed, nr of bytes received/sent, nr of kilo bytes per second 
+	ON_DCC_PROGRESS = Event_Publisher.next_global_eventID
+	# DCC error. Args: errormessage
+	ON_DCC_ERROR = Event_Publisher.next_global_eventID
+	
+	ON_ALL_EVENTS = ON_DCC_ESTABLISHED|
+					ON_DCC_COMPLETED|
+					ON_DCC_PROGRESS|
+					ON_DCC_ERROR
+
+	
+	def initialize()
+		@tcp_con = TCP_Connection.binary
+		@tcp_con.connect_to_events(TCP_Connection::ON_ALL_EVENTS, self)
+		self.init_events
+	end
+	
+	# Try to download using the given info.
+	# Resumes the download if required
+	def get(info, path)
+		# Init some variables
+		@info = DCC_File_Info.new(-1,
+								  info.irc_user,
+								  info.dccaddress_info,
+								  nil,
+								  "",
+								  nil,
+								  nil,
+								  DCC_Resume_Verification.new(false, 0, nil, 0, nil),
+								  false,
+								  ON_DCC_ERROR,
+								  "",
+								  0,
+								  0,
+								  nil,
+								  0)
+								  
+		# Check for correct tcp info
+		if !@info.address.address || !@info.address.port
+			@info.status = ON_DCC_ERROR
+			self.fire_event(ON_DCC_ERROR, $cfg.text.network.tcp.err_invalid_address)
+			return
+		end
+		
+		# Check for not routable addresses if required
+		if $cfg.network.dcc.block_nonroutable_addresses && !@info.address.address.routable_address?
+			@info.status = ON_DCC_ERROR
+			self.fire_event(ON_DCC_ERROR, $cfg.text.network.ip.err_notroutable_ip + " (#{@info.address.address.to_s})")
+			return
+		end
+		
+		# See if destination directory exists
+		if !path || !File.exist?(path)
+			@info.status = ON_DCC_ERROR
+			self.fire_event(ON_DCC_ERROR, $cfg.text.network.dcc.err_dir_notexist)
+			return
+		end
+		@info.joined_filename = File.join(path, info.filename)
+		@info.bytes_total = info.filesize
+		if File.exist?(@info.joined_filename)
+			self.resume
+		else
+			# No resume required.
+			# Init md5 if required and open connection
+			@info.verification.verified = true
+			@info.md5 = Digest::MD5.new if $cfg.network.xdcc.enable_md5
+			@tcp_con.open(@info.address.address.to_s, @info.address.port)
+		end
+	end
+	
+	# Resume a partially downloaded file
+	def resume
+		# See if file is writeable
+		if !File.writable?(@info.joined_filename)
+			@info.status = ON_DCC_ERROR
+			self.fire_event(ON_DCC_ERROR, $cfg.text.network.dcc.err_file_permission)
+			return
+		end
+		# As of now, no md5 checksum will be calculated for resumed packs in order to not
+		# slow down everything only due to md5 checksum calculation for the received data
+		@info.bytes_received = File.size(@info.joined_filename)
+		# Initialize verification
+		@info.verification.verified = false
+		@info.verification.bytes_mine = (@info.bytes_received > $cfg.network.dcc.verification_bytes) ? $cfg.network.dcc.verification_bytes : @info.bytes_received
+		if @info.bytes_received < @info.bytes_total
+			# Ask for DCC RESUME
+			@info.irc_user.irc_server.connect_to_events(IRC_Server::ON_USER_MESSAGE, self)
+			@info.irc_user.send("\001DCC RESUME #{@info.filename} #{@info.address.port} #{@info.bytes_received - @info.verification.bytes_mine}\001")
+		elsif @info.bytes_received == @info.bytes_total
+			# Pack already received. At least filesize tells us so. We therefore download a single byte from bot in 
+			# order to terminate the connection fast and make it available for other packs.
+			# This is not hack, well to be honest it is, but it is necessary due to dcc protocol limitations.
+			@info.verification.verified = true
+			@info.skip_download = true
+			@info.skip_status = ON_DCC_COMPLETED
+			@info.skip_reason = ""
+			@tcp_con.open(@info.address.address.to_s, @info.address.port)
+		else
+			@info.verification.verified = true
+			@info.skip_download = true
+			@info.skip_status = ON_DCC_ERROR
+			@info.skip_reason = $cfg.text.network.dcc.err_filesize_differ
+			@tcp_con.open(@info.address.address.to_s, @info.address.port)
+		end
+	end
+	
+	# Close current transfer if active
+	def close
+		if @info
+			@info.status = ON_DCC_ERROR
+			begin
+				@tcp_con.close if @tcp_con.connected?
+				@info.file.close if @info.file && !@info.file.closed?
+			rescue Exception
+			end
+		end
+	end
+	
+	def on_event(caller, event, eventargs)
+		case event
+			when IRC_Server::ON_USER_MESSAGE
+				return if @info.status == ON_DCC_ERROR
+				irc_user, message, targets, irc_msg = eventargs
+				# Check for private bot message
+				irc_server = @info.irc_user.irc_server
+				if ((@info.irc_user != irc_user) || !irc_server.me.has_name?(targets[0]))
+					return
+				end
+				if irc_msg.ctcp_command?
+					if dcc = $cfg.network.dcc.accept_regexp.match(message)
+						irc_server.disconnect_from_events(IRC_Server::ON_USER_MESSAGE, self)
+						# DCC Resume available, connect
+						@tcp_con.open(@info.address.address.to_s, @info.address.port)
+					end
+				end
+				
+			when TCP_Connection::ON_CONNECTED
+				if !@info.skip_download
+					# Open file (use binary mode windows platforms), append if file exists
+					begin
+						@info.file = File.new(@info.joined_filename, "a+b")
+					rescue Errno::EACCESS
+						@info.status = ON_DCC_ERROR
+						self.fire_event(ON_DCC_ERROR, $cfg.text.network.dcc.err_file_permission)
+						@tcp_con.close
+						return
+					end
+					if !@info.verification.verified
+						@info.file.seek(-@info.verification.bytes_mine, IO::SEEK_END)
+						@info.verification.md5_mine = Digest::MD5.new
+						@info.verification.md5_their = Digest::MD5.new
+						@info.verification.md5_mine << @info.file.read
+					else
+						@info.file.seek(0, IO::SEEK_END)
+					end
+					# Read verification bytes_mine
+					@info.file.sync = true
+					# Set internal stati and trigger event
+					@info.progress_timestamp = Time.now
+					@info.progress_bytes = 0
+					@info.status = ON_DCC_ESTABLISHED
+					self.fire_event(ON_DCC_ESTABLISHED)
+				else
+					if @info.skip_status == ON_DCC_COMPLETED
+						@info.status = ON_DCC_COMPLETED
+						self.fire_event(ON_DCC_COMPLETED, nil)
+					else
+						@info.status = ON_DCC_ERROR
+						self.fire_event(ON_DCC_ERROR, @info.skip_reason)
+					end
+					@tcp_con.close
+				end
+			
+			when TCP_Connection::ON_CLOSED
+				if @info.bytes_received != @info.bytes_total
+					if !@info.status == ON_DCC_ERROR
+						# No other code has yet triggered a download failed event
+						@info.status = ON_DCC_ERROR
+						self.fire_event(ON_DCC_ERROR, $cfg.text.network.xdcc.err_con_closed)
+					end
+				else
+					@tcp_con.close if @tcp_con.connected?
+					@info.status = ON_DCC_COMPLETED
+					self.fire_event(ON_DCC_COMPLETED, @info.md5)
+				end
+				
+			when TCP_Connection::ON_ERROR
+				# See if some other code has already triggered a download failed
+				if @info.status != ON_DCC_ERROR && @info.status != ON_DCC_COMPLETED
+					@info.status = ON_DCC_ERROR
+					self.fire_event(ON_DCC_ERROR, eventargs[0])
+				end
+				
+			when TCP_Connection::ON_DATA
+				if (@info.skip_download || @info.file.closed?)
+					return
+				end
+				
+				# Verify bytes if necessary
+				if !@info.verification.verified
+					self.add_verification_bytes(eventargs[0])
+					if @info.verification.bytes_mine == @info.verification.bytes_their
+						# Ready for md5 comparison
+						if @info.verification.md5_mine.hexdigest != @info.verification.md5_their.hexdigest
+							@info.status = ON_DCC_ERROR
+							self.fire_event(ON_DCC_ERROR, $cfg.text.network.dcc.err_verification)
+							@tcp_con.close
+							@info.file.close
+							return	
+						else
+							@info.verification.verified = true
+							# Write remaining bytes to file
+						end
+					else
+						# All bytes have been eat up by verification
+						return
+					end
+				end		
+				
+				# Increment download count after possible verification, as @info.bytes_received
+				# starts counting at local filesize.
+				@info.bytes_received += eventargs[0].length
+				# Ack data, as 4 byte integer big-endian network byte order
+				@tcp_con.send([@info.bytes_received].pack('N'))
+					
+				# Write to file
+				@info.file.syswrite(eventargs[0])
+				# Update MD5 if necessary
+				@info.md5 << eventargs[0] if @info.md5
+				# Update progress if necessary
+				@info.progress_bytes += eventargs[0].length
+				update_now = Time.now
+				if (time_elapsed = update_now - @info.progress_timestamp) >= 5
+					self.fire_event(
+							ON_DCC_PROGRESS, 
+							@info.bytes_received.to_f / @info.bytes_total * 100, 	# Percent done
+							@info.bytes_received,									# Total number of received bytes
+							(@info.progress_bytes.to_f / time_elapsed) / 1024)		# Speed
+					@info.progress_bytes = 0
+					@info.progress_timestamp = update_now
+				end
+				if @info.bytes_received == @info.bytes_total
+					# Finished downloading
+					@info.file.close if (@info.file && !@info.file.closed?)
+					# Wait for the bot closing the connection
+				end
+				
+		end
+	end
+	
+	def add_verification_bytes(bytes)
+		return if @info.verification.bytes_their == @info.verification.bytes_mine
+		their_length = bytes.length
+		if (@info.verification.bytes_their + their_length <= @info.verification.bytes_mine)
+			@info.verification.bytes_their += their_length
+			@info.verification.md5_their << bytes.slice!(0..-1)
+		else
+			req_length = @info.verification.bytes_mine - @info.verification.bytes_their
+			@info.verification.bytes_their += req_length
+			@info.verification.md5_their << bytes.slice!(0..req_length - 1)
+		end
+	end
+end

data/src/Network/DCC_Parser.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 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/IPAddr_Ext'
+
+DCCAddress_Info = Struct.new("DCCAddress_Info", :address, :port)
+DCCSEND_Info = Struct.new("DCCSEND_Info", :irc_user, :filename, :filesize, :dccaddress_info)
+
+# Listens for incoming dcc sends and forwards
+# them to its listeners
+class DCC_Parser
+	include Event_Publisher
+	
+	# -- Connectable events
+	
+	# User is offering a file. Args: DCCSEND_Info
+	ON_DCC_SEND = Event_Publisher.next_global_eventID
+	
+	def initialize(irc_server)
+		@irc_server = irc_server
+		@irc_server.connect_to_events(IRC_Server::ON_USER_MESSAGE, self)
+		self.init_events
+	end
+	
+	def on_event(caller, eventtype, eventargs)
+		case(eventtype)
+			when IRC_Server::ON_USER_MESSAGE
+				irc_user, message, targets, irc_msg = eventargs
+				if irc_msg.ctcp_command? && @irc_server.me.has_name?(targets[0])
+					# See if it is a dcc send
+					if dcc = $cfg.network.dcc.send_regexp.match(message)
+						# User is offerng a file
+						# Try converting the given address info
+						begin
+							ipaddy = IPAddr.new_ntoh([dcc[2].to_i].pack("N"))
+						rescue Exception 
+							ipaddy = nil
+						end
+						addr = DCCAddress_Info.new(ipaddy, dcc[3].to_i)
+						# Sanity check filename for invalid characters
+						filename = dcc[1].gsub(/\/{1,}|\\{1,}|\.{2,}/, "")
+						# Build DCCSEND_Info
+						info = DCCSEND_Info.new(irc_user, filename, dcc[4].to_i, addr)
+						self.fire_event(ON_DCC_SEND, info)
+					end
+				end
+				
+		end
+	end
+end

data/src/Network/IPAddr_Ext.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 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 'ipaddr'
+
+# Extends the IPAddr class with ip address range tests. 
+class IPAddr
+
+	# Split ip address at each dot
+	def split_at_dot(ip)
+		a = Array.new
+		ip.split(".") do |part|
+			a << part
+		end
+	end
+	
+	# Determine if the ip address is within the specified ip address range
+	# Example: "192.168.x.x" evals true for 192.168.0.0 to 192.168.255.255
+	# Example: "10.0.10-20.x" evals true for 10.0.10.0 to 10.0.19.255
+	def in_range?(ip_range)
+		ret = true
+		ip_parts = self.split_at_dot(self.to_s)
+		range_parts = self.split_at_dot(ip_range)
+		range_parts.each_with_index do |part, i|
+			if (reg = part.match(/^\d+$/))
+				# Is single ip address
+				if reg[0] != ip_parts[i]
+					ret = false
+					break
+				end
+			elsif reg = part.match(/^(\d+)-(\d+)$/)
+				ip_part = ip_parts[i].to_i
+				if ip_part < reg[1].to_i || ip_part >= reg[2].to_i
+					ret = false
+					break
+				end
+			end
+		end
+		ret
+	end
+	
+	# Determines if current ip address is routable over the internet or not
+	def routable_address?
+		return !self.in_range?("10.x.x.x") && 
+			   !self.in_range?("172.16-32.x.x") &&
+			   !self.in_range?("192.168.x.x") &&
+			   !self.local_loopback?
+	end
+	
+	# Determines if current ip address is representing a local loopback ip address
+	def local_loopback?
+		return self.in_range?("127.x.x.x")
+	end	
+end
+