XDCC-Fetch 1.386

data/src/Network/XDCC_Parser.rb

@@ -0,0 +1,253 @@
+# 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/Utilities/Timer.rb'
+require 'src/Network/XDCC_Announcement'
+require 'src/Network/XDCC_Pack.rb'
+require 'set'
+
+# Used for parsing xdcc announcements. During parsing, special precautions have been set 
+# in order to prevent endless parsing of single announcement. Detects full announcements and
+# broken/minimal announcements.
+class XDCC_Parser
+	include Event_Publisher
+
+	@@timer = Timer.new(3)
+
+	# -- Connectable events
+	
+	# Whenever a XDCC_Announcement completed. Args: XDCC_Announcement
+	ON_ANNOUNCEMENT = Event_Publisher.next_global_eventID
+
+	def initialize(proc_parse_ann, proc_parse_pack)
+		@unfinished_entities = Hash.new			# All currently unfinished announcements
+		@finished_entities = Array.new
+		@irc_servers = Array.new				# All irc_servers we are currently connected to
+		@parse_ann = proc_parse_ann				# Parses the beginning of an annoucement
+		@parse_pack = proc_parse_pack			# Parses a single offered pack
+		@mutex_unfinished = Mutex.new
+		@mutex_finished = Mutex.new
+		@max_idle_running = 5
+		self.init_events
+		@@timer.connect_to_events(Timer::ON_TIMER, self)
+	end
+	
+	# Prepare for deletion
+	def shutdown
+		@irc_servers.each do |server|
+			self.detach_from_server(server)
+		end
+		@@timer.disconnect_from_events(Timer::ON_TIMER, self)
+		@mutex_unfinished.sychronize do
+			@unfinished_entities.clear
+		end
+		@mutex_finished.sychronize do
+			@finished_entities.clear
+		end
+	end
+	
+	# Start tracking announcements on the given IRC_Server
+	def attach_to_server(irc_server)
+		if !@irc_servers.member?(irc_server)
+			@irc_servers << irc_server
+			irc_server.connect_to_events(IRC_Server::ON_USER_QUIT |
+													 IRC_Server::ON_USER_MESSAGE|
+													 IRC_Server::ON_SERVER_DISCONNECTED,
+													 self)
+		end
+	end
+	
+	# Stop tracking announcements on the specified IRC_Server
+	def detach_from_server(irc_server)
+		server = @irc_servers.delete(irc_server)
+		irc_server.disconnect_from_events(IRC_Server::ON_USER_QUIT |
+													    IRC_Server::ON_USER_MESSAGE|
+														IRC_Server::ON_SERVER_DISCONNECTED,
+													    self) if irc_server
+	end
+	
+	# A user has quit irc. Delete its announcements
+	def user_quit(irc_user)
+		@mutex_unfinished.synchronize do
+			@unfinished_entities.delete(irc_user)
+		end
+	end
+	
+	# A user sent a message. Parse message.
+	def user_message(irc_user, message, targets)
+		@mutex_unfinished.synchronize do
+			entity = @unfinished_entities[irc_user]
+			if entity
+				# An unfinished parsing entity was found
+				pack = @parse_pack.call(irc_user, message)
+				if pack
+					entity.ann.packs << pack
+					entity.last_update = Time.now
+					entity.idle_running_cnt = 0
+				elsif (ann = @parse_ann.call(irc_user, message, targets)) &&
+					  (entity.ann.ann_type == XDCC_Announcement::ANN_MINIMAL)
+					# Unfinished minimal/broken XDCC_Announcements are replaced if 
+					# a full announcement starts while still parsing the unfinished
+					# minimal/broken announcement.
+					@unfinished_entities.delete(irc_user)
+					entity = Parser_Entity.new
+					entity.ann = ann
+					entity.last_update = Time.now
+					entity.idle_running_cnt = 0
+					@unfinished_entities.store(irc_user, entity)
+				else
+					entity.idle_running_cnt += 1
+					if entity.idle_running_cnt >  @max_idle_running
+						@unfinished_entities.delete(irc_user)
+					end
+				end
+			else
+				# No unfinished parsing entity.
+				ann = @parse_ann.call(irc_user, message, targets)
+				if ann
+					entity = Parser_Entity.new
+					entity.ann = ann
+					entity.last_update = Time.now
+					entity.idle_running_cnt = 0
+					@unfinished_entities.store(irc_user, entity)
+				elsif pack = @parse_pack.call(irc_user, message)
+					entity = Parser_Entity.new
+					entity.ann = XDCC_Announcement.new(irc_user, XDCC_Announcement::ANN_MINIMAL)
+					entity.ann.targets = targets
+					entity.ann.packs << pack
+					entity.last_update = Time.now
+					entity.idle_running_cnt = 0
+					@unfinished_entities.store(irc_user, entity)
+				end
+			end
+			if entity && entity.ann.completed?
+				# A full announcement has finished
+				@unfinished_entities.delete(irc_user)
+				@mutex_finished.synchronize do
+					@finished_entities << entity
+				end
+			end
+		end
+	end
+	
+	def on_timer(timestamp)
+		# Broadcast finished packs
+		@mutex_finished.synchronize do
+			@finished_entities.each do |entity|
+				self.fire_event(ON_ANNOUNCEMENT, entity.ann)
+			end
+			@finished_entities.clear
+		end
+		# Kill broken announcements
+		@mutex_unfinished.synchronize do
+			@unfinished_entities.delete_if do |irc_user, entity|
+				ret = (timestamp - entity.last_update) > 30
+				if ret && entity.ann.ann_type == XDCC_Announcement::ANN_MINIMAL
+					# More then 30 seconds have passed since last bot message
+					# Treat broken announcement as completed
+					@mutex_finished.synchronize do
+						@finished_entities << entity
+					end
+				end
+				ret
+			end
+		end
+	end
+	
+	def server_disconnect(irc_server)
+		@mutex_unfinished.synchronize do
+			@unfinished_entities.delete_if do |irc_user, entity|
+				irc_user.irc_server == irc_server
+			end
+		end
+		@mutex_finished.synchronize do
+			@finished_entities.delete_if do |entity|
+				entity.ann.irc_user_bot.irc_server == irc_server
+			end
+		end
+	end
+		
+	def on_event(caller, eventtype, eventargs)
+		case eventtype
+			when IRC_Server::ON_USER_QUIT
+				self.user_quit(eventargs[0])
+			
+			when IRC_Server::ON_USER_MESSAGE
+				self.user_message(eventargs[0], eventargs[1], eventargs[2])
+			
+			when IRC_Server::ON_SERVER_DISCONNECTED
+				self.server_disconnect(caller)
+					
+			when Timer::ON_TIMER
+				self.on_timer(eventargs[0])
+				
+			
+		end
+	end
+	
+	def XDCC_Parser.iroffer_parser
+		# Parses the start of a full announcement
+		proc_ann = proc do |irc_user, message, targets|
+			if reg = $cfg.network.xdcc.offer_regexp.match(message)
+				ann = XDCC_Announcement.new(irc_user)
+				ann.pack_cnt = reg[1].to_i
+				ann.openslot_cnt = reg[2].to_i
+				ann.slot_cnt = reg[3].to_i
+				ann.targets = targets
+				# Try to fetch queue info
+				if queue_info = $cfg.network.xdcc.queue_regexp.match(message)
+					ann.openqueue_cnt = queue_info[1].to_i
+					ann.queue_cnt = queue_info[2].to_i
+				end
+				ann
+			else
+				nil
+			end
+		end
+		
+		# Parses a single pack within a full announcement
+		proc_pack = proc do |irc_user, message|
+			# Example: \002#1 \002 0x [123K] iroffer1.3.b09.tgz
+			if reg = $cfg.network.xdcc.pack_regexp.match(message)
+				pack = XDCC_Pack.new(irc_user)
+				pack.pack_nr = reg[1].to_i;
+				pack.download_cnt = reg[2].to_i;
+				pack.size = reg[3];
+				# Delete all style and/or color codes in pack name and leading/trailing spaces afterwards
+				pack.name = IRC_Message.delete_spaces(IRC_Message.delete_control_codes(reg[4]))
+				pack
+			else
+				nil
+			end
+		end
+		XDCC_Parser.new(proc_ann, proc_pack)
+	end
+end
+
+# Structure used while parsing an announcement
+class Parser_Entity
+	attr_accessor :ann
+	attr_accessor :last_update
+	attr_accessor :idle_running_cnt
+end

