1 # SPDX-FileCopyrightText: 2012-2023 kaliko <kaliko@azylum.org>
2 # SPDX-FileCopyrightText: 2021 Wonko der Verständige <wonko@hanstool.org>
3 # SPDX-FileCopyrightText: 2019 Naglis Jonaitis <naglis@mailbox.org>
4 # SPDX-FileCopyrightText: 2019 Bart Van Loon <bbb@bbbart.be>
5 # SPDX-FileCopyrightText: 2008-2010 J. Alexander Treuman <jat@spatialrift.net>
6 # SPDX-License-Identifier: LGPL-3.0-or-later
7 """python-musicpd: Python Music Player Daemon client library"""
13 from functools import wraps
14 # Type hint for python <= 3.8
15 from typing import Any, Dict, List, Tuple
16 from typing import Literal, Optional, Union
18 HELLO_PREFIX = "OK MPD "
23 #: Seconds before a connection attempt times out
24 #: (overriden by MPD_TIMEOUT env. var.)
25 CONNECTION_TIMEOUT: int = 30
26 #: Socket timeout in second (Default is None for no timeout)
27 SOCKET_TIMEOUT: Union[int, None] = None
30 def iterator_wrapper(func):
31 """Decorator handling iterate option"""
33 def decorated_function(instance, *args, **kwargs):
34 generator = func(instance, *args, **kwargs)
35 if not instance.iterate:
36 return list(generator)
37 instance._iterating = True
44 instance._iterating = False
45 return iterator(generator)
46 return decorated_function
49 class MPDError(Exception):
53 class ConnectionError(MPDError):
57 class ProtocolError(MPDError):
61 class CommandError(MPDError):
65 class CommandListError(MPDError):
69 class PendingCommandError(MPDError):
73 class IteratingError(MPDError):
79 def __init__(self, tpl: Tuple[int]):
84 if len(self.tpl) == 0:
86 if len(self.tpl) == 1:
87 return '{0}:'.format(self.tpl[0])
88 return '{0[0]}:{0[1]}'.format(self.tpl)
91 return 'Range({0})'.format(self.tpl)
94 if not isinstance(self.tpl, tuple):
95 raise CommandError('Wrong type, provide a tuple')
96 if len(self.tpl) not in [0, 1, 2]:
97 raise CommandError('length not in [0, 1, 2]')
98 for index in self.tpl:
101 except (TypeError, ValueError) as err:
102 raise CommandError('Not a tuple of int') from err
107 def __getattr__(self, attr):
110 def _dummy(self, *args):
111 raise ConnectionError("Not connected")
115 """MPDClient instance will look for ``MPD_HOST``/``MPD_PORT``/``XDG_RUNTIME_DIR`` environment
116 variables and set instance attribute ``host``, ``port`` and ``pwd``
117 accordingly. Regarding ``MPD_HOST`` format to expose password refer
118 MPD client manual :manpage:`mpc (1)`.
120 Then :py:obj:`musicpd.MPDClient.connect` will use ``host`` and ``port`` as defaults if not provided as args.
122 Cf. :py:obj:`musicpd.MPDClient.connect` for details.
124 >>> from os import environ
125 >>> environ['MPD_HOST'] = 'pass@mpdhost'
126 >>> cli = musicpd.MPDClient()
127 >>> cli.pwd == environ['MPD_HOST'].split('@')[0]
129 >>> cli.host == environ['MPD_HOST'].split('@')[1]
131 >>> cli.connect() # will use host/port as set in MPD_HOST/MPD_PORT
133 :ivar str host: host used with the current connection
134 :ivar str,int port: port used with the current connection
135 :ivar str pwd: password detected in ``MPD_HOST`` environment variable
137 .. warning:: Instance attribute host/port/pwd
139 While :py:attr:`musicpd.MPDClient().host` and
140 :py:attr:`musicpd.MPDClient().port` keep track of current connection
141 host and port, :py:attr:`musicpd.MPDClient().pwd` is set once with
142 password extracted from environment variable.
143 Calling :py:meth:`musicpd.MPDClient().password()` with a new password
144 won't update :py:attr:`musicpd.MPDClient().pwd` value.
146 Moreover, :py:attr:`musicpd.MPDClient().pwd` is only an helper attribute
147 exposing password extracted from ``MPD_HOST`` environment variable, it
148 will not be used as default value for the :py:meth:`password` method
151 def __init__(self) -> None:
152 self.iterate: bool = False
153 #: Socket timeout value in seconds
154 self._socket_timeout = SOCKET_TIMEOUT
155 #: Current connection timeout value, defaults to
156 #: :py:obj:`CONNECTION_TIMEOUT` or env. var. ``MPD_TIMEOUT`` if provided
157 self.mpd_timeout: Union[None,int] = None
158 #: Protocol version as exposed by the server
159 self.mpd_version: str = ''
163 "clearerror": self._fetch_nothing,
164 "currentsong": self._fetch_object,
165 "idle": self._fetch_list,
167 "status": self._fetch_object,
168 "stats": self._fetch_object,
169 # Playback Option Commands
170 "consume": self._fetch_nothing,
171 "crossfade": self._fetch_nothing,
172 "mixrampdb": self._fetch_nothing,
173 "mixrampdelay": self._fetch_nothing,
174 "random": self._fetch_nothing,
175 "repeat": self._fetch_nothing,
176 "setvol": self._fetch_nothing,
177 "getvol": self._fetch_object,
178 "single": self._fetch_nothing,
179 "replay_gain_mode": self._fetch_nothing,
180 "replay_gain_status": self._fetch_item,
181 "volume": self._fetch_nothing,
182 # Playback Control Commands
183 "next": self._fetch_nothing,
184 "pause": self._fetch_nothing,
185 "play": self._fetch_nothing,
186 "playid": self._fetch_nothing,
187 "previous": self._fetch_nothing,
188 "seek": self._fetch_nothing,
189 "seekid": self._fetch_nothing,
190 "seekcur": self._fetch_nothing,
191 "stop": self._fetch_nothing,
193 "add": self._fetch_nothing,
194 "addid": self._fetch_item,
195 "clear": self._fetch_nothing,
196 "delete": self._fetch_nothing,
197 "deleteid": self._fetch_nothing,
198 "move": self._fetch_nothing,
199 "moveid": self._fetch_nothing,
200 "playlist": self._fetch_playlist,
201 "playlistfind": self._fetch_songs,
202 "playlistid": self._fetch_songs,
203 "playlistinfo": self._fetch_songs,
204 "playlistsearch": self._fetch_songs,
205 "plchanges": self._fetch_songs,
206 "plchangesposid": self._fetch_changes,
207 "prio": self._fetch_nothing,
208 "prioid": self._fetch_nothing,
209 "rangeid": self._fetch_nothing,
210 "shuffle": self._fetch_nothing,
211 "swap": self._fetch_nothing,
212 "swapid": self._fetch_nothing,
213 "addtagid": self._fetch_nothing,
214 "cleartagid": self._fetch_nothing,
215 # Stored Playlist Commands
216 "listplaylist": self._fetch_list,
217 "listplaylistinfo": self._fetch_songs,
218 "listplaylists": self._fetch_playlists,
219 "load": self._fetch_nothing,
220 "playlistadd": self._fetch_nothing,
221 "playlistclear": self._fetch_nothing,
222 "playlistdelete": self._fetch_nothing,
223 "playlistmove": self._fetch_nothing,
224 "rename": self._fetch_nothing,
225 "rm": self._fetch_nothing,
226 "save": self._fetch_nothing,
228 "albumart": self._fetch_composite,
229 "count": self._fetch_object,
230 "getfingerprint": self._fetch_object,
231 "find": self._fetch_songs,
232 "findadd": self._fetch_nothing,
233 "list": self._fetch_list,
234 "listall": self._fetch_database,
235 "listallinfo": self._fetch_database,
236 "listfiles": self._fetch_database,
237 "lsinfo": self._fetch_database,
238 "readcomments": self._fetch_object,
239 "readpicture": self._fetch_composite,
240 "search": self._fetch_songs,
241 "searchadd": self._fetch_nothing,
242 "searchaddpl": self._fetch_nothing,
243 "update": self._fetch_item,
244 "rescan": self._fetch_item,
245 # Mounts and neighbors
246 "mount": self._fetch_nothing,
247 "unmount": self._fetch_nothing,
248 "listmounts": self._fetch_mounts,
249 "listneighbors": self._fetch_neighbors,
251 "sticker get": self._fetch_item,
252 "sticker set": self._fetch_nothing,
253 "sticker delete": self._fetch_nothing,
254 "sticker list": self._fetch_list,
255 "sticker find": self._fetch_songs,
256 # Connection Commands
259 "password": self._fetch_nothing,
260 "ping": self._fetch_nothing,
261 "binarylimit": self._fetch_nothing,
262 "tagtypes": self._fetch_list,
263 "tagtypes disable": self._fetch_nothing,
264 "tagtypes enable": self._fetch_nothing,
265 "tagtypes clear": self._fetch_nothing,
266 "tagtypes all": self._fetch_nothing,
268 "partition": self._fetch_nothing,
269 "listpartitions": self._fetch_list,
270 "newpartition": self._fetch_nothing,
271 "delpartition": self._fetch_nothing,
272 "moveoutput": self._fetch_nothing,
273 # Audio Output Commands
274 "disableoutput": self._fetch_nothing,
275 "enableoutput": self._fetch_nothing,
276 "toggleoutput": self._fetch_nothing,
277 "outputs": self._fetch_outputs,
278 "outputset": self._fetch_nothing,
279 # Reflection Commands
280 "config": self._fetch_object,
281 "commands": self._fetch_list,
282 "notcommands": self._fetch_list,
283 "urlhandlers": self._fetch_list,
284 "decoders": self._fetch_plugins,
286 "subscribe": self._fetch_nothing,
287 "unsubscribe": self._fetch_nothing,
288 "channels": self._fetch_list,
289 "readmessages": self._fetch_messages,
290 "sendmessage": self._fetch_nothing,
294 def _get_envvars(self) -> None:
296 Retrieve MPD env. var. to overrides "localhost:6600"
297 Use MPD_HOST/MPD_PORT if set
298 else use MPD_HOST=${XDG_RUNTIME_DIR:-/run/}/mpd/socket if file exists
300 self.host: str = 'localhost'
301 self.pwd: Union[None, str] = None
302 self.port: Union[int,str] = os.getenv('MPD_PORT', '6600')
303 _host: str = os.getenv('MPD_HOST', '')
305 # If password is set: MPD_HOST=pass@host
307 mpd_host_env = _host.split('@', 1)
309 # A password is actually set
310 self.pwd = mpd_host_env[0]
312 self.host = mpd_host_env[1]
313 elif mpd_host_env[1]:
314 # No password set but leading @ is an abstract socket
315 self.host = '@'+mpd_host_env[1]
317 # MPD_HOST is a plain host
321 xdg_runtime_dir = os.getenv('XDG_RUNTIME_DIR', '/run')
322 rundir = os.path.join(xdg_runtime_dir, 'mpd/socket')
323 if os.path.exists(rundir):
325 _mpd_timeout = os.getenv('MPD_TIMEOUT', 'X')
326 if _mpd_timeout.isdigit():
327 self.mpd_timeout = int(_mpd_timeout)
328 else: # Use CONNECTION_TIMEOUT as default even if MPD_TIMEOUT carries gargage
329 self.mpd_timeout = CONNECTION_TIMEOUT
331 def __getattr__(self, attr):
332 if attr == 'send_noidle': # have send_noidle to cancel idle as well as noidle
334 if attr.startswith("send_"):
335 command = attr.replace("send_", "", 1)
337 elif attr.startswith("fetch_"):
338 command = attr.replace("fetch_", "", 1)
339 wrapper = self._fetch
342 wrapper = self._execute
343 if command not in self._commands:
344 command = command.replace("_", " ")
345 if command not in self._commands:
346 cls = self.__class__.__name__
347 raise AttributeError(f"'{cls}' object has no attribute '{attr}'")
348 return lambda *args: wrapper(command, args)
350 def _send(self, command, args):
351 if self._command_list is not None:
352 raise CommandListError("Cannot use send_%s in a command list" %
353 command.replace(" ", "_"))
354 self._write_command(command, args)
355 retval = self._commands[command]
356 if retval is not None:
357 self._pending.append(command)
359 def _fetch(self, command, args=None): # pylint: disable=unused-argument
360 cmd_fmt = command.replace(" ", "_")
361 if self._command_list is not None:
362 raise CommandListError(f"Cannot use fetch_{cmd_fmt} in a command list")
364 raise IteratingError(f"Cannot use fetch_{cmd_fmt} while iterating")
365 if not self._pending:
366 raise PendingCommandError("No pending commands to fetch")
367 if self._pending[0] != command:
368 raise PendingCommandError(f"'{command}' is not the currently pending command")
370 retval = self._commands[command]
375 def _execute(self, command, args): # pylint: disable=unused-argument
377 raise IteratingError(f"Cannot execute '{command}' while iterating")
379 raise PendingCommandError(f"Cannot execute '{command}' with pending commands")
380 retval = self._commands[command]
381 if self._command_list is not None:
382 if not callable(retval):
383 raise CommandListError(f"'{command}' not allowed in command list")
384 self._write_command(command, args)
385 self._command_list.append(retval)
387 self._write_command(command, args)
393 def _write_line(self, line):
394 self._wfile.write(f"{line!s}\n")
397 def _write_command(self, command, args=None):
402 if isinstance(arg, tuple):
403 parts.append('{0!s}'.format(Range(arg)))
405 parts.append('"%s"' % escape(str(arg)))
406 if '\n' in ' '.join(parts):
407 raise CommandError('new line found in the command!')
408 self._write_line(" ".join(parts))
410 def _read_binary(self, amount):
413 result = self._rbfile.read(amount)
416 raise ConnectionError("Connection lost while reading binary content")
418 amount -= len(result)
421 def _read_line(self, binary: Literal[True,False] = False):
423 line = self._rbfile.readline().decode('utf-8')
425 line = self._rfile.readline()
426 if not line.endswith("\n"):
428 raise ConnectionError("Connection lost while reading line")
429 line = line.rstrip("\n")
430 if line.startswith(ERROR_PREFIX):
431 error = line[len(ERROR_PREFIX):].strip()
432 raise CommandError(error)
433 if self._command_list is not None:
437 raise ProtocolError(f"Got unexpected '{SUCCESS}'")
438 elif line == SUCCESS:
442 def _read_pair(self, separator: str, binary: Literal[True,False] = False):
443 line = self._read_line(binary=binary)
446 pair = line.split(separator, 1)
448 raise ProtocolError(f"Could not parse pair: '{line}'")
451 def _read_pairs(self, separator=": ", binary: Literal[True,False] =False):
452 pair = self._read_pair(separator, binary=binary)
455 pair = self._read_pair(separator, binary=binary)
457 def _read_list(self):
459 for key, value in self._read_pairs():
462 raise ProtocolError(f"Expected key '{seen}', got '{key}'")
466 def _read_playlist(self):
467 for _, value in self._read_pairs(":"):
470 def _read_objects(self, delimiters: Optional[List[str]] = None):
471 obj: Dict[str,Any] = {}
472 if delimiters is None:
474 for key, value in self._read_pairs():
477 if key in delimiters:
481 if not isinstance(obj[key], list):
482 obj[key] = [obj[key], value]
484 obj[key].append(value)
490 def _read_command_list(self):
492 for retval in self._command_list:
495 self._command_list = None
496 self._fetch_nothing()
498 def _fetch_nothing(self):
499 line = self._read_line()
501 raise ProtocolError(f"Got unexpected return value: '{line}'")
503 def _fetch_item(self):
504 pairs = list(self._read_pairs())
510 def _fetch_list(self):
511 return self._read_list()
514 def _fetch_playlist(self):
515 return self._read_playlist()
517 def _fetch_object(self):
518 objs = list(self._read_objects())
524 def _fetch_objects(self, delimiters):
525 return self._read_objects(delimiters)
527 def _fetch_changes(self):
528 return self._fetch_objects(["cpos"])
530 def _fetch_songs(self):
531 return self._fetch_objects(["file"])
533 def _fetch_playlists(self):
534 return self._fetch_objects(["playlist"])
536 def _fetch_database(self):
537 return self._fetch_objects(["file", "directory", "playlist"])
539 def _fetch_outputs(self):
540 return self._fetch_objects(["outputid"])
542 def _fetch_plugins(self):
543 return self._fetch_objects(["plugin"])
545 def _fetch_messages(self):
546 return self._fetch_objects(["channel"])
548 def _fetch_mounts(self):
549 return self._fetch_objects(["mount"])
551 def _fetch_neighbors(self):
552 return self._fetch_objects(["neighbor"])
554 def _fetch_composite(self):
556 for key, value in self._read_pairs(binary=True):
562 # If the song file was recognized, but there is no picture, the
563 # response is successful, but is otherwise empty.
565 amount = int(obj['binary'])
567 obj['data'] = self._read_binary(amount)
568 except IOError as err:
569 raise ConnectionError(f'Error reading binary content: {err}') from err
570 data_bytes = len(obj['data'])
571 if data_bytes != amount: # can we ever get there?
572 raise ConnectionError('Error reading binary content: '
573 f'Expects {amount}B, got {data_bytes}')
574 # Fetches trailing new line
575 self._read_line(binary=True)
576 # Fetches SUCCESS code
577 self._read_line(binary=True)
581 def _fetch_command_list(self):
582 return self._read_command_list()
585 line = self._rfile.readline()
586 if not line.endswith("\n"):
587 raise ConnectionError("Connection lost while reading MPD hello")
588 line = line.rstrip("\n")
589 if not line.startswith(HELLO_PREFIX):
590 raise ProtocolError(f"Got invalid MPD hello: '{line}'")
591 self.mpd_version = line[len(HELLO_PREFIX):].strip()
594 self.mpd_version = ''
595 self._iterating = False
597 self._command_list = None
599 self._rfile = _NotConnected()
600 self._rbfile = _NotConnected()
601 self._wfile = _NotConnected()
603 def _connect_unix(self, path):
604 if not hasattr(socket, "AF_UNIX"):
605 raise ConnectionError("Unix domain sockets not supported on this platform")
607 if path.startswith('@'):
609 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
610 sock.settimeout(self.mpd_timeout)
612 sock.settimeout(self.socket_timeout)
615 def _connect_tcp(self, host, port):
617 flags = socket.AI_ADDRCONFIG
618 except AttributeError:
621 for res in socket.getaddrinfo(host, port, socket.AF_UNSPEC,
622 socket.SOCK_STREAM, socket.IPPROTO_TCP,
624 af, socktype, proto, _, sa = res
627 sock = socket.socket(af, socktype, proto)
628 sock.settimeout(self.mpd_timeout)
630 sock.settimeout(self.socket_timeout)
632 except socket.error as socket_err:
637 raise ConnectionError(str(err))
638 raise ConnectionError("getaddrinfo returns an empty list")
641 # noidle's special case
642 if not self._pending or self._pending[0] != 'idle':
643 raise CommandError('cannot send noidle if send_idle was not called')
645 self._write_command("noidle")
646 return self._fetch_list()
648 def connect(self, host: Optional[str] = None, port: Optional[Union[int, str]] = None):
649 """Connects the MPD server
651 :param str host: hostname, IP or FQDN (defaults to `localhost` or socket, see below for details)
652 :param port: port number (defaults to 6600)
653 :type port: str or int
655 The connect method honors MPD_HOST/MPD_PORT environment variables.
657 The underlying socket also honors MPD_TIMEOUT environment variable
658 and defaults to :py:obj:`musicpd.CONNECTION_TIMEOUT` (connect command only).
660 If you want to have a timeout for each command once you got connected,
661 set its value in :py:obj:`MPDClient.socket_timeout` (in second) or at
662 module level in :py:obj:`musicpd.SOCKET_TIMEOUT`.
664 .. note:: Default host/port
666 If host evaluate to :py:obj:`False`
667 * use ``MPD_HOST`` environment variable if set, extract password if present,
668 * else looks for an existing file in ``${XDG_RUNTIME_DIR:-/run/}/mpd/socket``
669 * else set host to ``localhost``
671 If port evaluate to :py:obj:`False`
672 * if ``MPD_PORT`` environment variable is set, use it for port
683 if self._sock is not None:
684 raise ConnectionError("Already connected")
685 if host[0] in ['/', '@']:
686 self._sock = self._connect_unix(host)
688 self._sock = self._connect_tcp(host, port)
689 self._rfile = self._sock.makefile("r", encoding='utf-8', errors='surrogateescape')
690 self._rbfile = self._sock.makefile("rb")
691 self._wfile = self._sock.makefile("w", encoding='utf-8')
699 def socket_timeout(self):
700 """Socket timeout in second (defaults to :py:obj:`SOCKET_TIMEOUT`).
701 Use None to disable socket timout."""
702 return self._socket_timeout
704 @socket_timeout.setter
705 def socket_timeout(self, timeout):
706 self._socket_timeout = timeout
707 if getattr(self._sock, 'settimeout', False):
708 self._sock.settimeout(self._socket_timeout)
710 def disconnect(self):
711 """Closes the MPD connection.
712 The client closes the actual socket, it does not use the
713 'close' request from MPD protocol (as suggested in documentation).
715 if hasattr(self._rfile, 'close'):
717 if hasattr(self._rbfile, 'close'):
719 if hasattr(self._wfile, 'close'):
721 if hasattr(self._sock, 'close'):
729 def __exit__(self, exception_type, exception_value, exception_traceback):
733 """Return the socket’s file descriptor (a small integer).
734 This is useful with :py:obj:`select.select`.
736 if self._sock is None:
737 raise ConnectionError("Not connected")
738 return self._sock.fileno()
740 def command_list_ok_begin(self):
741 if self._command_list is not None:
742 raise CommandListError("Already in command list")
744 raise IteratingError("Cannot begin command list while iterating")
746 raise PendingCommandError("Cannot begin command list with pending commands")
747 self._write_command("command_list_ok_begin")
748 self._command_list = []
750 def command_list_end(self):
751 if self._command_list is None:
752 raise CommandListError("Not in command list")
754 raise IteratingError("Already iterating over a command list")
755 self._write_command("command_list_end")
756 return self._fetch_command_list()
759 def escape(text: str) -> str:
760 return text.replace("\\", "\\\\").replace('"', '\\"')
762 # vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=79: