musicpdaio.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     import sys
  23     print('Failed to import asyncio, need python >= 3.4')
  24     sys.exit(1)
  25
  26 import logging
  27
  28 from os import environ
  29 if 'DEBUG' in environ or 'PYTHONASYNCIODEBUG' in environ:
  30     # environ['PYTHONASYNCIODEBUG'] = '1'
  31     logging.basicConfig(level=logging.DEBUG)
  32
  33 HELLO_PREFIX = "OK MPD "
  34 ERROR_PREFIX = "ACK "
  35 SUCCESS = "OK"
  36 NEXT = "list_OK"
  37 VERSION = '0.0.1b'
  38
  39
  40 class MPDError(Exception):
  41     pass
  42
  43 class ConnectionError(MPDError):
  44     pass
  45
  46 class ProtocolError(MPDError):
  47     pass
  48
  49 class CommandError(MPDError):
  50     pass
  51
  52
  53 class Response:
  54     def __init__(self):
  55         self.version = None
  56         self.resp = ''
  57
  58     def __repr__(self):
  59         return '"{0}…" ({1})'.format(
  60                 ' '.join(self.resp.split('\n')[:2]),
  61                 self.version)
  62
  63
  64 class MPDProto(asyncio.Protocol):
  65     def __init__(self, future, payload):
  66         logging.debug('payload: "%s"', payload)
  67         self.transport = None
  68         self.future = future
  69         self.payload = payload
  70         self.sess = Response()
  71
  72     def connection_made(self, transport):
  73         self.transport = transport
  74         self.transport.write(bytes('{}\n'.format(self.payload), 'utf-8'))
  75
  76     def eof_received(self):
  77         self.transport.close()
  78         err = ConnectionError('Connection lost while reading line')
  79         self.future.set_exception(err)
  80
  81     def data_received(self, data):
  82         #logging.debug(data.decode('utf-8'))
  83         rcv = self._hello(data.decode('utf-8'))
  84
  85         if rcv.startswith(ERROR_PREFIX):
  86             err = rcv[len(ERROR_PREFIX):].strip()
  87             self.future.set_exception(CommandError(err))
  88
  89         self.sess.resp += rcv
  90         if rcv.endswith(SUCCESS+'\n'):
  91             # Strip final SUCCESS
  92             self.sess.resp = self.sess.resp[:len(SUCCESS+'\n')*-1]
  93             logging.debug('set future result')
  94             self.transport.close()
  95             self.future.set_result(self.sess)
  96
  97     def _hello(self, rcv):
  98         """Consume HELLO_PREFIX"""
  99         if rcv.startswith(HELLO_PREFIX):
 100             logging.debug('consumed hello prefix')
 101             self.sess.version = rcv.split('\n')[0][len(HELLO_PREFIX):]
 102             return rcv[rcv.find('\n')+1:]
 103         return rcv
 104
 105 class MPDClient:
 106     """MPD Client
 107     :param string host: Server name or IP, default to 'localhost'
 108     :param integer port: Server port, default to 6600
 109     :param string passwd: Password, default to ``None``
 110
 111     """
 112
 113     def __init__(self, host='localhost', port=6600, passwd=None):
 114         self._evloop = asyncio.get_event_loop()
 115         self.asio = False
 116         self.futures = []
 117         self._host = host
 118         self._port = port
 119         #self._pwd = passwd  # TODO: authentication yet to implement
 120         self._commands = {
 121                 'currentsong',
 122                 'stats',
 123                 'playlistinfo',
 124                 'next',
 125                 'find',
 126         }
 127
 128     def __getattr__(self, attr):
 129         #logging.debug(attr)
 130         command = attr
 131         wrapper = self._command
 132         if command not in self._commands:
 133             command = command.replace("_", " ")
 134             if command not in self._commands:
 135                 raise AttributeError("'%s' object has no attribute '%s'" %
 136                                      (self.__class__.__name__, attr))
 137         return lambda *args: wrapper(command, args)
 138
 139     async def _connect(self, proto):
 140         # coroutine allowing Exception handling
 141         # src: http://comments.gmane.org/gmane.comp.python.tulip/1401
 142         try:
 143             await self._evloop.create_connection(lambda: proto,
 144                                                  host=self._host,
 145                                                  port=self._port)
 146         except Exception as err:
 147             proto.future.set_exception(ConnectionError(err))
 148
 149     def _command(self, command, args):
 150         payload = command
 151         for arg in args:
 152             payload += ' "{}"'.format(escape(arg))
 153         future = asyncio.Future()
 154         # kick off a task to create the connection to MPD
 155         coro = self._connect(MPDProto(future, payload))
 156         asyncio.async(coro)
 157         self.futures.append(future)
 158         if not self.asio:
 159             # return once completed.
 160             self._evloop.run_until_complete(future)
 161         return future
 162         # alternative w/ callback
 163         #if not self.asio:
 164         #    future.add_done_callback(lambda ftr: MPDClient.loop.stop())
 165         #    self._evloop.run_forever()
 166         #return future
 167
 168     def run(self):
 169         """Run event loop gathering tasks from self.futures
 170         """
 171         if self.futures:
 172             self._evloop.run_until_complete(asyncio.gather(*self.futures))
 173             self.futures = []
 174         else:
 175             logging.info('No task found in queue, need to set self.asio?')
 176
 177
 178 def escape(text):
 179     """Escapting quotes and backslash"""
 180     return text.replace('\\', '\\\\').replace('"', '\\"')
 181