From 7fa150111299513ede15b0383256f6b9a9105c00 Mon Sep 17 00:00:00 2001
From: Carey Metcalfe <carey@cmetcalfe.ca>
Date: Thu, 17 Jan 2019 00:51:42 -0500
Subject: [PATCH] Cache lyrics obtained from ChartLyrics

Lyrics are stored as json in a zlib-compressed file.
---
 supysonic/api/media.py | 43 ++++++++++++++++++++++++++++++------------
 1 file changed, 31 insertions(+), 12 deletions(-)

diff --git a/supysonic/api/media.py b/supysonic/api/media.py
index 1df2ade..c588d2e 100644
--- a/supysonic/api/media.py
+++ b/supysonic/api/media.py
@@ -16,6 +16,9 @@ import shlex
 import subprocess
 import uuid
 import io
+import hashlib
+import json
+import zlib
 
 from flask import request, Response, send_file
 from flask import current_app
@@ -234,21 +237,37 @@ def lyrics():
                 value = lyrics
             ))
 
+    # Create a stable, unique, filesystem-compatible identifier for the artist+title
+    unique = hashlib.md5(json.dumps([x.lower() for x in (artist, title)]).encode('utf-8')).hexdigest()
+    cache_key = "lyrics-{}".format(unique)
+
+    lyrics = dict()
     try:
-        r = requests.get("http://api.chartlyrics.com/apiv1.asmx/SearchLyricDirect",
-            params = { 'artist': artist, 'song': title }, timeout = 5)
-        root = ElementTree.fromstring(r.content)
+        lyrics = json.loads(
+            zlib.decompress(
+                current_app.cache.get_value(cache_key)
+            ).decode('utf-8')
+        )
+    except (CacheMiss, zlib.error, TypeError, ValueError):
+        try:
+            r = requests.get("http://api.chartlyrics.com/apiv1.asmx/SearchLyricDirect",
+                             params={'artist': artist, 'song': title}, timeout=5)
+            root = ElementTree.fromstring(r.content)
 
-        ns = { 'cl': 'http://api.chartlyrics.com/' }
-        return request.formatter('lyrics', dict(
-            artist = root.find('cl:LyricArtist', namespaces = ns).text,
-            title = root.find('cl:LyricSong', namespaces = ns).text,
-            value = root.find('cl:Lyric', namespaces = ns).text
-        ))
-    except requests.exceptions.RequestException as e: # pragma: nocover
-        logger.warning('Error while requesting the ChartLyrics API: ' + str(e))
+            ns = {'cl': 'http://api.chartlyrics.com/'}
+            lyrics = dict(
+                artist = root.find('cl:LyricArtist', namespaces=ns).text,
+                title = root.find('cl:LyricSong', namespaces=ns).text,
+                value = root.find('cl:Lyric', namespaces=ns).text
+            )
 
-    return request.formatter('lyrics', dict()) # pragma: nocover
+            current_app.cache.set(
+                cache_key, zlib.compress(json.dumps(lyrics).encode('utf-8'), 9)
+            )
+        except requests.exceptions.RequestException as e: # pragma: nocover
+            logger.warning('Error while requesting the ChartLyrics API: ' + str(e))
+
+    return request.formatter('lyrics', lyrics)
 
 def read_file_as_unicode(path):
     """ Opens a file trying with different encodings and returns the contents as a unicode string """