musicpdasio.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # python-musicpd: Python MPD client library
   4 # Copyright (C) 2014-2015  Kaliko Jack <kaliko@azylum.org>
   5 #
   6 # python-musicpdasio is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU Lesser General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # python-musicpd is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU Lesser General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU Lesser General Public License
  17 # along with python-musicpd.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 try:
  20     import asyncio
  21 except ImportError:
  22     print('Failed to import asyncio, need python >= 3.4')
  23
  24 import sys
  25
  26 HELLO_PREFIX = "OK MPD "
  27 ERROR_PREFIX = "ACK "
  28 SUCCESS = "OK"
  29 NEXT = "list_OK"
  30 VERSION = '0.0.1b'
  31
  32
  33 class MPDError(Exception):
  34     pass
  35
  36 class ConnectionError(MPDError):
  37     pass
  38
  39 class ProtocolError(MPDError):
  40     pass
  41
  42 class CommandError(MPDError):
  43     pass
  44
  45 class CommandListError(MPDError):
  46     pass
  47
  48 class PendingCommandError(MPDError):
  49     pass
  50
  51 class IteratingError(MPDError):
  52     pass
  53
  54
  55 class Response:
  56     def __init__(self):
  57         self.version = None
  58         self.resp = ''
  59         self.err = None
  60
  61     def __repr__(self):
  62         return 'err:{0}, "{1}…" ({2})'.format(
  63                 self.err,
  64                 ' '.join(self.resp.split('\n')[:2]),
  65                 self.version)
  66
  67 class MPDProto(asyncio.Protocol):
  68     def __init__(self, future, payload):
  69         self.future = future
  70         self.payload = payload
  71         self.sess = Response()
  72
  73     def connection_made(self, transport):
  74         self.transport = transport
  75         self.transport.write(bytes('{}\n'.format(self.payload), 'utf-8'))
  76
  77     def data_received(self, data):
  78         rcv = data.decode('utf-8')
  79         if '\n' not in rcv:
  80             self.sess.err = ConnectionError('Connection lost while reading line')
  81             self.future.set_result(self.sess)
  82             raise ConnectionError('Connection lost while reading line')
  83
  84         rcv = rcv.strip('\n')
  85
  86         if rcv.startswith(HELLO_PREFIX):
  87             self.sess.version = rcv[len(HELLO_PREFIX):]
  88             return
  89         self.transport.close()
  90
  91         # set the result on the Future so that the coroutine can
  92         # resume
  93         if rcv.startswith(ERROR_PREFIX):
  94             self.sess.err = rcv[len(ERROR_PREFIX):].strip()
  95             self.future.set_result(self.sess)
  96             return
  97         else:
  98             self.sess.resp = rcv
  99             self.future.set_result(self.sess)
 100
 101 class MPDClient:
 102     loop = asyncio.get_event_loop()
 103
 104     def __init__(self, host='localhost', port=6600):
 105         self._host = host
 106         self._port = port
 107         self._commands = {
 108                 'currentsong',
 109                 'stats',
 110         }
 111
 112     def __getattr__(self, attr):
 113         command = attr
 114         wrapper = self._command
 115         if command not in self._commands:
 116             command = command.replace("_", " ")
 117             if command not in self._commands:
 118                 raise AttributeError("'%s' object has no attribute '%s'" %
 119                                      (self.__class__.__name__, attr))
 120         return lambda *args: wrapper(command, args)
 121
 122     def _command(self, command, args):
 123         # TODO: deal with encoding
 124         payload = '{} {}'.format(command ,''.join(args))
 125         future = asyncio.Future()
 126         # kick off a task to create the connection to MPD.
 127         asyncio.async(MPDClient.loop.create_connection(
 128                                     lambda: MPDProto(future, payload),
 129                                     host=self._host,
 130                                     port=self._port))
 131         MPDClient.loop.run_until_complete(future)
 132         # return the future once completed.
 133         return future.result()
 134