lyrics 0.0.2

data/lib/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/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" ) # FIXME: refactor
+        plugin = eval( "CLI#{classname}.new()" )
+        @@WIKI << plugin
+      else
+        eval( "class CLI#{classname} < #{classname}\ninclude PluginAdapter\nend" ) # FIXME: refactor
+        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/lyrics/cli/wikipluginadapter.rb

@@ -0,0 +1,139 @@
+# 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__ ) + "/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

data/lib/lyrics/i18n/README

@@ -0,0 +1 @@
+IMPORTANT: save all language files with UTF-8 encoding

data/lib/lyrics/i18n/en.rb

@@ -0,0 +1,181 @@
+cli.usage = Usage: %1 [OPTIONS]
+cli.description = Fetch lyrics from various sites and/or submit lyrics to Lyriki and LyricWiki.
+cli.values.true = true
+cli.values.false = false
+cli.options = Options:
+cli.options.artist = Song artist (mandatory unless %1 specified).
+cli.options.title = Song title (mandatory unless %1 specified).
+cli.options.album = Song album.
+cli.options.year = Song album year.
+cli.options.featfix = Fix artist/title when the later has "feat. ARTIST" (%1 by default).
+cli.options.batchfile = Batch process file (expects artist;title;album;year entries in each line).
+cli.options.cleanup = Cleanup fetched lyrics (%1 by default).
+cli.options.sites = Sites to search lyrics for, order included (%1 by default; see %2).
+cli.options.sites.list = List available sites.
+cli.options.sites.list.available = Available sites:
+cli.options.submit = Wiki site to submit content to (needs %1 and %2).
+cli.options.username = Username to login with (mandatory when %1 specified).
+cli.options.password = Password to login with (mandatory when %1 specified).
+cli.options.persist = Restore/save session from/to file (needs %1 and %2).
+cli.options.prompt.review = Prompt for review before submitting content (%1 by default, needs %2).
+cli.options.prompt.autogen = Prompt for review of autogenerated pages (%1 by default, needs %2).
+cli.options.prompt.nolyrics = Prompt for submission even when no lyrics to submit where found (%1 by default, needs %2).
+cli.options.proxy = Proxy server URL.
+cli.options.toolkits = GUI toolkits priority. Loading falls back to the next toolkit when one fails; an empty list will cause no dialog to be shown and lyrics to be dumped to stdout (defaults to %1).
+cli.options.help = Show this message and exit.
+cli.options.version = Show version and exit.
+cli.error.missingoption = missing %1
+cli.error.missingdependency = %1 requires %1
+cli.error.incompatibleoptions = %1 is incompatible with %2
+cli.error.invalidoptionvalue = invalid %1 value: %2
+cli.error.nosite = must provide at least one site
+cli.error.notoolkit = must provide at least one toolkit to use review mode
+
+cli.application.searchinglyrics = searching lyrics for %1 by %2...
+cli.application.lyricsfound = lyrics for %1 by %2 found at %3
+cli.application.nolyricsfound = no lyrics found for %1 by %2
+cli.application.plugintimeout = %1 request has timed out, site %2 is probably down
+cli.application.batchmode = operating in batch mode
+cli.application.processedcount = %1 files processed
+
+amarok.application.error.connectionrefused = Can't connect to the Internet (check your proxy settings)
+amarok.application.error.connectiondown = The connection is down, exiting
+amarok.application.error.notoolkit = Sorry...\nYou need one of QtRuby, RubyGTK or TkRuby to run this program
+amarok.application.error.nopluginsselected = No sites to search lyrics for specified
+amarok.application.search.current = Search current song lyrics
+amarok.application.search.current.nosongplaying = no song currently playing
+amarok.application.search.selected = Search selected song lyrics
+amarok.application.search.noinfofound = no song info found in Amarok database
+amarok.application.search.nolyricsfound = no lyrics found for <b>%1</b> by <b>%2</b>
+amarok.application.search.plugintimeout = %1 request has timed out! Site %2 is probably down
+amarok.application.clearlyricscache = Clear lyrics cache
+amarok.application.clearlyricscache.confirm = Are you sure you want to clear the lyrics cache?
+amarok.application.clearlyricscache.done = lyrics cache cleared
+
+amarok.wikiplugin.checksong = Check/Submit song page
+amarok.wikiplugin.checksong.noinfofound = no song info found in Amarok database
+amarok.wikiplugin.checkalbum = Check/Submit album page
+amarok.wikiplugin.checkalbum.noinfofound = no album info found in Amarok database
+amarok.wikiplugin.uploadcover = Upload album cover
+amarok.wikiplugin.uploadcover.invalidalbumparams = invalid album params received
+amarok.wikiplugin.uploadcover.noimagepath = no cover image received
+amarok.wikiplugin.uploadcover.searching = searching album cover for <b>%1</b> by <b>%2</b>...
+amarok.wikiplugin.uploadcover.found = album cover found (no need to upload)
+amarok.wikiplugin.submitcontent = Submit contents
+
+gui.common.cut = Cut
+gui.common.copy = Copy
+gui.common.paste = Paste
+gui.common.delete = Delete
+gui.common.selectall = Select All
+gui.common.undo = Undo
+gui.common.redo = Redo
+
+gui.common.accept = Accept
+gui.common.cancel = Cancel
+gui.common.submit = Submit
+gui.common.load = Load
+gui.common.fix = Fix
+gui.common.url = URL
+gui.common.artist = Artist
+gui.common.song = Song
+gui.common.album = Album
+gui.common.year = Year
+gui.common.month = Month
+gui.common.day = Day
+gui.common.released = Released
+gui.common.credits = Credits
+gui.common.lyricist = Lyricist
+gui.common.image = Image
+gui.common.reviewed = I have reviewed the contents of this form
+
+gui.searchlyrics.title = Search lyrics
+gui.searchlyrics.search = Search Settings
+
+gui.lyrics.title = Lyrics to %1 by %2
+
+gui.pluginsmanager.title = %1 script configuration
+gui.pluginsmanager.sites = Sites
+gui.pluginsmanager.sites.inuse = Currently used
+gui.pluginsmanager.sites.available = Available
+gui.pluginsmanager.sites.moveup = Move Up
+gui.pluginsmanager.sites.movedown = Move Down
+gui.pluginsmanager.sites.add = << Add
+gui.pluginsmanager.sites.remove = >> Remove
+gui.pluginsmanager.misc = Miscellaneous
+gui.pluginsmanager.misc.cleanup = Clean up retrieved lyrics
+gui.pluginsmanager.misc.singlethreaded = Avoid using multiple threads to save battery (needs restart)
+gui.pluginsmanager.misc.writelog = Write log to %1
+
+gui.wikiplugin.title = Configure %1 settings
+gui.wikiplugin.general = General Settings
+gui.wikiplugin.general.submit = Submit contents to %1
+gui.wikiplugin.general.review = Prompt for review before submitting contents
+gui.wikiplugin.general.autogen = Review song pages marked as auto-generated
+gui.wikiplugin.general.nolyrics = Show submit dialog even if no lyrics were found
+gui.wikiplugin.login = Login Settings
+gui.wikiplugin.login.username = Username
+gui.wikiplugin.login.password = Password
+
+gui.submitsong.title.submit = %1 - Submit song page
+gui.submitsong.title.edit = %1 - Review song page
+gui.submitsong.instrumental = Song is instrumental
+
+gui.submitalbum.title = %1 - Submit album page
+gui.submitalbum.coverfound = (cover found, no need to upload)
+
+gui.uploadcover.title = %1 - Upload album cover
+gui.uploadcover.imagepath = Path
+gui.uploadcover.browseimage.title = Select album cover image path
+gui.uploadcover.browseimage.images = Images
+gui.uploadcover.browseimage.allfiles = All Files
+
+gui.fixpages.success = Submitted page %1
+gui.fixpages.error = Error submitting page %1
+
+wiki.control.versionblocked = <b>Version %1 has been blocked</b> from submitting content. Please, update to the last version.
+wiki.control.userblocked = <b>User %1 has been blocked</b> from submitting content. Please, check your user page.
+wiki.control.updated = A new version of the script has been released. <b>Please, update to version %1</b>.
+
+wiki.login.attempt = starting session for user <b>%1</b>...
+wiki.login.success = session started successfully for user <b>%1</b>
+wiki.login.error = error starting session for user <b>%1</b>
+wiki.logout = session finished for user <b>%1</b>
+
+wiki.session.save.success = session saved for user <b>%1</b>
+wiki.session.save.error.notloggedin = can't save session before logging in
+wiki.session.save.error = there was an error saving the session for user <b>%1</b>
+wiki.session.restore.success = session restored for user <b>%1</b>
+wiki.session.restore.error = there was an error restoring the session for user <b>%1</b>
+wiki.session.restore.notfound = no saved session found
+
+wiki.submitsong.searchingpage = searching song page for <b>%1</b> by <b>%2</b>...
+wiki.submitsong.pagefound = song page found for <b>%1</b> by <b>%2</b>
+wiki.submitsong.pagefound.autogenerated = auto-generated song page found for <b>%1</b> by <b>%2</b>
+wiki.submitsong.nopagefound = no song page found for <b>%1</b> by <b>%2</b>
+wiki.submitsong.cancelled = song page submission cancelled by user
+wiki.submitsong.mustreviewcontent = contents were not reviewed, submission cancelled
+wiki.submitsong.success = successfully submitted song page for <b>%1</b> by <b>%2</b>
+wiki.submitsong.error.invalidsong = invalid song title received
+wiki.submitsong.error.invalidartist = invalid album artist received
+wiki.submitsong.error.nolyrics = no lyrics to submit received
+wiki.submitsong.error = there was an error submitting the song page for <b>%1</b> by <b>%2</b>
+
+wiki.submitalbum.searchingpage = searching album page for <b>%1</b> by <b>%2</b>...
+wiki.submitalbum.pagefound = found album page for <b>%1</b> by <b>%2</b>
+wiki.submitalbum.nopagefound = no album page found for <b>%1</b> by <b>%2</b>
+wiki.submitalbum.cancelled = album page submission cancelled by user
+wiki.submitalbum.mustreviewcontent = contents were not reviewed, submission cancelled
+wiki.submitalbum.success = successfully submitted album page for <b>%1</b> by <b>%2</b>
+wiki.submitalbum.error.invalidyear = invalid album year received
+wiki.submitalbum.error.invalidalbum = invalid album name received
+wiki.submitalbum.error.invalidartist = invalid album artist received
+wiki.submitalbum.error = there was an error submitting the album page for <b>%1</b> by <b>%2</b>
+
+wiki.submitredirect.success = submitted redirect page to %1
+wiki.submitredirect.error = there was an error submitting the redirect page to %1
+
+wiki.uploadcover.uploading = uploading album cover for <b>%1</b> by <b>%2</b>
+wiki.uploadcover.success = successfully uploaded album cover for <b>%1</b> by <b>%2</b>
+wiki.uploadcover.error.convert = there was an error converting the album cover to JPEG format
+wiki.uploadcover.error = there was an error uploading the album cover for <b>%1</b> by <b>%2</b>