data/src/Translations/README

@@ -0,0 +1,61 @@
+= XDCC-Fetch Translation HOW-TO
+
+Creating a new translation is very simple, just follow the next steps.
+
+1. Download the latest version of XDCC-Fetch, extract it, and move to
+   the directory "src/Translations".
+
+1. Copy the file "en.rb" to a filename that matches your language. (E.g.
+   "de.rb" if you want to translate into German)
+
+1. Open the newly created file with your favourite texteditor, and find
+   the following section:
+
+     lang = $cfg.text.en
+     lang.language_name = "English"
+     
+1. Now change the first line to contain the language shortcut (e.g.
+   "de", do not use whitespace or any other special character), and
+   the second line to contain the name:
+
+     lang = $cfg.text.de
+     lang.language_name = "Deutsch"
+
+1. That's all you need to set up, now just translate all the english texts
+   into your language. Take care not to forget any of the tabulators
+   ('\t'), they are important.
+
+1. After translating, run the script 'check_translations' to check if
+   your translation is ok:
+   
+     ./check_translations de.rb
+     
+   This prints everything that might be a problem, for example:
+   
+     missing translation items: none :-)
+
+     untranslated: 12 items :-(
+         $cfg.text.de.bot (in English: "Bot")
+         $cfg.text.de.channel (in English: "Channel")
+         $cfg.text.de.channel_name (in English: "Channel Name")
+         $cfg.text.de.name (in English: "Name")
+         $cfg.text.de.of (in English: "/")
+         $cfg.text.de.packs (in English: "")
+         $cfg.text.de.port (in English: "Port")
+         $cfg.text.de.revision (in English: "Revision")
+         $cfg.text.de.server (in English: "Server")
+         $cfg.text.de.status (in English: "Status")
+         $cfg.text.de.submit (in English: "&Submit")
+         $cfg.text.de.version (in English: "Version")
+
+     translations that can be removed: none :-)
+
+   If there are any missing translations, you may have accidently removed
+   something, this should definitely be fixed.
+   
+   As you can see, untranslated items might not be a problem, sometimes
+   terms are the same in several languages.
+   
+   Translations that can be removed are translations that exist in your
+   translation, but not in the english reference language.
+   

