1 # python-musicpd: Python MPD client library
2 # Copyright (C) 2008-2010 J. Alexander Treuman <jat@spatialrift.net>
3 # Copyright (C) 2012-2014 Kaliko Jack <kaliko@azylum.org>
5 # python-musicpd is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Lesser General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # python-musicpd is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public License
16 # along with python-musicpd. If not, see <http://www.gnu.org/licenses/>.
18 # pylint: disable=C0111
23 HELLO_PREFIX = "OK MPD "
30 class MPDError(Exception):
33 class ConnectionError(MPDError):
36 class ProtocolError(MPDError):
39 class CommandError(MPDError):
42 class CommandListError(MPDError):
45 class PendingCommandError(MPDError):
48 class IteratingError(MPDError):
53 def __init__(self, tpl):
58 if len(self.tpl) == 1:
59 return '{0}:'.format(self.tpl[0])
60 return '{0[0]}:{0[1]}'.format(self.tpl)
63 return 'Range({0})'.format(self.tpl)
66 if not isinstance(self.tpl, tuple):
67 raise CommandError('Wrong type, provide a tuple')
68 if len(self.tpl) not in [1, 2]:
69 raise CommandError('length not in [1, 2]')
70 for index in self.tpl:
73 except (TypeError, ValueError):
74 raise CommandError('Not a tuple of int')
78 def __getattr__(self, attr):
82 raise ConnectionError("Not connected")
90 "clearerror": self._fetch_nothing,
91 "currentsong": self._fetch_object,
92 "idle": self._fetch_list,
94 "status": self._fetch_object,
95 "stats": self._fetch_object,
96 # Playback Option Commands
97 "consume": self._fetch_nothing,
98 "crossfade": self._fetch_nothing,
99 "mixrampdb": self._fetch_nothing,
100 "mixrampdelay": self._fetch_nothing,
101 "random": self._fetch_nothing,
102 "repeat": self._fetch_nothing,
103 "setvol": self._fetch_nothing,
104 "single": self._fetch_nothing,
105 "replay_gain_mode": self._fetch_nothing,
106 "replay_gain_status": self._fetch_item,
107 "volume": self._fetch_nothing,
108 # Playback Control Commands
109 "next": self._fetch_nothing,
110 "pause": self._fetch_nothing,
111 "play": self._fetch_nothing,
112 "playid": self._fetch_nothing,
113 "previous": self._fetch_nothing,
114 "seek": self._fetch_nothing,
115 "seekid": self._fetch_nothing,
116 "seekcur": self._fetch_nothing,
117 "stop": self._fetch_nothing,
119 "add": self._fetch_nothing,
120 "addid": self._fetch_item,
121 "clear": self._fetch_nothing,
122 "delete": self._fetch_nothing,
123 "deleteid": self._fetch_nothing,
124 "move": self._fetch_nothing,
125 "moveid": self._fetch_nothing,
126 "playlist": self._fetch_playlist,
127 "playlistfind": self._fetch_songs,
128 "playlistid": self._fetch_songs,
129 "playlistinfo": self._fetch_songs,
130 "playlistsearch": self._fetch_songs,
131 "plchanges": self._fetch_songs,
132 "plchangesposid": self._fetch_changes,
133 "shuffle": self._fetch_nothing,
134 "swap": self._fetch_nothing,
135 "swapid": self._fetch_nothing,
136 # Stored Playlist Commands
137 "listplaylist": self._fetch_list,
138 "listplaylistinfo": self._fetch_songs,
139 "listplaylists": self._fetch_playlists,
140 "load": self._fetch_nothing,
141 "playlistadd": self._fetch_nothing,
142 "playlistclear": self._fetch_nothing,
143 "playlistdelete": self._fetch_nothing,
144 "playlistmove": self._fetch_nothing,
145 "rename": self._fetch_nothing,
146 "rm": self._fetch_nothing,
147 "save": self._fetch_nothing,
149 "count": self._fetch_object,
150 "find": self._fetch_songs,
151 "findadd": self._fetch_nothing,
152 "list": self._fetch_list,
153 "listall": self._fetch_database,
154 "listallinfo": self._fetch_database,
155 "lsinfo": self._fetch_database,
156 "search": self._fetch_songs,
157 "searchadd": self._fetch_nothing,
158 "searchaddpl": self._fetch_nothing,
159 "update": self._fetch_item,
160 "rescan": self._fetch_item,
161 "readcomments": self._fetch_object,
162 # Mounts and neighbors
163 "mount": self._fetch_nothing,
164 "unmount": self._fetch_nothing,
165 "listmounts": self._fetch_mounts,
166 "listneighbors": self._fetch_neighbors,
168 "sticker get": self._fetch_item,
169 "sticker set": self._fetch_nothing,
170 "sticker delete": self._fetch_nothing,
171 "sticker list": self._fetch_list,
172 "sticker find": self._fetch_songs,
173 # Connection Commands
176 "password": self._fetch_nothing,
177 "ping": self._fetch_nothing,
178 # Audio Output Commands
179 "disableoutput": self._fetch_nothing,
180 "enableoutput": self._fetch_nothing,
181 "toggleoutput": self._fetch_nothing,
182 "outputs": self._fetch_outputs,
183 # Reflection Commands
184 "commands": self._fetch_list,
185 "notcommands": self._fetch_list,
186 "tagtypes": self._fetch_list,
187 "urlhandlers": self._fetch_list,
188 "decoders": self._fetch_plugins,
190 "subscribe": self._fetch_nothing,
191 "unsubscribe": self._fetch_nothing,
192 "channels": self._fetch_list,
193 "readmessages": self._fetch_messages,
194 "sendmessage": self._fetch_nothing,
197 def __getattr__(self, attr):
198 if attr == 'send_noidle': # have send_noidle to cancel idle as well as noidle
200 if attr.startswith("send_"):
201 command = attr.replace("send_", "", 1)
203 elif attr.startswith("fetch_"):
204 command = attr.replace("fetch_", "", 1)
205 wrapper = self._fetch
208 wrapper = self._execute
209 if command not in self._commands:
210 command = command.replace("_", " ")
211 if command not in self._commands:
212 raise AttributeError("'%s' object has no attribute '%s'" %
213 (self.__class__.__name__, attr))
214 return lambda *args: wrapper(command, args)
216 def _send(self, command, args):
217 if self._command_list is not None:
218 raise CommandListError("Cannot use send_%s in a command list" %
219 command.replace(" ", "_"))
220 self._write_command(command, args)
221 retval = self._commands[command]
222 if retval is not None:
223 self._pending.append(command)
225 def _fetch(self, command, args=None):
226 if self._command_list is not None:
227 raise CommandListError("Cannot use fetch_%s in a command list" %
228 command.replace(" ", "_"))
230 raise IteratingError("Cannot use fetch_%s while iterating" %
231 command.replace(" ", "_"))
232 if not self._pending:
233 raise PendingCommandError("No pending commands to fetch")
234 if self._pending[0] != command:
235 raise PendingCommandError("'%s' is not the currently "
236 "pending command" % command)
238 retval = self._commands[command]
243 def _execute(self, command, args):
245 raise IteratingError("Cannot execute '%s' while iterating" %
248 raise PendingCommandError("Cannot execute '%s' with "
249 "pending commands" % command)
250 retval = self._commands[command]
251 if self._command_list is not None:
252 if not callable(retval):
253 raise CommandListError("'%s' not allowed in command list" %
255 self._write_command(command, args)
256 self._command_list.append(retval)
258 self._write_command(command, args)
263 def _write_line(self, line):
264 self._wfile.write("%s\n" % line)
267 def _write_command(self, command, args=None):
272 if isinstance(arg, tuple):
273 parts.append('{0!s}'.format(Range(arg)))
275 parts.append('"%s"' % escape(str(arg)))
276 self._write_line(" ".join(parts))
278 def _read_line(self):
279 line = self._rfile.readline()
280 if not line.endswith("\n"):
282 raise ConnectionError("Connection lost while reading line")
283 line = line.rstrip("\n")
284 if line.startswith(ERROR_PREFIX):
285 error = line[len(ERROR_PREFIX):].strip()
286 raise CommandError(error)
287 if self._command_list is not None:
291 raise ProtocolError("Got unexpected '%s'" % SUCCESS)
292 elif line == SUCCESS:
296 def _read_pair(self, separator):
297 line = self._read_line()
300 pair = line.split(separator, 1)
302 raise ProtocolError("Could not parse pair: '%s'" % line)
305 def _read_pairs(self, separator=": "):
306 pair = self._read_pair(separator)
309 pair = self._read_pair(separator)
311 def _read_list(self):
313 for key, value in self._read_pairs():
316 raise ProtocolError("Expected key '%s', got '%s'" %
321 def _read_playlist(self):
322 for _, value in self._read_pairs(":"):
325 def _read_objects(self, delimiters=None):
327 if delimiters is None:
329 for key, value in self._read_pairs():
332 if key in delimiters:
336 if not isinstance(obj[key], list):
337 obj[key] = [obj[key], value]
339 obj[key].append(value)
345 def _read_command_list(self):
347 for retval in self._command_list:
350 self._command_list = None
351 self._fetch_nothing()
353 def _iterator_wrapper(self, iterator):
355 for item in iterator:
358 self._iterating = False
360 def _wrap_iterator(self, iterator):
362 return list(iterator)
363 self._iterating = True
364 return self._iterator_wrapper(iterator)
366 def _fetch_nothing(self):
367 line = self._read_line()
369 raise ProtocolError("Got unexpected return value: '%s'" % line)
371 def _fetch_item(self):
372 pairs = list(self._read_pairs())
377 def _fetch_list(self):
378 return self._wrap_iterator(self._read_list())
380 def _fetch_playlist(self):
381 return self._wrap_iterator(self._read_playlist())
383 def _fetch_object(self):
384 objs = list(self._read_objects())
389 def _fetch_objects(self, delimiters):
390 return self._wrap_iterator(self._read_objects(delimiters))
392 def _fetch_changes(self):
393 return self._fetch_objects(["cpos"])
395 def _fetch_songs(self):
396 return self._fetch_objects(["file"])
398 def _fetch_playlists(self):
399 return self._fetch_objects(["playlist"])
401 def _fetch_database(self):
402 return self._fetch_objects(["file", "directory", "playlist"])
404 def _fetch_outputs(self):
405 return self._fetch_objects(["outputid"])
407 def _fetch_plugins(self):
408 return self._fetch_objects(["plugin"])
410 def _fetch_messages(self):
411 return self._fetch_objects(["channel"])
413 def _fetch_mounts(self):
414 return self._fetch_objects(["mount"])
416 def _fetch_neighbors(self):
417 return self._fetch_objects(["neighbor"])
419 def _fetch_command_list(self):
420 return self._wrap_iterator(self._read_command_list())
423 line = self._rfile.readline()
424 if not line.endswith("\n"):
425 raise ConnectionError("Connection lost while reading MPD hello")
426 line = line.rstrip("\n")
427 if not line.startswith(HELLO_PREFIX):
428 raise ProtocolError("Got invalid MPD hello: '%s'" % line)
429 self.mpd_version = line[len(HELLO_PREFIX):].strip()
432 # pylint: disable=w0201
433 self.mpd_version = None
434 self._iterating = False
436 self._command_list = None
438 self._rfile = _NotConnected()
439 self._wfile = _NotConnected()
441 def _connect_unix(self, path):
442 if not hasattr(socket, "AF_UNIX"):
443 raise ConnectionError("Unix domain sockets not supported "
445 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
449 def _connect_tcp(self, host, port):
451 flags = socket.AI_ADDRCONFIG
452 except AttributeError:
455 for res in socket.getaddrinfo(host, port, socket.AF_UNSPEC,
456 socket.SOCK_STREAM, socket.IPPROTO_TCP,
458 af, socktype, proto, _, sa = res
461 sock = socket.socket(af, socktype, proto)
464 except socket.error as socket_err:
469 raise ConnectionError(str(err))
471 raise ConnectionError("getaddrinfo returns an empty list")
474 # noidle's special case
475 if not self._pending or self._pending[0] != 'idle':
476 raise CommandError('cannot send noidle if send_idle was not called')
478 self._write_command("noidle")
479 return self._fetch_list()
481 def connect(self, host, port):
482 if self._sock is not None:
483 raise ConnectionError("Already connected")
484 if host.startswith("/"):
485 self._sock = self._connect_unix(host)
487 self._sock = self._connect_tcp(host, port)
488 self._rfile = self._sock.makefile("r", encoding='utf-8')
489 self._wfile = self._sock.makefile("w", encoding='utf-8')
496 def disconnect(self):
497 if hasattr(self._rfile, 'close'):
499 if hasattr(self._wfile, 'close'):
501 if hasattr(self._sock, 'close'):
506 if self._sock is None:
507 raise ConnectionError("Not connected")
508 return self._sock.fileno()
510 def command_list_ok_begin(self):
511 if self._command_list is not None:
512 raise CommandListError("Already in command list")
514 raise IteratingError("Cannot begin command list while iterating")
516 raise PendingCommandError("Cannot begin command list "
517 "with pending commands")
518 self._write_command("command_list_ok_begin")
519 self._command_list = []
521 def command_list_end(self):
522 if self._command_list is None:
523 raise CommandListError("Not in command list")
525 raise IteratingError("Already iterating over a command list")
526 self._write_command("command_list_end")
527 return self._fetch_command_list()
531 return text.replace("\\", "\\\\").replace('"', '\\"')
534 # vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=79: