Lyrics: add some new grabbers based on ones from upstream.

Only tested using their self test method not in MythMusic.

Also move some logging to only show when debug mode is on.

mythtv/programs/scripts/metadata/Music/lyrics/README

@@ -90,15 +90,17 @@ Options:
 Current Grabbers, Their Priority And Whether Synchronized
 =========================================================
 
-EmbeddedLyrics 100  Yes/No
-FileLyrics     105  Yes/No
-TTPlayer       110  Yes
-Alsong         120  Yes
-LetsSingIt     130  No
-LyricsCom      140  No
-LyricsWiki     150  No
-Genius         160  No
-LyricsMode     170  No
-DarkLyrics     180  No
-GomAudio       200  Yes
-Baidu          210  Yes
+EmbeddedLyrics   50     Yes/No
+FileLyrics       90     Yes/No
+musixmatchlrc   100     Yes     NEW in v34
+lrclib          110     Yes     NEW in v34
+lyricsify       130     Yes     NEW in v34
+genius          200     No
+musixmatch      210     No      NEW in v34
+lyricsmode      220     No
+azlyrics        230     No      NEW in v34
+lyricscom       240     No
+supermusic      250     No      NEW in v34
+darklyrics      260     No
+megalobiz       400     Yes     (too slow to be earlier, was 140)
+music163        500     Yes     (returns incomplete results, was 120)

mythtv/programs/scripts/metadata/Music/lyrics/azlyrics.py

@@ -0,0 +1,159 @@
+#-*- coding: UTF-8 -*-
+"""
+Scraper for http://www.azlyrics.com/
+ronie
+"""
+
+import sys
+import re
+import requests
+import html
+from optparse import OptionParser
+from common import utilities
+
+__author__      = "ronie"
+__title__       = "Azlyrics"
+__description__ = "Search http://www.azlyrics.com/ for lyrics"
+__version__     = "0.1"
+__priority__    = "230"
+__syncronized__ = False
+
+debug = False
+
+class LyricsFetcher:
+    def __init__( self ):
+        self.url = 'https://www.azlyrics.com/lyrics/%s/%s.html'
+
+    def get_lyrics(self, lyrics):
+        utilities.log(debug, '%s: searching lyrics for %s - %s' % (__title__, lyrics.artist, lyrics.title))
+        artist = re.sub("[^a-zA-Z0-9]+", "", lyrics.artist).lower().lstrip('the ')
+        title = re.sub("[^a-zA-Z0-9]+", "", lyrics.title).lower()
+        try:
+            req = requests.get(self.url % (artist, title), timeout=10)
+            response = req.text
+
+        except:
+            return False
+        req.close()
+        try:
+            lyricscode = response.split('t. -->')[1].split('</div')[0]
+            lyricstext = html.unescape(lyricscode).replace('<br />', '\n')
+            lyr = re.sub('<[^<]+?>', '', lyricstext)
+            lyrics.lyrics = lyr
+            return True
+        except:
+            return False
+
+def performSelfTest():
+    found = False
+    lyrics = utilities.Lyrics()
+    lyrics.source = __title__
+    lyrics.syncronized = __syncronized__
+    lyrics.artist = 'Dire Straits'
+    lyrics.album = 'Brothers In Arms'
+    lyrics.title = 'Money For Nothing'
+
+    fetcher = LyricsFetcher()
+    found = fetcher.get_lyrics(lyrics)
+
+    if found:
+        utilities.log(True, "Everything appears in order.")
+        buildLyrics(lyrics)
+        sys.exit(0)
+
+    utilities.log(True, "The lyrics for the test search failed!")
+    sys.exit(1)
+
+def buildLyrics(lyrics):
+    from lxml import etree
+    xml = etree.XML(u'<lyrics></lyrics>')
+    etree.SubElement(xml, "artist").text = lyrics.artist
+    etree.SubElement(xml, "album").text = lyrics.album
+    etree.SubElement(xml, "title").text = lyrics.title
+    etree.SubElement(xml, "syncronized").text = 'True' if __syncronized__ else 'False'
+    etree.SubElement(xml, "grabber").text = lyrics.source
+
+    lines = lyrics.lyrics.splitlines()
+    for line in lines:
+        etree.SubElement(xml, "lyric").text = line
+
+    utilities.log(True,  utilities.convert_etree(etree.tostring(xml, encoding='UTF-8',
+                                                 pretty_print=True, xml_declaration=True)))
+    sys.exit(0)
+
+def buildVersion():
+    from lxml import etree
+    version = etree.XML(u'<grabber></grabber>')
+    etree.SubElement(version, "name").text = __title__
+    etree.SubElement(version, "author").text = __author__
+    etree.SubElement(version, "command").text = 'azlyrics.py'
+    etree.SubElement(version, "type").text = 'lyrics'
+    etree.SubElement(version, "description").text = __description__
+    etree.SubElement(version, "version").text = __version__
+    etree.SubElement(version, "priority").text = __priority__
+    etree.SubElement(version, "syncronized").text = 'True' if __syncronized__ else 'False'
+
+    utilities.log(True,  utilities.convert_etree(etree.tostring(version, encoding='UTF-8',
+                                                 pretty_print=True, xml_declaration=True)))
+    sys.exit(0)
+
+def main():
+    global debug
+
+    parser = OptionParser()
+
+    parser.add_option('-v', "--version", action="store_true", default=False,
+                      dest="version", help="Display version and author")
+    parser.add_option('-t', "--test", action="store_true", default=False,
+                      dest="test", help="Perform self-test for dependencies.")
+    parser.add_option('-s', "--search", action="store_true", default=False,
+                      dest="search", help="Search for lyrics.")
+    parser.add_option('-a', "--artist", metavar="ARTIST", default=None,
+                      dest="artist", help="Artist of track.")
+    parser.add_option('-b', "--album", metavar="ALBUM", default=None,
+                      dest="album", help="Album of track.")
+    parser.add_option('-n', "--title", metavar="TITLE", default=None,
+                      dest="title", help="Title of track.")
+    parser.add_option('-f', "--filename", metavar="FILENAME", default=None,
+                      dest="filename", help="Filename of track.")
+    parser.add_option('-d', '--debug', action="store_true", default=False,
+                      dest="debug", help=("Show debug messages"))
+
+    opts, args = parser.parse_args()
+
+    lyrics = utilities.Lyrics()
+    lyrics.source = __title__
+    lyrics.syncronized = __syncronized__
+
+    if opts.debug:
+        debug = True
+
+    if opts.version:
+        buildVersion()
+
+    if opts.test:
+        performSelfTest()
+
+    if opts.artist:
+        lyrics.artist = opts.artist
+    if opts.album:
+        lyrics.album = opts.album
+    if opts.title:
+        lyrics.title = opts.title
+    if opts.filename:
+        lyrics.filename = opts.filename
+
+    if (len(args) > 0):
+        utilities.log('ERROR: invalid arguments found')
+        sys.exit(1)
+
+    fetcher = LyricsFetcher()
+    if fetcher.get_lyrics(lyrics):
+        buildLyrics(lyrics)
+        sys.exit(0)
+    else:
+        utilities.log(True, "No lyrics found for this track")
+        sys.exit(1)
+
+if __name__ == '__main__':
+    main()

mythtv/programs/scripts/metadata/Music/lyrics/common/utilities.py

@@ -25,3 +25,20 @@ def convert_etree(etostr):
     """
     return(etostr.decode())
 
+def getCacheDir():
+    confdir = os.environ.get('MYTHCONFDIR', '')
+
+    if (not confdir) or (confdir == '/'):
+        confdir = os.environ.get('HOME', '')
+
+    if (not confdir) or (confdir == '/'):
+        print ("Unable to find MythTV directory for metadata cache.")
+        return '/tmp'
+
+    confdir = os.path.join(confdir, '.mythtv')
+    cachedir = os.path.join(confdir, 'cache')
+
+    if not os.path.exists(cachedir):
+        os.makedirs(cachedir)
+
+    return cachedir

mythtv/programs/scripts/metadata/Music/lyrics/genius.py

@@ -49,7 +49,7 @@ def get_lyrics(self, lyrics):
                 return False
         except:
             return False
-        utilities.log(True, '%s: search url: %s' % (__title__, self.page))
+        utilities.log(debug, '%s: search url: %s' % (__title__, self.page))
         try:
             headers = {'user-agent': 'Mozilla/5.0 (Windows NT 10.0; rv:77.0) Gecko/20100101 Firefox/77.0'}
             req = requests.get(self.page, headers=headers, timeout=10)
@@ -72,8 +72,6 @@ def get_lyrics(self, lyrics):
         except:
             return False
 
-
-
 def performSelfTest():
     found = False
     lyrics = utilities.Lyrics()