lighttpd1.4/src/mod_status.c

#include "first.h"

#include "base.h"
#include "fdevent.h"
#include "h2.h"
#include "http_chunk.h"
#include "http_header.h"
#include "log.h"

#include "plugin.h"

#include <sys/types.h>
#include "sys-time.h"

#include <fcntl.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>

typedef struct {
    const buffer *config_url;
    const buffer *status_url;
    const buffer *statistics_url;

    int sort;
} plugin_config;

typedef struct {
	PLUGIN_DATA;
	plugin_config defaults;
	plugin_config conf;

	double traffic_out;
	double requests;

	double mod_5s_traffic_out[5];
	double mod_5s_requests[5];
	size_t mod_5s_ndx;

	double rel_traffic_out;
	double rel_requests;

	double abs_traffic_out;
	double abs_requests;

	double bytes_written;
} plugin_data;

INIT_FUNC(mod_status_init) {
    return calloc(1, sizeof(plugin_data));
}

static void mod_status_merge_config_cpv(plugin_config * const pconf, const config_plugin_value_t * const cpv) {
    switch (cpv->k_id) { /* index into static config_plugin_keys_t cpk[] */
      case 0: /* status.status-url */
        pconf->status_url = cpv->v.b;
        break;
      case 1: /* status.config-url */
        pconf->config_url = cpv->v.b;
        break;
      case 2: /* status.statistics-url */
        pconf->statistics_url = cpv->v.b;
        break;
      case 3: /* status.enable-sort */
        pconf->sort = (int)cpv->v.u;
        break;
      default:/* should not happen */
        return;
    }
}

static void mod_status_merge_config(plugin_config * const pconf, const config_plugin_value_t *cpv) {
    do {
        mod_status_merge_config_cpv(pconf, cpv);
    } while ((++cpv)->k_id != -1);
}

static void mod_status_patch_config(request_st * const r, plugin_data * const p) {
    p->conf = p->defaults; /* copy small struct instead of memcpy() */
    /*memcpy(&p->conf, &p->defaults, sizeof(plugin_config));*/
    for (int i = 1, used = p->nconfig; i < used; ++i) {
        if (config_check_cond(r, (uint32_t)p->cvlist[i].k_id))
            mod_status_merge_config(&p->conf, p->cvlist + p->cvlist[i].v.u2[0]);
    }
}

SETDEFAULTS_FUNC(mod_status_set_defaults) {
    static const config_plugin_keys_t cpk[] = {
      { CONST_STR_LEN("status.status-url"),
        T_CONFIG_STRING,
        T_CONFIG_SCOPE_CONNECTION }
     ,{ CONST_STR_LEN("status.config-url"),
        T_CONFIG_STRING,
        T_CONFIG_SCOPE_CONNECTION }
     ,{ CONST_STR_LEN("status.statistics-url"),
        T_CONFIG_STRING,
        T_CONFIG_SCOPE_CONNECTION }
     ,{ CONST_STR_LEN("status.enable-sort"),
        T_CONFIG_BOOL,
        T_CONFIG_SCOPE_CONNECTION }
     ,{ NULL, 0,
        T_CONFIG_UNSET,
        T_CONFIG_SCOPE_UNSET }
    };

    plugin_data * const p = p_d;
    if (!config_plugin_values_init(srv, p, cpk, "mod_status"))
        return HANDLER_ERROR;

    /* process and validate config directives
     * (init i to 0 if global context; to 1 to skip empty global context) */
    for (int i = !p->cvlist[0].v.u2[1]; i < p->nconfig; ++i) {
        config_plugin_value_t *cpv = p->cvlist + p->cvlist[i].v.u2[0];
        for (; -1 != cpv->k_id; ++cpv) {
            switch (cpv->k_id) {
              case 0: /* status.status-url */
              case 1: /* status.config-url */
              case 2: /* status.statistics-url */
                if (buffer_is_blank(cpv->v.b))
                    cpv->v.b = NULL;
                break;
              case 3: /* status.enable-sort */
                break;
              default:/* should not happen */
                break;
            }
        }
    }

    p->defaults.sort = 1;

    /* initialize p->defaults from global config context */
    if (p->nconfig > 0 && p->cvlist->v.u2[1]) {
        const config_plugin_value_t *cpv = p->cvlist + p->cvlist->v.u2[0];
        if (-1 != cpv->k_id)
            mod_status_merge_config(&p->defaults, cpv);
    }

    return HANDLER_GO_ON;
}



