torchat 0.0.1.rc.1

data/doc/protocol/typing.md

@@ -0,0 +1,41 @@
+Typing notice extension lifecycle and packet description
+========================================================
+This is a simple extension to support typing notice.
+
+They're simply packets sent to the buddy you're talking to to tell them your current
+typing status.
+
+Packets
+-------
+Following is a list and description of the packets in the groupchat extension.
+
+In the examples `>` refers to packet sent to the buddy, while `<` refers to packet received
+from the buddy.
+
+### Typing Start
+
+This packet is used to tell the other end we started typing.
+
+```
+> typing_start
+```
+
+### Typing Thinking
+
+This packet is used to tell the other end we stopped typing momentarily to think.
+
+This packet can be not sent at all, it's just a fancy addition because BitlBee supports it.
+
+```
+> typing_thinking
+```
+
+### Typing Stop
+
+This packet is used to tell the other end we stopped typing.
+
+This packet can avoid being sent if the message is sent.
+
+```
+> typing_stop
+```

data/etc/torchat.yml

@@ -0,0 +1,12 @@
+---
+name:        Anonymous
+description: This is a description.
+
+connection:
+  outgoing:
+    host: 127.0.0.1
+    port: 11108
+
+  incoming:
+    host: 127.0.0.1
+    port: 11008

data/lib/torchat.rb