data/src/Translations/check_translations

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+if __FILE__ == $0
+	class Translation_Checker
+		def initialize(languages)
+			require '../Utilities/Recursive_Open_Struct'
+			$cfg = Recursive_Open_Struct.new
+			require 'en'
+			
+			@missing = [ ]
+			@untranslated = [ ]
+			@unrequired = [ ]
+		
+			if languages.empty?
+				# load all languages
+				Dir['*.rb'].each do |file|
+					require file
+				end
+			else
+				languages.each do |lang_file|
+					require lang_file
+				end
+			end
+			# english is the reference language
+			@reference_language = $cfg.text.en
+		end
+		
+		def self.usage
+			puts "usage: #{__FILE__} [language.rb...]"
+		end
+		
+		def print_status(ary, str)
+			if ary.empty?
+				puts "#{str} none :-)"
+			else
+				puts "#{str} #{ary.size} items :-("
+				ary.each do |item|
+					puts "\t" + item
+				end
+			end
+			puts "\n"
+		end
+		
+		def check
+			$cfg.text.attrs.each do |lang_name|
+				next if $cfg.text[lang_name] == @reference_language
+				@attr_stack = [ "$cfg.text", lang_name]
+				check_attrs(@reference_language, $cfg.text[lang_name])
+			end
+			# print status
+			print_status(@missing, "missing translation items:")
+			print_status(@untranslated, "untranslated:")
+			print_status(@unrequired, "translations that can be removed:")
+		end
+		
+		# checks a language against a reference language
+		def check_attrs(reference, lang)
+			reference.attrs.each do |attr|
+				@attr_stack.push attr
+				if reference[attr].class == Recursive_Open_Struct && lang[attr].class == Recursive_Open_Struct
+					check_attrs(reference[attr], lang[attr])
+				else
+					if lang.class != Recursive_Open_Struct || !lang.attrs.include?(attr)
+						@missing.push(@attr_stack.join(".") + " (in English: \"#{reference[attr]}\")")
+					elsif lang[attr] == reference[attr]
+						@untranslated.push(@attr_stack.join(".") + " (in English: \"#{reference[attr]}\")")
+					end
+				end
+				@attr_stack.pop
+			end
+			(lang.attrs - reference.attrs).each do |attr|
+				@unrequired.push((@attr_stack+[attr]).join("."))
+			end
+		end
+	end
+	
+	# execute it
+	if ARGV.include?("-h") || ARGV.include?("-help") || ARGV.include?("--help") || ARGV.include?("/?")
+		Translation_Checker.usage
+	else
+		t = Translation_Checker.new(ARGV)
+		t.check
+	end
+end