static void
mod_status_append_state (buffer * const b, request_state_t state)
{
    const char *s;
    size_t n;
    switch (state) {
      case CON_STATE_CONNECT:
        s = "connect";    n = sizeof("connect")-1;    break;
      case CON_STATE_READ:
        s = "read";       n = sizeof("read")-1;       break;
      case CON_STATE_READ_POST:
        s = "readpost";   n = sizeof("readpost")-1;   break;
      case CON_STATE_WRITE:
        s = "write";      n = sizeof("write")-1;      break;
      case CON_STATE_CLOSE:
        s = "close";      n = sizeof("close")-1;      break;
      case CON_STATE_ERROR:
        s = "error";      n = sizeof("error")-1;      break;
      case CON_STATE_HANDLE_REQUEST:
        s = "handle-req"; n = sizeof("handle-req")-1; break;
      case CON_STATE_REQUEST_START:
        s = "req-start";  n = sizeof("req-start")-1;  break;
      case CON_STATE_REQUEST_END:
        s = "req-end";    n = sizeof("req-end")-1;    break;
      case CON_STATE_RESPONSE_START:
        s = "resp-start"; n = sizeof("resp-start")-1; break;
      case CON_STATE_RESPONSE_END:
        s = "resp-end";   n = sizeof("resp-end")-1;   break;
      default:
        s = "(unknown)";  n = sizeof("(unknown)")-1;  break;
    }
    buffer_append_string_len(b, s, n);
}


static const char *
mod_status_get_short_state (request_state_t state)
{
    switch (state) {
      case CON_STATE_CONNECT:        return ".";
      case CON_STATE_READ:           return "r";
      case CON_STATE_READ_POST:      return "R";
      case CON_STATE_WRITE:          return "W";
      case CON_STATE_CLOSE:          return "C";
      case CON_STATE_ERROR:          return "E";
      case CON_STATE_HANDLE_REQUEST: return "h";
      case CON_STATE_REQUEST_START:  return "q";
      case CON_STATE_REQUEST_END:    return "Q";
      case CON_STATE_RESPONSE_START: return "s";
      case CON_STATE_RESPONSE_END:   return "S";
      default:                       return "x";
    }
}


static void mod_status_header_append_sort(buffer *b, plugin_data *p, const char* k, size_t klen)
{
    p->conf.sort
      ? buffer_append_str3(b,
          CONST_STR_LEN("<th class=\"status\"><a href=\"#\" class=\"sortheader\" onclick=\"resort(this);return false;\">"),
          k, klen,
          CONST_STR_LEN("<span class=\"sortarrow\">:</span></a></th>\n"))
      : buffer_append_str3(b,
          CONST_STR_LEN("<th class=\"status\">"),
          k, klen,
          CONST_STR_LEN("</th>\n"));
}

static void mod_status_get_multiplier(buffer *b, double avg, int size) {
    char unit[] = "  ";

    if (avg > size) { avg /= size; unit[1] = 'k'; }
    if (avg > size) { avg /= size; unit[1] = 'M'; }
    if (avg > size) { avg /= size; unit[1] = 'G'; }
    if (avg > size) { avg /= size; unit[1] = 'T'; }
    if (avg > size) { avg /= size; unit[1] = 'P'; }
    if (avg > size) { avg /= size; unit[1] = 'E'; }
    if (avg > size) { avg /= size; unit[1] = 'Z'; }
    if (avg > size) { avg /= size; unit[1] = 'Y'; }

    if (size == 1000) {
        buffer_append_int(b, (intmax_t)avg);
    }
    else { /* (size == 1024) */
        char buf[32+1];
        buffer_append_string_len(b, buf, (size_t)
                                 snprintf(buf, sizeof(buf), "%.2f", avg));
    }
    buffer_append_string_len(b, unit, 2);
}

