2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
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.1 of the License,
10 or (at your option) any later version.
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.
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
31 #include <pulse/xmalloc.h>
33 #include <pulsecore/i18n.h>
34 #include <pulsecore/macro.h>
35 #include <pulsecore/core-error.h>
36 #include <pulsecore/log.h>
37 #include <pulsecore/conf-parser.h>
38 #include <pulsecore/core-util.h>
39 #include <pulsecore/authkey.h>
41 #include "client-conf.h"
43 #define DEFAULT_CLIENT_CONFIG_FILE PA_DEFAULT_CONFIG_DIR PA_PATH_SEP "client.conf"
44 #define DEFAULT_CLIENT_CONFIG_FILE_USER "client.conf"
46 #define ENV_CLIENT_CONFIG_FILE "PULSE_CLIENTCONFIG"
47 #define ENV_DEFAULT_SINK "PULSE_SINK"
48 #define ENV_DEFAULT_SOURCE "PULSE_SOURCE"
49 #define ENV_DEFAULT_SERVER "PULSE_SERVER"
50 #define ENV_DAEMON_BINARY "PULSE_BINARY"
51 #define ENV_COOKIE_FILE "PULSE_COOKIE"
53 static const pa_client_conf default_conf
= {
54 .daemon_binary
= NULL
,
55 .extra_arguments
= NULL
,
57 .default_source
= NULL
,
58 .default_server
= NULL
,
59 .default_dbus_server
= NULL
,
60 .cookie_file_from_env
= NULL
,
61 .cookie_from_x11_valid
= false,
62 .cookie_file_from_application
= NULL
,
63 .cookie_file_from_client_conf
= NULL
,
67 .auto_connect_localhost
= false,
68 .auto_connect_display
= false
71 pa_client_conf
*pa_client_conf_new(void) {
72 pa_client_conf
*c
= pa_xmemdup(&default_conf
, sizeof(default_conf
));
74 c
->daemon_binary
= pa_xstrdup(PA_BINARY
);
75 c
->extra_arguments
= pa_xstrdup("--log-target=syslog");
80 void pa_client_conf_free(pa_client_conf
*c
) {
82 pa_xfree(c
->daemon_binary
);
83 pa_xfree(c
->extra_arguments
);
84 pa_xfree(c
->default_sink
);
85 pa_xfree(c
->default_source
);
86 pa_xfree(c
->default_server
);
87 pa_xfree(c
->default_dbus_server
);
88 pa_xfree(c
->cookie_file_from_env
);
89 pa_xfree(c
->cookie_file_from_application
);
90 pa_xfree(c
->cookie_file_from_client_conf
);
94 int pa_client_conf_load(pa_client_conf
*c
) {
99 /* Prepare the configuration parse table */
100 pa_config_item table
[] = {
101 { "daemon-binary", pa_config_parse_string
, &c
->daemon_binary
, NULL
},
102 { "extra-arguments", pa_config_parse_string
, &c
->extra_arguments
, NULL
},
103 { "default-sink", pa_config_parse_string
, &c
->default_sink
, NULL
},
104 { "default-source", pa_config_parse_string
, &c
->default_source
, NULL
},
105 { "default-server", pa_config_parse_string
, &c
->default_server
, NULL
},
106 { "default-dbus-server", pa_config_parse_string
, &c
->default_dbus_server
, NULL
},
107 { "autospawn", pa_config_parse_bool
, &c
->autospawn
, NULL
},
108 { "cookie-file", pa_config_parse_string
, &c
->cookie_file_from_client_conf
, NULL
},
109 { "disable-shm", pa_config_parse_bool
, &c
->disable_shm
, NULL
},
110 { "enable-shm", pa_config_parse_not_bool
, &c
->disable_shm
, NULL
},
111 { "shm-size-bytes", pa_config_parse_size
, &c
->shm_size
, NULL
},
112 { "auto-connect-localhost", pa_config_parse_bool
, &c
->auto_connect_localhost
, NULL
},
113 { "auto-connect-display", pa_config_parse_bool
, &c
->auto_connect_display
, NULL
},
114 { NULL
, NULL
, NULL
, NULL
},
117 if (!(f
= pa_open_config_file(DEFAULT_CLIENT_CONFIG_FILE
, DEFAULT_CLIENT_CONFIG_FILE_USER
, ENV_CLIENT_CONFIG_FILE
, &fn
)))
121 r
= f
? pa_config_parse(fn
, f
, table
, NULL
, NULL
) : 0;
132 int pa_client_conf_load_cookie(pa_client_conf
*c
, uint8_t *cookie
, size_t cookie_length
) {
137 pa_assert(cookie_length
> 0);
139 if (c
->cookie_file_from_env
) {
140 r
= pa_authkey_load_auto(c
->cookie_file_from_env
, true, cookie
, cookie_length
);
144 pa_log_warn("Failed to load cookie from %s (configured with environment variable PULSE_COOKIE): %s",
145 c
->cookie_file_from_env
, pa_cstrerror(errno
));
148 if (c
->cookie_from_x11_valid
) {
149 if (cookie_length
== sizeof(c
->cookie_from_x11
)) {
150 memcpy(cookie
, c
->cookie_from_x11
, cookie_length
);
154 pa_log_warn("Failed to load cookie from X11 root window property PULSE_COOKIE: size mismatch.");
157 if (c
->cookie_file_from_application
) {
158 r
= pa_authkey_load_auto(c
->cookie_file_from_application
, true, cookie
, cookie_length
);
162 pa_log_warn("Failed to load cookie from %s (configured by the application): %s", c
->cookie_file_from_application
,
163 pa_cstrerror(errno
));
166 if (c
->cookie_file_from_client_conf
) {
167 r
= pa_authkey_load_auto(c
->cookie_file_from_client_conf
, true, cookie
, cookie_length
);
171 pa_log_warn("Failed to load cookie from %s (configured in client.conf): %s", c
->cookie_file_from_client_conf
,
172 pa_cstrerror(errno
));
175 r
= pa_authkey_load_auto(PA_NATIVE_COOKIE_FILE
, false, cookie
, cookie_length
);
179 r
= pa_authkey_load_auto(PA_NATIVE_COOKIE_FILE_FALLBACK
, false, cookie
, cookie_length
);
183 r
= pa_authkey_load_auto(PA_NATIVE_COOKIE_FILE
, true, cookie
, cookie_length
);
187 pa_log("Failed to load cookie file from %s: %s", PA_NATIVE_COOKIE_FILE
, pa_cstrerror(errno
));
188 memset(cookie
, 0, cookie_length
);
193 int pa_client_conf_env(pa_client_conf
*c
) {
196 if ((e
= getenv(ENV_DEFAULT_SINK
))) {
197 pa_xfree(c
->default_sink
);
198 c
->default_sink
= pa_xstrdup(e
);
201 if ((e
= getenv(ENV_DEFAULT_SOURCE
))) {
202 pa_xfree(c
->default_source
);
203 c
->default_source
= pa_xstrdup(e
);
206 if ((e
= getenv(ENV_DEFAULT_SERVER
))) {
207 pa_xfree(c
->default_server
);
208 c
->default_server
= pa_xstrdup(e
);
210 /* We disable autospawning automatically if a specific server was set */
211 c
->autospawn
= false;
214 if ((e
= getenv(ENV_DAEMON_BINARY
))) {
215 pa_xfree(c
->daemon_binary
);
216 c
->daemon_binary
= pa_xstrdup(e
);
219 if ((e
= getenv(ENV_COOKIE_FILE
)) && *e
) {
220 pa_xfree(c
->cookie_file_from_env
);
221 c
->cookie_file_from_env
= pa_xstrdup(e
);
227 void pa_client_conf_set_cookie_file_from_application(pa_client_conf
*c
, const char *cookie_file
) {
229 pa_assert(!cookie_file
|| *cookie_file
);
231 pa_xfree(c
->cookie_file_from_application
);
232 c
->cookie_file_from_application
= pa_xstrdup(cookie_file
);