@@ -0,0 +1,239 @@
+#--
+# Copyleft meh. [http://meh.paranoid.pk | meh@paranoici.org]
+#
+# This file is part of torchat for ruby.
+#
+# torchat for ruby is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# torchat for ruby 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with torchat for ruby. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'yaml'
+require 'iniparse'
+require 'fileutils'
+
+require 'torchat/version'
+require 'torchat/utils'
+require 'torchat/session'
+require 'torchat/protocol'
+require 'torchat/tor'
+
+class Torchat
+	def self.profile (name = nil)
+		FileUtils.mkpath(directory = File.expand_path("~/.torchat#{"_#{name}" if name}"))
+
+		new("#{directory}/torchat.ini").tap {|t|
+			t.name = name
+			t.path = directory
+		}
+	end
+
+	attr_reader   :config, :session, :tor, :path
+	attr_accessor :name
+
+	def initialize (path)
+		@config = if path.is_a? Hash
+			path
+		elsif path.end_with?('ini')
+			ini = IniParse.parse(File.read(File.expand_path(path)))
+
+			{
+				'id'          => ini[:client][:own_hostname],
+				'name'        => ini[:profile][:name],
+				'description' => ini[:profile][:text],
+
+				'connection' => {
+					'outgoing' => {
+						'host' => ini[:tor_portable][:tor_server],
+						'port' => ini[:tor_portable][:tor_server_socks_port]
+					},
+
+					'incoming' => {
+						'host' => ini[:client][:listen_interface],
+						'port' => ini[:client][:listen_port]
+					}
+				}
+			}
+		else
+			YAML.parse_file(path).transform
+		end
+
+		if @config['path']
+			if @config['path'].is_a? String
+				self.path = @config['path']
+			else
+				if @config['path']['buddy_list']
+					buddy_list_at @config['path']['buddy_list']
+				end
+
+				if @config['path']['blocked_buddy_list']
+					blocked_buddy_list_at @config['path']['blocked_buddy_list']
+				end
+
+				if @config['path']['offline_messages']
+					offline_messages_at @config['path']['offline_messages']
+				end
+			end
+		end
+
+		@tor = Tor.new(@config)
+	end
+
+	def method_missing (id, *args, &block)
+		return @session.__send__ id, *args, &block if @session.respond_to? id
+
+		super
+	end
+
+	def respond_to_missing? (id, include_private = false)
+		@session.respond_to? id, include_private
+	end
+
+	def start (&block)
+		@session = Session.new(@config, &block)
+
+		if @config['buddies']
+			@config['buddies'].each {|id|
+				@session.buddies.add(id)
+			}
+		end
+
+		if @buddy_list && File.readable?(@buddy_list)
+			File.open(@buddy_list).lines.each {|line|
+				line.match(/^(.+?)(?: (.*?))?$/) {|m|
+					next if m[1] == @session.id
+
+					@session.buddies.add(m[1], m[2])
+				}
+			}
+		end
+
+		if @blocked_buddy_list && File.readable?(@blocked_buddy_list)
+			File.open(@blocked_buddy_list).lines.each {|line|
+				line.match(/^(.+?)(?: (.*?))?$/) {|m|
+					next if m[1] == @session.id
+
+					@session.buddies.add_temporary(m[1], m[2]).block!
+				}
+			}
+		end
+
+		if @offline_messages
+			Dir["#@offline_messages/*_offline.txt"].each {|path|
+				unless buddy = @session.buddies[path[/([^\/_]+)_offline\.txt$/, 1]]
+					File.delete(path)
+
+					next
+				end
+
+				File.open(path) {|f|
+					current = ''
+
+					until f.eof?
+						line = f.readline
+						
+						if line.start_with? '[delayed] '
+							buddy.messages.push current
+
+							current = line[10 .. -1]
+						else
+							current << "\n" << line
+						end
+					end
+
+					buddy.messages.push current unless current.empty?
+				}
+
+				File.delete(path)
+			}
+		end
+
+		@session.start
+	end
+
+	def stop
+		@session.stop
+		@tor.stop
+
+		if @buddy_list
+			File.open(@buddy_list, 'w') {|f|
+				@session.buddies.each {|id, buddy|
+					next if buddy.temporary?
+
+					f.puts "#{id} #{buddy.alias || buddy.name}"
+				}
+			}
+		end
+
+		if @blocked_buddy_list
+			File.open(@blocked_buddy_list, 'w') {|f|
+				@session.buddies.each {|id, buddy|
+					next unless buddy.blocked?
+
+					f.puts "#{id} #{buddy.alias || buddy.name}"
+				}
+			}
+		end
+
+		if @offline_messages
+			@session.buddies.each {|id, buddy|
+				next if buddy.messages.empty?
+
+				File.open("#@offline_messages/#{id}_offline.txt") {|f|
+					buddy.messages.each {|message|
+						f.write "[delayed] #{message}\n"
+					}
+				}
+			}
+		end
+	end
+
+	def path= (directory)
+		@path = directory
+
+		unless @buddy_list
+			buddy_list_at "#{directory}/buddy-list.txt"
+		end
+
+		unless @blocked_buddy_list
+			blocked_buddy_list_at "#{directory}/blocked-buddy-list.txt"
+		end
+
+		unless @offline_messages
+			offline_messages_at directory
+		end
+	end
+
+	def buddy_list_at (path)
+		@buddy_list = File.expand_path(path)
+	end
+
+	def blocked_buddy_list_at (path)
+		@blocked_buddy_list = File.expand_path(path)
+	end
+
+	def offline_messages_at (path)
+		@offline_messages = File.expand_path(path)
+	end
+
+	def send_packet_to (name, packet)
+		@session.buddies[name].send_packet(packet)
+	end
+
+	def send_message_to (name, message)
+		@session.buddies[name].send_message(message)
+	end
+
+	def send_broadcast (message)
+		@session.broadcasts.send_message(message)
+	end
+end

data/lib/torchat/protocol.rb

@@ -0,0 +1,256 @@
+#--
+# Copyleft meh. [http://meh.paranoid.pk | meh@paranoici.org]
+#
+# This file is part of torchat for ruby.
+#
+# torchat for ruby is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# torchat for ruby 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with torchat for ruby. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+class Torchat; module Protocol
+
+def self.encode (data)
+	data = data.dup
+
+	data.force_encoding 'BINARY'
+	data.gsub!("\\", "\\/")
+	data.gsub!("\n", "\\n")
+
+	data
+end
+
+def self.decode (data)
+	data = data.dup
+
+	data.force_encoding 'BINARY'
+	data.gsub!("\\n", "\n")
+	data.gsub!("\\/", "\\")
+
+	data
+end
+
+@packets    = Hash.new { |h, k| h[k] = {} }
+@extensions = []
+
+def self.[] (extension = nil, name)
+	extension = extension.to_sym.downcase if extension
+	name      = name.to_sym.downcase
+
+	@packets[extension][name]
+end
+
+def self.[]= (extension = nil, name, value)
+	extension = extension.to_sym.downcase if extension
+	name      = name.to_sym.downcase
+
+	if value.nil?
+		@packets[extension].delete(name)
+	else
+		@packets[extension][name] = value
+	end
+end
+
+def self.has_packet? (extension = nil, name)
+	extension = extension.to_sym.downcase if extension
+	name      = name.to_sym.downcase
+
+	@packets[extension].has_key?(name)
+end
+
+def self.packets (extension = nil)
+	if extension
+		@packets[extension].values
+	else
+		@packets.map { |extension, packets|
+			packets.map { |name, packet|
+				packet
+			}
+		}.flatten
+	end
+end
+
+def self.extensions
+	@extensions.map {|name|
+		Struct.new(:name, :packets).new(name, packets(name))
+	}
+end
+
+def self.define_packet (name, &block)
+	raise ArgumentError, "#{name} already exists" if has_packet?(@extension, name)
+
+	self[@extension, name] = Packet.define(name, @extension, &block)
+end
+
+def self.define_packet! (name, &block)
+	self[@extension, name] = nil
+
+	define_packet(name, &block)
+end
+
+def self.define_extension (name)
+	@extensions.push(name).uniq!
+
+	tmp, @extension = @extension, name
+	result = yield
+	@extension = tmp
+
+	result
+end
+
+def self.packet (*args)
+	if args.first.is_a? Packet
+		args.first
+	else
+		unless packet = self[*args.first]
+			raise ArgumentError, "#{args.first.inspect} packet unknown"
+		end
+
+		args.shift
+
+		packet.new(*args)
+	end
+end
+
+def self.unpack (data, from = nil)
+	name, data = data.chomp.split(' ', 2)
+
+	unless packet = self[name] || self[*name.split('_', 2)]
+		raise ArgumentError, "#{name} packet unknown"
+	end
+
+	unless packet.respond_to? :unpack
+		raise ArgumentError, "#{name} packet has no unpacker"
+	end
+
+	packet      = packet.unpack(data ? decode(data) : nil)
+	packet.from = from
+
+	packet
+end
+
+class Packet
+	def self.define (name, extension = nil, &block)
+		Class.new(self, &block).tap {|c|
+			c.instance_eval {
+				define_singleton_method :type do name end
+				define_method :type do name end
+
+				define_singleton_method :extension do extension end
+				define_method :extension do extension end
+
+				define_singleton_method :inspect do
+					"#<Torchat::Packet: #{"#{extension}_" if extension}#{type}>"
+				end
+			}
+		}
+	end
+
+	def self.define_unpacker (&block)
+		define_singleton_method :unpack do |data|
+			new(*block.call(data))
+		end
+	end
+
+	def self.define_unpacker_for (range, &block)
+		unless range.is_a? Range
+			range = range .. range
+		end
+
+		if block
+			define_unpacker &block
+		else
+			define_unpacker do |data|
+				if data.nil? || data.empty?
+					if range.begin == 0 || range.end == 0
+						next
+					else
+						raise ArgumentError, "wrong number of arguments (0 for #{range.begin})"
+					end
+				end
+
+				args  = range.end == -1 ? data.split(' ') : data.split(' ', range.end)
+				arity = range.end == -1 ? range.begin .. args.length : range
+
+				if args.last && args.last.empty?
+					args[-1] = nil
+				end
+
+				unless arity === args.length
+					raise ArgumentError, "wrong number of arguments (#{args.length} for #{args.length < range.begin ? range.begin : range.end})"
+				end
+
+				args
+			end
+		end
+
+		if range == (0 .. 0)
+			define_method :pack do
+				super('')
+			end
+
+			define_method :inspect do
+				"#<Torchat::Packet[#{"#{extension}_" if extension}#{type}]>"
+			end
+		elsif range.end == 1
+			if range.begin == 0
+				define_method :initialize do |value = nil|
+					@internal = value
+				end
+			else
+				define_method :initialize do |value|
+					@internal = value
+				end
+			end
+
+			define_method :pack do
+				super(@internal.to_s)
+			end
+
+			define_method :nil? do
+				@internal.nil?
+			end
+
+			define_method :inspect do
+				"#<Torchat::Packet[#{"#{extension}_" if extension}#{type}]#{": #{@internal.inspect}" if @internal}>"
+			end
+		else
+			define_method :initialize do |*args|
+				@internal = args
+			end
+
+			define_method :inspect do
+				"#<Torchat::Packet[#{"#{extension}_" if extension}#{type}]: #{@internal.map(&:inspect).join(', ')}>"
+			end
+		end
+	end
+
+	def self.new (*args, &block)
+		super(*args, &block).tap {|packet|
+			packet.at = Time.new
+		}
+	end
+
+	attr_accessor :from, :at
+
+	def pack (data)
+		"#{"#{extension}_" if extension}#{type}#{" #{Protocol.encode(data)}" if data}\n"
+	end
+end
+
+require 'torchat/protocol/standard'
+require 'torchat/protocol/groupchat'
+require 'torchat/protocol/typing'
+require 'torchat/protocol/broadcast'
+require 'torchat/protocol/latency'
+
+end; end