2 This file is part of PulseAudio.
4 Copyright 2005-2009 Lennart Poettering
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
29 #include <pulse/util.h>
30 #include <pulse/xmalloc.h>
31 #include <pulse/timeval.h>
33 #include <pulsecore/core-util.h>
34 #include <pulsecore/ioline.h>
35 #include <pulsecore/thread-mq.h>
36 #include <pulsecore/macro.h>
37 #include <pulsecore/log.h>
38 #include <pulsecore/namereg.h>
39 #include <pulsecore/cli-text.h>
40 #include <pulsecore/shared.h>
41 #include <pulsecore/core-error.h>
42 #include <pulsecore/mime-type.h>
44 #include "protocol-http.h"
46 /* Don't allow more than this many concurrent connections */
47 #define MAX_CONNECTIONS 10
50 #define URL_CSS "/style"
51 #define URL_STATUS "/status"
52 #define URL_LISTEN "/listen"
53 #define URL_LISTEN_SOURCE "/listen/source/"
55 #define MIME_HTML "text/html; charset=utf-8"
56 #define MIME_TEXT "text/plain; charset=utf-8"
57 #define MIME_CSS "text/css"
59 #define HTML_HEADER(t) \
60 "<?xml version=\"1.0\"?>\n" \
61 "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n" \
62 "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n" \
64 " <title>"t"</title>\n" \
65 " <link rel=\"stylesheet\" type=\"text/css\" href=\"style\"/>\n" \
73 #define RECORD_BUFFER_SECONDS (5)
74 #define DEFAULT_SOURCE_LATENCY (300*PA_USEC_PER_MSEC)
88 pa_http_protocol *protocol;
91 pa_memblockq *output_memblockq;
92 pa_source_output *source_output;
100 struct pa_http_protocol {
104 pa_idxset *connections;
110 SOURCE_OUTPUT_MESSAGE_POST_DATA = PA_SOURCE_OUTPUT_MESSAGE_MAX
113 /* Called from main context */
114 static void connection_unlink(struct connection *c) {
117 if (c->source_output) {
118 pa_source_output_unlink(c->source_output);
119 c->source_output->userdata = NULL;
120 pa_source_output_unref(c->source_output);
124 pa_client_free(c->client);
129 pa_ioline_unref(c->line);
132 pa_iochannel_free(c->io);
134 if (c->output_memblockq)
135 pa_memblockq_free(c->output_memblockq);
137 pa_idxset_remove_by_data(c->protocol->connections, c, NULL);
142 /* Called from main context */
143 static int do_write(struct connection *c) {
150 if (pa_memblockq_peek(c->output_memblockq, &chunk) < 0)
153 pa_assert(chunk.memblock);
154 pa_assert(chunk.length > 0);
156 p = pa_memblock_acquire(chunk.memblock);
157 r = pa_iochannel_write(c->io, (uint8_t*) p+chunk.index, chunk.length);
158 pa_memblock_release(chunk.memblock);
160 pa_memblock_unref(chunk.memblock);
163 pa_log("write(): %s", pa_cstrerror(errno));
167 pa_memblockq_drop(c->output_memblockq, (size_t) r);
172 /* Called from main context */
173 static void do_work(struct connection *c) {
176 if (pa_iochannel_is_hungup(c->io))
179 while (pa_iochannel_is_writable(c->io)) {
190 connection_unlink(c);
193 /* Called from thread context, except when it is not */
194 static int source_output_process_msg(pa_msgobject *m, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
195 pa_source_output *o = PA_SOURCE_OUTPUT(m);
196 struct connection *c;
198 pa_source_output_assert_ref(o);
200 if (!(c = o->userdata))
205 case SOURCE_OUTPUT_MESSAGE_POST_DATA:
206 /* While this function is usually called from IO thread
207 * context, this specific command is not! */
208 pa_memblockq_push_align(c->output_memblockq, chunk);
213 return pa_source_output_process_msg(m, code, userdata, offset, chunk);
219 /* Called from thread context */
220 static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk) {
221 struct connection *c;
223 pa_source_output_assert_ref(o);
224 pa_assert_se(c = o->userdata);
227 pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(o), SOURCE_OUTPUT_MESSAGE_POST_DATA, NULL, 0, chunk, NULL);
230 /* Called from main context */
231 static void source_output_kill_cb(pa_source_output *o) {
234 pa_source_output_assert_ref(o);
235 pa_assert_se(c = o->userdata);
237 connection_unlink(c);
240 /* Called from main context */
241 static pa_usec_t source_output_get_latency_cb(pa_source_output *o) {
244 pa_source_output_assert_ref(o);
245 pa_assert_se(c = o->userdata);
247 return pa_bytes_to_usec(pa_memblockq_get_length(c->output_memblockq), &c->source_output->sample_spec);
250 /*** client callbacks ***/
251 static void client_kill_cb(pa_client *client) {
255 pa_assert_se(c = client->userdata);
257 connection_unlink(c);
260 /*** pa_iochannel callbacks ***/
261 static void io_callback(pa_iochannel*io, void *userdata) {
262 struct connection *c = userdata;
270 static char *escape_html(const char *t) {
274 sb = pa_strbuf_new();
276 for (e = p = t; *p; p++) {
278 if (*p == '>' || *p == '<' || *p == '&') {
281 pa_strbuf_putsn(sb, e, p-e);
286 pa_strbuf_puts(sb, ">");
288 pa_strbuf_puts(sb, "<");
290 pa_strbuf_puts(sb, "&");
295 pa_strbuf_putsn(sb, e, p-e);
297 return pa_strbuf_to_string_free(sb);
300 static void http_response(
301 struct connection *c,
312 s = pa_sprintf_malloc(
314 "Connection: close\n"
316 "Cache-Control: no-cache\n"
318 "Server: "PACKAGE_NAME"/"PACKAGE_VERSION"\n"
319 "\n", code, msg, mime);
320 pa_ioline_puts(c->line, s);
324 static void html_response(
325 struct connection *c,
333 http_response(c, code, msg, MIME_HTML);
335 if (c->method == METHOD_HEAD) {
336 pa_ioline_defer_close(c->line);
343 s = pa_sprintf_malloc(
349 pa_ioline_puts(c->line, s);
352 pa_ioline_defer_close(c->line);
355 static void html_print_field(pa_ioline *line, const char *left, const char *right) {
356 char *eleft, *eright;
358 eleft = escape_html(left);
359 eright = escape_html(right);
361 pa_ioline_printf(line,
362 "<tr><td><b>%s</b></td>"
363 "<td>%s</td></tr>\n", eleft, eright);
369 static void handle_root(struct connection *c) {
374 http_response(c, 200, "OK", MIME_HTML);
376 if (c->method == METHOD_HEAD) {
377 pa_ioline_defer_close(c->line);
381 pa_ioline_puts(c->line,
382 HTML_HEADER(PACKAGE_NAME" "PACKAGE_VERSION)
383 "<h1>"PACKAGE_NAME" "PACKAGE_VERSION"</h1>\n"
386 t = pa_get_user_name_malloc();
387 html_print_field(c->line, "User Name:", t);
390 t = pa_get_host_name_malloc();
391 html_print_field(c->line, "Host name:", t);
395 html_print_field(c->line, "Machine ID:", t);
398 t = pa_uname_string();
399 html_print_field(c->line, "System:", t);
402 t = pa_sprintf_malloc("%lu", (unsigned long) getpid());
403 html_print_field(c->line, "Process ID:", t);
406 pa_ioline_puts(c->line,
408 "<p><a href=\"" URL_STATUS "\">Show an extensive server status report</a></p>\n"
409 "<p><a href=\"" URL_LISTEN "\">Monitor sinks and sources</a></p>\n"
412 pa_ioline_defer_close(c->line);
415 static void handle_css(struct connection *c) {
418 http_response(c, 200, "OK", MIME_CSS);
420 if (c->method == METHOD_HEAD) {
421 pa_ioline_defer_close(c->line);
425 pa_ioline_puts(c->line,
426 "body { color: black; background-color: white; }\n"
427 "a:link, a:visited { color: #900000; }\n"
428 "div.news-date { font-size: 80%; font-style: italic; }\n"
429 "pre { background-color: #f0f0f0; padding: 0.4cm; }\n"
430 ".grey { color: #8f8f8f; font-size: 80%; }"
431 "table { margin-left: 1cm; border:1px solid lightgrey; padding: 0.2cm; }\n"
432 "td { padding-left:10px; padding-right:10px; }\n");
434 pa_ioline_defer_close(c->line);
437 static void handle_status(struct connection *c) {
442 http_response(c, 200, "OK", MIME_TEXT);
444 if (c->method == METHOD_HEAD) {
445 pa_ioline_defer_close(c->line);
449 r = pa_full_status_string(c->protocol->core);
450 pa_ioline_puts(c->line, r);
453 pa_ioline_defer_close(c->line);
456 static void handle_listen(struct connection *c) {
461 http_response(c, 200, "OK", MIME_HTML);
463 pa_ioline_puts(c->line,
464 HTML_HEADER("Listen")
468 if (c->method == METHOD_HEAD) {
469 pa_ioline_defer_close(c->line);
473 PA_IDXSET_FOREACH(sink, c->protocol->core->sinks, idx) {
476 t = escape_html(pa_strna(pa_proplist_gets(sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
477 m = pa_sample_spec_to_mime_type_mimefy(&sink->sample_spec, &sink->channel_map);
479 pa_ioline_printf(c->line,
480 "<a href=\"" URL_LISTEN_SOURCE "%s\" title=\"%s\">%s</a><br/>\n",
481 sink->monitor_source->name, m, t);
487 pa_ioline_puts(c->line,
492 PA_IDXSET_FOREACH(source, c->protocol->core->sources, idx) {
495 if (source->monitor_of)
498 t = escape_html(pa_strna(pa_proplist_gets(source->proplist, PA_PROP_DEVICE_DESCRIPTION)));
499 m = pa_sample_spec_to_mime_type_mimefy(&source->sample_spec, &source->channel_map);
501 pa_ioline_printf(c->line,
502 "<a href=\"" URL_LISTEN_SOURCE "%s\" title=\"%s\">%s</a><br/>\n",
510 pa_ioline_puts(c->line,
514 pa_ioline_defer_close(c->line);
517 static void line_drain_callback(pa_ioline *l, void *userdata) {
518 struct connection *c;
521 pa_assert_se(c = userdata);
523 /* We don't need the line reader anymore, instead we need a real
524 * binary io channel */
525 pa_assert_se(c->io = pa_ioline_detach_iochannel(c->line));
526 pa_iochannel_set_callback(c->io, io_callback, c);
528 pa_iochannel_socket_set_sndbuf(c->io, pa_memblockq_get_length(c->output_memblockq));
530 pa_ioline_unref(c->line);
534 static void handle_listen_prefix(struct connection *c, const char *source_name) {
536 pa_source_output_new_data data;
543 pa_assert(source_name);
548 if (!(source = pa_namereg_get(c->protocol->core, source_name, PA_NAMEREG_SOURCE))) {
549 html_response(c, 404, "Source not found", NULL);
553 ss = source->sample_spec;
554 cm = source->channel_map;
556 pa_sample_spec_mimefy(&ss, &cm);
558 pa_source_output_new_data_init(&data);
559 data.driver = __FILE__;
560 data.module = c->module;
561 data.client = c->client;
562 pa_source_output_new_data_set_source(&data, source, false, true);
563 pa_proplist_update(data.proplist, PA_UPDATE_MERGE, c->client->proplist);
564 pa_source_output_new_data_set_sample_spec(&data, &ss);
565 pa_source_output_new_data_set_channel_map(&data, &cm);
567 pa_source_output_new(&c->source_output, c->protocol->core, &data);
568 pa_source_output_new_data_done(&data);
570 if (!c->source_output) {
571 html_response(c, 403, "Cannot create source output", NULL);
575 c->source_output->parent.process_msg = source_output_process_msg;
576 c->source_output->push = source_output_push_cb;
577 c->source_output->kill = source_output_kill_cb;
578 c->source_output->get_latency = source_output_get_latency_cb;
579 c->source_output->userdata = c;
581 pa_source_output_set_requested_latency(c->source_output, DEFAULT_SOURCE_LATENCY);
583 l = (size_t) (pa_bytes_per_second(&ss)*RECORD_BUFFER_SECONDS);
584 c->output_memblockq = pa_memblockq_new(
585 "http protocol connection output_memblockq",
595 pa_source_output_put(c->source_output);
597 t = pa_sample_spec_to_mime_type(&ss, &cm);
598 http_response(c, 200, "OK", t);
601 if (c->method == METHOD_HEAD) {
602 connection_unlink(c);
605 pa_ioline_set_callback(c->line, NULL, NULL);
607 if (pa_ioline_is_drained(c->line))
608 line_drain_callback(c->line, c);
610 pa_ioline_set_drain_callback(c->line, line_drain_callback, c);
613 static void handle_url(struct connection *c) {
616 pa_log_debug("Request for %s", c->url);
618 if (pa_streq(c->url, URL_ROOT))
620 else if (pa_streq(c->url, URL_CSS))
622 else if (pa_streq(c->url, URL_STATUS))
624 else if (pa_streq(c->url, URL_LISTEN))
626 else if (pa_startswith(c->url, URL_LISTEN_SOURCE))
627 handle_listen_prefix(c, c->url + sizeof(URL_LISTEN_SOURCE)-1);
629 html_response(c, 404, "Not Found", NULL);
632 static void line_callback(pa_ioline *line, const char *s, void *userdata) {
633 struct connection *c = userdata;
639 connection_unlink(c);
644 case STATE_REQUEST_LINE: {
645 if (pa_startswith(s, "GET ")) {
646 c->method = METHOD_GET;
648 } else if (pa_startswith(s, "HEAD ")) {
649 c->method = METHOD_HEAD;
655 c->url = pa_xstrndup(s, strcspn(s, " \r\n\t?"));
656 c->state = STATE_MIME_HEADER;
660 case STATE_MIME_HEADER: {
662 /* Ignore MIME headers */
663 if (strcspn(s, " \r\n") != 0)
667 c->state = STATE_DATA;
680 html_response(c, 500, "Internal Server Error", NULL);
683 void pa_http_protocol_connect(pa_http_protocol *p, pa_iochannel *io, pa_module *m) {
684 struct connection *c;
685 pa_client_new_data client_data;
692 if (pa_idxset_size(p->connections)+1 > MAX_CONNECTIONS) {
693 pa_log("Warning! Too many connections (%u), dropping incoming connection.", MAX_CONNECTIONS);
694 pa_iochannel_free(io);
698 c = pa_xnew0(struct connection, 1);
700 c->state = STATE_REQUEST_LINE;
703 c->line = pa_ioline_new(io);
704 pa_ioline_set_callback(c->line, line_callback, c);
706 pa_client_new_data_init(&client_data);
707 client_data.module = c->module;
708 client_data.driver = __FILE__;
709 pa_iochannel_socket_peer_to_string(io, pname, sizeof(pname));
710 pa_proplist_setf(client_data.proplist, PA_PROP_APPLICATION_NAME, "HTTP client (%s)", pname);
711 pa_proplist_sets(client_data.proplist, "http-protocol.peer", pname);
712 c->client = pa_client_new(p->core, &client_data);
713 pa_client_new_data_done(&client_data);
718 c->client->kill = client_kill_cb;
719 c->client->userdata = c;
721 pa_idxset_put(p->connections, c, NULL);
727 connection_unlink(c);
730 void pa_http_protocol_disconnect(pa_http_protocol *p, pa_module *m) {
731 struct connection *c;
737 PA_IDXSET_FOREACH(c, p->connections, idx)
739 connection_unlink(c);
742 static pa_http_protocol* http_protocol_new(pa_core *c) {
747 p = pa_xnew0(pa_http_protocol, 1);
750 p->connections = pa_idxset_new(NULL, NULL);
752 pa_assert_se(pa_shared_set(c, "http-protocol", p) >= 0);
757 pa_http_protocol* pa_http_protocol_get(pa_core *c) {
760 if ((p = pa_shared_get(c, "http-protocol")))
761 return pa_http_protocol_ref(p);
763 return http_protocol_new(c);
766 pa_http_protocol* pa_http_protocol_ref(pa_http_protocol *p) {
768 pa_assert(PA_REFCNT_VALUE(p) >= 1);
775 void pa_http_protocol_unref(pa_http_protocol *p) {
776 struct connection *c;
779 pa_assert(PA_REFCNT_VALUE(p) >= 1);
781 if (PA_REFCNT_DEC(p) > 0)
784 while ((c = pa_idxset_first(p->connections, NULL)))
785 connection_unlink(c);
787 pa_idxset_free(p->connections, NULL);
789 pa_strlist_free(p->servers);
791 pa_assert_se(pa_shared_remove(p->core, "http-protocol") >= 0);
796 void pa_http_protocol_add_server_string(pa_http_protocol *p, const char *name) {
798 pa_assert(PA_REFCNT_VALUE(p) >= 1);
801 p->servers = pa_strlist_prepend(p->servers, name);
804 void pa_http_protocol_remove_server_string(pa_http_protocol *p, const char *name) {
806 pa_assert(PA_REFCNT_VALUE(p) >= 1);
809 p->servers = pa_strlist_remove(p->servers, name);
812 pa_strlist *pa_http_protocol_servers(pa_http_protocol *p) {
814 pa_assert(PA_REFCNT_VALUE(p) >= 1);