fuo协议Show命令增强-Add Features

fuocore/cmds/__init__.py

@@ -1,6 +1,8 @@
 import logging
 
 from fuocore.excs import FuoException
+from fuocore.router import ShowCmdException
+
 from .base import cmd_handler_mapping
 
 from .help import HelpHandler  # noqa
@@ -66,6 +68,9 @@ def exec_cmd(cmd, *args, app):
                               playlist=playlist,
                               live_lyric=live_lyric)
         rv = handler.handle(cmd)
+    except ShowCmdException:
+        logger.exception('handle cmd({}) error'.format(cmd))
+        return False, 'show command not correct'
     except Exception:
         logger.exception('handle cmd({}) error'.format(cmd))
         return False, 'internal server error'

fuocore/cmds/show.py

@@ -11,12 +11,11 @@
 import logging
 from urllib.parse import urlparse
 
-from fuocore.router import Router
 from fuocore.utils import reader_to_list, to_reader
+from fuocore.router import Router
 
 from .base import AbstractHandler
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -39,54 +38,152 @@ def handle(self, cmd):
         return rv
 
 
+def noexception_handler_default(obj_name, obj_identifier, obj):
+    if obj is None:
+        return "{} identified by {} is not found"\
+            .format(obj_name, obj_identifier)
+    return obj
+
+
+def noexception_handler_lyric(obj_name, obj_identifier, obj):
+    song, sid = obj, obj_identifier
+    if song is None:
+        return "{} identified by {} is not found"\
+            .format(obj_name, sid)
+
+    if song.lyric is None:
+        return "no lyric for this song, enjoy it ~"
+
+    return song.lyric.content
+
+
+def noexception_handler_user(obj_name, obj_identifier, obj):
+    user, uid = obj, obj_identifier
+    if user is not None:
+        return user
+    elif uid == 'me':
+        return "User is not logged in in current session(plugin)"
+    else:
+        return "No {} with uid {} ".format(obj_name, uid)
+
+
+def noexception_handler_readerlist(obj_name, obj_identifier, obj):
+    if obj is None:
+        return "No {} found by {} "\
+            .format(obj_name, obj_identifier)
+
+    # quick and dirty implement
+    if obj_name == 'playlists':
+        return reader_to_list(to_reader(obj, "songs"))
+    else:
+        return reader_to_list(to_reader(obj, "albums"))
+
+
+def get_from_provider(
+        req,
+        provider,
+        obj_identifier,
+        obj_name,
+        handler=noexception_handler_default):
+    provider_path_name = provider
+    provider = req.ctx['library'].get(provider)
+
+    if provider is None:
+        return "No such provider : {}".format(provider_path_name)
+
+    try:
+        if obj_name == 'songs':
+            obj = provider.Song.get(obj_identifier)
+        elif obj_name == 'artists':
+            obj = provider.Artist.get(obj_identifier)
+        elif obj_name == 'ablums':
+            obj = provider.Album.get(obj_identifier)
+        elif obj_name == 'playlists':
+            obj = provider.Playlist.get(obj_identifier)
+        elif obj_name == 'users':
+            if obj_identifier == 'me':
+                obj = provider._user
+            else:
+                obj = provider.User.get(obj_identifier)
+        else:
+            obj = None
+    except Exception:
+        return "resource-{} identified by {} is unavailable in {}"\
+            .format(obj_name, obj_identifier, provider.name)
+    else:
+        return handler(obj_name, obj_identifier, obj)
+
+
 @route('/')
 def list_providers(req):
     return req.ctx['library'].list()
 
 
 @route('/<provider>/songs/<sid>')
 def song_detail(req, provider, sid):
-    provider = req.ctx['library'].get(provider)
-    song = provider.Song.get(sid)
-    return song
+    return get_from_provider(req, provider, sid, "songs")
 
 
 @route('/<provider>/songs/<sid>/lyric')
 def lyric(req, provider, sid):
