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