pidgin2adium 1.0.0 → 2.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-09-27
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile.rb
+bin/pidgin2adium
+lib/pidgin2adium.rb
+lib/pidgin2adium/balance_tags.rb
+lib/pidgin2adium/log_converter.rb
+lib/pidgin2adium/log_file.rb
+lib/pidgin2adium/log_parser.rb

data/README.rdoc

@@ -0,0 +1,106 @@
+== pidgin2adium
+* http://rubyforge.org/projects/pidgin2adium/
+
+== DESCRIPTION:
+Pidgin2Adium is a fast, easy way to convert Pidgin (formerly gaim) logs to the
+Adium format.
+Note that it assumes a Mac OS X environment with Adium installed.
+
+== FEATURES/PROBLEMS:
+* No problems (well, hopefully).
+
+== SYNOPSIS:
+
+There are two ways you can use this gem: as a script or as a library.
+Both require you to provide aliases, which may require a bit of explanation.
+Adium and Pidgin allow you to set aliases for buddies as well as for yourself,
+so that you show up in chats as (for example) "Me" instead of as
+"best_screen_name_ever_018845".
+
+However, Pidgin then uses aliases in the log file instead of the actual screen
+name, which complicates things. To parse properly, this gem needs to know which
+aliases belong to you so it can map them to the correct screen name.
+If it encounters an alias that you did not list,  it assumes that it belongs to
+the person to whom you are chatting.
+Note that aliases are lower-cased and space is removed, so providing "Gabe B-W,
+GBW" is the same as providing "gabeb-w,gbw".
+
+===Example (using script)
+Assuming that:
+* your Pidgin log files are in the "pidgin-logs" folder
+* your various aliases in your chats are "Gabe", "Gabe B-W", and "gbw"
+Then run:
+ pidgin2adium -i pidgin-logs -a "Gabe, Gabe B-W, gbw"
+
+===Example (using library)
+The library style allows you to parse a log file and get back a
+LogFile instance for easy reading, manipulation, etc.
+You can also create log files yourself using Pidgin2Adium.parse_and_generate.
+ 
+ require 'pidgin2adium'
+ logfile = Pidgin2Adium.parse("/path/to/log/file.html", "gabe,gbw,gabeb-w")
+ if logfile == false
+     puts "Oh no! Could not parse!"
+ else
+     logfile.each do |message|
+	# Every message has these properties
+	puts "Sender's screen name: #{message.sender}"
+ 	puts "Time message was sent: #{message.time}"
+ 	puts "Sender's alias: #{message.buddy_alias}"
+ 	if [Pidgin2Adium::XMLMessage, Pidgin2Adium::AutoReplyMessage, Pidgin2Adium::Event].include?(message.class)
+ 	    # All of these have a body
+ 	    puts "Message body: #{message.body}"
+ 	    if message.class == Pidgin2Adium::Event
+ 		puts "Event type: #{message.event_type}"
+ 	    end
+ 	elsif message.class == Pidgin2Adium::StatusMessage
+	    # Only StatusMessage has status
+ 	    puts "Status: #{message.status}"
+ 	end
+ 	# Prints out the message in Adium log format
+ 	puts message.to_s
+     end
+ end
+
+===Example 2 (using library)
+If you want to output the logfile to an output dir instead of just parsing it, use Pidgin2Adium.parse_and_generate:
+ 
+ require 'pidgin2adium'
+ opts = {:overwrite => true, :output_dir => "/my/output/dir"}
+ path_to_converted_log = Pidgin2Adium.parse_and_generate("/path/to/log/file.html", "gabe,gbw,gabeb-w", opts)
+
+== REQUIREMENTS:
+* None
+
+== INSTALL:
+* sudo gem install pidgin2adium
+
+== THANKS
+With thanks to Li Ma, whose blog post at
+http://li-ma.blogspot.com/2008/10/pidgin-log-file-to-adium-log-converter.html
+helped tremendously.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Gabriel Berke-Williams
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/pidgin2adium.rb'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'pidgin2adium' do
+  self.developer('Gabe B-W', 'gbw@brandeis.edu')
+  self.extra_rdoc_files = %w{README.rdoc}
+  #self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/pidgin2adium

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby -w
+
+=begin
+Author: Gabe Berke-Williams, 2008
+Usage:
+This is the shell script, which is a wrapper around Pidgin2Adium::LogConverter.
+Call it like so:
+<tt>pidgin2adium -i ~/in_logs/ -a "me,my_pidgin_alias,other_pidgin_alias"</tt>
+For <tt>-a/--aliases</tt>, there is no need to use spaces or capitalization,
+since spaces will be stripped out and the aliases will be lowercased anyway.
+Aliases doesn't have to include screennames, either, since these are
+automatically recognized.
+=end
+
+require 'pidgin2adium/log_converter'
+require 'optparse'
+
+options = {}
+oparser = OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename($0)} [options]"
+    opts.on('-i', '--in=IN_DIR', String, 'Specify directory where pidgin logs are stored') do |i|
+	options[:in] = i
+    end
+    opts.on('-a alias1,alias2', "--aliases alias1,alias2",
+	    "A comma-separated list of your alias(es) so this script knows
+	    which person in a chat is you.", "Whitespace and case do not matter.") do |aliases|
+	options[:aliases] = aliases
+    end
+    opts.on('-f', '--force', 'If this is set, then logs in the Adium log folder that have the same name as converted logs will be overwritten.') do |f|
+	options[:force] = f
+    end
+    opts.on_tail("-h", "--help", "Show this message") do
+	puts opts
+	exit
+    end
+end
+begin
+    oparser.parse!
+rescue => bang
+    if bang.class == OptionParser::MissingArgument 
+	# No argument provided for a switch that requires an argument.
+	puts '"%s" requires an argument.' % bang.args[0]
+	exit 1
+    elsif bang.class == OptionParser::InvalidOption 
+	# Provided a switch that we don't handle.
+	puts '"%s" is not a valid switch.' % bang.args[0]
+    elsif bang.class == OptionParser::NeedlessArgument
+	# Raised when argument provided for a switch that doesn't take an argument.
+	puts bang.message
+    end
+end
+
+need_opts = false
+required_opts = [[:i, :in], [:a, :aliases]]
+required_opts.each do |short, long|
+    if options.has_key?(long)
+	next
+    else
+	need_opts = true
+	puts "Required option -#{short}/--#{long} missing."
+    end
+end
+if need_opts
+    puts oparser.to_s
+    exit 1
+end
+
+log_converter = Pidgin2Adium::LogConverter.new(options[:in],
+					       options[:aliases],
+					       {:overwrite =>  options[:force]}
+					      )
+log_converter.start

data/lib/pidgin2adium.rb

@@ -0,0 +1,120 @@
+# Author: Gabe Berke-Williams, 2008
+#
+# A ruby program to convert Pidgin log files to Adium log files, then place
+# them in the Adium log directory.
+
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'fileutils'
+require 'pidgin2adium/log_parser'
+
+module Pidgin2Adium
+    # Returned by LogFile.write_out if the output logfile already exists.
+    FILE_EXISTS = 42
+    ADIUM_LOG_DIR = File.expand_path('~/Library/Application Support/Adium 2.0/Users/Default/Logs/') << '/' 
+    # These files/directories show up in Dir.entries()
+    BAD_DIRS = %w{. .. .DS_Store Thumbs.db .system}
+    VERSION = "2.0.0"
+
+    def log_msg(str) #:nodoc
+	puts str.to_s
+    end
+
+    def oops(str) #:nodoc
+	warn("Oops: #{str}")
+    end
+
+    def error(str) #:nodoc
+	warn("Error: #{str}")
+    end
+
+    #######################
+    private :log_msg, :oops, :error
+    #######################
+
+    # Returns a LogFile instance or false if an error occurred.
+    def parse(logfile_path, my_aliases)
+	logfile_path = File.expand_path(logfile_path)
+	ext = File.extname(logfile_path).sub('.', '').downcase
+
+	if(ext == "html" || ext == "htm")
+	    parser = HtmlLogParser.new(logfile_path, my_aliases) 
+	elsif(ext == "txt")
+	    parser = TextLogParser.new(logfile_path, my_aliases) 
+	else
+	    error("logfile (#{logfile_path}) is not a text or html file. Doing nothing.")
+	    return false
+	end
+
+	return parser.parse()
+    end
+    
+    # Returns the path to the converted log, false if an error occurred, or
+    # Pidgin2Adium::FILE_EXISTS if file already exists AND opts[:overwrite] =
+    # false.
+    #
+    # You can add options using the _opts_ hash, which can have the following
+    # keys, all of which are optional:
+    # * *overwrite*: If true, then overwrite even if log is found.
+    #	Defaults to false.
+    # * *output_dir*: The top-level dir to put the logs in.
+    #   Logs under output_dir are still each in their own folders, etc.
+    #   Defaults to Pidgin2Adium::ADIUM_LOG_DIR
+    def parse_and_generate(logfile_path, my_aliases, opts = {})
+	opts = {} unless opts.is_a?(Hash)
+	overwrite = !!opts[:overwrite]
+	if opts.key?(:output_dir)
+	    output_dir = opts[:output_dir]
+	else
+	    output_dir = ADIUM_LOG_DIR
+	end
+	
+	unless File.directory?(output_dir)
+	    puts "Output log directory (#{output_dir}) does not exist or is not a directory."
+	    raise Errno::ENOENT
+	end
+
+	logfile_obj = parse(logfile_path, my_aliases)
+	return false if logfile_obj == false
+	dest_file_path = logfile_obj.write_out(overwrite, output_dir)
+	if dest_file_path == false
+	    error("Converting #{logfile_path} failed.") 
+	    return false
+	elsif dest_file_path == FILE_EXISTS
+	    log_msg("File already exists.")
+	    return FILE_EXISTS
+	else
+	    log_msg("Output to: #{dest_file_path}")
+	    return true
+	end
+    end
+
+    # Newly-converted logs are viewable in the Adium Chat Transcript
+    # Viewer, but are not indexed, so a search of the logs doesn't give
+    # results from the converted logs. To fix this, we delete the cached log
+    # indexes, which forces Adium to re-index.
+    # 
+    # Note: This function is run by LogConverter after converting all of its
+    # files.  LogFile.write_out intentionally does _not_ run it in order to
+    # allow for batch-processing of files. Thus, you will probably want to run
+    # Pidgin2Adium.delete_search_indexes after running LogFile.write_out in
+    # your own scripts.
+    def delete_search_indexes()
+	log_msg "Deleting log search indexes in order to force re-indexing of imported logs..."
+	dirty_file = File.expand_path("~/Library/Caches/Adium/Default/DirtyLogs.plist")
+	log_index_file = File.expand_path("~/Library/Caches/Adium/Default/Logs.index")
+	[dirty_file, log_index_file].each do |f|
+	    if File.exist?(f)
+		if File.writable?(f)
+		    File.delete(f)
+		else
+		    error("#{f} exists but is not writable. Please delete it yourself.")
+		end
+	    end
+	end
+	log_msg "...done."
+	log_msg "When you next start the Adium Chat Transcript Viewer, it will re-index the logs, which may take a while."
+    end
+
+    module_function :parse, :parse_and_generate, :delete_search_indexes
+end

data/lib/pidgin2adium/{balance-tags.rb → balance_tags.rb}

@@ -1,19 +1,23 @@
-
 module Pidgin2Adium
-    #From Wordpress's formatting.php; rewritten in Ruby by Gabe Berke-Williams, 2009.
-    #Balances tags of string using a modified stack.
-    #
-    # @author Leonard Lin <leonard@acm.org>
-    # @license GPL v2.0
-    # @copyright November 4, 2001
-    # @return string Balanced text.
-    def Pidgin2Adium.balanceTags( text )
+    # Balances tags of string using a modified stack. Returns a balanced
+    # string, but also affects the text passed into it!
+    # Use text = balance_tags(text).
+    
+    # From Wordpress's formatting.php; rewritten in Ruby by Gabe
+    # Berke-Williams, 2009.
+    # Author:: Leonard Lin <leonard@acm.org>
+    # License:: GPL v2.0
+    # Copyright:: November 4, 2001
+    def balance_tags( text )
 	tagstack = []
 	stacksize = 0
 	tagqueue = ''
 	newtext = ''
-	single_tags = ['br', 'hr', 'img', 'input', 'meta'] # Known single-entity/self-closing tags
-	nestable_tags = ['blockquote', 'div', 'span'] # Tags that can be immediately nested within themselves
+	single_tags = %w{br hr img input meta} # Known single-entity/self-closing tags
+	#nestable_tags = %w{blockquote div span} # Tags that can be immediately nested within themselves
+	nestable_tags = %w{blockquote div span font} # Tags that can be immediately nested within themselves
+	# 1: tagname, with possible leading "/"
+	# 2: attributes
 	tag_regex = /<(\/?\w*)\s*([^>]*)>/
 
 	# WP bug fix for comments - in case you REALLY meant to type '< !--'
@@ -22,24 +26,24 @@ module Pidgin2Adium
 	# WP bug fix for LOVE <3 (and other situations with '<' before a number)
 	text.gsub!(/<([0-9]{1})/, '&lt;\1')
 
-	while ( regex = text.match(tag_regex) )
-	    regex = regex.to_a
+	while ( pos = (text =~ tag_regex) )
 	    newtext << tagqueue
-	    i = text.index(regex[0])
-	    l = regex[0].length
+	    tag = $1.downcase
+	    attributes = $2
+	    matchlen = $~[0].size
 
 	    # clear the shifter
 	    tagqueue = ''
 	    # Pop or Push
-	    if (regex[1][0,1] == "/") # End Tag
-		tag = regex[1][1,regex[1].length].downcase
+	    if (tag[0,1] == "/") # End Tag
+		tag.slice!(0,1)
 		# if too many closing tags
 		if(stacksize <= 0)
 		    tag = ''
-		    #or close to be safe tag = '/' . tag
-		    # if stacktop value = tag close value then pop
+		    #or close to be safe: tag = '/' << tag
 		elsif (tagstack[stacksize - 1] == tag) # found closing tag
-		    tag = '</' << tag << '>'; # Close Tag
+		    # if stacktop value == tag close value then pop
+		    tag = '</' << tag << '>' # Close Tag
 		    # Pop
 		    tagstack.pop
 		    stacksize -= 1
@@ -59,14 +63,13 @@ module Pidgin2Adium
 		end
 	    else
 		# Begin Tag
-		tag = regex[1].downcase
 
 		# Tag Cleaning
-		if( (regex[2].slice(-1,1) == '/') || (tag == '') )
+		if( (attributes[-1,1] == '/') || (tag == '') )
 		    # If: self-closing or '', don't do anything.
 		elsif ( single_tags.include?(tag) )
 		    # ElseIf: it's a known single-entity tag but it doesn't close itself, do so
-		    regex[2] << '/'
+		    attributes << '/'
 		else
 		    # Push the tag onto the stack
 		    # If the top of the stack is the same as the tag we want to push, close previous tag
@@ -76,11 +79,11 @@ module Pidgin2Adium
 			tagqueue = '</' << tagstack.pop << '>'
 			stacksize -= 1
 		    end
-		    stacksize = tagstack.push(tag).length
+		    tagstack.push(tag)
+		    stacksize += 1
 		end
 
 		# Attributes
-		attributes = regex[2]
 		if(attributes != '')
 		    attributes = ' ' << attributes
 		end
@@ -91,8 +94,8 @@ module Pidgin2Adium
 		    tag = ''
 		end
 	    end
-	    newtext << text[0,i] << tag
-	    text = text[i+l, text.length - (i+l)]
+	    newtext << text[0,pos] << tag
+	    text = text[pos+matchlen, text.length - (pos+matchlen)]
 	end
 
 	# Clear Tag Queue
@@ -102,8 +105,8 @@ module Pidgin2Adium
 	newtext << text
 
 	# Empty Stack
-	while(x = tagstack.pop)
-	    newtext << '</' << x << '>'; # Add remaining tags to close
+	tagstack.reverse_each do |t|
+	    newtext << '</' << t << '>' # Add remaining tags to close
 	end
 
 	# WP fix for the bug with HTML comments