#include "protocol-http.h"
/* Don't allow more than this many concurrent connections */
#define MAX_CONNECTIONS 10
#define URL_ROOT "/"
#define URL_CSS "/style"
#define URL_STATUS "/status"
#define URL_LISTEN "/listen"
#define URL_LISTEN_SOURCE "/listen/source/"
#define MIME_HTML "text/html; charset=utf-8"
#define MIME_TEXT "text/plain; charset=utf-8"
#define MIME_CSS "text/css"
#define HTML_HEADER(t) \
"\n" \
"\n" \
"\n" \
" \n" \
" "t"\n" \
" \n" \
" \n" \
" \n"
#define HTML_FOOTER \
" \n" \
"\n"
#define RECORD_BUFFER_SECONDS (5)
#define DEFAULT_SOURCE_LATENCY (300*PA_USEC_PER_MSEC)
enum state {
STATE_REQUEST_LINE,
STATE_MIME_HEADER,
STATE_DATA
};
enum method {
METHOD_GET,
METHOD_HEAD
};
struct connection {
pa_http_protocol *protocol;
pa_iochannel *io;
pa_ioline *line;
pa_memblockq *output_memblockq;
pa_source_output *source_output;
pa_client *client;
enum state state;
char *url;
enum method method;
pa_module *module;
};
struct pa_http_protocol {
PA_REFCNT_DECLARE;
pa_core *core;
pa_idxset *connections;
pa_strlist *servers;
};
enum {
SOURCE_OUTPUT_MESSAGE_POST_DATA = PA_SOURCE_OUTPUT_MESSAGE_MAX
};
/* Called from main context */
static void connection_unlink(struct connection *c) {
pa_assert(c);
if (c->source_output) {
pa_source_output_unlink(c->source_output);
c->source_output->userdata = NULL;
pa_source_output_unref(c->source_output);
}
if (c->client)
pa_client_free(c->client);
pa_xfree(c->url);
if (c->line)
pa_ioline_unref(c->line);
if (c->io)
pa_iochannel_free(c->io);
if (c->output_memblockq)
pa_memblockq_free(c->output_memblockq);
pa_idxset_remove_by_data(c->protocol->connections, c, NULL);
pa_xfree(c);
}
/* Called from main context */
static int do_write(struct connection *c) {
pa_memchunk chunk;
ssize_t r;
void *p;
pa_assert(c);
if (pa_memblockq_peek(c->output_memblockq, &chunk) < 0)
return 0;
pa_assert(chunk.memblock);
pa_assert(chunk.length > 0);
p = pa_memblock_acquire(chunk.memblock);
r = pa_iochannel_write(c->io, (uint8_t*) p+chunk.index, chunk.length);
pa_memblock_release(chunk.memblock);
pa_memblock_unref(chunk.memblock);
if (r < 0) {
pa_log("write(): %s", pa_cstrerror(errno));
return -1;
}
pa_memblockq_drop(c->output_memblockq, (size_t) r);
return 1;
}
/* Called from main context */
static void do_work(struct connection *c) {
pa_assert(c);
if (pa_iochannel_is_hungup(c->io))
goto fail;
while (pa_iochannel_is_writable(c->io)) {
int r = do_write(c);
if (r < 0)
goto fail;
if (r == 0)
break;
}
return;
fail:
connection_unlink(c);
}
/* Called from thread context, except when it is not */
static int source_output_process_msg(pa_msgobject *m, int code, void *userdata, int64_t offset, pa_memchunk *chunk) {
pa_source_output *o = PA_SOURCE_OUTPUT(m);
struct connection *c;
pa_source_output_assert_ref(o);
if (!(c = o->userdata))
return -1;
switch (code) {
case SOURCE_OUTPUT_MESSAGE_POST_DATA:
/* While this function is usually called from IO thread
* context, this specific command is not! */
pa_memblockq_push_align(c->output_memblockq, chunk);
do_work(c);
break;
default:
return pa_source_output_process_msg(m, code, userdata, offset, chunk);
}
return 0;
}
/* Called from thread context */
static void source_output_push_cb(pa_source_output *o, const pa_memchunk *chunk) {
struct connection *c;
pa_source_output_assert_ref(o);
pa_assert_se(c = o->userdata);
pa_assert(chunk);
pa_asyncmsgq_post(pa_thread_mq_get()->outq, PA_MSGOBJECT(o), SOURCE_OUTPUT_MESSAGE_POST_DATA, NULL, 0, chunk, NULL);
}
/* Called from main context */
static void source_output_kill_cb(pa_source_output *o) {
struct connection*c;
pa_source_output_assert_ref(o);
pa_assert_se(c = o->userdata);
connection_unlink(c);
}
/* Called from main context */
static pa_usec_t source_output_get_latency_cb(pa_source_output *o) {
struct connection*c;
pa_source_output_assert_ref(o);
pa_assert_se(c = o->userdata);
return pa_bytes_to_usec(pa_memblockq_get_length(c->output_memblockq), &c->source_output->sample_spec);
}
/*** client callbacks ***/
static void client_kill_cb(pa_client *client) {
struct connection*c;
pa_assert(client);
pa_assert_se(c = client->userdata);
connection_unlink(c);
}
/*** pa_iochannel callbacks ***/
static void io_callback(pa_iochannel*io, void *userdata) {
struct connection *c = userdata;
pa_assert(c);
pa_assert(io);
do_work(c);
}
static char *escape_html(const char *t) {
pa_strbuf *sb;
const char *p, *e;
sb = pa_strbuf_new();
for (e = p = t; *p; p++) {
if (*p == '>' || *p == '<' || *p == '&') {
if (p > e) {
pa_strbuf_putsn(sb, e, p-e);
e = p + 1;
}
if (*p == '>')
pa_strbuf_puts(sb, ">");
else if (*p == '<')
pa_strbuf_puts(sb, "<");
else
pa_strbuf_puts(sb, "&");
}
}
if (p > e)
pa_strbuf_putsn(sb, e, p-e);
return pa_strbuf_to_string_free(sb);
}
static void http_response(
struct connection *c,
int code,
const char *msg,
const char *mime) {
char *s;
pa_assert(c);
pa_assert(msg);
pa_assert(mime);
s = pa_sprintf_malloc(
"HTTP/1.0 %i %s\n"
"Connection: close\n"
"Content-Type: %s\n"
"Cache-Control: no-cache\n"
"Expires: 0\n"
"Server: "PACKAGE_NAME"/"PACKAGE_VERSION"\n"
"\n", code, msg, mime);
pa_ioline_puts(c->line, s);
pa_xfree(s);
}
static void html_response(
struct connection *c,
int code,
const char *msg,
const char *text) {
char *s;
pa_assert(c);
http_response(c, code, msg, MIME_HTML);
if (c->method == METHOD_HEAD) {
pa_ioline_defer_close(c->line);
return;
}
if (!text)
text = msg;
s = pa_sprintf_malloc(
HTML_HEADER("%s")
"%s"
HTML_FOOTER,
text, text);
pa_ioline_puts(c->line, s);
pa_xfree(s);
pa_ioline_defer_close(c->line);
}
static void html_print_field(pa_ioline *line, const char *left, const char *right) {
char *eleft, *eright;
eleft = escape_html(left);
eright = escape_html(right);
pa_ioline_printf(line,
"| %s | "
"%s |
\n", eleft, eright);
pa_xfree(eleft);
pa_xfree(eright);
}
static void handle_root(struct connection *c) {
char *t;
pa_assert(c);
http_response(c, 200, "OK", MIME_HTML);
if (c->method == METHOD_HEAD) {
pa_ioline_defer_close(c->line);
return;
}
pa_ioline_puts(c->line,
HTML_HEADER(PACKAGE_NAME" "PACKAGE_VERSION)
""PACKAGE_NAME" "PACKAGE_VERSION"
\n"
"\n");
t = pa_get_user_name_malloc();
html_print_field(c->line, "User Name:", t);
pa_xfree(t);
t = pa_get_host_name_malloc();
html_print_field(c->line, "Host name:", t);
pa_xfree(t);
t = pa_machine_id();
html_print_field(c->line, "Machine ID:", t);
pa_xfree(t);
t = pa_uname_string();
html_print_field(c->line, "System:", t);
pa_xfree(t);
t = pa_sprintf_malloc("%lu", (unsigned long) getpid());
html_print_field(c->line, "Process ID:", t);
pa_xfree(t);
pa_ioline_puts(c->line,
"
\n"
"Show an extensive server status report
\n"
"Monitor sinks and sources
\n"
HTML_FOOTER);
pa_ioline_defer_close(c->line);
}
static void handle_css(struct connection *c) {
pa_assert(c);
http_response(c, 200, "OK", MIME_CSS);
if (c->method == METHOD_HEAD) {
pa_ioline_defer_close(c->line);
return;
}
pa_ioline_puts(c->line,
"body { color: black; background-color: white; }\n"
"a:link, a:visited { color: #900000; }\n"
"div.news-date { font-size: 80%; font-style: italic; }\n"
"pre { background-color: #f0f0f0; padding: 0.4cm; }\n"
".grey { color: #8f8f8f; font-size: 80%; }"
"table { margin-left: 1cm; border:1px solid lightgrey; padding: 0.2cm; }\n"
"td { padding-left:10px; padding-right:10px; }\n");
pa_ioline_defer_close(c->line);
}
static void handle_status(struct connection *c) {
char *r;
pa_assert(c);
http_response(c, 200, "OK", MIME_TEXT);
if (c->method == METHOD_HEAD) {
pa_ioline_defer_close(c->line);
return;
}
r = pa_full_status_string(c->protocol->core);
pa_ioline_puts(c->line, r);
pa_xfree(r);
pa_ioline_defer_close(c->line);
}
static void handle_listen(struct connection *c) {
pa_source *source;
pa_sink *sink;
uint32_t idx;
http_response(c, 200, "OK", MIME_HTML);
pa_ioline_puts(c->line,
HTML_HEADER("Listen")
"Sinks
\n"
"\n");
if (c->method == METHOD_HEAD) {
pa_ioline_defer_close(c->line);
return;
}
PA_IDXSET_FOREACH(sink, c->protocol->core->sinks, idx) {
char *t, *m;
t = escape_html(pa_strna(pa_proplist_gets(sink->proplist, PA_PROP_DEVICE_DESCRIPTION)));
m = pa_sample_spec_to_mime_type_mimefy(&sink->sample_spec, &sink->channel_map);
pa_ioline_printf(c->line,
"%s
\n",
sink->monitor_source->name, m, t);
pa_xfree(t);
pa_xfree(m);
}
pa_ioline_puts(c->line,
"
\n"
"Sources
\n"
"\n");
PA_IDXSET_FOREACH(source, c->protocol->core->sources, idx) {
char *t, *m;
if (source->monitor_of)
continue;
t = escape_html(pa_strna(pa_proplist_gets(source->proplist, PA_PROP_DEVICE_DESCRIPTION)));
m = pa_sample_spec_to_mime_type_mimefy(&source->sample_spec, &source->channel_map);
pa_ioline_printf(c->line,
"%s
\n",
source->name, m, t);
pa_xfree(m);
pa_xfree(t);
}
pa_ioline_puts(c->line,
"
\n"
HTML_FOOTER);
pa_ioline_defer_close(c->line);
}
static void line_drain_callback(pa_ioline *l, void *userdata) {
struct connection *c;
pa_assert(l);
pa_assert_se(c = userdata);
/* We don't need the line reader anymore, instead we need a real
* binary io channel */
pa_assert_se(c->io = pa_ioline_detach_iochannel(c->line));
pa_iochannel_set_callback(c->io, io_callback, c);
pa_iochannel_socket_set_sndbuf(c->io, pa_memblockq_get_length(c->output_memblockq));
pa_ioline_unref(c->line);
c->line = NULL;
}
static void handle_listen_prefix(struct connection *c, const char *source_name) {
pa_source *source;
pa_source_output_new_data data;
pa_sample_spec ss;
pa_channel_map cm;
char *t;
size_t l;
pa_assert(c);
pa_assert(source_name);
pa_assert(c->line);
pa_assert(!c->io);
if (!(source = pa_namereg_get(c->protocol->core, source_name, PA_NAMEREG_SOURCE))) {
html_response(c, 404, "Source not found", NULL);
return;
}
ss = source->sample_spec;
cm = source->channel_map;
pa_sample_spec_mimefy(&ss, &cm);
pa_source_output_new_data_init(&data);
data.driver = __FILE__;
data.module = c->module;
data.client = c->client;
pa_source_output_new_data_set_source(&data, source, false, true);
pa_proplist_update(data.proplist, PA_UPDATE_MERGE, c->client->proplist);
pa_source_output_new_data_set_sample_spec(&data, &ss);
pa_source_output_new_data_set_channel_map(&data, &cm);
pa_source_output_new(&c->source_output, c->protocol->core, &data);
pa_source_output_new_data_done(&data);
if (!c->source_output) {
html_response(c, 403, "Cannot create source output", NULL);
return;
}
c->source_output->parent.process_msg = source_output_process_msg;
c->source_output->push = source_output_push_cb;
c->source_output->kill = source_output_kill_cb;
c->source_output->get_latency = source_output_get_latency_cb;
c->source_output->userdata = c;
pa_source_output_set_requested_latency(c->source_output, DEFAULT_SOURCE_LATENCY);
l = (size_t) (pa_bytes_per_second(&ss)*RECORD_BUFFER_SECONDS);
c->output_memblockq = pa_memblockq_new(
"http protocol connection output_memblockq",
0,
l,
0,
&ss,
1,
0,
0,
NULL);
pa_source_output_put(c->source_output);
t = pa_sample_spec_to_mime_type(&ss, &cm);
http_response(c, 200, "OK", t);
pa_xfree(t);
if (c->method == METHOD_HEAD) {
connection_unlink(c);
return;
}
pa_ioline_set_callback(c->line, NULL, NULL);
if (pa_ioline_is_drained(c->line))
line_drain_callback(c->line, c);
else
pa_ioline_set_drain_callback(c->line, line_drain_callback, c);
}
static void handle_url(struct connection *c) {
pa_assert(c);
pa_log_debug("Request for %s", c->url);
if (pa_streq(c->url, URL_ROOT))
handle_root(c);
else if (pa_streq(c->url, URL_CSS))
handle_css(c);
else if (pa_streq(c->url, URL_STATUS))
handle_status(c);
else if (pa_streq(c->url, URL_LISTEN))
handle_listen(c);
else if (pa_startswith(c->url, URL_LISTEN_SOURCE))
handle_listen_prefix(c, c->url + sizeof(URL_LISTEN_SOURCE)-1);
else
html_response(c, 404, "Not Found", NULL);
}
static void line_callback(pa_ioline *line, const char *s, void *userdata) {
struct connection *c = userdata;
pa_assert(line);
pa_assert(c);
if (!s) {
/* EOF */
connection_unlink(c);
return;
}
switch (c->state) {
case STATE_REQUEST_LINE: {
if (pa_startswith(s, "GET ")) {
c->method = METHOD_GET;
s +=4;
} else if (pa_startswith(s, "HEAD ")) {
c->method = METHOD_HEAD;
s +=5;
} else {
goto fail;
}
c->url = pa_xstrndup(s, strcspn(s, " \r\n\t?"));
c->state = STATE_MIME_HEADER;
break;
}
case STATE_MIME_HEADER: {
/* Ignore MIME headers */
if (strcspn(s, " \r\n") != 0)
break;
/* We're done */
c->state = STATE_DATA;
handle_url(c);
break;
}
default:
;
}
return;
fail:
html_response(c, 500, "Internal Server Error", NULL);
}
void pa_http_protocol_connect(pa_http_protocol *p, pa_iochannel *io, pa_module *m) {
struct connection *c;
pa_client_new_data client_data;
char pname[128];
pa_assert(p);
pa_assert(io);
pa_assert(m);
if (pa_idxset_size(p->connections)+1 > MAX_CONNECTIONS) {
pa_log("Warning! Too many connections (%u), dropping incoming connection.", MAX_CONNECTIONS);
pa_iochannel_free(io);
return;
}
c = pa_xnew0(struct connection, 1);
c->protocol = p;
c->state = STATE_REQUEST_LINE;
c->module = m;
c->line = pa_ioline_new(io);
pa_ioline_set_callback(c->line, line_callback, c);
pa_client_new_data_init(&client_data);
client_data.module = c->module;
client_data.driver = __FILE__;
pa_iochannel_socket_peer_to_string(io, pname, sizeof(pname));
pa_proplist_setf(client_data.proplist, PA_PROP_APPLICATION_NAME, "HTTP client (%s)", pname);
pa_proplist_sets(client_data.proplist, "http-protocol.peer", pname);
c->client = pa_client_new(p->core, &client_data);
pa_client_new_data_done(&client_data);
if (!c->client)
goto fail;
c->client->kill = client_kill_cb;
c->client->userdata = c;
pa_idxset_put(p->connections, c, NULL);
return;
fail:
if (c)
connection_unlink(c);
}
void pa_http_protocol_disconnect(pa_http_protocol *p, pa_module *m) {
struct connection *c;
uint32_t idx;
pa_assert(p);
pa_assert(m);
PA_IDXSET_FOREACH(c, p->connections, idx)
if (c->module == m)
connection_unlink(c);
}
static pa_http_protocol* http_protocol_new(pa_core *c) {
pa_http_protocol *p;
pa_assert(c);
p = pa_xnew0(pa_http_protocol, 1);
PA_REFCNT_INIT(p);
p->core = c;
p->connections = pa_idxset_new(NULL, NULL);
pa_assert_se(pa_shared_set(c, "http-protocol", p) >= 0);
return p;
}
pa_http_protocol* pa_http_protocol_get(pa_core *c) {
pa_http_protocol *p;
if ((p = pa_shared_get(c, "http-protocol")))
return pa_http_protocol_ref(p);
return http_protocol_new(c);
}
pa_http_protocol* pa_http_protocol_ref(pa_http_protocol *p) {
pa_assert(p);
pa_assert(PA_REFCNT_VALUE(p) >= 1);
PA_REFCNT_INC(p);
return p;
}
void pa_http_protocol_unref(pa_http_protocol *p) {
struct connection *c;
pa_assert(p);
pa_assert(PA_REFCNT_VALUE(p) >= 1);
if (PA_REFCNT_DEC(p) > 0)
return;
while ((c = pa_idxset_first(p->connections, NULL)))
connection_unlink(c);
pa_idxset_free(p->connections, NULL);
pa_strlist_free(p->servers);
pa_assert_se(pa_shared_remove(p->core, "http-protocol") >= 0);
pa_xfree(p);
}
void pa_http_protocol_add_server_string(pa_http_protocol *p, const char *name) {
pa_assert(p);
pa_assert(PA_REFCNT_VALUE(p) >= 1);
pa_assert(name);
p->servers = pa_strlist_prepend(p->servers, name);
}
void pa_http_protocol_remove_server_string(pa_http_protocol *p, const char *name) {
pa_assert(p);
pa_assert(PA_REFCNT_VALUE(p) >= 1);
pa_assert(name);
p->servers = pa_strlist_remove(p->servers, name);
}
pa_strlist *pa_http_protocol_servers(pa_http_protocol *p) {
pa_assert(p);
pa_assert(PA_REFCNT_VALUE(p) >= 1);
return p->servers;
}