lyrics-ebook 0.1

data/lib/wiki_lyrics/cli/pluginadapter.rb

@@ -0,0 +1,56 @@
+# Copyright (C) 2006-2008 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# 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.
+
+require "cgi"
+
+module PluginAdapter
+
+	# Hack to make module methods become class methods when the module gets included
+	def PluginAdapter.included( including )
+		if including.is_a?( Class )
+			including.extend( ClassMethods ) # adds class methods
+		else # if including.is_a?( Module )
+			including::ClassMethods.append_class_methods( self )
+		end
+	end
+
+	# Methods under this module will became class methods when the module gets included
+	# Note: don't use def self.<method name> but just <method name>
+	module ClassMethods
+		def ClassMethods.append_class_methods( mod )
+			include mod::ClassMethods
+		end
+
+		def plugin_name()
+			return site_name()
+		end
+
+		def notify( message )
+			puts plugin_name() + ": " + message.gsub( /\/?<[^>]+>/, "" )
+		end
+	end
+
+	def plugin_name()
+		return self.class.plugin_name()
+	end
+
+	def notify( message )
+		self.class.notify( message )
+	end
+
+end

data/lib/wiki_lyrics/cli/plugins.rb

@@ -0,0 +1,79 @@
+# Copyright (C) 2007 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# 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.
+
+require File.expand_path( File.dirname( __FILE__ ) + "/../mediawikilyrics" )
+require File.expand_path( File.dirname( __FILE__ ) + "/pluginadapter" )
+require File.expand_path( File.dirname( __FILE__ ) + "/wikipluginadapter" )
+
+module Plugins
+
+	@@ALL  = []
+	@@WIKI = []
+
+	def Plugins.find_plugins()
+		plugins = {}
+		Dir.new( File.expand_path( File.dirname( __FILE__ ) + "/.." ) ).each() do |filename|
+			filename = File.expand_path( File.dirname( __FILE__ ) + "/../" + filename )
+			if File.file?( filename ) && (md = /\/lyrics_([A-Za-z_0-9]*)\.rb$/.match( filename ))
+				plugins[md[1]] = filename
+			end
+		end
+		return plugins
+	end
+
+	def Plugins.load_plugins( plugins )
+		plugins.each() do |classname, filename|
+			require( filename ? filename : File.expand_path( File.dirname( __FILE__ ) + "/../lyrics_#{classname}.rb" ) )
+			classobj = eval( classname )
+			if classobj.ancestors().include?( MediaWikiLyrics )
+				eval( "class CLI#{classname} < #{classname}\ninclude WikiPluginAdapter\nend" )
+				plugin = eval( "CLI#{classname}.new()" )
+				@@WIKI << plugin
+			else
+				eval( "class CLI#{classname} < #{classname}\ninclude PluginAdapter\nend" )
+				plugin = eval( "CLI#{classname}.new()" )
+			end
+			@@ALL << plugin
+		end
+	end
+
+
+	def Plugins.all_plugins()
+		return @@ALL
+	end
+
+	def Plugins.all_names()
+		return @@ALL.collect(){ |plugin| plugin.plugin_name() }
+	end
+
+	def Plugins.wiki_plugins()
+		return @@WIKI
+	end
+
+	def Plugins.wiki_names()
+		return @@WIKI.collect(){ |plugin| plugin.plugin_name() }
+	end
+
+	def Plugins.plugin_by_name( name )
+		@@ALL.each() do |plugin|
+			return plugin if plugin.plugin_name() == name
+		end
+		return nil
+	end
+
+end

data/lib/wiki_lyrics/cli/wikilyrics.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+
+# Copyright (C) 2006-2008 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# 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.
+
+require File.expand_path( File.dirname( __FILE__ ) + "/../i18n/i18n" )
+require File.expand_path( File.dirname( __FILE__ ) + "/../utils/strings" )
+require File.expand_path( File.dirname( __FILE__ ) + "/../utils/logger" )
+require File.expand_path( File.dirname( __FILE__ ) + "/optionsparser" )
+require File.expand_path( File.dirname( __FILE__ ) + "/plugins" )
+
+class Application
+
+	def initialize( featuring_fix, cleanup_lyrics, submit, review=true,
+					prompt_autogen=false, prompt_no_lyrics=false, username=nil, password=nil )
+		@featuring_fix = featuring_fix
+		@submit_plugin = nil
+		@logger = Logger.new( "#{ENV["HOME"]}/.wikilyrics.log" )
+		Plugins.all_plugins().each() do |plugin|
+			plugin.cleanup_lyrics = cleanup_lyrics
+			plugin.logger = @logger
+			if plugin.plugin_name() == submit
+				@submit_plugin = plugin
+				@submit_plugin.set_submit_settings( username, password, review, prompt_autogen, prompt_no_lyrics )
+			end
+		end
+	end
+
+	def finalize()
+		@logger.finalize() if @logger
+	end
+
+	def Application.notify( message )
+		puts "Wiki-Lyrics: " + message.gsub( /\/?<[^>]+>/, "" )
+	end
+
+	def notify( message )
+		self.class.notify( message )
+	end
+
+	def restore_session( session_file )
+		@submit_plugin.restore_session( session_file ) if @submit_plugin
+	end
+
+	def save_session( session_file )
+		@submit_plugin.save_session( session_file ) if @submit_plugin
+	end
+
+	def fetch_lyrics( request )
+
+		used_plugins = Plugins.all_plugins()
+
+		response = nil
+		response_plugin = nil
+		shown_review_dialog = false
+		submit_plugin_searched = false
+
+		used_plugins.each() do |plugin|
+			begin
+				submit_plugin_searched = true if plugin == @submit_plugin
+				response = plugin.lyrics_full_search( request )
+				if response.lyrics
+					response_plugin = plugin
+					break
+				end
+			rescue TimeoutError
+				notify( I18n.get( "cli.application.plugintimeout", plugin.plugin_name(), plugin.site_host() ) )
+			end
+		end
+
+ 		if @submit_plugin
+			shown_review_dialog = @submit_plugin.wiki_process_response( response, response_plugin, submit_plugin_searched )
+		end
+
+		return response, response_plugin, shown_review_dialog
+
+	end
+
+	def process( artist, title, album, year )
+
+		if @featuring_fix
+			artist = Strings.cleanup_artist( artist, title )
+			title  = Strings.cleanup_title( title )
+		end
+
+		notify( I18n.get( "cli.application.searchinglyrics", title, artist ) )
+
+		request = Lyrics::Request.new( artist, title, album, year )
+		response, response_plugin, shown_review_dialog = fetch_lyrics( request )
+
+		if response.lyrics
+			artist = response.artist ? response.artist : response.request.artist
+			title = response.title ? response.title : response.request.title
+			notify( I18n.get( "cli.application.lyricsfound", title, artist, response_plugin.site_name ) )
+			if ! shown_review_dialog
+				if GUI.get_current_toolkit()
+					GUI.show_lyrics_dialog( {
+						"artist" => artist,
+						"title" => title,
+						"lyrics" => response.lyrics,
+						"site_name" => response_plugin.site_name
+					} )
+				else
+					puts "\n#{response.lyrics}\n\n"
+				end
+			end
+		else
+			notify( I18n.get( "cli.application.nolyricsfound", request.title, request.artist ) )
+		end
+
+	end
+
+end
+
+if $0 == __FILE__
+
+	options = OptionsParser.parse( ARGV )
+
+	Plugins.load_plugins( options.sites )
+
+	HTTP.set_proxy_settings( options.proxy ) if options.proxy
+	GUI.set_toolkit_priority( options.toolkits ) if options.toolkits.size > 0
+
+	app = Application.new(
+		options.feat_fix,
+		options.cleanup,
+		options.submit,
+		options.review,
+		options.prompt_autogen,
+		options.prompt_no_lyrics,
+		options.username,
+		options.password
+	)
+
+	begin
+
+		app.restore_session( options.session_file ) if options.session_file
+
+		if options.batch_file
+			app.notify( I18n.get( "cli.application.batchmode" ) )
+			file = File.new( options.batch_file, "r" )
+			count = 0
+			while ( line = file.gets )
+				params = line.split( ";" )
+				next if params.length < 2
+				app.process( params[0], params[1], params[2], params[3] )
+				count += 1
+			end
+			notify( I18n.get( "cli.application.processedcount", count ) )
+			file.close()
+		else
+			app.process( options.artist, options.title, options.album, options.year )
+		end
+
+		app.save_session( options.session_file ) if options.session_file
+
+	ensure
+
+		app.finalize()
+
+	end
+
+end

data/lib/wiki_lyrics/cli/wikipluginadapter.rb