-    provider = req.ctx['library'].get(provider)
-    song = provider.Song.get(sid)
-    if song.lyric:
-        return song.lyric.content
-    return ''
+    return get_from_provider(req, provider, sid, "songs", noexception_handler_lyric)
 
 
 @route('/<provider>/artists/<aid>')
 def artist_detail(req, provider, aid):
-    provider = req.ctx['library'].get(provider)
-    return provider.Artist.get(aid)
+    return get_from_provider(req, provider, aid, "artists")
 
 
 @route('/<provider>/albums/<bid>')
 def album_detail(req, provider, bid):
-    provider = req.ctx['library'].get(provider)
-    return provider.Album.get(bid)
+    return get_from_provider(req, provider, bid, "albums")
+
+
+'''
+------------------------------------
+Original Route -- get User by uid
+example : fuo show fuo://<provider>/users/12345678
+------------------------------------
+Issue #317
+Description: fuo show nehancement -- show info about current user
+example : fuo show fuo://<provider>/users/me
+'''
 
 
 @route('/<provider>/users/<uid>')
 def user_detail(req, provider, uid):
-    provider = req.ctx['library'].get(provider)
-    return provider.User.get(uid)
+    return get_from_provider(req, provider, uid, "users", noexception_handler_user)
 
 
 @route('/<provider>/playlists/<pid>')
 def playlist_detail(req, provider, pid):
-    provider = req.ctx['library'].get(provider)
-    return provider.Playlist.get(pid)
+    return get_from_provider(req, provider, pid, "playlists")
 
 
 @route('/<provider>/playlists/<pid>/songs')
 def playlist_songs(req, provider, pid):
-    provider = req.ctx['library'].get(provider)
-    playlist = provider.Playlist.get(pid)
-    songs = reader_to_list(to_reader(playlist, "songs"))
-    return songs
+    return get_from_provider(
+        req,
+        provider,
+        pid,
+        "playlists",
+        noexception_handler_readerlist
+    )
+
+
+'''
+Issue #317
+Description: fuo show enhancement -- show all albums of an artist identified by aid
+example : fuo show fuo://<provider>/artists/<aid>/albums
+'''
+
+
+@route('/<provider>/artists/<aid>/albums')
+def albums_of_artist(req, provider, aid):
+    return get_from_provider(
+        req,
+        provider,
+        aid,
+        "artists",
+        noexception_handler_readerlist
+    )

fuocore/router.py

@@ -3,10 +3,22 @@
 from urllib.parse import parse_qsl, urlsplit
 
 
-class NotFound(Exception):
+class ShowCmdException(Exception):
     pass
 
 
+# Rule not found
+class NotFound(ShowCmdException):
+    def __init__(self, rule):
+        self.rule = rule
+
+    def __str__(self):
+        # use backstrace lib (the format_exc/print_exc) causes fail
+        # maybe the coroutine issue ?
+        uri_msg = "Bad Uri Exception: fuo://{}".format(self.rule)
+        return uri_msg
+
+
 def match(url, rules):
     """找到 path 对应的 rule，并解析其中的参数
 
@@ -30,7 +42,8 @@ def match(url, rules):
             query = dict(parse_qsl(qs))
             params = match.groupdict()
             return rule, params, query
-    raise NotFound
+
+    raise NotFound(path)
 
 
 def _validate_rule(rule):
@@ -96,7 +109,13 @@ def wrapper(*args, **kwargs):
         return decorator
 
     def dispatch(self, uri, ctx):
-        rule, params, query = match(uri, self.rules)
+        try:
+            rule, params, query = match(uri, self.rules)
+        except NotFound:
+            # pass it to the exception handle procedure in __init__.py
+            raise
+            return None
+
         handler = self.handlers[rule]
         req = Request(uri=uri, rule=rule, params=params, query=query, ctx=ctx)
         return handler(req, **params)