home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / lib / rhythmbox / plugins / artdisplay / AmazonCoverArtSearch.py < prev    next >
Encoding:
Python Source  |  2006-08-30  |  7.8 KB  |  266 lines
  1. # -*- Mode: python; coding: utf-8; tab-width: 8; indent-tabs-mode: t; -*- 
  2. #
  3. # Copyright (C) 2006 - Gareth Murphy, Martin Szulecki
  4. #
  5. # This program is free software; you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation; either version 2, or (at your option)
  8. # any later version.
  9. # 
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program; if not, write to the Free Software
  17. # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.
  18.  
  19. from xml.dom import minidom
  20. import re
  21. import locale
  22. import urllib
  23.  
  24. import rhythmdb
  25. from Loader import Loader
  26.  
  27. LICENSE_KEY = "18C3VZN9HCECM5G3HQG2"
  28. DEFAULT_LOCALE = "en_US"
  29. ASSOCIATE = "webservices-20"
  30.  
  31.  
  32. class Bag: pass
  33.  
  34. class AmazonCoverArtSearch (object):
  35.     def __init__ (self, loader):
  36.         self.searching = False
  37.         self.cancel = False
  38.         self.loader = loader
  39.         self._supportedLocales = {
  40.             "en_US" : ("us", "xml.amazon.com"),
  41.             "en_GB" : ("uk", "xml-eu.amazon.com"),
  42.             "de" : ("de", "xml-eu.amazon.com"),
  43.             "ja" : ("jp", "xml.amazon.co.jp")
  44.         }
  45.         self.db = None
  46.         self.entry = None
  47.  
  48.     def __get_locale (self):
  49.         default = locale.getdefaultlocale ()
  50.         lc_id = DEFAULT_LOCALE
  51.         if default[0] is not None:
  52.             if self._supportedLocales.has_key (default[0]):
  53.                 lc_id = default[0]
  54.  
  55.         lc_host = self._supportedLocales[lc_id][1]
  56.         lc_name = self._supportedLocales[lc_id][0]
  57.         return ((lc_host, lc_name))
  58.  
  59.     def search (self, db, entry, on_search_completed_callback, *args):
  60.         self.searching = True
  61.         self.cancel = False
  62.         self.db = db
  63.         self.entry = entry
  64.         self.on_search_completed_callback = on_search_completed_callback
  65.         self.args = args
  66.         self.keywords = []
  67.  
  68.         st_artist = db.entry_get (entry, rhythmdb.PROP_ARTIST)
  69.         st_album = db.entry_get (entry, rhythmdb.PROP_ALBUM)
  70.  
  71.         # Tidy up
  72.  
  73.         # Replace quote characters
  74.         # don't replace single quote: could be important punctuation
  75.         for char in ["\""]:
  76.             st_artist = st_artist.replace (char, '')
  77.             st_album = st_album.replace (char, '')
  78.  
  79.  
  80.         self.st_album = st_album
  81.         self.st_artist = st_artist
  82.  
  83.         # Remove variants of Disc/CD [1-9] from album title before search
  84.         for exp in ["\([Dd]isc *[1-9]+\)", "\([Cc][Dd] *[1-9]+\)"]:
  85.             p = re.compile (exp)
  86.             st_album = p.sub ('', st_album)
  87.  
  88.         st_album_no_vol = st_album
  89.         for exp in ["\(*[Vv]ol.*[1-9]+\)*"]:
  90.             p = re.compile (exp)
  91.             st_album_no_vol = p.sub ('', st_album_no_vol)
  92.  
  93.         self.st_album_no_vol = st_album_no_vol
  94.  
  95.         # Save current search's entry properties
  96.         self.search_album = st_album
  97.         self.search_artist = st_artist
  98.         self.search_album_no_vol = st_album_no_vol
  99.         
  100.         # TODO: Improve to decrease wrong cover downloads, maybe add severity?
  101.         # Assemble list of search keywords (and thus search queries)
  102.         if st_album == "Unknown":
  103.             self.keywords.append ("%s Best of" % (st_artist))
  104.             self.keywords.append ("%s Greatest Hits" % (st_artist))
  105.             self.keywords.append ("%s Essential" % (st_artist))
  106.             self.keywords.append ("%s Collection" % (st_artist))
  107.             self.keywords.append ("%s" % (st_artist))
  108.         elif st_artist == "Unknown":
  109.             self.keywords.append ("%s" % (st_album))
  110.             if st_album_no_vol != st_artist:
  111.                 self.keywords.append ("%s" % (st_album_no_vol))
  112.             self.keywords.append ("Various %s" % (st_album))
  113.         else:
  114.             if st_album != st_artist:
  115.                 self.keywords.append ("%s %s" % (st_artist, st_album))
  116.                 if st_album_no_vol != st_album:
  117.                     self.keywords.append ("%s %s" % (st_artist, st_album_no_vol))
  118.                 if (st_album != "Unknown"):
  119.                     self.keywords.append ("Various %s" % (st_album))
  120.             self.keywords.append ("%s" % (st_artist))
  121.  
  122.         # Initiate asynchronous search
  123.         self.search_next ();
  124.  
  125.     def __build_url (self, keyword):
  126.         (lc_host, lc_name) = self.__get_locale ()
  127.  
  128.         url = "http://" + lc_host + "/onca/xml3?f=xml"
  129.         url += "&t=%s" % ASSOCIATE
  130.         url += "&dev-t=%s" % LICENSE_KEY
  131.         url += "&type=%s" % 'lite'
  132.         url += "&locale=%s" % lc_name
  133.         url += "&mode=%s" % 'music'
  134.         url += "&%s=%s" % ('KeywordSearch', urllib.quote (keyword))
  135.  
  136.         return url
  137.  
  138.     def search_next (self):
  139.         self.searching = True
  140.         
  141.         if len (self.keywords)==0:
  142.             keyword = None
  143.         else:
  144.             keyword = self.keywords.pop (0)
  145.  
  146.         if keyword is None:
  147.             # No keywords left to search -> no results
  148.             self.on_search_completed (None)
  149.             ret = False
  150.         else:
  151.             # Retrieve search for keyword
  152.             url = self.__build_url (keyword.strip ())
  153.             self.loader.get_url (url, self.on_search_response)
  154.             ret = True
  155.  
  156.         return ret
  157.  
  158.     def __unmarshal (self, element):
  159.         rc = Bag ()
  160.         if isinstance (element, minidom.Element) and (element.tagName == 'Details'):
  161.             rc.URL = element.attributes["url"].value
  162.         childElements = [e for e in element.childNodes if isinstance (e, minidom.Element)]
  163.         if childElements:
  164.             for child in childElements:
  165.                 key = child.tagName
  166.                 if hasattr (rc, key):
  167.                     if type (getattr (rc, key)) <> type ([]):
  168.                         setattr (rc, key, [getattr (rc, key)])
  169.                     setattr (rc, key, getattr (rc, key) + [self.__unmarshal (child)])
  170.                 elif isinstance(child, minidom.Element) and (child.tagName == 'Details'):
  171.                     setattr (rc,key,[self.__unmarshal(child)])
  172.                 else:
  173.                     setattr (rc, key, self.__unmarshal(child))
  174.         else:
  175.             rc = "".join ([e.data for e in element.childNodes if isinstance (e, minidom.Text)])
  176.             if element.tagName == 'SalesRank':
  177.                 rc = rc.replace ('.', '')
  178.                 rc = rc.replace (',', '')
  179.                 rc = int (rc)
  180.         return rc
  181.  
  182.     def on_search_response (self, result_data):
  183.         if result_data is None:
  184.             self.search_next()
  185.             return
  186.  
  187.         try:
  188.             xmldoc = minidom.parseString (result_data)
  189.         except:
  190.             self.search_next()
  191.             return
  192.         
  193.         data = self.__unmarshal (xmldoc).ProductInfo
  194.  
  195.         if hasattr(data, 'ErrorMsg'):
  196.             # Search was unsuccessful, try next keyword
  197.             self.search_next ()
  198.         else:
  199.             # We got some search results
  200.             self.on_search_results (data.Details)
  201.  
  202.     def on_search_results (self, results):
  203.         self.on_search_completed (results)
  204.  
  205.     def on_search_completed (self, result):
  206.         self.on_search_completed_callback (self, self.entry, result, *self.args)
  207.         self.searching = False
  208.  
  209.     def __tidy_up_string (self, s):
  210.         # Lowercase
  211.         s = s.lower ()
  212.         # Strip
  213.         s = s.strip ()
  214.  
  215.         # TODO: Convert accented to unaccented (fixes matching Salom├⌐ vs Salome)
  216.         s = s.replace (" - ", " ")    
  217.         s = s.replace (": ", " ")
  218.         s = s.replace (" & ", " and ")
  219.  
  220.         return s
  221.  
  222.     def get_best_match (self, search_results):
  223.         # Default to "no match", our results must match our criteria
  224.         best_match = None
  225.  
  226.         try:
  227.             if self.search_album != "Unknown":
  228.                 album_check = self.__tidy_up_string (self.search_album)
  229.                 for item in search_results:
  230.                     # Check for album name in ProductName
  231.                     product_name = self.__tidy_up_string (item.ProductName)
  232.  
  233.                     if product_name == album_check:
  234.                         # Found exact album, can not get better than that
  235.                         best_match = item
  236.                         break
  237.                     # If we already found a best_match, just keep checking for exact one
  238.                     elif (best_match is None) and (product_name.find (album_check) != -1):
  239.                         best_match = item
  240.  
  241.             # If we still have no definite hit, use first result where artist matches
  242.             if (self.search_album == "Unknown" and self.search_artist != "Unknown"):
  243.                 artist_check = self.__tidy_up_string (self.search_artist)
  244.                 if best_match is None:
  245.                     # Check if artist appears in the Artists list
  246.                     hit = False
  247.                     for item in search_results:
  248.                         if type (item.Artists.Artist) <> type ([]):
  249.                             artists = [item.Artists.Artist]
  250.                         else:
  251.                             artists = item.Artists.Artist
  252.  
  253.                         for artist in artists:
  254.                             artist = self.__tidy_up_string (artist)
  255.                             if artist.find (artist_check) != -1:
  256.                                 best_match = item
  257.                                 hit = True                        
  258.                                 break
  259.                         if hit:
  260.                             break
  261.  
  262.             return best_match
  263.  
  264.         except TypeError:
  265.             return None
  266.