data/src/Translations/de.rb

@@ -0,0 +1,140 @@
+# Copyright (c) 2004, 2005 Christoph Heindl and Martin Ankerl
+# 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 and Martin Ankerl 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.
+
+# Language definition #################################
+
+lang = $cfg.text.de
+lang.language_name = "German"
+
+lang.about = "&�ber\t\tZeigt �ber-Dialog"
+lang.help = "&Hilfe"
+lang.add_server = "&Server Hinzuf�gen\tCtrl-A\tF�gt einen IRC Server hinzu und verbindet sich"
+lang.remove_server = "Entfernen\t\tBeendet Verbindung mit IRC Server und entfernt ihn"
+lang.add_channel = "&Channel Hinzuf�gen\t\tF�gt einen Channel hinzu (join)"
+lang.add_channel_dialog = "Channel Hinzuf�gen"
+lang.remove_channel = "Entfernen\t\tEntfernt einen Channel (part)"
+lang.specify_server = "Server Daten"
+
+lang.server = "Server"
+lang.port = "Port"
+lang.nickname = "Spitzname"
+lang.password = "Passwort"
+lang.channel = "Channel"
+
+lang.file = "&Datei"
+lang.quit = "&Beenden\tCtrl-X\tSchlie�t die Applikation und beendet alle aktiven Verbindungen"
+
+lang.speed_widget_init = "0.0 kb\tZeigt Gesamtdownloadgeschwindigkeit in Kilobyte\tZeigt Gesamtdownloadgeschwindigkeit in Kilobyte"
+
+lang.enter_ip_or_domain = "IP-Adresse oder Domain-Name"
+lang.the_servers_port = "Port des Servers"
+
+lang.channel_name = "Channel Name"
+lang.connections = "Verbindungen\tRechte Maustaste im unteren Fenster dr�cken\num einen IRC Server und Channel hinzuzuf�gen\tRechte Maustaste im unteren Fenster dr�cken um einen IRC Server und Channel hinzuzuf�gen"
+lang.search = "Suche\tSuchanfragen in die Box eingeben\tSuchanfragen in die Box eingeben"
+
+lang.free_slots = "\tZeige/Verstecke Pakete deren Bot freie Slots hat\tZeige/Verstecke Pakete deren Bot freie Slots hat"
+lang.slots_unknown = "\tZeige/Verstecke Pakete deren Bot's Slot-status unbekannt ist\tZeige/Verstecke Pakete deren Bot's Slot-status unbekannt ist"
+lang.no_free_slots = "\tZeige/Verstecke Pakete deren Bot keine freien Slots hat\tZeige/Verstecke Pakete deren Bot keine freien Slots hat"
+
+lang.what_do_you_want_to_fetch_today = "Was darf's heute sein?"
+
+lang.bot = "Bot"
+lang.name = "Name"
+lang.size = "Gr��e"
+
+lang.active = "Aktiv\tZeigt aktive Downloads\tZeigt aktive Downloads"
+lang.completed = "Fertig\tZeigt fertige Downloads\tZeigt fertige Downloads"
+lang.error = "Abgebrochen\tZeigt abgebrochene Downloads\tZeigt abgebrochene Downloads"
+
+lang.download = "&Herunterladen\t\tLade dieses Pack herunter"
+lang.status = "Status"
+lang.target_directory = "Zielverzeichnis"
+lang.clear_list = "&L�sche Liste"
+
+lang.download_waiting = "Warte"
+lang.download_requesting = "Anfordern"
+lang.download_timeout = "Zeit�berschreitung"
+lang.download_cancelling = "Breche ab"
+lang.download_started = "Lade herunter"
+lang.download_finished = "Fertig"
+lang.download_failed = "Fehler"
+lang.queue_remote = "Bot Warteschlange: "
+lang.queue_local = "Lokale Warteschlange: "
+lang.speed = "Geschwindigkeit"
+
+lang.version = "Version"
+lang.revision = "Revision"
+lang.credits = "Entwickler"
+lang.thanks = "Besonderer Dank an"
+
+
+# "x of x packs"
+lang.of = "/"
+lang.packs = ""
+lang.status_label_tooltip = "\tZeigt Anzahl der sichtbaren\nPakete / Gesamtanzahl der Pakete\tZeigt Anzahl der sichtbaren Pakete / Gesamtanzahl der Pakete"
+
+lang.cancel = "&Abbrechen\t\tBricht das Herunterladen ab"
+lang.submit = "&Submit"
+
+lang.md5.disabled = "unbekannt"
+lang.md5.unavailable = "unbekannt"
+lang.md5.ok = "Ok"
+lang.md5.failed = "Falsch"
+
+lang.checksum = "Pr�fsumme"
+
+lang.speed = "Geschwindigkeit"
+
+lang.download_finished_box = "Fertig Heruntergeladen"
+
+lang.show_warning = "&Fehler Zeigen"
+
+
+# Network messages
+lang.network.ip.err_notroutable_ip = "IP Adresse nicht kann nicht gerouted werden"
+lang.network.tcp.err_invalid_address = "Ung�ltige Zielhost Angabe"
+lang.network.tcp.err_con_closed = "Verbindung ist geschlossen"
+lang.network.tcp.err_con_active = "Verbindung ist gerade aktiv"
+lang.network.tcp.err_con_timeout = "Zeit�berschreitung beim Verbinden"
+lang.network.tcp.err_con_no_remote = "Keine Adresse oder Port angegeben"
+lang.network.dcc.err_dir_notexist = "Zielverzeichnis existiert nicht"
+lang.network.dcc.err_file_permission = "Kann Datei nicht schreiben"
+lang.network.dcc.err_filesize_differ = "Dateigr��e unterschiedlich"
+lang.network.dcc.err_verification = "Dateiverifikation fehlgeschlagen"
+lang.network.xdcc.err_punish_slowness = "Downloadgeschwindigkeit zu gering f�r Bot"
+lang.network.xdcc.err_pack_already_requested = "Paket bereits angefordert"
+lang.network.xdcc.err_max_packs_requested = "Maximale Anzahl von Paketen vom Bot angefordert"
+lang.network.xdcc.err_bot_left = "Bot vom IRC Server ausgestiegen"
+lang.network.xdcc.err_server_disconnect = "Verbindung zum IRC Server verloren"
+lang.network.xdcc.err_con_closed = "Verbindung wurde beendet"
+lang.network.xdcc.err_no_answer = "Keine XDCC Antwort"
+lang.network.xdcc.err_ip_address_conversion = "IP Adresse kann nicht festgestellt werden"
+lang.network.xdcc.cancel_download_default = "Abbruch durch Benutzer"
+
+
+lang.message.connection_error_title = "Verbindungsfehler"
+lang.message.connection_error = "Verbindung zu IRC-Server abgebrochen"
+lang.connect = "&Verbinden"
+lang.disconnect = "&Trennen"