code.delx.au - pulseaudio/blob - src/pulse/context.c

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