Verified Commit 86964502 authored by Eliot Berriot's avatar Eliot Berriot
Browse files

Poc of browsing favorites with cache

parent 8d51087d
...@@ -9,39 +9,40 @@ import os ...@@ -9,39 +9,40 @@ import os
__author__ = """Eliot Berriot""" __author__ = """Eliot Berriot"""
__email__ = '' __email__ = ""
__version__ = '0.1.0' __version__ = "0.1.0"
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
class Extension(mopidy.ext.Extension): class Extension(mopidy.ext.Extension):
dist_name = 'Mopidy-Funkwhale' dist_name = "Mopidy-Funkwhale"
ext_name = 'funkwhale' ext_name = "funkwhale"
version = __version__ version = __version__
def get_default_config(self): def get_default_config(self):
conf_file = os.path.join(os.path.dirname(__file__), 'ext.conf') conf_file = os.path.join(os.path.dirname(__file__), "ext.conf")
return return
def get_config_schema(self): def get_config_schema(self):
schema = super(Extension, self).get_config_schema() schema = super(Extension, self).get_config_schema()
schema['url'] = mopidy.config.String() schema["url"] = mopidy.config.String()
schema['username'] = mopidy.config.String(optional=True) schema["username"] = mopidy.config.String(optional=True)
schema['password'] = mopidy.config.Secret(optional=True) schema["password"] = mopidy.config.Secret(optional=True)
return schema return schema
def validate_config(self, config): def validate_config(self, config):
if not config.getboolean('funkwhale', 'enabled'): if not config.getboolean("funkwhale", "enabled"):
return return
username = config.getstring('funkwhale', 'username') username = config.getstring("funkwhale", "username")
password = config.getstring('funkwhale', 'password') password = config.getstring("funkwhale", "password")
if any([username, password]) and not all([username, password]): if any([username, password]) and not all([username, password]):
raise mopidy.ext.ExtensionError( raise mopidy.ext.ExtensionError(
'You need to provide username and password to authenticate with the funkwhale backend' "You need to provide username and password to authenticate with the funkwhale backend"
) )
def setup(self, registry): def setup(self, registry):
from . import actor from . import actor
registry.add('backend', actor.FunkwhaleBackend)
registry.add("backend", actor.FunkwhaleBackend)
...@@ -14,34 +14,37 @@ logger = logging.getLogger(__name__) ...@@ -14,34 +14,37 @@ logger = logging.getLogger(__name__)
class FunkwhaleBackend(pykka.ThreadingActor, backend.Backend): class FunkwhaleBackend(pykka.ThreadingActor, backend.Backend):
def __init__(self, config, audio): def __init__(self, config, audio):
super(FunkwhaleBackend, self).__init__() super(FunkwhaleBackend, self).__init__()
self.config = config self.config = config
self.remote = client.FunkwhaleClient(config) self.client = client.APIClient(config)
self.library = library.FunkwhaleLibraryProvider(backend=self) self.library = library.FunkwhaleLibraryProvider(backend=self)
self.playback = FunkwhalePlaybackProvider(audio=audio, backend=self) self.playback = FunkwhalePlaybackProvider(audio=audio, backend=self)
self.uri_schemes = ['funkwhale', 'fw'] self.uri_schemes = ["funkwhale", "fw"]
def on_start(self): def on_start(self):
username = self.remote.username if self.client.username is not None:
if username is not None: self.client.login()'Logged in to Funkwhale as "%s" on "%s"', username, self.config['funkwhale']['url'])
'Logged in to Funkwhale as "%s" on "%s"',
else: else:'Using "%s" anonymously', self.config['funkwhale']['url'])'Using "%s" anonymously', self.config["funkwhale"]["url"])
class FunkwhalePlaybackProvider(backend.PlaybackProvider): class FunkwhalePlaybackProvider(backend.PlaybackProvider):
def translate_uri(self, uri): def translate_uri(self, uri):
_, id = library.parse_uri(uri) _, id = library.parse_uri(uri)
track = self.backend.remote.http_client.get_track(id) track = self.backend.client.get_track(id)
if track is None: if track is None:
return None return None
url = track['listen_url'] url = track["listen_url"]
if url.startswith('/'): if url.startswith("/"):
url = self.backend.config['funkwhale']['url'] + url url = self.backend.config["funkwhale"]["url"] + url
if self.backend.remote.token: if self.backend.client.token:
url += '?jwt=' + self.backend.remote.token url += "?jwt=" + self.backend.client.token
return url return url
...@@ -23,68 +23,66 @@ class SessionWithUrlBase(requests.Session): ...@@ -23,68 +23,66 @@ class SessionWithUrlBase(requests.Session):
def get_requests_session(url, proxy_config, user_agent): def get_requests_session(url, proxy_config, user_agent):
if not url.endswith('/'): if not url.endswith("/"):
url += '/' url += "/"
url += 'api/v1/' url += "api/v1/"
proxy = httpclient.format_proxy(proxy_config) proxy = httpclient.format_proxy(proxy_config)
full_user_agent = httpclient.format_user_agent(user_agent) full_user_agent = httpclient.format_user_agent(user_agent)
session = SessionWithUrlBase(url_base=url) session = SessionWithUrlBase(url_base=url)
session.proxies.update({'http': proxy, 'https': proxy}) session.proxies.update({"http": proxy, "https": proxy})
session.headers.update({'user-agent': full_user_agent}) session.headers.update({"user-agent": full_user_agent})
return session return session
def login(session, username, password): def login(session, username, password):
response ='token/', {'username': username, 'password': password}) if not username:
response ="token/", {"username": username, "password": password})
try: try:
response.raise_for_status() response.raise_for_status()
except requests.exceptions.HTTPError: except requests.exceptions.HTTPError:
raise exceptions.BackendError('Authentication failed for user %s' % (username,)) raise exceptions.BackendError("Authentication failed for user %s" % (username,))
token = response.json()['token'] token = response.json()["token"]
session.headers.update({'Authorization': 'JWT %s' % (token,)}) session.headers.update({"Authorization": "JWT %s" % (token,)})
return token return token
class APIClient(object): class APIClient(object):
def __init__(self, session): def __init__(self, config):
self.session = session self.config = config
self.session = get_requests_session(
user_agent="%s/%s" % (Extension.dist_name, __version__),
self.username = self.config["funkwhale"]["username"]
self.token = None
def login(self):
self.username = self.config["funkwhale"]["username"]
if self.username:
self.token = login(
self.token = None
def search(self, query): def search(self, query):
response = self.session.get('search', params={'query': query}) response = self.session.get("search", params={"query": query})
response.raise_for_status() response.raise_for_status()
return response.json() return response.json()
def get_track(self, id): def get_track(self, id):
response = self.session.get('tracks/{}/'.format(id)) response = self.session.get("tracks/{}/".format(id))
response.raise_for_status() response.raise_for_status()
return response.json() return response.json()
def list_tracks(self, filters): def list_tracks(self, filters):
response = self.session.get('tracks/', params=filters) response = self.session.get("tracks/", params=filters)
response.raise_for_status() response.raise_for_status()
return response.json() return response.json()
class FunkwhaleClient(object):
def __init__(self, config):
super(FunkwhaleClient, self).__init__()
self.page_size = config['funkwhale'].get('page_size', 50)
self.http_client = APIClient(
user_agent='%s/%s' % (
self.username = config['funkwhale']['username']
self.token = None
if config['funkwhale']['username']:
self.token = login(
...@@ -3,12 +3,21 @@ from __future__ import unicode_literals ...@@ -3,12 +3,21 @@ from __future__ import unicode_literals
import collections import collections
import logging import logging
import re import re
import time
import urllib
from mopidy import backend, models from mopidy import backend, models
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
def generate_uri(path):
return "funkwhale:directory:%s" % path
def new_folder(name, path):
return, name=name)
def simplify_search_query(query): def simplify_search_query(query):
...@@ -19,165 +28,185 @@ def simplify_search_query(query): ...@@ -19,165 +28,185 @@ def simplify_search_query(query):
r.extend(v) r.extend(v)
else: else:
r.append(v) r.append(v)
return ' '.join(r) return " ".join(r)
if isinstance(query, list): if isinstance(query, list):
return ' '.join(query) return " ".join(query)
else: else:
return query return query
class Cache(collections.OrderedDict):
def __init__(self, max_age=0):
self.max_age = max_age
super(Cache, self).__init__()
def set(self, key, value):
now = time.time()
self[key] = (now, value)
def get(self, key):
value = super(Cache, self).get(key)
if value is None:
now = time.time()
t, v = value
if self.max_age and t + self.max_age < now:
# entry is too old, we delete it
del self[key]
return None
return v
class FunkwhaleLibraryProvider(backend.LibraryProvider): class FunkwhaleLibraryProvider(backend.LibraryProvider):
root_directory = root_directory ="funkwhale:directory", name="Funkwhale")
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
super(FunkwhaleLibraryProvider, self).__init__(*args, **kwargs) super(FunkwhaleLibraryProvider, self).__init__(*args, **kwargs)
self.vfs = {'funkwhale:directory': collections.OrderedDict()} self.vfs = {"funkwhale:directory": collections.OrderedDict()}
# self.add_to_vfs(new_folder('Favorites', ['favorites'])) self.add_to_vfs(new_folder("Favorites", "favorites"))
# self.add_to_vfs(new_folder('Following', ['following'])) # self.add_to_vfs(new_folder('Following', ['following']))
# self.add_to_vfs(new_folder('Sets', ['sets'])) # self.add_to_vfs(new_folder('Sets', ['sets']))
# self.add_to_vfs(new_folder('Stream', ['stream'])) # self.add_to_vfs(new_folder('Stream', ['stream']))
self.cache = Cache()
def add_to_vfs(self, _model): def add_to_vfs(self, _model):
self.vfs['funkwhale:directory'][_model.uri] = _model self.vfs["funkwhale:directory"][_model.uri] = _model
def list_sets(self):
sets_vfs = collections.OrderedDict()
for (name, set_id, tracks) in self.backend.remote.get_sets():
sets_list = new_folder(name, ['sets', set_id])
logger.debug('Adding set %s to vfs' %
sets_vfs[set_id] = sets_list
return sets_vfs.values()
def list_favorites(self):
vfs_list = collections.OrderedDict()
for track in self.backend.remote.get_likes():
logger.debug('Adding liked track %s to vfs' %
vfs_list[] = models.Ref.track(
return vfs_list.values()
def list_user_follows(self):
sets_vfs = collections.OrderedDict()
for (name, user_id) in self.backend.remote.get_followings():
sets_list = new_folder(name, ['following', user_id])
logger.debug('Adding set %s to vfs' %
sets_vfs[user_id] = sets_list
return sets_vfs.values()
def tracklist_to_vfs(self, track_list):
vfs_list = collections.OrderedDict()
for temp_track in track_list:
if not isinstance(temp_track, Track):
temp_track = self.backend.remote.parse_track(temp_track)
if hasattr(temp_track, 'uri'):
vfs_list[] = models.Ref.track(
return vfs_list.values()
def browse(self, uri): def browse(self, uri):
if not self.vfs.get(uri): if not self.vfs.get(uri):
(req_type, res_id) = re.match(r'.*:(\w*)(?:/(\d*))?', uri).groups() if uri.startswith("funkwhale:directory:"):
uri = uri.replace("funkwhale:directory:", "", 1)
if 'favorites' == req_type: parts = uri.split(":")
return self.list_favorites() remaining = parts[1:] if len(parts) > 1 else []
print("PARTS", parts, remaining)
handler = getattr(self, "browse_%s" % parts[0])
return handler(remaining)
# root directory # root directory
return self.vfs.get(uri, {}).values() return self.vfs.get(uri, {}).values()
def browse_favorites(self, remaining):
if remaining == []:
return [
new_folder("Recent", "favorites:recent"),
new_folder("By artist", "favorites:by-artist"),
if remaining == ["recent"]:
payload = self.backend.client.list_tracks(
{"favorites": "true", "ordering": "-creation_date", "page_size": 100}
return [
convert_to_track(row, ref=True, cache=self.cache) for row in payload
return []
def search(self, query=None, uris=None, exact=False): def search(self, query=None, uris=None, exact=False):
# TODO Support exact search # TODO Support exact search
if not query: if not query:
return return
if 'uri' in query:
search_query = ''.join(query['uri'])
url = urlparse(search_query)
if '' in url.netloc:'Resolving SoundCloud for: %s', search_query)
return SearchResult(
else: else:
search_query = simplify_search_query(query) search_query = simplify_search_query(query)'Searching Funkwhale for: %s', search_query)"Searching Funkwhale for: %s", search_query)
raw_results = raw_results =
artists = [convert_to_artist(row) for row in raw_results['artists']] artists = [convert_to_artist(row) for row in raw_results["artists"]]
albums = [convert_to_album(row) for row in raw_results['albums']] albums = [convert_to_album(row) for row in raw_results["albums"]]
tracks = [convert_to_track(row) for row in raw_results['tracks']] tracks = [convert_to_track(row) for row in raw_results["tracks"]]
return models.SearchResult( return models.SearchResult(
uri='funkwhale:search', uri="funkwhale:search", tracks=tracks, albums=albums, artists=artists
) )
def lookup(self, uri): def lookup(self, uri):
if 'fw:' in uri: print("CACHE", self.cache, uri)
uri = uri.replace('fw:', '') from_cache = self.cache.get(uri)
if from_cache:
return from_cache
except TypeError:
return [from_cache]
if "fw:" in uri:
uri = uri.replace("fw:", "")
return self.backend.remote.resolve_url(uri) return self.backend.remote.resolve_url(uri)
client = self.backend.remote.http_client client = self.backend.client
config = { config = {
'track': lambda id: [client.get_track(id)], "track": lambda id: [client.get_track(id)],
'album': lambda id: client.list_tracks({'album': id})['results'], "album": lambda id: client.list_tracks({"album": id})["results"],
'artist': lambda id: client.list_tracks({'artist': id})['results'], "artist": lambda id: client.list_tracks({"artist": id})["results"],
} }
type, id = parse_uri(uri) type, id = parse_uri(uri)
payload = config[type](id) payload = config[type](id)
return [convert_to_track(row, cache=self.cache) for row in payload]
return [convert_to_track(row) for row in payload]
def parse_uri(uri): def parse_uri(uri):
uri = uri.replace('funkwhale:', '') uri = uri.replace("funkwhale:", "", 1)
parts = uri.split(':') parts = uri.split(":")
type = parts[0].rstrip('s') type = parts[0].rstrip("s")
id = int(parts[1]) id = int(parts[1])
return type, id return type, id
def cast_to_ref(f):
def inner(payload, ref=False, cache=None):
result = f(payload)
if cache is not None:
cache.set(result.uri, result)
if ref:
return to_ref(result)
return result
return inner
def convert_to_artist(payload): def convert_to_artist(payload):
return models.Artist( return models.Artist(
uri='funkwhale:artists:%s' % (payload['id'],), uri="funkwhale:artists:%s" % (payload["id"],),
name=payload['name'], name=payload["name"],
sortname=payload['name'], sortname=payload["name"],
musicbrainz_id=payload['mbid'], musicbrainz_id=payload["mbid"],
) )
def convert_to_album(payload): def convert_to_album(payload):
artist = convert_to_artist(payload['artist']) artist = convert_to_artist(payload["artist"])
image = payload['cover']['original'] if payload['cover'] else None image = payload["cover"]["original"] if payload["cover"] else None
return models.Album( return models.Album(
uri='funkwhale:albums:%s' % (payload['id'],), uri="funkwhale:albums:%s" % (payload["id"],),
name=payload['title'], name=payload["title"],
musicbrainz_id=payload['mbid'], musicbrainz_id=payload["mbid"],
images=[image] if image else [], images=[image] if image else [],
artists=[artist], artists=[artist],
date=payload['release_date'], date=payload["release_date"],
num_tracks=len(payload.get('tracks', [])), num_tracks=len(payload.get("tracks", [])),
) )