static void mod_status_html_rtable_r (buffer * const b, const request_st * const r, const connection * const con, const unix_time64_t cur_ts) {
    buffer_append_str3(b, CONST_STR_LEN("<tr><td class=\"string\">"),
                          BUF_PTR_LEN(&con->dst_addr_buf),
                          CONST_STR_LEN("</td><td class=\"int\">"));

    if (r->reqbody_length) {
        buffer_append_int(b, r->reqbody_queue.bytes_in);
        buffer_append_string_len(b, CONST_STR_LEN("/"));
        buffer_append_int(b, r->reqbody_length);
    }
    else
        buffer_append_string_len(b, CONST_STR_LEN("0/0"));

    buffer_append_string_len(b, CONST_STR_LEN("</td><td class=\"int\">"));

    buffer_append_int(b, r->write_queue.bytes_out);
    buffer_append_string_len(b, CONST_STR_LEN("/"));
    buffer_append_int(b, r->write_queue.bytes_out + chunkqueue_length(&r->write_queue));

    buffer_append_string_len(b, CONST_STR_LEN("</td><td class=\"string\">"));

    if (CON_STATE_READ == r->state && !buffer_is_blank(&r->target_orig)) {
        buffer_append_string_len(b, CONST_STR_LEN("keep-alive"));
    }
    else
        mod_status_append_state(b, r->state);

    buffer_append_string_len(b, CONST_STR_LEN("</td><td class=\"int\">"));

    buffer_append_int(b, cur_ts - r->start_hp.tv_sec);

    buffer_append_string_len(b, CONST_STR_LEN("</td><td class=\"string\">"));

    if (buffer_is_blank(r->server_name))
        buffer_append_string_encoded(b, BUF_PTR_LEN(&r->uri.authority), ENCODING_HTML);
    else
        buffer_append_string_encoded(b, BUF_PTR_LEN(r->server_name), ENCODING_HTML);

    buffer_append_string_len(b, CONST_STR_LEN("</td><td class=\"string\">"));

    if (!buffer_is_blank(&r->uri.path))
        buffer_append_string_encoded(b, BUF_PTR_LEN(&r->uri.path), ENCODING_HTML);

    if (!buffer_is_blank(&r->uri.query)) {
        buffer_append_string_len(b, CONST_STR_LEN("?"));
        buffer_append_string_encoded(b, BUF_PTR_LEN(&r->uri.query), ENCODING_HTML);
    }

    if (!buffer_is_blank(&r->target_orig)) {
        buffer_append_string_len(b, CONST_STR_LEN(" ("));
        buffer_append_string_encoded(b, BUF_PTR_LEN(&r->target_orig), ENCODING_HTML);
        buffer_append_string_len(b, CONST_STR_LEN(")"));
    }
    buffer_append_string_len(b, CONST_STR_LEN("</td><td class=\"string\">"));

    buffer_append_string_encoded(b, BUF_PTR_LEN(&r->physical.path), ENCODING_HTML);

    buffer_append_string_len(b, CONST_STR_LEN("</td></tr>\n"));
}

static void mod_status_html_rtable (request_st * const rq, const server * const srv, const unix_time64_t cur_ts) {
    /* connection table and URLs might be large, so double-buffer to aggregate
     * before sending to chunkqueue, which might be temporary file
     * (avoid write() per connection) */
    buffer * const b = rq->tmp_buf;
    buffer_clear(b);
    for (const connection *con = srv->conns; con; con = con->next) {
        const request_st * const r = &con->request;
        if (r->http_status <= HTTP_VERSION_1_1) {
            if (buffer_string_space(b) < 4096) {
                http_chunk_append_mem(rq, BUF_PTR_LEN(b));
                buffer_clear(b);
            }
            mod_status_html_rtable_r(b, r, con, cur_ts);
        }
        else {
            h2con * const h2c = con->h2;
            for (uint32_t j = 0, rused = h2c->rused; j < rused; ++j) {
                if (buffer_string_space(b) < 4096) {
                    http_chunk_append_mem(rq, BUF_PTR_LEN(b));
                    buffer_clear(b);
                }
                mod_status_html_rtable_r(b, h2c->r[j], con, cur_ts);
            }
        }
    }
    http_chunk_append_mem(rq, BUF_PTR_LEN(b));
}

static handler_t mod_status_handle_server_status_html(server *srv, request_st * const r, plugin_data *p) {
	buffer * const b = chunkqueue_append_buffer_open(&r->write_queue);
	buffer_string_prepare_append(b, 8192-1);/*(status page base HTML is ~5.2k)*/
	double avg;
	uint32_t j;
	unix_time64_t ts;
	const unix_time64_t cur_ts = log_epoch_secs;

	int days, hours, mins, seconds;

	/*(CON_STATE_CLOSE must be last state in enum connection_state_t)*/
	int cstates[CON_STATE_CLOSE+3];
	memset(cstates, 0, sizeof(cstates));

	buffer_copy_string_len(b, CONST_STR_LEN(
				 "<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>\n"
				 "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n"
				 "         \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n"
				 "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n"
				 " <head>\n"
				 "  <title>Status</title>\n"

				   "  <style type=\"text/css\">\n"
				   "    table.status { border: black solid thin; }\n"
				   "    td { white-space: nowrap; }\n"
				   "    td.int { background-color: #f0f0f0; text-align: right }\n"
				   "    td.string { background-color: #f0f0f0; text-align: left }\n"
				   "    th.status { background-color: black; color: white; font-weight: bold; }\n"
				   "    a.sortheader { background-color: black; color: white; font-weight: bold; text-decoration: none; display: block; }\n"
				   "    span.sortarrow { color: white; text-decoration: none; }\n"
				   "  </style>\n"));

	if (!buffer_is_blank(&r->uri.query) && 0 == memcmp(r->uri.query.ptr, CONST_STR_LEN("refresh="))) {
		/* Note: Refresh is an historical, but non-standard HTTP header
		 * References (meta http-equiv="refresh" use is deprecated):
		 *   https://www.w3.org/TR/WCAG10-HTML-TECHS/#meta-element
		 *   https://www.w3.org/TR/WCAG10-CORE-TECHS/#auto-page-refresh
		 *   https://www.w3.org/QA/Tips/reback
		 */
		const long refresh = strtol(r->uri.query.ptr+sizeof("refresh=")-1, NULL, 10);
		if (refresh > 0) {
			buffer_append_string_len(b, CONST_STR_LEN("<meta http-equiv=\"refresh\" content=\""));
			buffer_append_int(b, refresh < 604800 ? refresh : 604800);
			buffer_append_string_len(b, CONST_STR_LEN("\">\n"));
		}
	}

	if (p->conf.sort) {
		buffer_append_string_len(b, CONST_STR_LEN(
					   "<script type=\"text/javascript\">\n"
					   "// <!--\n"
					   "var sort_column;\n"
					   "var prev_span = null;\n"

					   "function get_inner_text(el) {\n"
					   " if((typeof el == 'string')||(typeof el == 'undefined'))\n"
					   "  return el;\n"
					   " if(el.innerText)\n"
					   "  return el.innerText;\n"
					   " else {\n"
					   "  var str = \"\";\n"
					   "  var cs = el.childNodes;\n"
					   "  var l = cs.length;\n"
					   "  for (i=0;i<l;i++) {\n"
					   "   if (cs[i].nodeType==1) str += get_inner_text(cs[i]);\n"
					   "   else if (cs[i].nodeType==3) str += cs[i].nodeValue;\n"
					   "  }\n"
					   " }\n"
					   " return str;\n"
					   "}\n"

					   "function sortfn(a,b) {\n"
					   " var at = get_inner_text(a.cells[sort_column]);\n"
					   " var bt = get_inner_text(b.cells[sort_column]);\n"
					   " if (a.cells[sort_column].className == 'int') {\n"
					   "  return parseInt(at)-parseInt(bt);\n"
					   " } else {\n"
					   "  aa = at.toLowerCase();\n"
					   "  bb = bt.toLowerCase();\n"
					   "  if (aa==bb) return 0;\n"
					   "  else if (aa<bb) return -1;\n"
					   "  else return 1;\n"
					   " }\n"
					   "}\n"

					   "function resort(lnk) {\n"
					   " var span = lnk.childNodes[1];\n"
					   " var table = lnk.parentNode.parentNode.parentNode.parentNode;\n"
					   " var rows = new Array();\n"
					   " for (j=1;j<table.rows.length;j++)\n"
					   "  rows[j-1] = table.rows[j];\n"
					   " sort_column = lnk.parentNode.cellIndex;\n"
					   " rows.sort(sortfn);\n"

					   " if (prev_span != null) prev_span.innerHTML = '';\n"
					   " if (span.getAttribute('sortdir')=='down') {\n"
					   "  span.innerHTML = '&uarr;';\n"
					   "  span.setAttribute('sortdir','up');\n"
					   "  rows.reverse();\n"
					   " } else {\n"
					   "  span.innerHTML = '&darr;';\n"
					   "  span.setAttribute('sortdir','down');\n"
					   " }\n"
					   " for (i=0;i<rows.length;i++)\n"
					   "  table.tBodies[0].appendChild(rows[i]);\n"
					   " prev_span = span;\n"
					   "}\n"
					   "// -->\n"
					   "</script>\n"));
	}

	buffer_append_string_len(b, CONST_STR_LEN(
				 " </head>\n"
				 "<body>\n"));



	/* connection listing */
	buffer_append_string_len(b,
	                      CONST_STR_LEN("<h1>Server-Status"));
	if (r->conf.server_tag)
		buffer_append_str3(b, CONST_STR_LEN(
			      " ("),
	                      BUF_PTR_LEN(r->conf.server_tag),
	                      CONST_STR_LEN(
			      ")"));
	buffer_append_string_len(b,
	                      CONST_STR_LEN("</h1>"
	                                    "<table summary=\"status\" class=\"status\">"
	                                    "<tr><td>Hostname</td><td class=\"string\">"));
	buffer_append_string_encoded(b, BUF_PTR_LEN(&r->uri.authority), ENCODING_HTML);
	if (!buffer_is_blank(r->server_name) && r->server_name != &r->uri.authority) {
		buffer_append_string_len(b, CONST_STR_LEN(" ("));
		buffer_append_string_encoded(b, BUF_PTR_LEN(r->server_name), ENCODING_HTML);
		buffer_append_string_len(b, CONST_STR_LEN(")"));
	}
	buffer_append_string_len(b, CONST_STR_LEN("</td></tr>\n"
	                                          "<tr><td>Uptime</td><td class=\"string\">"));

	ts = cur_ts - srv->startup_ts;

	days = ts / (60 * 60 * 24);
	ts %= (60 * 60 * 24);

	hours = ts / (60 * 60);
	ts %= (60 * 60);

	mins = ts / (60);
	ts %= (60);

	seconds = ts;

	if (days) {
		buffer_append_int(b, days);
		buffer_append_string_len(b, CONST_STR_LEN(" days "));
	}

	if (hours) {
		buffer_append_int(b, hours);
		buffer_append_string_len(b, CONST_STR_LEN(" hours "));
	}

	if (mins) {
		buffer_append_int(b, mins);
		buffer_append_string_len(b, CONST_STR_LEN(" min "));
	}

	buffer_append_int(b, seconds);
	buffer_append_string_len(b, CONST_STR_LEN(" s"
	                                          "</td></tr>\n"
	                                          "<tr><td>Started at</td><td class=\"string\">"));

	ts = srv->startup_ts;

	struct tm tm;
	buffer_append_strftime(b, "%F %T", localtime64_r(&ts, &tm));
	buffer_append_string_len(b, CONST_STR_LEN("</td></tr>\n"
	                                          "<tr><th colspan=\"2\">absolute (since start)</th></tr>\n"
	                                          "<tr><td>Requests</td><td class=\"string\">"));
	avg = p->abs_requests;
	mod_status_get_multiplier(b, avg, 1000);
	buffer_append_string_len(b, CONST_STR_LEN("req</td></tr>\n"
	                                          "<tr><td>Traffic</td><td class=\"string\">"));
	avg = p->abs_traffic_out;
	mod_status_get_multiplier(b, avg, 1024);
	buffer_append_string_len(b, CONST_STR_LEN("byte</td></tr>\n"
	                                          "<tr><th colspan=\"2\">average (since start)</th></tr>\n"
	                                          "<tr><td>Requests</td><td class=\"string\">"));
	avg = p->abs_requests / (cur_ts - srv->startup_ts);
	mod_status_get_multiplier(b, avg, 1000);
	buffer_append_string_len(b, CONST_STR_LEN("req/s</td></tr>\n"
	                                          "<tr><td>Traffic</td><td class=\"string\">"));
	avg = p->abs_traffic_out / (cur_ts - srv->startup_ts);
	mod_status_get_multiplier(b, avg, 1024);
	buffer_append_string_len(b, CONST_STR_LEN("byte/s</td></tr>\n"
	                                          "<tr><th colspan=\"2\">average (5s sliding average)</th></tr>\n"));
	for (j = 0, avg = 0; j < 5; j++) {
		avg += p->mod_5s_requests[j];
	}

	avg /= 5;

	buffer_append_string_len(b, CONST_STR_LEN("<tr><td>Requests</td><td class=\"string\">"));

	mod_status_get_multiplier(b, avg, 1000);
	buffer_append_string_len(b, CONST_STR_LEN("req/s</td></tr>\n"));

	for (j = 0, avg = 0; j < 5; j++) {
		avg += p->mod_5s_traffic_out[j];
	}

	avg /= 5;

	buffer_append_string_len(b, CONST_STR_LEN("<tr><td>Traffic</td><td class=\"string\">"));

	mod_status_get_multiplier(b, avg, 1024);
	buffer_append_string_len(b, CONST_STR_LEN("byte/s</td></tr>\n"
	                                          "</table>\n"
	                                          "<hr />\n<pre>\n"
	                                          "<b>"));
	buffer_append_int(b, srv->srvconf.max_conns - srv->lim_conns);
	buffer_append_string_len(b, CONST_STR_LEN(" connections</b>\n"));

	int per_line = 50;
	for (const connection *c = srv->conns; c; c = c->next) {
		const request_st * const cr = &c->request;
		const char *state;

		if ((c->h2 && 0 == c->h2->rused)
		    || (CON_STATE_READ == cr->state && !buffer_is_blank(&cr->target_orig))) {
			state = "k";
			++cstates[CON_STATE_CLOSE+2];
		} else {
			state = mod_status_get_short_state(cr->state);
			++cstates[(cr->state <= CON_STATE_CLOSE ? cr->state : CON_STATE_CLOSE+1)];
		}

		buffer_append_string_len(b, state, 1);

		if (0 == --per_line) {
			per_line = 50;
			buffer_append_string_len(b, CONST_STR_LEN("\n"));
		}
	}
	buffer_append_string_len(b, CONST_STR_LEN("\n\n<table>\n"
	                                          "<tr><td style=\"text-align:right\">"));
	buffer_append_int(b, cstates[CON_STATE_CLOSE+2]);
	buffer_append_string_len(b, CONST_STR_LEN("<td>&nbsp;&nbsp;k = keep-alive</td></tr>\n"));
	for (j = 0; j < CON_STATE_CLOSE+2; ++j) {