ratchet 0.3.0

data/gem_bin/ratchet

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+#get the datadir, which is relative to this file's location
+DATADIR = File.expand_path(__FILE__).
+	split(File::SEPARATOR)[0...-2].join(File::SEPARATOR)+File::SEPARATOR+'share'
+begin
+	require 'ratchet'
+rescue LoadError
+	require 'rubygems'
+	require_gem 'ratchet'
+end
+
+$0 = "ratchet"
+
+#start the ball rolling...
+begin
+	main = Ratchet::Main.new
+	main.start
+rescue Interrupt => detail
+	puts 'got keyboard interrupt'
+	main.windows.each{|win| win.quit(false)}
+	main.quit
+end

data/lib/ratchet.rb

@@ -0,0 +1,613 @@
+=begin
+	This file is part of the Ratchet project, a client for Icecap.
+    Copyright (C) 2005-6  Andrew Thompson
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+=end
+
+#### ratchet.rb ####
+# This file contains the core methods of the Ratchet::Main class,
+# which is the object at the heart of a ratchet instance
+####
+
+require 'libglade2'
+require 'socket'
+require 'rbconfig'
+require 'base64'
+require 'thread'
+require 'monitor'
+require 'yaml'
+require 'scw'
+require 'observer'
+require 'pathname'
+
+require 'ratchet/ratchet-version'
+
+require 'ratchet/utils'
+
+require 'ratchet/contrib/instance_exec'
+
+if RUBY_PLATFORM.include?('win32') or RUBY_PLATFORM.include?('mingw32')
+	$platform = 'win32'
+	$ratchetfolder = File.join(ENV['APPDATA'], 'ratchet')
+else
+	$platform = 'linux'
+	$ratchetfolder = File.join(ENV['HOME'], '.ratchet')
+end
+
+# begin
+#     $:.unshift "lib"
+#     require 'net/ssh'
+#     $netssh = true
+# rescue LoadError
+	$netssh = false
+# end
+
+$args = {}
+
+Thread.current.priority = 1
+
+def parse_args
+	args = ARGV
+	args.each do |arg|
+		while arg[0].chr == '-'
+			arg = arg[1, arg.length]
+		end
+		name, value = arg.split('=')
+		if value
+			$args[name] = value
+		else
+			$args[name] = true
+		end
+	end
+end
+
+parse_args
+
+#useful for debugging
+Thread.abort_on_exception = true
+
+#load all my home rolled ruby files here
+require 'ratchet/help'
+require 'ratchet/constants'
+require 'ratchet/queue'
+require 'ratchet/lines'
+require 'ratchet/configuration'
+require 'ratchet/items'
+require 'ratchet/bufferparser'
+require 'ratchet/plugins'
+require 'ratchet/aliases'
+require 'ratchet/commandparser'
+require 'ratchet/eventparser'
+require 'ratchet/replyparser'
+require 'ratchet/tabcomplete'
+require 'ratchet/users'
+require 'ratchet/gtk/userlistview'
+require 'ratchet/gtk/bufferview'
+require 'ratchet/commandbuffer'
+# #require 'ratchet/buffers'
+require 'ratchet/networks'
+require 'ratchet/gtk/bufferlistview'
+require 'ratchet/replies'
+require 'ratchet/connections'
+require 'ratchet/gtk/keybinding'
+require 'ratchet/gtk/mainwindow'
+require 'ratchet/gtk/configwindow'
+require 'ratchet/gtk/connectionwindow'
+require 'ratchet/gtk/networkpresenceconf'
+require 'ratchet/gtk/linkwindow'
+require 'ratchet/gtk/pluginwindow'
+require 'ratchet/gtk/pluginconfig'
+
+module Ratchet
+	class Main
+		attr_reader :windows, :replies, :connectionwindow, :drift, :config, :console, :networks, :protocols, :buffers
+		#extend Plugins
+		include PluginAPI
+		include EventParser
+		include ReplyParser
+		#include CommandParser
+
+		def initialize
+			@connection = nil
+			@replies = {}
+			@keys = {}
+			@drift = 0
+			@config = Configuration.new
+			@windows = []
+			@networks = ItemList.new(Network)
+			@protocols = ItemList.new(Protocol)
+			@inputqueue = MessageQueue.new
+			@outputqueue = MessageQueue.new
+			@console = ConsoleBuffer.new(self)
+
+			@buffers = {}
+			@inputwatcher = Watcher.new(@inputqueue) {|x| command_parse(*x)}
+			@outputwatcher = Watcher.new(@outputqueue) {|x| handle_output(x)}
+			Plugin.main = self
+		end
+
+		# start the GUI
+		def start
+			Gtk.init
+			settings = Gtk::Settings.default
+			settings.gtk_entry_select_on_focus = false
+
+			reply_reaper
+			@connectionwindow = ConnectionWindow.new(self) unless @connectionwindow and @connectionwindow.open?
+			if @connectionwindow.autoconnect == true
+				@connectionwindow.start_connect
+			end
+			Gtk.main
+		end
+
+		#connect to icecap, called from connectionwindow
+		def connect(type, settings)
+			return if @connection
+			@connectionwindow.send_text('Connecting...')
+			begin
+				@connection = ConnectionFactory.spawn(type, self, settings, @connectionwindow)
+			rescue IOError
+				@connectionwindow.send_text("Error: "+$!)
+				return
+			rescue ArgumentError
+				@connectionwindow.send_text("Error: "+$!+" This is a bug.  Please report it.")
+				return
+			end
+
+			@connectionwindow.send_text("Connected to irssi2!")
+			@connection.listen(self)
+
+			#@config.get_config
+			unless $args['noconfig']
+				send_command('getconfig', 'config get;*')
+				while @replies['getconfig']
+					sleep 1
+				end
+			end
+			restyle
+			@console.buffer.redraw
+
+			@config['plugins'].each {|plugin| plugin_load(plugin)}
+			@config['plugins'] = Plugin.list.values.map{|x| x[:name]}#trim any plugins that failed to load
+			@config['windows'].each do |hash|
+				puts hash.inspect
+				window = MainWindow.new(self, hash)
+				@windows.push(window)
+				window.draw_from_config
+			end
+
+			@connectionwindow.destroy
+
+			send_command('protocols', 'protocol list')
+		end
+
+		# Creates a thread which polls events without completed replies and 
+		# processes depending on the state of the reply.
+		# TODO: This is an ugly function
+		def reply_reaper
+			# Create the thread, turn down the priority, and loop forever
+			@reaperthread = Thread.new do
+				Thread.current.priority = -3
+				while true
+					@replies.each do |key, reply|
+						if reply.complete
+							@replies.delete(key)
+							reply_parse(reply)
+						elsif (Time.new - reply.start).to_i > 15
+							if reply.retries < 1
+								@replies.delete(key)
+								send_command(key, reply.origcommand)
+								@replies[key].retries = reply.retries+1
+							else
+								@replies.delete(key)
+							end
+						end
+					end
+					sleep 5
+				end
+			end
+		end
+
+
+		#TODO: This is an ugly function
+		def syncchannels
+			@syncchannels = true
+			Thread.new do
+				Thread.current.priority = -2
+				@windows.each do |win|
+					win.buffers.channels.each do |channel|
+						if !channel.usersync and channel.joined?
+							send_command('listchan-'+channel.network.name+channel.name, "channel names;network="+channel.network.name+";channel="+channel.name+";mypresence="+channel.presence)
+							while !channel.usersync
+								sleep 2
+							end
+						end
+					end
+
+					win.buffers.channels.each do |channel|
+						if !channel.eventsync and channel.joined?
+							send_command('events-'+channel.network.name+channel.name, 'event get;end=*;limit=100;filter=&(channel='+channel.name+')(network='+channel.network.name+')(mypresence='+channel.presence+')(!(|(event=client_command_reply)(init=*)(deinit=*)(raw=*)))(time>1)')
+							while !channel.eventsync
+								sleep 2
+							end
+						end
+					end
+
+					#~ @serverlist.servers.each do |server|
+					#~ server.channels.each do |channel|
+					#~ if !channel.usersync and channel.connected
+					#~ send_command('listchan-'+server.name+channel.name, "channel names;network="+server.name+";channel="+channel.name+";mypresence="+server.presence)
+					#~ while !channel.usersync
+					#~ sleep 2
+					#~ end
+					#~ end
+					#~ end
+
+					#~ server.channels.each do |channel|
+					#~ if !channel.eventsync and channel.connected
+					#~ send_command('events-'+server.name+channel.name, 'event get;end=*;limit=100;filter=&(channel='+channel.name+')(network='+server.name+')(mypresence='+server.presence+')(!(|(event=client_command_reply)(init=*)(deinit=*)(raw=*)))(time>1)')
+					#~ while !channel.eventsync
+					#~ sleep 2
+					#~ end
+					#~ end
+					#~ end
+					#~ if server.connected
+					#~ end
+					#~ end
+				end
+			end
+			@syncchannels = nil
+		end
+
+		# Resets the scw configuration after a ratchet configuration change
+		# This is an ugly function, just by the means it has to be done,
+		# but there's nothing that can be done about it for the time being
+		# since the SCW API is shitty in this respect.
+		def restyle
+			even = @config['scw_even'].to_hex
+			odd = @config['scw_odd'].to_hex
+
+			#		 puts even, odd
+
+			Gtk::RC.parse_string("style \"scwview\" {\
+							ScwView::even-row-color = \"#{even}\"\
+							ScwView::odd-row-color = \"#{odd}\"\
+							ScwView::column-spacing = 5\
+							ScwView::row-padding = 2\
+							}\n\
+							widget \"*.ScwView\" style \"scwview\"")
+
+		end
+
+		#CRITICAL TODO: AUGH MY EYES!
+		def remove_buffer(buffer)
+			@buffers.delete_if{|k,v| v == buffer}
+		end
+
+		def add_buffer(*key)
+			if buffer = find_buffer(*key)
+				return buffer
+			end
+			#puts key.inspect
+			if key[2]
+				testkey = key[0..2]
+				if network = find_buffer(*key[0..1])
+					buffer = ChannelBuffer.new(key[2], network, self)
+				else
+					puts "undefined network #{key[0..1].inspect}"
+				end
+			elsif key[3]
+				testkey = [key[0], key[1], key[3]]
+				if network = find_buffer(*key[0..1])
+					buffer = ChatBuffer.new(key[3], network, self)
+				else
+					puts "undefined network #{key[0..1].inspect}"
+				end
+			else
+				testkey = key[0..1]
+				buffer = NetworkBuffer.new(key[0], key[1], self)
+			end
+			assign_buffer_to_window(buffer) if buffer
+			@buffers[testkey] = buffer
+			buffer
+		end
+
+		def find_buffer(*key)
+			if key[2]
+				testkey = key[0..2]
+			elsif key[3]
+				testkey = [key[0], key[1], key[3]]
+			else
+				testkey = key[0..1]
+			end
+
+			@buffers[testkey]
+		end
+
+		def assign_buffer_to_window(buffer)
+			#TODO - filter to allow intelligent buffer assignment
+			@windows[0].buffers.add_buffer(buffer)#if @windows[0]
+		end
+
+		def reassign_buffer_to_window(buffer, window)
+			#TODO
+		end
+
+		def find_windows_with_buffer(buffer)
+			res = []
+			@windows.each do |window|
+				res << window if  window.buffers.include? buffer
+			end
+			res
+		end
+
+		#what do do when we get disconnected from icecap
+		def disconnect
+			@connection.close if @connection
+			@connection = nil
+			@serverlist.servers.each do |server|
+				server.disconnect
+				server.channels.each {|channel| channel.disconnect}
+			end
+			@connectionwindow = ConnectionWindow.new unless @connectionwindow and @connectionwindow.open?
+		end
+
+		#connect to a network
+		def network_add(name, protocol, address, port)
+			unless @serverlist.get_network_by_name(name)
+				send_command('addnet', "network add;network="+name+";protocol="+protocol)
+				temp = "gateway add;host="+address+";network="+name
+				temp += ";port="+port if port != '' and port
+				send_command('addhost', temp)
+				@networks.add(name, protocol)
+			else
+				throw_error('Network '+network+' is already defined')
+			end
+		end
+
+		def network_connect(network, presence)
+			if !@serverlist.get_network_by_name(network)  and !@networks[network]
+				throw_error('Undefined network '+network)
+			elsif !@serverlist[network, presence] and !@networks[network].presences[presence]
+				throw_error('Undefined presence '+presence)
+			else
+				send_command('connect', "presence connect;network="+network+";mypresence="+presence)
+			end
+		end
+
+		def presence_add(network, presence)
+			if !@serverlist.get_network_by_name(network) and !@networks[network]
+				throw_error('Undefined network '+network)
+			elsif @serverlist[network, presence] or @networks[network].presences[presence]
+				return true
+			else
+				cmdstring = "presence add;mypresence="+presence+";network="+network
+				if @keys[presence] and @keys[presence]['silc_pub']
+					cmdstring += ";pub_key="+@keys[presence]['silc_pub']+";prv_key="+@keys[presence]['silc_priv']
+					cmdstring += ";passphrase="+@keys[presence]['silc_pass'] if @keys[presence]['silc_pass']
+				end
+
+				cmdstring.gsub!("\n", "\\n")
+				send_command('addpres', cmdstring)
+				@networks[network].add_presence(presence)
+				return true
+			end
+			return false
+		end
+
+		def channel_add(network, presence, channel)
+			if @serverlist[network, presence] and channel
+				send_command('add', 'channel add;network='+network+';mypresence='+presence+';channel='+channel)
+			else
+				throw_error('Invalid Network')
+			end
+		end
+
+		def throw_error(error, buffer=@console)
+			line = Line[ERR => 'Client Error: '+error]
+			buffer.send_user_event(line, EVENT_ERROR)
+		end
+
+		def throw_message(message, buffer=@console)
+			line = Line[MSG => 'Client Message: '+message]
+			@console.send_user_event(line, EVENT_NOTICE)
+		end
+
+		def queue_input(msg)
+			@inputqueue.enq(msg)
+		end
+
+		def queue_output(msg)
+			@outputqueue.enq(msg)
+		end
+
+		def parse_line(line)
+			@console.send_user_event({'msg' =>line.chomp}, EVENT_NOTICE) if $args['debug']
+			queue_output(line)
+		end
+
+		#split by line and parse each line
+		def parse_lines(lines)
+			lines.each do |line|
+				@console.send_user_event({'msg' =>line.chomp}, EVENT_NOTICE) if $args['debug']
+				queue_output(line)
+			end
+		end
+
+		#send a command to irssi2
+		def send_command(tag, command, length=nil)
+			if !@connection
+				disconnect
+				return
+			end
+
+			@replies[tag] = Reply.new(self, tag, command)
+
+			if length
+				cmdstr = '+'+length.to_s+';'+tag+';'+command+"\n"
+			else
+				cmdstr = tag+';'+command+"\n"
+			end
+
+			puts "[SENT] #{cmdstr}" if $args['debug']
+
+			sent = @connection.send(cmdstr)
+
+			if !sent
+				@connection = nil
+				disconnect
+			end
+			return @replies[tag]
+		end
+
+		#handle output from icecap
+		def handle_output(string)
+			return if string.length == 0
+
+			tag, event = string.split(';', 2)
+
+			#its an event
+			if tag == '*'
+				type, event = event.split(';', 2)
+				#puts type, event
+				line= Line.new
+
+				line[:event_type] = type
+				line['original'] = string
+
+				items = event.split(';')
+
+				items.each do |x|
+					vals = x.split('=', 2)
+					if vals[1] and vals[1] != ''
+						line[vals[0].to_sym] = unescape(vals[1])
+					elsif x.count('=') == 0
+						line[x.to_sym] = true
+					end
+				end
+				calculate_clock_drift(line['time']) if line['time']
+
+				if @config['canonicaltime'] == 'client'
+					line[:time] = Time.at(line[:time].to_i + @drift)
+				end
+
+				event_parse(line)
+				#its a reply
+			else
+				if @replies[tag]
+					reply = @replies[tag]
+					Thread.new do
+						#Thread.current.priority = -3
+						reply.addline(string)
+					end
+					if @replies[tag] and @replies[tag].complete
+						Thread.new do
+							reply_parse(reply)
+							@replies.delete(reply.name)
+						end
+					end
+				end
+				return
+			end
+		end
+
+		#keep an eye on the difference between client & server time
+		#TODO: There could be a better way to do this
+		def calculate_clock_drift(servertime)
+			server = Time.at(servertime.to_i)
+			client = Time.new
+			@drift = (client - server).to_i
+		end
+
+		def handle_error(line, reply)
+			channel ||= reply.command['channel']
+			network ||= reply.command['network']
+			presence ||= reply.command['mypresence']
+
+			puts line
+			return
+
+			if network = assign_window.buffers.find_network(network, presence)
+				target = network
+			elsif @serverlist[network, presence] and channel = @serverlist[network, presence][channel]
+				target = channel
+			else
+				target = @window.networks.console
+			end
+
+			if line['bad']
+				err = 'Bad line - '+reply.origcommand
+			elsif line['args']
+				err = 'Bad arguments - '+reply.origcommand
+			elsif line['state']
+				err = 'Bad state - '+reply.origcommand
+			elsif line['unknown']
+				err = 'Unknown command - '+reply.command['command']
+			elsif line['nogateway']
+				err = 'No gateway'
+				err += ' for network - '+reply.command['network'] if reply.command['network']
+			elsif line['noprotocol']
+				err = 'Invalid Protocol'
+				err += ' - '+reply.command['protocol'] if reply.command['protocol']
+			elsif line['noconnection']
+			elsif line['nonetwork']
+				err = 'Invalid network'
+				err += ' - '+reply.command['network'] if reply.command['network']
+			elsif line['nopresence']
+				err = 'Invalid or protected presence'
+				err += ' - '+reply.command['mypresence'] if reply.command['mypresence']
+			elsif line['exists']
+				err ='Already Exists'
+			elsif line['notfound']
+				err = 'Not Found'
+			elsif line['reply_lost']
+				err = 'Reply to command - '+reply.origcommand+' lost.'
+			else
+				puts 'unhandled error '+line['original']
+				return
+			end
+
+			@window.networks.send_user_event(target, Line['err' => err], EVENT_ERROR)
+		end
+
+		def quit
+			#if the connection is dead, don't bother trying to comunicate with irssi2
+			if !@connection
+				do_quit
+
+				#update the config and wait for quit response
+			else
+				send_command('sendconfig', @config.changes)
+				send_command('quit', 'quit')
+#             puts 'sending quit (timeout 5 seconds...)'
+#             sleep 5
+#                 unless @quit
+#                 puts 'failed to get quit confirmation, doing it manually'
+#                  do_quit
+#             end
+			end
+			true
+		end
+
+		def do_quit
+			@connection.close if @connection
+			@reaperthread.kill if @reaperthread
+			Gtk.main_quit
+			puts 'bye byeeeeee...'
+			exit
+		end
+	end
+end