]> code.delx.au - pulseaudio/blob - src/pulse/context.c
drop check for PA_PROP_APPLICATION_NAME since often enough we can deduce this better...
[pulseaudio] / src / pulse / context.c
1 /***
2 This file is part of PulseAudio.
3
4 Copyright 2004-2008 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
6
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2 of the License,
10 or (at your option) any later version.
11
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA.
21 ***/
22
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <sys/types.h>
31 #include <unistd.h>
32 #include <sys/stat.h>
33 #include <errno.h>
34 #include <signal.h>
35 #include <limits.h>
36 #include <locale.h>
37
38 #ifdef HAVE_SYS_WAIT_H
39 #include <sys/wait.h>
40 #endif
41
42 #ifdef HAVE_SYS_SOCKET_H
43 #include <sys/socket.h>
44 #endif
45 #ifdef HAVE_SYS_UN_H
46 #include <sys/un.h>
47 #endif
48 #ifdef HAVE_NETDB_H
49 #include <netdb.h>
50 #endif
51
52 #include <pulse/version.h>
53 #include <pulse/xmalloc.h>
54 #include <pulse/utf8.h>
55 #include <pulse/util.h>
56 #include <pulse/i18n.h>
57
58 #include <pulsecore/winsock.h>
59 #include <pulsecore/core-error.h>
60
61 #include <pulsecore/native-common.h>
62 #include <pulsecore/pdispatch.h>
63 #include <pulsecore/pstream.h>
64 #include <pulsecore/dynarray.h>
65 #include <pulsecore/socket-client.h>
66 #include <pulsecore/pstream-util.h>
67 #include <pulsecore/core-util.h>
68 #include <pulsecore/log.h>
69 #include <pulsecore/socket-util.h>
70 #include <pulsecore/creds.h>
71 #include <pulsecore/macro.h>
72 #include <pulsecore/proplist-util.h>
73
74 #include "internal.h"
75
76 #include "client-conf.h"
77
78 #ifdef HAVE_X11
79 #include "client-conf-x11.h"
80 #endif
81
82 #include "context.h"
83
84 void pa_command_extension(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata);
85
86 static const pa_pdispatch_cb_t command_table[PA_COMMAND_MAX] = {
87 [PA_COMMAND_REQUEST] = pa_command_request,
88 [PA_COMMAND_OVERFLOW] = pa_command_overflow_or_underflow,
89 [PA_COMMAND_UNDERFLOW] = pa_command_overflow_or_underflow,
90 [PA_COMMAND_PLAYBACK_STREAM_KILLED] = pa_command_stream_killed,
91 [PA_COMMAND_RECORD_STREAM_KILLED] = pa_command_stream_killed,
92 [PA_COMMAND_PLAYBACK_STREAM_MOVED] = pa_command_stream_moved,
93 [PA_COMMAND_RECORD_STREAM_MOVED] = pa_command_stream_moved,
94 [PA_COMMAND_PLAYBACK_STREAM_SUSPENDED] = pa_command_stream_suspended,
95 [PA_COMMAND_RECORD_STREAM_SUSPENDED] = pa_command_stream_suspended,
96 [PA_COMMAND_STARTED] = pa_command_stream_started,
97 [PA_COMMAND_SUBSCRIBE_EVENT] = pa_command_subscribe_event,
98 [PA_COMMAND_EXTENSION] = pa_command_extension,
99 [PA_COMMAND_PLAYBACK_STREAM_EVENT] = pa_command_stream_event,
100 [PA_COMMAND_RECORD_STREAM_EVENT] = pa_command_stream_event,
101 [PA_COMMAND_CLIENT_EVENT] = pa_command_client_event
102 };
103 static void context_free(pa_context *c);
104
105 pa_context *pa_context_new(pa_mainloop_api *mainloop, const char *name) {
106 return pa_context_new_with_proplist(mainloop, name, NULL);
107 }
108
109 static void reset_callbacks(pa_context *c) {
110 pa_assert(c);
111
112 c->state_callback = NULL;
113 c->state_userdata = NULL;
114
115 c->subscribe_callback = NULL;
116 c->subscribe_userdata = NULL;
117
118 c->event_callback = NULL;
119 c->event_userdata = NULL;
120
121 c->ext_stream_restore.callback = NULL;
122 c->ext_stream_restore.userdata = NULL;
123 }
124
125 pa_context *pa_context_new_with_proplist(pa_mainloop_api *mainloop, const char *name, pa_proplist *p) {
126 pa_context *c;
127
128 pa_assert(mainloop);
129
130 pa_init_i18n();
131
132 c = pa_xnew(pa_context, 1);
133 PA_REFCNT_INIT(c);
134
135 c->proplist = p ? pa_proplist_copy(p) : pa_proplist_new();
136
137 if (name)
138 pa_proplist_sets(c->proplist, PA_PROP_APPLICATION_NAME, name);
139
140 c->mainloop = mainloop;
141 c->client = NULL;
142 c->pstream = NULL;
143 c->pdispatch = NULL;
144 c->playback_streams = pa_dynarray_new();
145 c->record_streams = pa_dynarray_new();
146 c->client_index = PA_INVALID_INDEX;
147
148 PA_LLIST_HEAD_INIT(pa_stream, c->streams);
149 PA_LLIST_HEAD_INIT(pa_operation, c->operations);
150
151 c->error = PA_OK;
152 c->state = PA_CONTEXT_UNCONNECTED;
153 c->ctag = 0;
154 c->csyncid = 0;
155
156 reset_callbacks(c);
157
158 c->is_local = FALSE;
159 c->server_list = NULL;
160 c->server = NULL;
161
162 c->do_shm = FALSE;
163
164 c->do_autospawn = FALSE;
165 memset(&c->spawn_api, 0, sizeof(c->spawn_api));
166
167 #ifndef MSG_NOSIGNAL
168 #ifdef SIGPIPE
169 pa_check_signal_is_blocked(SIGPIPE);
170 #endif
171 #endif
172
173 c->conf = pa_client_conf_new();
174 #ifdef HAVE_X11
175 pa_client_conf_from_x11(c->conf, NULL);
176 #endif
177 pa_client_conf_load(c->conf, NULL);
178 pa_client_conf_env(c->conf);
179
180 if (!(c->mempool = pa_mempool_new(!c->conf->disable_shm, c->conf->shm_size))) {
181
182 if (!c->conf->disable_shm)
183 c->mempool = pa_mempool_new(FALSE, c->conf->shm_size);
184
185 if (!c->mempool) {
186 context_free(c);
187 return NULL;
188 }
189 }
190
191 return c;
192 }
193
194 static void context_unlink(pa_context *c) {
195 pa_stream *s;
196
197 pa_assert(c);
198
199 s = c->streams ? pa_stream_ref(c->streams) : NULL;
200 while (s) {
201 pa_stream *n = s->next ? pa_stream_ref(s->next) : NULL;
202 pa_stream_set_state(s, c->state == PA_CONTEXT_FAILED ? PA_STREAM_FAILED : PA_STREAM_TERMINATED);
203 pa_stream_unref(s);
204 s = n;
205 }
206
207 while (c->operations)
208 pa_operation_cancel(c->operations);
209
210 if (c->pdispatch) {
211 pa_pdispatch_unref(c->pdispatch);
212 c->pdispatch = NULL;
213 }
214
215 if (c->pstream) {
216 pa_pstream_unlink(c->pstream);
217 pa_pstream_unref(c->pstream);
218 c->pstream = NULL;
219 }
220
221 if (c->client) {
222 pa_socket_client_unref(c->client);
223 c->client = NULL;
224 }
225
226 reset_callbacks(c);
227 }
228
229 static void context_free(pa_context *c) {
230 pa_assert(c);
231
232 context_unlink(c);
233
234 if (c->record_streams)
235 pa_dynarray_free(c->record_streams, NULL, NULL);
236 if (c->playback_streams)
237 pa_dynarray_free(c->playback_streams, NULL, NULL);
238
239 if (c->mempool)
240 pa_mempool_free(c->mempool);
241
242 if (c->conf)
243 pa_client_conf_free(c->conf);
244
245 pa_strlist_free(c->server_list);
246
247 if (c->proplist)
248 pa_proplist_free(c->proplist);
249
250 pa_xfree(c->server);
251 pa_xfree(c);
252 }
253
254 pa_context* pa_context_ref(pa_context *c) {
255 pa_assert(c);
256 pa_assert(PA_REFCNT_VALUE(c) >= 1);
257
258 PA_REFCNT_INC(c);
259 return c;
260 }
261
262 void pa_context_unref(pa_context *c) {
263 pa_assert(c);
264 pa_assert(PA_REFCNT_VALUE(c) >= 1);
265
266 if (PA_REFCNT_DEC(c) <= 0)
267 context_free(c);
268 }
269
270 void pa_context_set_state(pa_context *c, pa_context_state_t st) {
271 pa_assert(c);
272 pa_assert(PA_REFCNT_VALUE(c) >= 1);
273
274 if (c->state == st)
275 return;
276
277 pa_context_ref(c);
278
279 c->state = st;
280
281 if (c->state_callback)
282 c->state_callback(c, c->state_userdata);
283
284 if (st == PA_CONTEXT_FAILED || st == PA_CONTEXT_TERMINATED)
285 context_unlink(c);
286
287 pa_context_unref(c);
288 }
289
290 int pa_context_set_error(pa_context *c, int error) {
291 pa_assert(error >= 0);
292 pa_assert(error < PA_ERR_MAX);
293
294 if (c)
295 c->error = error;
296
297 return error;
298 }
299
300 void pa_context_fail(pa_context *c, int error) {
301 pa_assert(c);
302 pa_assert(PA_REFCNT_VALUE(c) >= 1);
303
304 pa_context_set_error(c, error);
305 pa_context_set_state(c, PA_CONTEXT_FAILED);
306 }
307
308 static void pstream_die_callback(pa_pstream *p, void *userdata) {
309 pa_context *c = userdata;
310
311 pa_assert(p);
312 pa_assert(c);
313
314 pa_context_fail(c, PA_ERR_CONNECTIONTERMINATED);
315 }
316
317 static void pstream_packet_callback(pa_pstream *p, pa_packet *packet, const pa_creds *creds, void *userdata) {
318 pa_context *c = userdata;
319
320 pa_assert(p);
321 pa_assert(packet);
322 pa_assert(c);
323
324 pa_context_ref(c);
325
326 if (pa_pdispatch_run(c->pdispatch, packet, creds, c) < 0)
327 pa_context_fail(c, PA_ERR_PROTOCOL);
328
329 pa_context_unref(c);
330 }
331
332 static void pstream_memblock_callback(pa_pstream *p, uint32_t channel, int64_t offset, pa_seek_mode_t seek, const pa_memchunk *chunk, void *userdata) {
333 pa_context *c = userdata;
334 pa_stream *s;
335
336 pa_assert(p);
337 pa_assert(chunk);
338 pa_assert(chunk->memblock);
339 pa_assert(chunk->length);
340 pa_assert(c);
341 pa_assert(PA_REFCNT_VALUE(c) >= 1);
342
343 pa_context_ref(c);
344
345 if ((s = pa_dynarray_get(c->record_streams, channel))) {
346
347 pa_assert(seek == PA_SEEK_RELATIVE);
348 pa_assert(offset == 0);
349
350 pa_memblockq_seek(s->record_memblockq, offset, seek);
351 pa_memblockq_push_align(s->record_memblockq, chunk);
352
353 if (s->read_callback) {
354 size_t l;
355
356 if ((l = pa_memblockq_get_length(s->record_memblockq)) > 0)
357 s->read_callback(s, l, s->read_userdata);
358 }
359 }
360
361 pa_context_unref(c);
362 }
363
364 int pa_context_handle_error(pa_context *c, uint32_t command, pa_tagstruct *t, pa_bool_t fail) {
365 uint32_t err;
366 pa_assert(c);
367 pa_assert(PA_REFCNT_VALUE(c) >= 1);
368
369 if (command == PA_COMMAND_ERROR) {
370 pa_assert(t);
371
372 if (pa_tagstruct_getu32(t, &err) < 0 ||
373 !pa_tagstruct_eof(t)) {
374 pa_context_fail(c, PA_ERR_PROTOCOL);
375 return -1;
376 }
377
378 } else if (command == PA_COMMAND_TIMEOUT)
379 err = PA_ERR_TIMEOUT;
380 else {
381 pa_context_fail(c, PA_ERR_PROTOCOL);
382 return -1;
383 }
384
385 if (err == PA_OK) {
386 pa_context_fail(c, PA_ERR_PROTOCOL);
387 return -1;
388 }
389
390 if (err >= PA_ERR_MAX)
391 err = PA_ERR_UNKNOWN;
392
393 if (fail) {
394 pa_context_fail(c, (int) err);
395 return -1;
396 }
397
398 pa_context_set_error(c, (int) err);
399
400 return 0;
401 }
402
403 static void setup_complete_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
404 pa_context *c = userdata;
405
406 pa_assert(pd);
407 pa_assert(c);
408 pa_assert(c->state == PA_CONTEXT_AUTHORIZING || c->state == PA_CONTEXT_SETTING_NAME);
409
410 pa_context_ref(c);
411
412 if (command != PA_COMMAND_REPLY) {
413 pa_context_handle_error(c, command, t, TRUE);
414 goto finish;
415 }
416
417 switch(c->state) {
418 case PA_CONTEXT_AUTHORIZING: {
419 pa_tagstruct *reply;
420 pa_bool_t shm_on_remote = FALSE;
421
422 if (pa_tagstruct_getu32(t, &c->version) < 0 ||
423 !pa_tagstruct_eof(t)) {
424 pa_context_fail(c, PA_ERR_PROTOCOL);
425 goto finish;
426 }
427
428 /* Minimum supported version */
429 if (c->version < 8) {
430 pa_context_fail(c, PA_ERR_VERSION);
431 goto finish;
432 }
433
434 /* Starting with protocol version 13 the MSB of the version
435 tag reflects if shm is available for this connection or
436 not. */
437 if (c->version >= 13) {
438 shm_on_remote = !!(c->version & 0x80000000U);
439 c->version &= 0x7FFFFFFFU;
440 }
441
442 pa_log_debug("Protocol version: remote %u, local %u", c->version, PA_PROTOCOL_VERSION);
443
444 /* Enable shared memory support if possible */
445 if (c->do_shm)
446 if (c->version < 10 || (c->version >= 13 && !shm_on_remote))
447 c->do_shm = FALSE;
448
449 if (c->do_shm) {
450
451 /* Only enable SHM if both sides are owned by the same
452 * user. This is a security measure because otherwise
453 * data private to the user might leak. */
454
455 #ifdef HAVE_CREDS
456 const pa_creds *creds;
457 if (!(creds = pa_pdispatch_creds(pd)) || getuid() != creds->uid)
458 c->do_shm = FALSE;
459 #endif
460 }
461
462 pa_log_debug("Negotiated SHM: %s", pa_yes_no(c->do_shm));
463 pa_pstream_enable_shm(c->pstream, c->do_shm);
464
465 reply = pa_tagstruct_command(c, PA_COMMAND_SET_CLIENT_NAME, &tag);
466
467 if (c->version >= 13) {
468 pa_init_proplist(c->proplist);
469 pa_tagstruct_put_proplist(reply, c->proplist);
470 } else
471 pa_tagstruct_puts(reply, pa_proplist_gets(c->proplist, PA_PROP_APPLICATION_NAME));
472
473 pa_pstream_send_tagstruct(c->pstream, reply);
474 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, setup_complete_callback, c, NULL);
475
476 pa_context_set_state(c, PA_CONTEXT_SETTING_NAME);
477 break;
478 }
479
480 case PA_CONTEXT_SETTING_NAME :
481
482 if ((c->version >= 13 && (pa_tagstruct_getu32(t, &c->client_index) < 0 ||
483 c->client_index == PA_INVALID_INDEX)) ||
484 !pa_tagstruct_eof(t)) {
485 pa_context_fail(c, PA_ERR_PROTOCOL);
486 goto finish;
487 }
488
489 pa_context_set_state(c, PA_CONTEXT_READY);
490 break;
491
492 default:
493 pa_assert_not_reached();
494 }
495
496 finish:
497 pa_context_unref(c);
498 }
499
500 static void setup_context(pa_context *c, pa_iochannel *io) {
501 pa_tagstruct *t;
502 uint32_t tag;
503
504 pa_assert(c);
505 pa_assert(io);
506
507 pa_context_ref(c);
508
509 pa_assert(!c->pstream);
510 c->pstream = pa_pstream_new(c->mainloop, io, c->mempool);
511
512 pa_pstream_set_die_callback(c->pstream, pstream_die_callback, c);
513 pa_pstream_set_recieve_packet_callback(c->pstream, pstream_packet_callback, c);
514 pa_pstream_set_recieve_memblock_callback(c->pstream, pstream_memblock_callback, c);
515
516 pa_assert(!c->pdispatch);
517 c->pdispatch = pa_pdispatch_new(c->mainloop, command_table, PA_COMMAND_MAX);
518
519 if (!c->conf->cookie_valid)
520 pa_log_info(_("No cookie loaded. Attempting to connect without."));
521
522 t = pa_tagstruct_command(c, PA_COMMAND_AUTH, &tag);
523
524 c->do_shm =
525 pa_mempool_is_shared(c->mempool) &&
526 c->is_local;
527
528 pa_log_debug("SHM possible: %s", pa_yes_no(c->do_shm));
529
530 /* Starting with protocol version 13 we use the MSB of the version
531 * tag for informing the other side if we could do SHM or not */
532 pa_tagstruct_putu32(t, PA_PROTOCOL_VERSION | (c->do_shm ? 0x80000000U : 0));
533 pa_tagstruct_put_arbitrary(t, c->conf->cookie, sizeof(c->conf->cookie));
534
535 #ifdef HAVE_CREDS
536 {
537 pa_creds ucred;
538
539 if (pa_iochannel_creds_supported(io))
540 pa_iochannel_creds_enable(io);
541
542 ucred.uid = getuid();
543 ucred.gid = getgid();
544
545 pa_pstream_send_tagstruct_with_creds(c->pstream, t, &ucred);
546 }
547 #else
548 pa_pstream_send_tagstruct(c->pstream, t);
549 #endif
550
551 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, setup_complete_callback, c, NULL);
552
553 pa_context_set_state(c, PA_CONTEXT_AUTHORIZING);
554
555 pa_context_unref(c);
556 }
557
558 static char *get_old_legacy_runtime_dir(void) {
559 char *p, u[128];
560 struct stat st;
561
562 if (!pa_get_user_name(u, sizeof(u)))
563 return NULL;
564
565 p = pa_sprintf_malloc("/tmp/pulse-%s", u);
566
567 if (stat(p, &st) < 0) {
568 pa_xfree(p);
569 return NULL;
570 }
571
572 if (st.st_uid != getuid()) {
573 pa_xfree(p);
574 return NULL;
575 }
576
577 return p;
578 }
579
580 static char *get_very_old_legacy_runtime_dir(void) {
581 char *p, h[128];
582 struct stat st;
583
584 if (!pa_get_home_dir(h, sizeof(h)))
585 return NULL;
586
587 p = pa_sprintf_malloc("%s/.pulse", h);
588
589 if (stat(p, &st) < 0) {
590 pa_xfree(p);
591 return NULL;
592 }
593
594 if (st.st_uid != getuid()) {
595 pa_xfree(p);
596 return NULL;
597 }
598
599 return p;
600 }
601
602
603 static pa_strlist *prepend_per_user(pa_strlist *l) {
604 char *ufn;
605 static char *legacy_dir;
606
607 /* The very old per-user instance path (< 0.9.11). This is supported only to ease upgrades */
608 if ((legacy_dir = get_very_old_legacy_runtime_dir())) {
609 char *p = pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET, legacy_dir);
610 l = pa_strlist_prepend(l, p);
611 pa_xfree(p);
612 pa_xfree(legacy_dir);
613 }
614
615 /* The old per-user instance path (< 0.9.12). This is supported only to ease upgrades */
616 if ((legacy_dir = get_old_legacy_runtime_dir())) {
617 char *p = pa_sprintf_malloc("%s" PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET, legacy_dir);
618 l = pa_strlist_prepend(l, p);
619 pa_xfree(p);
620 pa_xfree(legacy_dir);
621 }
622
623 /* The per-user instance */
624 if ((ufn = pa_runtime_path(PA_NATIVE_DEFAULT_UNIX_SOCKET))) {
625 l = pa_strlist_prepend(l, ufn);
626 pa_xfree(ufn);
627 }
628
629 return l;
630 }
631
632 #ifndef OS_IS_WIN32
633
634 static int context_autospawn(pa_context *c) {
635 pid_t pid;
636 int status, r;
637
638 pa_log_debug("Trying to autospawn...");
639
640 pa_context_ref(c);
641
642 if (c->spawn_api.prefork)
643 c->spawn_api.prefork();
644
645 if ((pid = fork()) < 0) {
646 pa_log_error(_("fork(): %s"), pa_cstrerror(errno));
647 pa_context_fail(c, PA_ERR_INTERNAL);
648
649 if (c->spawn_api.postfork)
650 c->spawn_api.postfork();
651
652 goto fail;
653 } else if (!pid) {
654 /* Child */
655
656 const char *state = NULL;
657 #define MAX_ARGS 64
658 const char * argv[MAX_ARGS+1];
659 int n;
660
661 if (c->spawn_api.atfork)
662 c->spawn_api.atfork();
663
664 pa_close_all(-1);
665
666 /* Setup argv */
667
668 n = 0;
669
670 argv[n++] = c->conf->daemon_binary;
671 argv[n++] = "--start";
672
673 while (n < MAX_ARGS) {
674 char *a;
675
676 if (!(a = pa_split_spaces(c->conf->extra_arguments, &state)))
677 break;
678
679 argv[n++] = a;
680 }
681
682 argv[n++] = NULL;
683
684 execv(argv[0], (char * const *) argv);
685 _exit(1);
686 #undef MAX_ARGS
687 }
688
689 /* Parent */
690
691 if (c->spawn_api.postfork)
692 c->spawn_api.postfork();
693
694 do {
695 r = waitpid(pid, &status, 0);
696 } while (r < 0 && errno == EINTR);
697
698 if (r < 0) {
699 pa_log(_("waitpid(): %s"), pa_cstrerror(errno));
700 pa_context_fail(c, PA_ERR_INTERNAL);
701 goto fail;
702 } else if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
703 pa_context_fail(c, PA_ERR_CONNECTIONREFUSED);
704 goto fail;
705 }
706
707 pa_context_unref(c);
708
709 return 0;
710
711 fail:
712
713 pa_context_unref(c);
714
715 return -1;
716 }
717
718 #endif /* OS_IS_WIN32 */
719
720 static void on_connection(pa_socket_client *client, pa_iochannel*io, void *userdata);
721
722 static int try_next_connection(pa_context *c) {
723 char *u = NULL;
724 int r = -1;
725
726 pa_assert(c);
727 pa_assert(!c->client);
728
729 for (;;) {
730 pa_xfree(u);
731 u = NULL;
732
733 c->server_list = pa_strlist_pop(c->server_list, &u);
734
735 if (!u) {
736
737 #ifndef OS_IS_WIN32
738 if (c->do_autospawn) {
739
740 if ((r = context_autospawn(c)) < 0)
741 goto finish;
742
743 /* Autospawn only once */
744 c->do_autospawn = FALSE;
745
746 /* Connect only to per-user sockets this time */
747 c->server_list = prepend_per_user(c->server_list);
748
749 /* Retry connection */
750 continue;
751 }
752 #endif
753
754 pa_context_fail(c, PA_ERR_CONNECTIONREFUSED);
755 goto finish;
756 }
757
758 pa_log_debug("Trying to connect to %s...", u);
759
760 pa_xfree(c->server);
761 c->server = pa_xstrdup(u);
762
763 if (!(c->client = pa_socket_client_new_string(c->mainloop, u, PA_NATIVE_DEFAULT_PORT)))
764 continue;
765
766 c->is_local = !!pa_socket_client_is_local(c->client);
767 pa_socket_client_set_callback(c->client, on_connection, c);
768 break;
769 }
770
771 r = 0;
772
773 finish:
774 pa_xfree(u);
775
776 return r;
777 }
778
779 static void on_connection(pa_socket_client *client, pa_iochannel*io, void *userdata) {
780 pa_context *c = userdata;
781 int saved_errno = errno;
782
783 pa_assert(client);
784 pa_assert(c);
785 pa_assert(c->state == PA_CONTEXT_CONNECTING);
786
787 pa_context_ref(c);
788
789 pa_socket_client_unref(client);
790 c->client = NULL;
791
792 if (!io) {
793 /* Try the item in the list */
794 if (saved_errno == ECONNREFUSED ||
795 saved_errno == ETIMEDOUT ||
796 saved_errno == EHOSTUNREACH) {
797 try_next_connection(c);
798 goto finish;
799 }
800
801 pa_context_fail(c, PA_ERR_CONNECTIONREFUSED);
802 goto finish;
803 }
804
805 setup_context(c, io);
806
807 finish:
808 pa_context_unref(c);
809 }
810
811 int pa_context_connect(
812 pa_context *c,
813 const char *server,
814 pa_context_flags_t flags,
815 const pa_spawn_api *api) {
816
817 int r = -1;
818
819 pa_assert(c);
820 pa_assert(PA_REFCNT_VALUE(c) >= 1);
821
822 PA_CHECK_VALIDITY(c, c->state == PA_CONTEXT_UNCONNECTED, PA_ERR_BADSTATE);
823 PA_CHECK_VALIDITY(c, !(flags & ~PA_CONTEXT_NOAUTOSPAWN), PA_ERR_INVALID);
824 PA_CHECK_VALIDITY(c, !server || *server, PA_ERR_INVALID);
825
826 if (!server)
827 server = c->conf->default_server;
828
829 pa_context_ref(c);
830
831 pa_assert(!c->server_list);
832
833 if (server) {
834 if (!(c->server_list = pa_strlist_parse(server))) {
835 pa_context_fail(c, PA_ERR_INVALIDSERVER);
836 goto finish;
837 }
838
839 } else {
840 char *d;
841
842 /* Prepend in reverse order */
843
844 /* Follow the X display */
845 if ((d = getenv("DISPLAY"))) {
846 char *e;
847 d = pa_xstrdup(d);
848 if ((e = strchr(d, ':')))
849 *e = 0;
850
851 if (*d)
852 c->server_list = pa_strlist_prepend(c->server_list, d);
853
854 pa_xfree(d);
855 }
856
857 /* Add TCP/IP on the localhost */
858 c->server_list = pa_strlist_prepend(c->server_list, "tcp6:[::1]");
859 c->server_list = pa_strlist_prepend(c->server_list, "tcp4:127.0.0.1");
860
861 /* The system wide instance via PF_LOCAL */
862 c->server_list = pa_strlist_prepend(c->server_list, PA_SYSTEM_RUNTIME_PATH PA_PATH_SEP PA_NATIVE_DEFAULT_UNIX_SOCKET);
863
864 /* The user instance via PF_LOCAL */
865 c->server_list = prepend_per_user(c->server_list);
866
867 /* Set up autospawning */
868 if (!(flags & PA_CONTEXT_NOAUTOSPAWN) && c->conf->autospawn) {
869
870 if (getuid() == 0)
871 pa_log_debug("Not doing autospawn since we are root.");
872 else {
873 c->do_autospawn = TRUE;
874
875 if (api)
876 c->spawn_api = *api;
877 }
878 }
879 }
880
881 pa_context_set_state(c, PA_CONTEXT_CONNECTING);
882 r = try_next_connection(c);
883
884 finish:
885 pa_context_unref(c);
886
887 return r;
888 }
889
890 void pa_context_disconnect(pa_context *c) {
891 pa_assert(c);
892 pa_assert(PA_REFCNT_VALUE(c) >= 1);
893
894 if (PA_CONTEXT_IS_GOOD(c->state))
895 pa_context_set_state(c, PA_CONTEXT_TERMINATED);
896 }
897
898 pa_context_state_t pa_context_get_state(pa_context *c) {
899 pa_assert(c);
900 pa_assert(PA_REFCNT_VALUE(c) >= 1);
901
902 return c->state;
903 }
904
905 int pa_context_errno(pa_context *c) {
906 pa_assert(c);
907 pa_assert(PA_REFCNT_VALUE(c) >= 1);
908
909 return c->error;
910 }
911
912 void pa_context_set_state_callback(pa_context *c, pa_context_notify_cb_t cb, void *userdata) {
913 pa_assert(c);
914 pa_assert(PA_REFCNT_VALUE(c) >= 1);
915
916 if (c->state == PA_CONTEXT_TERMINATED || c->state == PA_CONTEXT_FAILED)
917 return;
918
919 c->state_callback = cb;
920 c->state_userdata = userdata;
921 }
922
923 void pa_context_set_event_callback(pa_context *c, pa_context_event_cb_t cb, void *userdata) {
924 pa_assert(c);
925 pa_assert(PA_REFCNT_VALUE(c) >= 1);
926
927 if (c->state == PA_CONTEXT_TERMINATED || c->state == PA_CONTEXT_FAILED)
928 return;
929
930 c->event_callback = cb;
931 c->event_userdata = userdata;
932 }
933
934 int pa_context_is_pending(pa_context *c) {
935 pa_assert(c);
936 pa_assert(PA_REFCNT_VALUE(c) >= 1);
937
938 PA_CHECK_VALIDITY(c, PA_CONTEXT_IS_GOOD(c->state), PA_ERR_BADSTATE);
939
940 return (c->pstream && pa_pstream_is_pending(c->pstream)) ||
941 (c->pdispatch && pa_pdispatch_is_pending(c->pdispatch)) ||
942 c->client;
943 }
944
945 static void set_dispatch_callbacks(pa_operation *o);
946
947 static void pdispatch_drain_callback(pa_pdispatch*pd, void *userdata) {
948 set_dispatch_callbacks(userdata);
949 }
950
951 static void pstream_drain_callback(pa_pstream *s, void *userdata) {
952 set_dispatch_callbacks(userdata);
953 }
954
955 static void set_dispatch_callbacks(pa_operation *o) {
956 int done = 1;
957
958 pa_assert(o);
959 pa_assert(PA_REFCNT_VALUE(o) >= 1);
960 pa_assert(o->context);
961 pa_assert(PA_REFCNT_VALUE(o->context) >= 1);
962 pa_assert(o->context->state == PA_CONTEXT_READY);
963
964 pa_pstream_set_drain_callback(o->context->pstream, NULL, NULL);
965 pa_pdispatch_set_drain_callback(o->context->pdispatch, NULL, NULL);
966
967 if (pa_pdispatch_is_pending(o->context->pdispatch)) {
968 pa_pdispatch_set_drain_callback(o->context->pdispatch, pdispatch_drain_callback, o);
969 done = 0;
970 }
971
972 if (pa_pstream_is_pending(o->context->pstream)) {
973 pa_pstream_set_drain_callback(o->context->pstream, pstream_drain_callback, o);
974 done = 0;
975 }
976
977 if (done) {
978 if (o->callback) {
979 pa_context_notify_cb_t cb = (pa_context_notify_cb_t) o->callback;
980 cb(o->context, o->userdata);
981 }
982
983 pa_operation_done(o);
984 pa_operation_unref(o);
985 }
986 }
987
988 pa_operation* pa_context_drain(pa_context *c, pa_context_notify_cb_t cb, void *userdata) {
989 pa_operation *o;
990
991 pa_assert(c);
992 pa_assert(PA_REFCNT_VALUE(c) >= 1);
993
994 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
995 PA_CHECK_VALIDITY_RETURN_NULL(c, pa_context_is_pending(c), PA_ERR_BADSTATE);
996
997 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
998 set_dispatch_callbacks(pa_operation_ref(o));
999
1000 return o;
1001 }
1002
1003 void pa_context_simple_ack_callback(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1004 pa_operation *o = userdata;
1005 int success = 1;
1006
1007 pa_assert(pd);
1008 pa_assert(o);
1009 pa_assert(PA_REFCNT_VALUE(o) >= 1);
1010
1011 if (!o->context)
1012 goto finish;
1013
1014 if (command != PA_COMMAND_REPLY) {
1015 if (pa_context_handle_error(o->context, command, t, FALSE) < 0)
1016 goto finish;
1017
1018 success = 0;
1019 } else if (!pa_tagstruct_eof(t)) {
1020 pa_context_fail(o->context, PA_ERR_PROTOCOL);
1021 goto finish;
1022 }
1023
1024 if (o->callback) {
1025 pa_context_success_cb_t cb = (pa_context_success_cb_t) o->callback;
1026 cb(o->context, success, o->userdata);
1027 }
1028
1029 finish:
1030 pa_operation_done(o);
1031 pa_operation_unref(o);
1032 }
1033
1034 pa_operation* pa_context_send_simple_command(pa_context *c, uint32_t command, pa_pdispatch_cb_t internal_cb, pa_operation_cb_t cb, void *userdata) {
1035 pa_tagstruct *t;
1036 pa_operation *o;
1037 uint32_t tag;
1038
1039 pa_assert(c);
1040 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1041
1042 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1043
1044 o = pa_operation_new(c, NULL, cb, userdata);
1045
1046 t = pa_tagstruct_command(c, command, &tag);
1047 pa_pstream_send_tagstruct(c->pstream, t);
1048 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, internal_cb, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1049
1050 return o;
1051 }
1052
1053 pa_operation* pa_context_exit_daemon(pa_context *c, pa_context_success_cb_t cb, void *userdata) {
1054 pa_assert(c);
1055 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1056
1057 return pa_context_send_simple_command(c, PA_COMMAND_EXIT, pa_context_simple_ack_callback, (pa_operation_cb_t) cb, userdata);
1058 }
1059
1060 pa_operation* pa_context_set_default_sink(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata) {
1061 pa_tagstruct *t;
1062 pa_operation *o;
1063 uint32_t tag;
1064
1065 pa_assert(c);
1066 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1067
1068 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1069
1070 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1071 t = pa_tagstruct_command(c, PA_COMMAND_SET_DEFAULT_SINK, &tag);
1072 pa_tagstruct_puts(t, name);
1073 pa_pstream_send_tagstruct(c->pstream, t);
1074 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1075
1076 return o;
1077 }
1078
1079 pa_operation* pa_context_set_default_source(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata) {
1080 pa_tagstruct *t;
1081 pa_operation *o;
1082 uint32_t tag;
1083
1084 pa_assert(c);
1085 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1086
1087 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1088
1089 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1090 t = pa_tagstruct_command(c, PA_COMMAND_SET_DEFAULT_SOURCE, &tag);
1091 pa_tagstruct_puts(t, name);
1092 pa_pstream_send_tagstruct(c->pstream, t);
1093 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1094
1095 return o;
1096 }
1097
1098 int pa_context_is_local(pa_context *c) {
1099 pa_assert(c);
1100 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1101
1102 PA_CHECK_VALIDITY_RETURN_ANY(c, PA_CONTEXT_IS_GOOD(c->state), PA_ERR_BADSTATE, -1);
1103
1104 return !!c->is_local;
1105 }
1106
1107 pa_operation* pa_context_set_name(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata) {
1108 pa_operation *o;
1109
1110 pa_assert(c);
1111 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1112 pa_assert(name);
1113
1114 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1115
1116 if (c->version >= 13) {
1117 pa_proplist *p = pa_proplist_new();
1118
1119 pa_proplist_sets(p, PA_PROP_APPLICATION_NAME, name);
1120 o = pa_context_proplist_update(c, PA_UPDATE_REPLACE, p, cb, userdata);
1121 pa_proplist_free(p);
1122 } else {
1123 pa_tagstruct *t;
1124 uint32_t tag;
1125
1126 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1127 t = pa_tagstruct_command(c, PA_COMMAND_SET_CLIENT_NAME, &tag);
1128 pa_tagstruct_puts(t, name);
1129 pa_pstream_send_tagstruct(c->pstream, t);
1130 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1131 }
1132
1133 return o;
1134 }
1135
1136 const char* pa_get_library_version(void) {
1137 return PACKAGE_VERSION;
1138 }
1139
1140 const char* pa_context_get_server(pa_context *c) {
1141 pa_assert(c);
1142 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1143
1144 if (!c->server)
1145 return NULL;
1146
1147 if (*c->server == '{') {
1148 char *e = strchr(c->server+1, '}');
1149 return e ? e+1 : c->server;
1150 }
1151
1152 return c->server;
1153 }
1154
1155 uint32_t pa_context_get_protocol_version(pa_context *c) {
1156 return PA_PROTOCOL_VERSION;
1157 }
1158
1159 uint32_t pa_context_get_server_protocol_version(pa_context *c) {
1160 pa_assert(c);
1161 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1162
1163 PA_CHECK_VALIDITY_RETURN_ANY(c, PA_CONTEXT_IS_GOOD(c->state), PA_ERR_BADSTATE, PA_INVALID_INDEX);
1164
1165 return c->version;
1166 }
1167
1168 pa_tagstruct *pa_tagstruct_command(pa_context *c, uint32_t command, uint32_t *tag) {
1169 pa_tagstruct *t;
1170
1171 pa_assert(c);
1172 pa_assert(tag);
1173
1174 t = pa_tagstruct_new(NULL, 0);
1175 pa_tagstruct_putu32(t, command);
1176 pa_tagstruct_putu32(t, *tag = c->ctag++);
1177
1178 return t;
1179 }
1180
1181 uint32_t pa_context_get_index(pa_context *c) {
1182 pa_assert(c);
1183 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1184
1185 PA_CHECK_VALIDITY_RETURN_ANY(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE, PA_INVALID_INDEX);
1186 PA_CHECK_VALIDITY_RETURN_ANY(c, c->version >= 13, PA_ERR_NOTSUPPORTED, PA_INVALID_INDEX);
1187
1188 return c->client_index;
1189 }
1190
1191 pa_operation *pa_context_proplist_update(pa_context *c, pa_update_mode_t mode, pa_proplist *p, pa_context_success_cb_t cb, void *userdata) {
1192 pa_operation *o;
1193 pa_tagstruct *t;
1194 uint32_t tag;
1195
1196 pa_assert(c);
1197 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1198
1199 PA_CHECK_VALIDITY_RETURN_NULL(c, mode == PA_UPDATE_SET || mode == PA_UPDATE_MERGE || mode == PA_UPDATE_REPLACE, PA_ERR_INVALID);
1200 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1201 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 13, PA_ERR_NOTSUPPORTED);
1202
1203 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1204
1205 t = pa_tagstruct_command(c, PA_COMMAND_UPDATE_CLIENT_PROPLIST, &tag);
1206 pa_tagstruct_putu32(t, (uint32_t) mode);
1207 pa_tagstruct_put_proplist(t, p);
1208
1209 pa_pstream_send_tagstruct(c->pstream, t);
1210 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1211
1212 /* Please note that we don't update c->proplist here, because we
1213 * don't export that field */
1214
1215 return o;
1216 }
1217
1218 pa_operation *pa_context_proplist_remove(pa_context *c, const char *const keys[], pa_context_success_cb_t cb, void *userdata) {
1219 pa_operation *o;
1220 pa_tagstruct *t;
1221 uint32_t tag;
1222 const char * const *k;
1223
1224 pa_assert(c);
1225 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1226
1227 PA_CHECK_VALIDITY_RETURN_NULL(c, keys && keys[0], PA_ERR_INVALID);
1228 PA_CHECK_VALIDITY_RETURN_NULL(c, c->state == PA_CONTEXT_READY, PA_ERR_BADSTATE);
1229 PA_CHECK_VALIDITY_RETURN_NULL(c, c->version >= 13, PA_ERR_NOTSUPPORTED);
1230
1231 o = pa_operation_new(c, NULL, (pa_operation_cb_t) cb, userdata);
1232
1233 t = pa_tagstruct_command(c, PA_COMMAND_REMOVE_CLIENT_PROPLIST, &tag);
1234
1235 for (k = keys; *k; k++)
1236 pa_tagstruct_puts(t, *k);
1237
1238 pa_tagstruct_puts(t, NULL);
1239
1240 pa_pstream_send_tagstruct(c->pstream, t);
1241 pa_pdispatch_register_reply(c->pdispatch, tag, DEFAULT_TIMEOUT, pa_context_simple_ack_callback, pa_operation_ref(o), (pa_free_cb_t) pa_operation_unref);
1242
1243 /* Please note that we don't update c->proplist here, because we
1244 * don't export that field */
1245
1246 return o;
1247 }
1248
1249 void pa_command_extension(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1250 pa_context *c = userdata;
1251 uint32_t idx;
1252 const char *name;
1253
1254 pa_assert(pd);
1255 pa_assert(command == PA_COMMAND_EXTENSION);
1256 pa_assert(t);
1257 pa_assert(c);
1258 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1259
1260 pa_context_ref(c);
1261
1262 if (c->version < 15) {
1263 pa_context_fail(c, PA_ERR_PROTOCOL);
1264 goto finish;
1265 }
1266
1267 if (pa_tagstruct_getu32(t, &idx) < 0 ||
1268 pa_tagstruct_gets(t, &name) < 0) {
1269 pa_context_fail(c, PA_ERR_PROTOCOL);
1270 goto finish;
1271 }
1272
1273 if (!strcmp(name, "module-stream-restore"))
1274 pa_ext_stream_restore_command(c, tag, t);
1275 else
1276 pa_log(_("Received message for unknown extension '%s'"), name);
1277
1278 finish:
1279 pa_context_unref(c);
1280 }
1281
1282
1283 void pa_command_client_event(pa_pdispatch *pd, uint32_t command, uint32_t tag, pa_tagstruct *t, void *userdata) {
1284 pa_context *c = userdata;
1285 pa_proplist *pl = NULL;
1286 const char *event;
1287
1288 pa_assert(pd);
1289 pa_assert(command == PA_COMMAND_CLIENT_EVENT);
1290 pa_assert(t);
1291 pa_assert(c);
1292 pa_assert(PA_REFCNT_VALUE(c) >= 1);
1293
1294 pa_context_ref(c);
1295
1296 if (c->version < 15) {
1297 pa_context_fail(c, PA_ERR_PROTOCOL);
1298 goto finish;
1299 }
1300
1301 pl = pa_proplist_new();
1302
1303 if (pa_tagstruct_gets(t, &event) < 0 ||
1304 pa_tagstruct_get_proplist(t, pl) < 0 ||
1305 !pa_tagstruct_eof(t) || !event) {
1306 pa_context_fail(c, PA_ERR_PROTOCOL);
1307 goto finish;
1308 }
1309
1310 if (c->event_callback)
1311 c->event_callback(c, event, pl, c->event_userdata);
1312
1313 finish:
1314 pa_context_unref(c);
1315
1316 if (pl)
1317 pa_proplist_free(pl);
1318 }