1 # python-musicpd: Python MPD client library
2 # Copyright (C) 2012-2021 kaliko <kaliko@azylum.org>
3 # Copyright (C) 2019 Naglis Jonaitis <naglis@mailbox.org>
4 # Copyright (C) 2019 Bart Van Loon <bbb@bbbart.be>
5 # Copyright (C) 2008-2010 J. Alexander Treuman <jat@spatialrift.net>
7 # python-musicpd is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Lesser General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # python-musicpd is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public License
18 # along with python-musicpd. If not, see <http://www.gnu.org/licenses/>.
23 from functools import wraps
25 HELLO_PREFIX = "OK MPD "
30 #: Seconds before a connection attempt times out
31 #: (overriden by MPD_TIMEOUT env. var.)
32 CONNECTION_TIMEOUT = 30
33 #: Socket timeout in second (Default is None for no timeout)
37 def iterator_wrapper(func):
38 """Decorator handling iterate option"""
40 def decorated_function(instance, *args, **kwargs):
41 generator = func(instance, *args, **kwargs)
42 if not instance.iterate:
43 return list(generator)
44 instance._iterating = True
51 instance._iterating = False
52 return iterator(generator)
53 return decorated_function
56 class MPDError(Exception):
60 class ConnectionError(MPDError):
64 class ProtocolError(MPDError):
68 class CommandError(MPDError):
72 class CommandListError(MPDError):
76 class PendingCommandError(MPDError):
80 class IteratingError(MPDError):
86 def __init__(self, tpl):
91 if len(self.tpl) == 0:
93 if len(self.tpl) == 1:
94 return '{0}:'.format(self.tpl[0])
95 return '{0[0]}:{0[1]}'.format(self.tpl)
98 return 'Range({0})'.format(self.tpl)
101 if not isinstance(self.tpl, tuple):
102 raise CommandError('Wrong type, provide a tuple')
103 if len(self.tpl) not in [0, 1, 2]:
104 raise CommandError('length not in [0, 1, 2]')
105 for index in self.tpl:
108 except (TypeError, ValueError) as err:
109 raise CommandError('Not a tuple of int') from err
114 def __getattr__(self, attr):
117 def _dummy(self, *args):
118 raise ConnectionError("Not connected")
122 """MPDClient instance will look for ``MPD_HOST``/``MPD_PORT``/``XDG_RUNTIME_DIR`` environment
123 variables and set instance attribute ``host``, ``port`` and ``pwd``
124 accordingly. Regarding ``MPD_HOST`` format to expose password refer
125 MPD client manual :manpage:`mpc (1)`.
127 Then :py:obj:`musicpd.MPDClient.connect` will use ``host`` and ``port`` as defaults if not provided as args.
129 Cf. :py:obj:`musicpd.MPDClient.connect` for details.
131 >>> from os import environ
132 >>> environ['MPD_HOST'] = 'pass@mpdhost'
133 >>> cli = musicpd.MPDClient()
134 >>> cli.pwd == environ['MPD_HOST'].split('@')[0]
136 >>> cli.host == environ['MPD_HOST'].split('@')[1]
138 >>> cli.connect() # will use host/port as set in MPD_HOST/MPD_PORT
140 :ivar str host: host used with the current connection
141 :ivar str,int port: port used with the current connection
142 :ivar str pwd: password detected in ``MPD_HOST`` environment variable
144 .. warning:: Instance attribute host/port/pwd
146 While :py:attr:`musicpd.MPDClient().host` and
147 :py:attr:`musicpd.MPDClient().port` keep track of current connection
148 host and port, :py:attr:`musicpd.MPDClient().pwd` is set once with
149 password extracted from environment variable.
150 Calling :py:meth:`musicpd.MPDClient().password()` with a new password
151 won't update :py:attr:`musicpd.MPDClient().pwd` value.
153 Moreover, :py:attr:`musicpd.MPDClient().pwd` is only an helper attribute
154 exposing password extracted from ``MPD_HOST`` environment variable, it
155 will not be used as default value for the :py:meth:`password` method
160 #: Socket timeout value in seconds
161 self._socket_timeout = SOCKET_TIMEOUT
162 #: Current connection timeout value, defaults to
163 #: :py:obj:`CONNECTION_TIMEOUT` or env. var. ``MPD_TIMEOUT`` if provided
164 self.mpd_timeout = None
168 "clearerror": self._fetch_nothing,
169 "currentsong": self._fetch_object,
170 "idle": self._fetch_list,
172 "status": self._fetch_object,
173 "stats": self._fetch_object,
174 # Playback Option Commands
175 "consume": self._fetch_nothing,
176 "crossfade": self._fetch_nothing,
177 "mixrampdb": self._fetch_nothing,
178 "mixrampdelay": self._fetch_nothing,
179 "random": self._fetch_nothing,
180 "repeat": self._fetch_nothing,
181 "setvol": self._fetch_nothing,
182 "getvol": self._fetch_object,
183 "single": self._fetch_nothing,
184 "replay_gain_mode": self._fetch_nothing,
185 "replay_gain_status": self._fetch_item,
186 "volume": self._fetch_nothing,
187 # Playback Control Commands
188 "next": self._fetch_nothing,
189 "pause": self._fetch_nothing,
190 "play": self._fetch_nothing,
191 "playid": self._fetch_nothing,
192 "previous": self._fetch_nothing,
193 "seek": self._fetch_nothing,
194 "seekid": self._fetch_nothing,
195 "seekcur": self._fetch_nothing,
196 "stop": self._fetch_nothing,
198 "add": self._fetch_nothing,
199 "addid": self._fetch_item,
200 "clear": self._fetch_nothing,
201 "delete": self._fetch_nothing,
202 "deleteid": self._fetch_nothing,
203 "move": self._fetch_nothing,
204 "moveid": self._fetch_nothing,
205 "playlist": self._fetch_playlist,
206 "playlistfind": self._fetch_songs,
207 "playlistid": self._fetch_songs,
208 "playlistinfo": self._fetch_songs,
209 "playlistsearch": self._fetch_songs,
210 "plchanges": self._fetch_songs,
211 "plchangesposid": self._fetch_changes,
212 "prio": self._fetch_nothing,
213 "prioid": self._fetch_nothing,
214 "rangeid": self._fetch_nothing,
215 "shuffle": self._fetch_nothing,
216 "swap": self._fetch_nothing,
217 "swapid": self._fetch_nothing,
218 "addtagid": self._fetch_nothing,
219 "cleartagid": self._fetch_nothing,
220 # Stored Playlist Commands
221 "listplaylist": self._fetch_list,
222 "listplaylistinfo": self._fetch_songs,
223 "listplaylists": self._fetch_playlists,
224 "load": self._fetch_nothing,
225 "playlistadd": self._fetch_nothing,
226 "playlistclear": self._fetch_nothing,
227 "playlistdelete": self._fetch_nothing,
228 "playlistmove": self._fetch_nothing,
229 "rename": self._fetch_nothing,
230 "rm": self._fetch_nothing,
231 "save": self._fetch_nothing,
233 "albumart": self._fetch_composite,
234 "count": self._fetch_object,
235 "getfingerprint": self._fetch_object,
236 "find": self._fetch_songs,
237 "findadd": self._fetch_nothing,
238 "list": self._fetch_list,
239 "listall": self._fetch_database,
240 "listallinfo": self._fetch_database,
241 "listfiles": self._fetch_database,
242 "lsinfo": self._fetch_database,
243 "readcomments": self._fetch_object,
244 "readpicture": self._fetch_composite,
245 "search": self._fetch_songs,
246 "searchadd": self._fetch_nothing,
247 "searchaddpl": self._fetch_nothing,
248 "update": self._fetch_item,
249 "rescan": self._fetch_item,
250 # Mounts and neighbors
251 "mount": self._fetch_nothing,
252 "unmount": self._fetch_nothing,
253 "listmounts": self._fetch_mounts,
254 "listneighbors": self._fetch_neighbors,
256 "sticker get": self._fetch_item,
257 "sticker set": self._fetch_nothing,
258 "sticker delete": self._fetch_nothing,
259 "sticker list": self._fetch_list,
260 "sticker find": self._fetch_songs,
261 # Connection Commands
264 "password": self._fetch_nothing,
265 "ping": self._fetch_nothing,
266 "binarylimit": self._fetch_nothing,
267 "tagtypes": self._fetch_list,
268 "tagtypes disable": self._fetch_nothing,
269 "tagtypes enable": self._fetch_nothing,
270 "tagtypes clear": self._fetch_nothing,
271 "tagtypes all": self._fetch_nothing,
273 "partition": self._fetch_nothing,
274 "listpartitions": self._fetch_list,
275 "newpartition": self._fetch_nothing,
276 "delpartition": self._fetch_nothing,
277 "moveoutput": self._fetch_nothing,
278 # Audio Output Commands
279 "disableoutput": self._fetch_nothing,
280 "enableoutput": self._fetch_nothing,
281 "toggleoutput": self._fetch_nothing,
282 "outputs": self._fetch_outputs,
283 "outputset": self._fetch_nothing,
284 # Reflection Commands
285 "config": self._fetch_object,
286 "commands": self._fetch_list,
287 "notcommands": self._fetch_list,
288 "urlhandlers": self._fetch_list,
289 "decoders": self._fetch_plugins,
291 "subscribe": self._fetch_nothing,
292 "unsubscribe": self._fetch_nothing,
293 "channels": self._fetch_list,
294 "readmessages": self._fetch_messages,
295 "sendmessage": self._fetch_nothing,
299 def _get_envvars(self):
301 Retrieve MPD env. var. to overrides "localhost:6600"
302 Use MPD_HOST/MPD_PORT if set
303 else use MPD_HOST=${XDG_RUNTIME_DIR:-/run/}/mpd/socket if file exists
305 self.host = 'localhost'
307 self.port = os.getenv('MPD_PORT', '6600')
308 if os.getenv('MPD_HOST'):
309 # If password is set: MPD_HOST=pass@host
310 if '@' in os.getenv('MPD_HOST'):
311 mpd_host_env = os.getenv('MPD_HOST').split('@', 1)
313 # A password is actually set
314 self.pwd = mpd_host_env[0]
316 self.host = mpd_host_env[1]
317 elif mpd_host_env[1]:
318 # No password set but leading @ is an abstract socket
319 self.host = '@'+mpd_host_env[1]
321 # MPD_HOST is a plain host
322 self.host = os.getenv('MPD_HOST')
325 xdg_runtime_dir = os.getenv('XDG_RUNTIME_DIR', '/run')
326 rundir = os.path.join(xdg_runtime_dir, 'mpd/socket')
327 if os.path.exists(rundir):
329 self.mpd_timeout = os.getenv('MPD_TIMEOUT')
330 if self.mpd_timeout and self.mpd_timeout.isdigit():
331 self.mpd_timeout = int(self.mpd_timeout)
332 else: # Use CONNECTION_TIMEOUT as default even if MPD_TIMEOUT carries gargage
333 self.mpd_timeout = CONNECTION_TIMEOUT
335 def __getattr__(self, attr):
336 if attr == 'send_noidle': # have send_noidle to cancel idle as well as noidle
338 if attr.startswith("send_"):
339 command = attr.replace("send_", "", 1)
341 elif attr.startswith("fetch_"):
342 command = attr.replace("fetch_", "", 1)
343 wrapper = self._fetch
346 wrapper = self._execute
347 if command not in self._commands:
348 command = command.replace("_", " ")
349 if command not in self._commands:
350 cls = self.__class__.__name__
351 raise AttributeError(f"'{cls}' object has no attribute '{attr}'")
352 return lambda *args: wrapper(command, args)
354 def _send(self, command, args):
355 if self._command_list is not None:
356 raise CommandListError("Cannot use send_%s in a command list" %
357 command.replace(" ", "_"))
358 self._write_command(command, args)
359 retval = self._commands[command]
360 if retval is not None:
361 self._pending.append(command)
363 def _fetch(self, command, args=None): # pylint: disable=unused-argument
364 cmd_fmt = command.replace(" ", "_")
365 if self._command_list is not None:
366 raise CommandListError(f"Cannot use fetch_{cmd_fmt} in a command list")
368 raise IteratingError(f"Cannot use fetch_{cmd_fmt} while iterating")
369 if not self._pending:
370 raise PendingCommandError("No pending commands to fetch")
371 if self._pending[0] != command:
372 raise PendingCommandError(f"'{command}' is not the currently pending command")
374 retval = self._commands[command]
379 def _execute(self, command, args): # pylint: disable=unused-argument
381 raise IteratingError(f"Cannot execute '{command}' while iterating")
383 raise PendingCommandError(f"Cannot execute '{command}' with pending commands")
384 retval = self._commands[command]
385 if self._command_list is not None:
386 if not callable(retval):
387 raise CommandListError(f"'{command}' not allowed in command list")
388 self._write_command(command, args)
389 self._command_list.append(retval)
391 self._write_command(command, args)
397 def _write_line(self, line):
398 self._wfile.write(f"{line!s}\n")
401 def _write_command(self, command, args=None):
406 if isinstance(arg, tuple):
407 parts.append('{0!s}'.format(Range(arg)))
409 parts.append('"%s"' % escape(str(arg)))
410 if '\n' in ' '.join(parts):
411 raise CommandError('new line found in the command!')
412 self._write_line(" ".join(parts))
414 def _read_binary(self, amount):
417 result = self._rbfile.read(amount)
420 raise ConnectionError("Connection lost while reading binary content")
422 amount -= len(result)
425 def _read_line(self, binary=False):
427 line = self._rbfile.readline().decode('utf-8')
429 line = self._rfile.readline()
430 if not line.endswith("\n"):
432 raise ConnectionError("Connection lost while reading line")
433 line = line.rstrip("\n")
434 if line.startswith(ERROR_PREFIX):
435 error = line[len(ERROR_PREFIX):].strip()
436 raise CommandError(error)
437 if self._command_list is not None:
441 raise ProtocolError(f"Got unexpected '{SUCCESS}'")
442 elif line == SUCCESS:
446 def _read_pair(self, separator, binary=False):
447 line = self._read_line(binary=binary)
450 pair = line.split(separator, 1)
452 raise ProtocolError(f"Could not parse pair: '{line}'")
455 def _read_pairs(self, separator=": ", binary=False):
456 pair = self._read_pair(separator, binary=binary)
459 pair = self._read_pair(separator, binary=binary)
461 def _read_list(self):
463 for key, value in self._read_pairs():
466 raise ProtocolError(f"Expected key '{seen}', got '{key}'")
470 def _read_playlist(self):
471 for _, value in self._read_pairs(":"):
474 def _read_objects(self, delimiters=None):
476 if delimiters is None:
478 for key, value in self._read_pairs():
481 if key in delimiters:
485 if not isinstance(obj[key], list):
486 obj[key] = [obj[key], value]
488 obj[key].append(value)
494 def _read_command_list(self):
496 for retval in self._command_list:
499 self._command_list = None
500 self._fetch_nothing()
502 def _fetch_nothing(self):
503 line = self._read_line()
505 raise ProtocolError(f"Got unexpected return value: '{line}'")
507 def _fetch_item(self):
508 pairs = list(self._read_pairs())
514 def _fetch_list(self):
515 return self._read_list()
518 def _fetch_playlist(self):
519 return self._read_playlist()
521 def _fetch_object(self):
522 objs = list(self._read_objects())
528 def _fetch_objects(self, delimiters):
529 return self._read_objects(delimiters)
531 def _fetch_changes(self):
532 return self._fetch_objects(["cpos"])
534 def _fetch_songs(self):
535 return self._fetch_objects(["file"])
537 def _fetch_playlists(self):
538 return self._fetch_objects(["playlist"])
540 def _fetch_database(self):
541 return self._fetch_objects(["file", "directory", "playlist"])
543 def _fetch_outputs(self):
544 return self._fetch_objects(["outputid"])
546 def _fetch_plugins(self):
547 return self._fetch_objects(["plugin"])
549 def _fetch_messages(self):
550 return self._fetch_objects(["channel"])
552 def _fetch_mounts(self):
553 return self._fetch_objects(["mount"])
555 def _fetch_neighbors(self):
556 return self._fetch_objects(["neighbor"])
558 def _fetch_composite(self):
560 for key, value in self._read_pairs(binary=True):
566 # If the song file was recognized, but there is no picture, the
567 # response is successful, but is otherwise empty.
569 amount = int(obj['binary'])
571 obj['data'] = self._read_binary(amount)
572 except IOError as err:
573 raise ConnectionError(f'Error reading binary content: {err}') from err
574 data_bytes = len(obj['data'])
575 if data_bytes != amount: # can we ever get there?
576 raise ConnectionError('Error reading binary content: '
577 f'Expects {amount}B, got {data_bytes}')
578 # Fetches trailing new line
579 self._read_line(binary=True)
580 # Fetches SUCCESS code
581 self._read_line(binary=True)
585 def _fetch_command_list(self):
586 return self._read_command_list()
589 line = self._rfile.readline()
590 if not line.endswith("\n"):
591 raise ConnectionError("Connection lost while reading MPD hello")
592 line = line.rstrip("\n")
593 if not line.startswith(HELLO_PREFIX):
594 raise ProtocolError(f"Got invalid MPD hello: '{line}'")
595 self.mpd_version = line[len(HELLO_PREFIX):].strip()
598 self.mpd_version = None
599 self._iterating = False
601 self._command_list = None
603 self._rfile = _NotConnected()
604 self._rbfile = _NotConnected()
605 self._wfile = _NotConnected()
607 def _connect_unix(self, path):
608 if not hasattr(socket, "AF_UNIX"):
609 raise ConnectionError("Unix domain sockets not supported on this platform")
611 if path.startswith('@'):
613 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
614 sock.settimeout(self.mpd_timeout)
616 sock.settimeout(self.socket_timeout)
619 def _connect_tcp(self, host, port):
621 flags = socket.AI_ADDRCONFIG
622 except AttributeError:
625 for res in socket.getaddrinfo(host, port, socket.AF_UNSPEC,
626 socket.SOCK_STREAM, socket.IPPROTO_TCP,
628 af, socktype, proto, _, sa = res
631 sock = socket.socket(af, socktype, proto)
632 sock.settimeout(self.mpd_timeout)
634 sock.settimeout(self.socket_timeout)
636 except socket.error as socket_err:
641 raise ConnectionError(str(err))
642 raise ConnectionError("getaddrinfo returns an empty list")
645 # noidle's special case
646 if not self._pending or self._pending[0] != 'idle':
647 raise CommandError('cannot send noidle if send_idle was not called')
649 self._write_command("noidle")
650 return self._fetch_list()
652 def connect(self, host=None, port=None):
653 """Connects the MPD server
655 :param str host: hostname, IP or FQDN (defaults to `localhost` or socket, see below for details)
656 :param port: port number (defaults to 6600)
657 :type port: str or int
659 The connect method honors MPD_HOST/MPD_PORT environment variables.
661 The underlying socket also honors MPD_TIMEOUT environment variable
662 and defaults to :py:obj:`musicpd.CONNECTION_TIMEOUT` (connect command only).
664 If you want to have a timeout for each command once you got connected,
665 set its value in :py:obj:`MPDClient.socket_timeout` (in second) or at
666 module level in :py:obj:`musicpd.SOCKET_TIMEOUT`.
668 .. note:: Default host/port
670 If host evaluate to :py:obj:`False`
671 * use ``MPD_HOST`` environment variable if set, extract password if present,
672 * else looks for an existing file in ``${XDG_RUNTIME_DIR:-/run/}/mpd/socket``
673 * else set host to ``localhost``
675 If port evaluate to :py:obj:`False`
676 * if ``MPD_PORT`` environment variable is set, use it for port
687 if self._sock is not None:
688 raise ConnectionError("Already connected")
689 if host[0] in ['/', '@']:
690 self._sock = self._connect_unix(host)
692 self._sock = self._connect_tcp(host, port)
693 self._rfile = self._sock.makefile("r", encoding='utf-8', errors='surrogateescape')
694 self._rbfile = self._sock.makefile("rb")
695 self._wfile = self._sock.makefile("w", encoding='utf-8')
703 def socket_timeout(self):
704 """Socket timeout in second (defaults to :py:obj:`SOCKET_TIMEOUT`).
705 Use None to disable socket timout."""
706 return self._socket_timeout
708 @socket_timeout.setter
709 def socket_timeout(self, timeout):
710 self._socket_timeout = timeout
711 if getattr(self._sock, 'settimeout', False):
712 self._sock.settimeout(self._socket_timeout)
714 def disconnect(self):
715 """Closes the MPD connection.
716 The client closes the actual socket, it does not use the
717 'close' request from MPD protocol (as suggested in documentation).
719 if hasattr(self._rfile, 'close'):
721 if hasattr(self._rbfile, 'close'):
723 if hasattr(self._wfile, 'close'):
725 if hasattr(self._sock, 'close'):
730 """Return the socket’s file descriptor (a small integer).
731 This is useful with :py:obj:`select.select`.
733 if self._sock is None:
734 raise ConnectionError("Not connected")
735 return self._sock.fileno()
737 def command_list_ok_begin(self):
738 if self._command_list is not None:
739 raise CommandListError("Already in command list")
741 raise IteratingError("Cannot begin command list while iterating")
743 raise PendingCommandError("Cannot begin command list with pending commands")
744 self._write_command("command_list_ok_begin")
745 self._command_list = []
747 def command_list_end(self):
748 if self._command_list is None:
749 raise CommandListError("Not in command list")
751 raise IteratingError("Already iterating over a command list")
752 self._write_command("command_list_end")
753 return self._fetch_command_list()
757 return text.replace("\\", "\\\\").replace('"', '\\"')
759 # vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=79: