1 # Python MPD client library
2 # Copyright (C) 2008-2010 J. Alexander Treuman <jat@spatialrift.net>
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 HELLO_PREFIX = "OK MPD "
26 class MPDError(Exception):
29 class ConnectionError(MPDError):
32 class ProtocolError(MPDError):
35 class CommandError(MPDError):
38 class CommandListError(MPDError):
41 class PendingCommandError(MPDError):
44 class IteratingError(MPDError):
48 class _NotConnected(object):
49 def __getattr__(self, attr):
53 raise ConnectionError("Not connected")
55 class MPDClient(object):
61 "clearerror": self._fetch_nothing,
62 "currentsong": self._fetch_object,
63 "idle": self._fetch_list,
65 "status": self._fetch_object,
66 "stats": self._fetch_object,
67 # Playback Option Commands
68 "consume": self._fetch_nothing,
69 "crossfade": self._fetch_nothing,
70 "random": self._fetch_nothing,
71 "repeat": self._fetch_nothing,
72 "setvol": self._fetch_nothing,
73 "single": self._fetch_nothing,
74 "volume": self._fetch_nothing,
75 # Playback Control Commands
76 "next": self._fetch_nothing,
77 "pause": self._fetch_nothing,
78 "play": self._fetch_nothing,
79 "playid": self._fetch_nothing,
80 "previous": self._fetch_nothing,
81 "seek": self._fetch_nothing,
82 "seekid": self._fetch_nothing,
83 "stop": self._fetch_nothing,
85 "add": self._fetch_nothing,
86 "addid": self._fetch_item,
87 "clear": self._fetch_nothing,
88 "delete": self._fetch_nothing,
89 "deleteid": self._fetch_nothing,
90 "move": self._fetch_nothing,
91 "moveid": self._fetch_nothing,
92 "playlist": self._fetch_playlist,
93 "playlistfind": self._fetch_songs,
94 "playlistid": self._fetch_songs,
95 "playlistinfo": self._fetch_songs,
96 "playlistsearch": self._fetch_songs,
97 "plchanges": self._fetch_songs,
98 "plchangesposid": self._fetch_changes,
99 "shuffle": self._fetch_nothing,
100 "swap": self._fetch_nothing,
101 "swapid": self._fetch_nothing,
102 # Stored Playlist Commands
103 "listplaylist": self._fetch_list,
104 "listplaylistinfo": self._fetch_songs,
105 "listplaylists": self._fetch_playlists,
106 "load": self._fetch_nothing,
107 "playlistadd": self._fetch_nothing,
108 "playlistclear": self._fetch_nothing,
109 "playlistdelete": self._fetch_nothing,
110 "playlistmove": self._fetch_nothing,
111 "rename": self._fetch_nothing,
112 "rm": self._fetch_nothing,
113 "save": self._fetch_nothing,
115 "count": self._fetch_object,
116 "find": self._fetch_songs,
117 "list": self._fetch_list,
118 "listall": self._fetch_database,
119 "listallinfo": self._fetch_database,
120 "lsinfo": self._fetch_database,
121 "search": self._fetch_songs,
122 "update": self._fetch_item,
123 # Connection Commands
126 "password": self._fetch_nothing,
127 "ping": self._fetch_nothing,
128 # Audio Output Commands
129 "disableoutput": self._fetch_nothing,
130 "enableoutput": self._fetch_nothing,
131 "outputs": self._fetch_outputs,
132 # Reflection Commands
133 "commands": self._fetch_list,
134 "notcommands": self._fetch_list,
135 "tagtypes": self._fetch_list,
136 "urlhandlers": self._fetch_list,
139 def __getattr__(self, attr):
140 if attr.startswith("send_"):
141 command = attr.replace("send_", "", 1)
143 elif attr.startswith("fetch_"):
144 command = attr.replace("fetch_", "", 1)
145 wrapper = self._fetch
148 wrapper = self._execute
149 if command not in self._commands:
150 raise AttributeError("'%s' object has no attribute '%s'" %
151 (self.__class__.__name__, attr))
152 return lambda *args: wrapper(command, args)
154 def _send(self, command, args):
155 if self._command_list is not None:
156 raise CommandListError("Cannot use send_%s in a command list" %
158 self._write_command(command, args)
159 self._pending.append(command)
161 def _fetch(self, command, args=None):
162 if self._command_list is not None:
163 raise CommandListError("Cannot use fetch_%s in a command list" %
166 raise IteratingError("Cannot use fetch_%s while iterating" %
168 if not self._pending:
169 raise PendingCommandError("No pending commands to fetch")
170 if self._pending[0] != command:
171 raise PendingCommandError("%s is not the currently "
172 "pending command" % command)
174 retval = self._commands[command]
178 def _execute(self, command, args):
180 raise IteratingError("Cannot execute %s while iterating" % command)
182 raise PendingCommandError("Cannot execute %s with "
183 "pending commands" % command)
184 retval = self._commands[command]
185 if self._command_list is not None:
186 if not callable(retval):
187 raise CommandListError("%s not allowed in command list" %
189 self._write_command(command, args)
190 self._command_list.append(retval)
192 self._write_command(command, args)
197 def _write_line(self, line):
198 self._wfile.write("%s\n" % line)
201 def _write_command(self, command, args=[]):
204 parts.append('"%s"' % escape(str(arg)))
205 self._write_line(" ".join(parts))
207 def _read_line(self):
208 line = self._rfile.readline()
209 if not line.endswith("\n"):
210 raise ConnectionError("Connection lost while reading line")
211 line = line.rstrip("\n")
212 if line.startswith(ERROR_PREFIX):
213 error = line[len(ERROR_PREFIX):].strip()
214 raise CommandError(error)
215 if self._command_list is not None:
219 raise ProtocolError("Got unexpected '%s'" % SUCCESS)
220 elif line == SUCCESS:
224 def _read_pair(self, separator):
225 line = self._read_line()
228 pair = line.split(separator, 1)
230 raise ProtocolError("Could not parse pair: '%s'" % line)
233 def _read_pairs(self, separator=": "):
234 pair = self._read_pair(separator)
237 pair = self._read_pair(separator)
239 def _read_list(self):
241 for key, value in self._read_pairs():
244 raise ProtocolError("Expected key '%s', got '%s'" %
249 def _read_playlist(self):
250 for key, value in self._read_pairs(":"):
253 def _read_objects(self, delimiters=[]):
255 for key, value in self._read_pairs():
258 if key in delimiters:
262 if not isinstance(obj[key], list):
263 obj[key] = [obj[key], value]
265 obj[key].append(value)
271 def _read_command_list(self):
272 for retval in self._command_list:
274 self._command_list = None
275 self._fetch_nothing()
277 def _iterator_wrapper(self, iterator):
278 for item in iterator:
280 self._iterating = False
282 def _wrap_iterator(self, iterator):
284 return list(iterator)
285 self._iterating = True
286 return self._iterator_wrapper(iterator)
288 def _fetch_nothing(self):
289 line = self._read_line()
291 raise ProtocolError("Got unexpected return value: '%s'" % line)
293 def _fetch_item(self):
294 pairs = list(self._read_pairs())
299 def _fetch_list(self):
300 return self._wrap_iterator(self._read_list())
302 def _fetch_playlist(self):
303 return self._wrap_iterator(self._read_playlist())
305 def _fetch_object(self):
306 objs = list(self._read_objects())
311 def _fetch_objects(self, delimiters):
312 return self._wrap_iterator(self._read_objects(delimiters))
314 def _fetch_songs(self):
315 return self._fetch_objects(["file"])
317 def _fetch_playlists(self):
318 return self._fetch_objects(["playlist"])
320 def _fetch_database(self):
321 return self._fetch_objects(["file", "directory", "playlist"])
323 def _fetch_outputs(self):
324 return self._fetch_objects(["outputid"])
326 def _fetch_changes(self):
327 return self._fetch_objects(["cpos"])
329 def _fetch_command_list(self):
330 return self._wrap_iterator(self._read_command_list())
333 line = self._rfile.readline()
334 if not line.endswith("\n"):
335 raise ConnectionError("Connection lost while reading MPD hello")
336 line = line.rstrip("\n")
337 if not line.startswith(HELLO_PREFIX):
338 raise ProtocolError("Got invalid MPD hello: '%s'" % line)
339 self.mpd_version = line[len(HELLO_PREFIX):].strip()
342 self.mpd_version = None
343 self._iterating = False
345 self._command_list = None
347 self._rfile = _NotConnected()
348 self._wfile = _NotConnected()
350 def _connect_unix(self, path):
351 if not hasattr(socket, "AF_UNIX"):
352 raise ConnectionError("Unix domain sockets not supported "
354 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
358 def _connect_tcp(self, host, port):
360 flags = socket.AI_ADDRCONFIG
361 except AttributeError:
363 msg = "getaddrinfo returns an empty list"
364 for res in socket.getaddrinfo(host, port, socket.AF_UNSPEC,
365 socket.SOCK_STREAM, socket.IPPROTO_TCP,
367 af, socktype, proto, canonname, sa = res
369 sock = socket.socket(af, socktype, proto)
371 except socket.error, msg:
378 raise socket.error(msg)
381 def connect(self, host, port):
383 raise ConnectionError("Already connected")
384 if host.startswith("/"):
385 self._sock = self._connect_unix(host)
387 self._sock = self._connect_tcp(host, port)
388 self._rfile = self._sock.makefile("rb")
389 self._wfile = self._sock.makefile("wb")
396 def disconnect(self):
404 raise ConnectionError("Not connected")
405 return self._sock.fileno()
407 def command_list_ok_begin(self):
408 if self._command_list is not None:
409 raise CommandListError("Already in command list")
411 raise IteratingError("Cannot begin command list while iterating")
413 raise PendingCommandError("Cannot begin command list "
414 "with pending commands")
415 self._write_command("command_list_ok_begin")
416 self._command_list = []
418 def command_list_end(self):
419 if self._command_list is None:
420 raise CommandListError("Not in command list")
421 self._write_command("command_list_end")
422 return self._fetch_command_list()
426 return text.replace("\\", "\\\\").replace('"', '\\"')
429 # vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=79: