home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / lib / rhythmbox / plugins / lyrics.py < prev    next >
Encoding:
Python Source  |  2006-08-30  |  9.1 KB  |  316 lines
  1. # -*- Mode: python; coding: utf-8; tab-width: 8; indent-tabs-mode: t; -*- 
  2. #
  3. # Copyright 2005 Eduardo Gonzalez
  4. # Copyright (C) 2006 Jonathan Matthew
  5. #
  6. # This program is free software; you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License as published by
  8. # the Free Software Foundation; either version 2, or (at your option)
  9. # any later version.
  10. # 
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with this program; if not, write to the Free Software
  18. # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.
  19. #
  20. # TODO: 
  21. # - multiple lyrics sites (lyrc.com.ar, etc.)
  22. # - handle multiple results usefully
  23. # - save lyrics to disk?
  24. # - check that the lyrics returned even remotely match the request?
  25. # - share URL grabbing code with other plugins
  26.  
  27. import os 
  28. import gtk, gobject
  29. import urllib
  30. import re
  31. from xml.dom import minidom
  32. from gettext import gettext as _
  33. import rb
  34. import rhythmdb
  35.  
  36. from Loader import Loader
  37.     
  38. ui_str = """
  39. <ui>
  40.   <menubar name="MenuBar">
  41.     <menu name="ViewMenu" action="View">
  42.       <menuitem name="ViewSongLyrics" action="ViewSongLyrics"/>
  43.     </menu>
  44.   </menubar>
  45. </ui>
  46. """
  47.  
  48. LYRICS_FOLDER="~/.gnome2/rhythmbox/lyrics"
  49. LYRIC_TITLE_STRIP=["\(live[^\)]*\)", "\(acoustic[^\)]*\)", "\([^\)]*mix\)", "\([^\)]*version\)", "\([^\)]*edit\)", "\(feat[^\)]*\)"]
  50. LYRIC_TITLE_REPLACE=[("/", "-"), ("&", "and")]
  51. LYRIC_ARTIST_REPLACE=[("/", "-"), ("&", "and")]
  52.  
  53.  
  54. def create_lyrics_view():
  55.     view = gtk.TextView()
  56.     view.set_wrap_mode(gtk.WRAP_WORD)
  57.     view.set_editable(False)
  58.  
  59.     sw = gtk.ScrolledWindow()
  60.     sw.add(view)
  61.     sw.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
  62.     sw.set_shadow_type(gtk.SHADOW_IN)
  63.  
  64.     vbox = gtk.VBox(spacing=12)
  65.     vbox.pack_start(sw, expand=True)
  66.     return (vbox, view.get_buffer())
  67.  
  68. class LyricWindow(gtk.Window):
  69.     def __init__(self, db, entry):
  70.         gtk.Window.__init__(self)
  71.         self.set_border_width(12)
  72.  
  73.     title = db.entry_get(entry, rhythmdb.PROP_TITLE)
  74.     artist = db.entry_get(entry, rhythmdb.PROP_ARTIST)
  75.         self.set_title(title + " - " + artist + " - Lyrics")
  76.  
  77.     close = gtk.Button(stock=gtk.STOCK_CLOSE)
  78.     close.connect('clicked', lambda w: self.destroy())
  79.  
  80.     (lyrics_view, buffer) = create_lyrics_view()
  81.     self.buffer = buffer
  82.         bbox = gtk.HButtonBox()
  83.         bbox.set_layout(gtk.BUTTONBOX_END)
  84.         bbox.pack_start(close)
  85.         lyrics_view.pack_start(bbox, expand=False)
  86.  
  87.         self.buffer.set_text(_("Searching for lyrics..."))
  88.         self.add(lyrics_view)
  89.         self.set_default_size(400, 300)
  90.         self.show_all()
  91.  
  92. class LyricPane(object):
  93.     def __init__(self, db, song_info):
  94.         (self.view, self.buffer) = create_lyrics_view()
  95.     self.view.show_all()
  96.     self.page_num = song_info.append_page(_("Lyrics"), self.view)
  97.     self.db = db
  98.     self.song_info = song_info
  99.     self.have_lyrics = 0
  100.     self.visible = 0
  101.         self.entry = self.song_info.get_property("current-entry")
  102.  
  103.     self.entry_change_id = song_info.connect('notify::current-entry', self.entry_changed)
  104.     nb = self.view.get_parent()
  105.     self.switch_page_id = nb.connect('switch-page', self.switch_page_cb)
  106.  
  107.     def entry_changed(self, pspec, duh):
  108.         self.entry = self.song_info.get_property("current-entry")
  109.     self.have_lyrics = 0
  110.     if self.visible != 0:
  111.         self.get_lyrics()
  112.  
  113.     def switch_page_cb(self, notebook, page, page_num):
  114.         if self.have_lyrics != 0:
  115.         return
  116.  
  117.         if page_num != self.page_num:
  118.         self.visible = 0
  119.         return
  120.  
  121.     self.visible = 1
  122.     self.get_lyrics()
  123.  
  124.     def get_lyrics(self):
  125.         if self.entry is None:
  126.         return
  127.  
  128.     self.buffer.set_text(_("Searching for lyrics..."));
  129.     lyrics_grabber = LyricGrabber()
  130.     lyrics_grabber.get_lyrics(self.db, self.entry, self.buffer.set_text)
  131.     
  132.     
  133.  
  134. class LyricGrabber(object):
  135.     def __init__(self):
  136.         self.loader = Loader ()
  137.  
  138.     def _build_cache_path(self, artist, title):
  139.         lyrics_folder = os.path.expanduser (LYRICS_FOLDER)
  140.         if not os.path.exists (lyrics_folder):
  141.             os.mkdir (lyrics_folder)
  142.  
  143.         return lyrics_folder + '/%s - %s.txt' % (artist, title)
  144.  
  145.     def get_lyrics(self, db, entry, callback):
  146.     self.callback = callback
  147.         artist = db.entry_get(entry, rhythmdb.PROP_ARTIST).lower()
  148.         title = db.entry_get(entry, rhythmdb.PROP_TITLE).lower()
  149.  
  150.     # replace ampersands and the like
  151.     for exp in LYRIC_ARTIST_REPLACE:
  152.         p = re.compile (exp[0])
  153.         artist = p.sub(exp[1], artist)
  154.     for exp in LYRIC_TITLE_REPLACE:
  155.         p = re.compile (exp[0])
  156.         title = p.sub(exp[1], title)
  157.  
  158.         # strip things like "(live at Somewhere)", "(accoustic)", etc
  159.         for exp in LYRIC_TITLE_STRIP:
  160.             p = re.compile (exp)
  161.             title = p.sub ('', title)
  162.  
  163.     # compress spaces
  164.     title = title.strip()
  165.     artist = artist.strip()
  166.  
  167.     self.cache_path = self._build_cache_path(artist, title)
  168.  
  169.     if os.path.exists (self.cache_path):
  170.             self.loader.get_url(self.cache_path, callback)
  171.             return;
  172.         
  173.     url = "http://api.leoslyrics.com/api_search.php?auth=Rhythmbox&artist=%s&songtitle=%s" % (
  174.         urllib.quote(artist.encode('utf-8')),
  175.         urllib.quote(title.encode('utf-8')))
  176.     self.loader.get_url(url, self.search_results)
  177.  
  178.     def search_results(self, data):
  179.         if data is None:
  180.         self.callback("Server did not respond.")
  181.         return
  182.  
  183.     try:
  184.         xmldoc = minidom.parseString(data).documentElement
  185.     except:
  186.         self.callback("Couldn't parse search results.")
  187.         return
  188.     
  189.     result_code = xmldoc.getElementsByTagName('response')[0].getAttribute('code')
  190.     if result_code != '0':
  191.         self.callback("Server is busy, try again later.")
  192.         xmldoc.unlink()
  193.         return
  194.     
  195.     # We don't really need the top 100 matches, so I'm limiting it to ten
  196.     matches = xmldoc.getElementsByTagName('result')[:10]
  197.     #songs = map(lambda x:
  198.     #        x.getElementsByTagName('name')[0].firstChild.nodeValue
  199.     #        + " - " +
  200.     #        x.getElementsByTagName('title')[0].firstChild.nodeValue,
  201.     #        matches)
  202.     hids = map(lambda x: x.getAttribute('hid'), matches)
  203.     #exacts = map(lambda x: x.getAttribute('exactMatch'), matches)
  204.  
  205.     if len(hids) == 0:
  206.         # FIXME show other matches
  207.         self.callback("Unable to find lyrics for this track.")
  208.         xmldoc.unlink()
  209.         return
  210.     
  211.     #songlist = []
  212.     #for i in range(len(hids)):
  213.     #    songlist.append((songs[i], hids[i], exacts[i]))
  214.  
  215.     xmldoc.unlink()
  216.     url = "http://api.leoslyrics.com/api_lyrics.php?auth=Rhythmbox&hid=%s" % (urllib.quote(hids[0].encode('utf-8')))
  217.     self.loader.get_url(url, self.lyrics)
  218.  
  219.  
  220.     def lyrics(self, data):
  221.         if data is None:
  222.         self.callback("Unable to find lyrics for this track.")
  223.         return
  224.  
  225.     try:
  226.         xmldoc = minidom.parseString(data).documentElement
  227.     except:
  228.         self.callback("Unable to parse the lyrics returned.")
  229.         return
  230.  
  231.     text = xmldoc.getElementsByTagName('title')[0].firstChild.nodeValue
  232.     text += ' - ' + xmldoc.getElementsByTagName('artist')[0].getElementsByTagName('name')[0].firstChild.nodeValue + '\n\n'
  233.     text += xmldoc.getElementsByTagName('text')[0].firstChild.nodeValue
  234.     xmldoc.unlink()
  235.  
  236.     text += "\n\n"+_("Lyrics provided by leoslyrics.com")
  237.  
  238.  
  239.         f = file (self.cache_path, 'w')
  240.         f.write (text)
  241.         f.close ()
  242.  
  243.     self.callback(text)
  244.  
  245.  
  246.  
  247. class LyricsDisplayPlugin(rb.Plugin):
  248.  
  249.     def __init__ (self):
  250.     rb.Plugin.__init__ (self)
  251.     self.window = None
  252.  
  253.     def activate (self, shell):
  254.     self.action = gtk.Action ('ViewSongLyrics', _('Song L_yrics'),
  255.                   _('Display lyrics for the playing song'),
  256.                   'rb-song-lyrics')
  257.     self.activate_id = self.action.connect ('activate', self.show_song_lyrics, shell)
  258.  
  259.     self.action_group = gtk.ActionGroup ('SongLyricsPluginActions')
  260.     self.action_group.add_action (self.action)
  261.         
  262.         uim = shell.get_ui_manager ()
  263.     uim.insert_action_group (self.action_group, 0)
  264.     self.ui_id = uim.add_ui_from_string (ui_str)
  265.     uim.ensure_update ()
  266.  
  267.     sp = shell.get_player ()
  268.     self.pec_id = sp.connect('playing-song-changed', self.playing_entry_changed)
  269.     self.playing_entry_changed (sp, sp.get_playing_entry ())
  270.  
  271.     self.csi_id = shell.connect('create_song_info', self.create_song_info)
  272.  
  273.     def deactivate (self, shell):
  274.         
  275.     uim = shell.get_ui_manager()
  276.     uim.remove_ui (self.ui_id)
  277.     uim.remove_action_group (self.action_group)
  278.  
  279.     self.action_group = None
  280.     self.action = None
  281.  
  282.     sp = shell.get_player ()
  283.     sp.disconnect (self.pec_id)
  284.  
  285.     if self.window is not None:
  286.         self.window.destroy ()
  287.  
  288.  
  289.     def playing_entry_changed (self, sp, entry):
  290.         if entry is not None:
  291.         self.action.set_sensitive (True)
  292.     else:
  293.         self.action.set_sensitive (False)
  294.  
  295.     def show_song_lyrics (self, action, shell):
  296.  
  297.     if self.window is not None:
  298.         self.window.destroy ()
  299.  
  300.     db = shell.get_property ("db")
  301.     sp = shell.get_player ()
  302.     entry = sp.get_playing_entry ()
  303.  
  304.     if entry is None:
  305.         return
  306.  
  307.     self.window = LyricWindow(db, entry)
  308.     lyrics_grabber = LyricGrabber()
  309.     lyrics_grabber.get_lyrics(db, entry, self.window.buffer.set_text)
  310.     
  311.     def create_song_info (self, shell, song_info, is_multiple):
  312.  
  313.     if is_multiple is False:
  314.         x = LyricPane(shell.get_property ("db"), song_info)
  315.  
  316.