@@ -0,0 +1,140 @@
+# Copyright (C) 2006-2008 by Sergio Pistone
+# sergio_pistone@yahoo.com.ar
+#
+# 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.
+
+require File.expand_path( File.dirname( __FILE__ ) + "/../utils/strings" )
+require File.expand_path( File.dirname( __FILE__ ) + "/../i18n/i18n" )
+require File.expand_path( File.dirname( __FILE__ ) + "/../gui/gui" )
+require File.expand_path( File.dirname( __FILE__ ) + "/pluginadapter" )
+require File.expand_path( File.dirname( __FILE__ ) + "/plugins" )
+
+require "md5"
+require "uri"
+
+module WikiPluginAdapter
+
+	# Hack to make module methods become class methods when the module gets included
+	def WikiPluginAdapter.included( including )
+		if including.is_a?( Class )
+			including.extend( ClassMethods ) # adds class methods
+		else # including.is_a?( Module )
+			including::ClassMethods.append_class_methods( self )
+		end
+	end
+
+	# Methods under this module will became class methods when the module gets included
+	# Note: don't use def self.<method name> but just <method name>
+	module ClassMethods
+		def ClassMethods.append_class_methods( mod )
+			include mod::ClassMethods
+		end
+	end
+
+	include PluginAdapter
+
+	def submit?()
+		return @wpa_submit
+	end
+
+	def check_submit_conditions()
+ 		if @wpa_submit
+			login( @wpa_username, @wpa_password, false )
+		else
+			logout()
+		end
+
+		if ! logged_in?
+			@wpa_submit = false
+		end
+
+		if ! @wpa_submit || ! @wpa_review
+			@wpa_prompt_no_lyrics = false
+			@wpa_prompt_autogen = false
+		end
+	end
+
+	def set_submit_settings( username, password, review, prompt_autogen, prompt_no_lyrics )
+		@wpa_submit = true
+		@wpa_review = review
+		@wpa_prompt_autogen = prompt_autogen
+		@wpa_prompt_no_lyrics = prompt_no_lyrics
+		@wpa_username = username
+		@wpa_password = password
+		if ! @wpa_submit || ! @wpa_review
+			@wpa_prompt_no_lyrics = false
+			@wpa_prompt_autogen = false
+		end
+	end
+
+	# returns true if the review contents page is shown to the user (which can only happen when there was something to submit)
+	def wiki_process_response( response, response_plugin, wiki_searched )
+
+		return false if ! submit?() || ! authorized?
+
+		lyrics_found_on_site = response.lyrics && response_plugin == self
+		lyrics_autogenerated = lyrics_found_on_site && ! response.custom_data["reviewed"]
+
+		return false if lyrics_found_on_site && ! lyrics_autogenerated # we have nothing to do
+		return false if (! @wpa_prompt_autogen && lyrics_autogenerated) || (! @wpa_prompt_no_lyrics && ! response.lyrics)
+
+		begin
+
+			check_submit_conditions()
+
+			song_data = MediaWikiLyrics::SongData.new(
+				response.artist ? response.artist : response.request.artist,
+				response.title ? response.title : response.request.title,
+				response.lyrics,
+				response.album ? response.album : response.request.album,
+				response.year ? response.year : response.request.year,
+				response.custom_data["credits"],
+				response.custom_data["lyricist"]
+			)
+
+			submitted_url, submitted_data = submit_song_page(
+				song_data,
+				lyrics_autogenerated ? response.url : nil, # are we editing an existing page or creating a new one?
+				song_data.artist == response.request.artist && song_data.title == response.request.title &&
+				wiki_searched && ! lyrics_found_on_site, # do we KNOW FOR SURE the page doesn't exists?
+				@wpa_review || lyrics_autogenerated, # should we show the review contents dialog?
+				lyrics_autogenerated # should user be forced to review contents? (true causes the operation to abort otherwise)
+			)
+
+			# transfer summited data to response
+			if submitted_data
+				response.artist = submitted_data["artist"] if ! Strings.empty?( submitted_data["artist"] )
+				response.title = submitted_data["title"] if ! Strings.empty?( submitted_data["title"] )
+				response.album = submitted_data["album"] if ! Strings.empty?( submitted_data["album"] )
+				response.year = submitted_data["year"] if ! Strings.empty?( submitted_data["year"] )
+				response.lyrics = submitted_data["lyrics"] if ! Strings.empty?( submitted_data["lyrics"] )
+				custom_data = {}
+				custom_data.merge( response.custom_data )
+				custom_data["credits"] = submitted_data["credits"] if ! Strings.empty?( submitted_data["credits"] )
+				custom_data["lyricst"] = submitted_data["lyricst"] if ! Strings.empty?( submitted_data["lyricst"] )
+				response.custom_data = custom_data
+			end
+
+			return (@wpa_review || lyrics_autogenerated) && submitted_data
+
+		rescue TimeoutError
+			notify( I18n.get( "cli.application.plugintimeout", plugin_name(), site_host() ) )
+			return false
+		end
+
+	end
+
+end