3 #define INITIAL_WEB_DATA_LENGTH 16384
4 #define WEB_REQUEST_LENGTH 16384
5 #define TOO_BIG_REQUEST 16384
7 int web_client_timeout = DEFAULT_DISCONNECT_IDLE_WEB_CLIENTS_AFTER_SECONDS;
8 int web_donotrack_comply = 0;
10 #ifdef NETDATA_WITH_ZLIB
11 int web_enable_gzip = 1, web_gzip_level = 3, web_gzip_strategy = Z_DEFAULT_STRATEGY;
12 #endif /* NETDATA_WITH_ZLIB */
14 struct web_client *web_clients = NULL;
15 unsigned long long web_clients_count = 0;
17 inline int web_client_crock_socket(struct web_client *w) {
19 if(likely(!w->tcp_cork && w->ofd != -1)) {
21 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
22 error("%llu: failed to enable TCP_CORK on socket.", w->id);
32 inline int web_client_uncrock_socket(struct web_client *w) {
34 if(likely(w->tcp_cork && w->ofd != -1)) {
36 if(unlikely(setsockopt(w->ofd, IPPROTO_TCP, TCP_CORK, (char *) &w->tcp_cork, sizeof(int)) != 0)) {
37 error("%llu: failed to disable TCP_CORK on socket.", w->id);
47 struct web_client *web_client_create(int listener)
51 w = callocz(1, sizeof(struct web_client));
52 w->id = ++web_clients_count;
53 w->mode = WEB_CLIENT_MODE_NORMAL;
56 struct sockaddr *sadr;
59 sadr = (struct sockaddr*) &w->clientaddr;
60 addrlen = sizeof(w->clientaddr);
62 w->ifd = accept4(listener, sadr, &addrlen, SOCK_NONBLOCK);
64 error("%llu: Cannot accept new incoming connection.", w->id);
70 if(getnameinfo(sadr, addrlen, w->client_ip, NI_MAXHOST, w->client_port, NI_MAXSERV, NI_NUMERICHOST | NI_NUMERICSERV) != 0) {
71 error("Cannot getnameinfo() on received client connection.");
72 strncpyz(w->client_ip, "UNKNOWN", NI_MAXHOST);
73 strncpyz(w->client_port, "UNKNOWN", NI_MAXSERV);
75 w->client_ip[NI_MAXHOST] = '\0';
76 w->client_port[NI_MAXSERV] = '\0';
78 switch(sadr->sa_family) {
80 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv4 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
84 if(strncmp(w->client_ip, "::ffff:", 7) == 0) {
85 memmove(w->client_ip, &w->client_ip[7], strlen(&w->client_ip[7]) + 1);
86 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv4 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
89 debug(D_WEB_CLIENT_ACCESS, "%llu: New IPv6 web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
93 debug(D_WEB_CLIENT_ACCESS, "%llu: New UNKNOWN web client from %s port %s on socket %d.", w->id, w->client_ip, w->client_port, w->ifd);
98 if(setsockopt(w->ofd, IPPROTO_TCP, TCP_NODELAY, (char *) &flag, sizeof(int)) != 0)
99 error("%llu: failed to enable TCP_NODELAY on socket.", w->id);
102 if(setsockopt(w->ifd, SOL_SOCKET, SO_KEEPALIVE, (char *) &flag, sizeof(int)) != 0)
103 error("%llu: Cannot set SO_KEEPALIVE on socket.", w->id);
106 w->response.data = buffer_create(INITIAL_WEB_DATA_LENGTH);
107 w->response.header = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
108 w->response.header_output = buffer_create(HTTP_RESPONSE_HEADER_SIZE);
112 if(web_clients) web_clients->prev = w;
113 w->next = web_clients;
116 global_statistics.connected_clients++;
121 void web_client_reset(struct web_client *w) {
122 web_client_uncrock_socket(w);
124 debug(D_WEB_CLIENT, "%llu: Reseting client.", w->id);
126 if(likely(w->last_url[0])) {
128 gettimeofday(&tv, NULL);
130 size_t size = (w->mode == WEB_CLIENT_MODE_FILECOPY)?w->response.rlen:w->response.data->len;
132 #ifdef NETDATA_WITH_ZLIB
133 if(likely(w->response.zoutput)) sent = (size_t)w->response.zstream.total_out;
136 // --------------------------------------------------------------------
139 if(web_server_mode == WEB_SERVER_MODE_MULTI_THREADED)
140 global_statistics_lock();
142 global_statistics.web_requests++;
143 global_statistics.web_usec += usecdiff(&tv, &w->tv_in);
144 global_statistics.bytes_received += w->stats_received_bytes;
145 global_statistics.bytes_sent += w->stats_sent_bytes;
146 global_statistics.content_size += size;
147 global_statistics.compressed_content_size += sent;
149 if(web_server_mode == WEB_SERVER_MODE_MULTI_THREADED)
150 global_statistics_unlock();
152 w->stats_received_bytes = 0;
153 w->stats_sent_bytes = 0;
156 // --------------------------------------------------------------------
159 log_access("%llu: (sent/all = %zu/%zu bytes %0.0f%%, prep/sent/total = %0.2f/%0.2f/%0.2f ms) %s: %d '%s'",
161 sent, size, -((size > 0) ? ((size - sent) / (double) size * 100.0) : 0.0),
162 usecdiff(&w->tv_ready, &w->tv_in) / 1000.0,
163 usecdiff(&tv, &w->tv_ready) / 1000.0,
164 usecdiff(&tv, &w->tv_in) / 1000.0,
165 (w->mode == WEB_CLIENT_MODE_FILECOPY) ? "filecopy" : ((w->mode == WEB_CLIENT_MODE_OPTIONS)
166 ? "options" : "data"),
172 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY)) {
173 if(w->ifd != w->ofd) {
174 debug(D_WEB_CLIENT, "%llu: Closing filecopy input file descriptor %d.", w->id, w->ifd);
175 if(w->ifd != -1) close(w->ifd);
180 w->last_url[0] = '\0';
181 w->cookie1[0] = '\0';
182 w->cookie2[0] = '\0';
186 w->mode = WEB_CLIENT_MODE_NORMAL;
190 w->tracking_required = 0;
192 w->decoded_url[0] = '\0';
194 buffer_reset(w->response.header_output);
195 buffer_reset(w->response.header);
196 buffer_reset(w->response.data);
197 w->response.rlen = 0;
198 w->response.sent = 0;
199 w->response.code = 0;
204 w->response.zoutput = 0;
206 // if we had enabled compression, release it
207 #ifdef NETDATA_WITH_ZLIB
208 if(w->response.zinitialized) {
209 debug(D_DEFLATE, "%llu: Freeing compression resources.", w->id);
210 deflateEnd(&w->response.zstream);
211 w->response.zsent = 0;
212 w->response.zhave = 0;
213 w->response.zstream.avail_in = 0;
214 w->response.zstream.avail_out = 0;
215 w->response.zstream.total_in = 0;
216 w->response.zstream.total_out = 0;
217 w->response.zinitialized = 0;
219 #endif // NETDATA_WITH_ZLIB
222 struct web_client *web_client_free(struct web_client *w) {
225 struct web_client *n = w->next;
226 if(w == web_clients) web_clients = n;
228 debug(D_WEB_CLIENT_ACCESS, "%llu: Closing web client from %s port %s.", w->id, w->client_ip, w->client_port);
230 if(w->prev) w->prev->next = w->next;
231 if(w->next) w->next->prev = w->prev;
232 if(w->response.header_output) buffer_free(w->response.header_output);
233 if(w->response.header) buffer_free(w->response.header);
234 if(w->response.data) buffer_free(w->response.data);
235 if(w->ifd != -1) close(w->ifd);
236 if(w->ofd != -1 && w->ofd != w->ifd) close(w->ofd);
239 global_statistics.connected_clients--;
244 uid_t web_files_uid(void) {
245 static char *web_owner = NULL;
246 static uid_t owner_uid = 0;
248 if(unlikely(!web_owner)) {
249 web_owner = config_get("global", "web files owner", config_get("global", "run as user", ""));
250 if(!web_owner || !*web_owner)
251 owner_uid = geteuid();
253 // getpwnam() is not thread safe,
254 // but we have called this function once
255 // while single threaded
256 struct passwd *pw = getpwnam(web_owner);
258 error("User '%s' is not present. Ignoring option.", web_owner);
259 owner_uid = geteuid();
262 debug(D_WEB_CLIENT, "Web files owner set to %s.", web_owner);
263 owner_uid = pw->pw_uid;
271 gid_t web_files_gid(void) {
272 static char *web_group = NULL;
273 static gid_t owner_gid = 0;
275 if(unlikely(!web_group)) {
276 web_group = config_get("global", "web files group", config_get("global", "web files owner", ""));
277 if(!web_group || !*web_group)
278 owner_gid = getegid();
280 // getgrnam() is not thread safe,
281 // but we have called this function once
282 // while single threaded
283 struct group *gr = getgrnam(web_group);
285 error("Group '%s' is not present. Ignoring option.", web_group);
286 owner_gid = getegid();
289 debug(D_WEB_CLIENT, "Web files group set to %s.", web_group);
290 owner_gid = gr->gr_gid;
298 int mysendfile(struct web_client *w, char *filename)
300 static char *web_dir = NULL;
302 // initialize our static data
303 if(unlikely(!web_dir)) web_dir = config_get("global", "web files directory", WEB_DIR);
305 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, web_dir, filename);
307 // skip leading slashes
308 while (*filename == '/') filename++;
310 // if the filename contain known paths, skip them
311 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0)
312 filename = &filename[strlen(WEB_PATH_FILE) + 1];
315 for(s = filename; *s ;s++) {
316 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
317 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
318 buffer_sprintf(w->response.data, "File '%s' cannot be served. Filename contains invalid character '%c'", filename, *s);
323 // if the filename contains a .. refuse to serve it
324 if(strstr(filename, "..") != 0) {
325 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
326 buffer_sprintf(w->response.data, "File '%s' cannot be served. Relative filenames with '..' in them are not supported.", filename);
331 char webfilename[FILENAME_MAX + 1];
332 snprintfz(webfilename, FILENAME_MAX, "%s/%s", web_dir, filename);
334 // check if the file exists
336 if(lstat(webfilename, &stat) != 0) {
337 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
338 buffer_sprintf(w->response.data, "File '%s' does not exist, or is not accessible.", webfilename);
342 // check if the file is owned by expected user
343 if(stat.st_uid != web_files_uid()) {
344 error("%llu: File '%s' is owned by user %u (expected user %u). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
345 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
349 // check if the file is owned by expected group
350 if(stat.st_gid != web_files_gid()) {
351 error("%llu: File '%s' is owned by group %u (expected group %u). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
352 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
356 if((stat.st_mode & S_IFMT) == S_IFDIR) {
357 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
358 return mysendfile(w, webfilename);
361 if((stat.st_mode & S_IFMT) != S_IFREG) {
362 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
363 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
368 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
372 if(errno == EBUSY || errno == EAGAIN) {
373 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
374 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
375 buffer_sprintf(w->response.data, "The file '%s' is currently busy. Please try again later.", webfilename);
379 error("%llu: Cannot open file '%s'.", w->id, webfilename);
380 buffer_sprintf(w->response.data, "Cannot open file '%s'.", webfilename);
384 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
385 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, webfilename);
387 // pick a Content-Type for the file
388 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
389 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
390 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
391 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
392 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
393 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
394 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
395 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
396 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
397 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
398 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
399 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
400 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
401 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
402 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
403 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
404 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
405 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
406 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
407 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
409 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending file '%s' (%ld bytes, ifd %d, ofd %d).", w->id, webfilename, stat.st_size, w->ifd, w->ofd);
411 w->mode = WEB_CLIENT_MODE_FILECOPY;
414 buffer_flush(w->response.data);
415 w->response.rlen = stat.st_size;
416 w->response.data->date = stat.st_mtim.tv_sec;
422 #ifdef NETDATA_WITH_ZLIB
423 void web_client_enable_deflate(struct web_client *w, int gzip) {
424 if(unlikely(w->response.zinitialized)) {
425 error("%llu: Compression has already be initialized for this client.", w->id);
429 if(unlikely(w->response.sent)) {
430 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
434 w->response.zstream.zalloc = Z_NULL;
435 w->response.zstream.zfree = Z_NULL;
436 w->response.zstream.opaque = Z_NULL;
438 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
439 w->response.zstream.avail_in = 0;
440 w->response.zstream.total_in = 0;
442 w->response.zstream.next_out = w->response.zbuffer;
443 w->response.zstream.avail_out = 0;
444 w->response.zstream.total_out = 0;
446 w->response.zstream.zalloc = Z_NULL;
447 w->response.zstream.zfree = Z_NULL;
448 w->response.zstream.opaque = Z_NULL;
450 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
451 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
455 // Select GZIP compression: windowbits = 15 + 16 = 31
456 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
457 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
461 w->response.zsent = 0;
462 w->response.zoutput = 1;
463 w->response.zinitialized = 1;
465 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
467 #endif // NETDATA_WITH_ZLIB
469 uint32_t web_client_api_request_v1_data_options(char *o)
471 uint32_t ret = 0x00000000;
474 while(o && *o && (tok = mystrsep(&o, ", |"))) {
477 if(!strcmp(tok, "nonzero"))
478 ret |= RRDR_OPTION_NONZERO;
479 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
480 ret |= RRDR_OPTION_REVERSED;
481 else if(!strcmp(tok, "jsonwrap"))
482 ret |= RRDR_OPTION_JSON_WRAP;
483 else if(!strcmp(tok, "min2max"))
484 ret |= RRDR_OPTION_MIN2MAX;
485 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
486 ret |= RRDR_OPTION_MILLISECONDS;
487 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
488 ret |= RRDR_OPTION_ABSOLUTE;
489 else if(!strcmp(tok, "seconds"))
490 ret |= RRDR_OPTION_SECONDS;
491 else if(!strcmp(tok, "null2zero"))
492 ret |= RRDR_OPTION_NULL2ZERO;
493 else if(!strcmp(tok, "objectrows"))
494 ret |= RRDR_OPTION_OBJECTSROWS;
495 else if(!strcmp(tok, "google_json"))
496 ret |= RRDR_OPTION_GOOGLE_JSON;
497 else if(!strcmp(tok, "percentage"))
498 ret |= RRDR_OPTION_PERCENTAGE;
499 else if(!strcmp(tok, "unaligned"))
500 ret |= RRDR_OPTION_NOT_ALIGNED;
506 uint32_t web_client_api_request_v1_data_format(char *name)
508 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
509 return DATASOURCE_DATATABLE_JSON;
511 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
512 return DATASOURCE_DATATABLE_JSONP;
514 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
515 return DATASOURCE_JSON;
517 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
518 return DATASOURCE_JSONP;
520 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
521 return DATASOURCE_SSV;
523 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
524 return DATASOURCE_CSV;
526 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
527 return DATASOURCE_TSV;
529 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
530 return DATASOURCE_HTML;
532 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
533 return DATASOURCE_JS_ARRAY;
535 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
536 return DATASOURCE_SSV_COMMA;
538 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
539 return DATASOURCE_CSV_JSON_ARRAY;
541 return DATASOURCE_JSON;
544 uint32_t web_client_api_request_v1_data_google_format(char *name)
546 if(!strcmp(name, "json"))
547 return DATASOURCE_DATATABLE_JSONP;
549 else if(!strcmp(name, "html"))
550 return DATASOURCE_HTML;
552 else if(!strcmp(name, "csv"))
553 return DATASOURCE_CSV;
555 else if(!strcmp(name, "tsv-excel"))
556 return DATASOURCE_TSV;
558 return DATASOURCE_JSON;
561 int web_client_api_request_v1_data_group(char *name)
563 if(!strcmp(name, "max"))
566 else if(!strcmp(name, "average"))
567 return GROUP_AVERAGE;
569 else if(!strcmp(name, "sum"))
572 else if(!strcmp(name, "incremental-sum"))
573 return GROUP_INCREMENTAL_SUM;
575 return GROUP_AVERAGE;
578 int web_client_api_request_v1_charts(struct web_client *w, char *url)
582 buffer_flush(w->response.data);
583 w->response.data->contenttype = CT_APPLICATION_JSON;
584 rrd_stats_api_v1_charts(w->response.data);
588 int web_client_api_request_v1_chart(struct web_client *w, char *url)
593 buffer_flush(w->response.data);
596 char *value = mystrsep(&url, "?&[]");
597 if(!value || !*value) continue;
599 char *name = mystrsep(&value, "=");
600 if(!name || !*name) continue;
601 if(!value || !*value) continue;
603 // name and value are now the parameters
604 // they are not null and not empty
606 if(!strcmp(name, "chart")) chart = value;
608 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
613 if(!chart || !*chart) {
614 buffer_sprintf(w->response.data, "No chart id is given at the request.");
618 RRDSET *st = rrdset_find(chart);
619 if(!st) st = rrdset_find_byname(chart);
621 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
626 w->response.data->contenttype = CT_APPLICATION_JSON;
627 rrd_stats_api_v1_chart(st, w->response.data);
634 int web_client_api_v1_badge(struct web_client *w, char *url) {
636 buffer_flush(w->response.data);
638 BUFFER *dimensions = NULL;
640 const char *chart = NULL
644 , *multiply_str = NULL
648 , *label_color = NULL
649 , *value_color = NULL
650 , *refresh_str = NULL
651 , *precision_str = NULL;
653 int group = GROUP_AVERAGE;
654 uint32_t options = 0x00000000;
657 char *value = mystrsep(&url, "/?&[]");
658 if(!value || !*value) continue;
660 char *name = mystrsep(&value, "=");
661 if(!name || !*name) continue;
662 if(!value || !*value) continue;
664 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
666 // name and value are now the parameters
667 // they are not null and not empty
669 if(!strcmp(name, "chart")) chart = value;
670 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
672 dimensions = buffer_create(100);
674 buffer_strcat(dimensions, "|");
675 buffer_strcat(dimensions, value);
677 else if(!strcmp(name, "after")) after_str = value;
678 else if(!strcmp(name, "before")) before_str = value;
679 else if(!strcmp(name, "points")) points_str = value;
680 else if(!strcmp(name, "group")) {
681 group = web_client_api_request_v1_data_group(value);
683 else if(!strcmp(name, "options")) {
684 options |= web_client_api_request_v1_data_options(value);
686 else if(!strcmp(name, "label")) label = value;
687 else if(!strcmp(name, "units")) units = value;
688 else if(!strcmp(name, "label_color")) label_color = value;
689 else if(!strcmp(name, "value_color")) value_color = value;
690 else if(!strcmp(name, "multiply")) multiply_str = value;
691 else if(!strcmp(name, "divide")) divide_str = value;
692 else if(!strcmp(name, "refresh")) refresh_str = value;
693 else if(!strcmp(name, "precision")) precision_str = value;
696 if(!chart || !*chart) {
697 buffer_sprintf(w->response.data, "No chart id is given at the request.");
701 RRDSET *st = rrdset_find(chart);
702 if(!st) st = rrdset_find_byname(chart);
704 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
709 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
710 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
711 long long before = (before_str && *before_str )?atol(before_str):0;
712 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
713 int points = (points_str && *points_str )?atoi(points_str):1;
714 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
716 if(!multiply) multiply = 1;
717 if(!divide) divide = 1;
720 if(refresh_str && *refresh_str) {
721 if(!strcmp(refresh_str, "auto")) {
722 if(options & RRDR_OPTION_NOT_ALIGNED)
723 refresh = st->update_every;
725 refresh = (before - after);
726 if(refresh < 0) refresh = -refresh;
730 refresh = atoi(refresh_str);
731 if(refresh < 0) refresh = -refresh;
737 const char *dim = buffer_tostring(dimensions);
738 if(*dim == '|') dim++;
745 if(options & RRDR_OPTION_PERCENTAGE)
751 debug(D_WEB_CLIENT, "%llu: API command 'badge.svg' for chart '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%d', options '0x%08x'"
754 , (dimensions)?buffer_tostring(dimensions):""
762 time_t latest_timestamp = 0;
763 int value_is_null = 1;
764 calculated_number n = 0;
767 // if the collected value is too old, don't calculate its value
768 if(rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
769 ret = rrd2value(st, w->response.data, &n, dimensions, points, after, before, group, options, &latest_timestamp, &value_is_null);
771 // if the value cannot be calculated, show empty badge
778 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
781 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null, precision);
785 buffer_free(dimensions);
789 // returns the HTTP code
790 int web_client_api_request_v1_data(struct web_client *w, char *url)
792 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
795 BUFFER *dimensions = NULL;
797 buffer_flush(w->response.data);
799 char *google_version = "0.6",
802 *google_out = "json",
803 *responseHandler = NULL,
806 time_t last_timestamp_in_data = 0, google_timestamp = 0;
811 , *points_str = NULL;
813 int group = GROUP_AVERAGE;
814 uint32_t format = DATASOURCE_JSON;
815 uint32_t options = 0x00000000;
818 char *value = mystrsep(&url, "?&[]");
819 if(!value || !*value) continue;
821 char *name = mystrsep(&value, "=");
822 if(!name || !*name) continue;
823 if(!value || !*value) continue;
825 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
827 // name and value are now the parameters
828 // they are not null and not empty
830 if(!strcmp(name, "chart")) chart = value;
831 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
832 if(!dimensions) dimensions = buffer_create(100);
833 buffer_strcat(dimensions, "|");
834 buffer_strcat(dimensions, value);
836 else if(!strcmp(name, "after")) after_str = value;
837 else if(!strcmp(name, "before")) before_str = value;
838 else if(!strcmp(name, "points")) points_str = value;
839 else if(!strcmp(name, "group")) {
840 group = web_client_api_request_v1_data_group(value);
842 else if(!strcmp(name, "format")) {
843 format = web_client_api_request_v1_data_format(value);
845 else if(!strcmp(name, "options")) {
846 options |= web_client_api_request_v1_data_options(value);
848 else if(!strcmp(name, "callback")) {
849 responseHandler = value;
851 else if(!strcmp(name, "filename")) {
854 else if(!strcmp(name, "tqx")) {
855 // parse Google Visualization API options
856 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
857 char *tqx_name, *tqx_value;
860 tqx_value = mystrsep(&value, ";");
861 if(!tqx_value || !*tqx_value) continue;
863 tqx_name = mystrsep(&tqx_value, ":");
864 if(!tqx_name || !*tqx_name) continue;
865 if(!tqx_value || !*tqx_value) continue;
867 if(!strcmp(tqx_name, "version"))
868 google_version = tqx_value;
869 else if(!strcmp(tqx_name, "reqId"))
870 google_reqId = tqx_value;
871 else if(!strcmp(tqx_name, "sig")) {
872 google_sig = tqx_value;
873 google_timestamp = strtoul(google_sig, NULL, 0);
875 else if(!strcmp(tqx_name, "out")) {
876 google_out = tqx_value;
877 format = web_client_api_request_v1_data_google_format(google_out);
879 else if(!strcmp(tqx_name, "responseHandler"))
880 responseHandler = tqx_value;
881 else if(!strcmp(tqx_name, "outFileName"))
882 outFileName = tqx_value;
887 if(!chart || !*chart) {
888 buffer_sprintf(w->response.data, "No chart id is given at the request.");
892 RRDSET *st = rrdset_find(chart);
893 if(!st) st = rrdset_find_byname(chart);
895 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
900 long long before = (before_str && *before_str)?atol(before_str):0;
901 long long after = (after_str && *after_str) ?atol(after_str):0;
902 int points = (points_str && *points_str)?atoi(points_str):0;
904 debug(D_WEB_CLIENT, "%llu: API command 'data' for chart '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%d', format '%u', options '0x%08x'"
907 , (dimensions)?buffer_tostring(dimensions):""
916 if(outFileName && *outFileName) {
917 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
918 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
921 if(format == DATASOURCE_DATATABLE_JSONP) {
922 if(responseHandler == NULL)
923 responseHandler = "google.visualization.Query.setResponse";
925 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
926 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
929 buffer_sprintf(w->response.data,
930 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
931 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
933 else if(format == DATASOURCE_JSONP) {
934 if(responseHandler == NULL)
935 responseHandler = "callback";
937 buffer_strcat(w->response.data, responseHandler);
938 buffer_strcat(w->response.data, "(");
941 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
943 if(format == DATASOURCE_DATATABLE_JSONP) {
944 if(google_timestamp < last_timestamp_in_data)
945 buffer_strcat(w->response.data, "});");
948 // the client already has the latest data
949 buffer_flush(w->response.data);
950 buffer_sprintf(w->response.data,
951 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
952 responseHandler, google_version, google_reqId);
955 else if(format == DATASOURCE_JSONP)
956 buffer_strcat(w->response.data, ");");
959 if(dimensions) buffer_free(dimensions);
963 int web_client_api_request_v1_registry(struct web_client *w, char *url)
965 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
966 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
967 hash_to = 0 /*, hash_redirects = 0 */;
969 if(unlikely(!hash_action)) {
970 hash_action = simple_hash("action");
971 hash_access = simple_hash("access");
972 hash_hello = simple_hash("hello");
973 hash_delete = simple_hash("delete");
974 hash_search = simple_hash("search");
975 hash_switch = simple_hash("switch");
976 hash_machine = simple_hash("machine");
977 hash_url = simple_hash("url");
978 hash_name = simple_hash("name");
979 hash_delete_url = simple_hash("delete_url");
980 hash_for = simple_hash("for");
981 hash_to = simple_hash("to");
983 hash_redirects = simple_hash("redirects");
987 char person_guid[36 + 1] = "";
989 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
992 // The browser may send multiple cookies with our id
994 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
996 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
999 char *machine_guid = NULL,
1000 *machine_url = NULL,
1002 *search_machine_guid = NULL,
1004 *to_person_guid = NULL;
1010 char *value = mystrsep(&url, "?&[]");
1011 if (!value || !*value) continue;
1013 char *name = mystrsep(&value, "=");
1014 if (!name || !*name) continue;
1015 if (!value || !*value) continue;
1017 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1019 uint32_t hash = simple_hash(name);
1021 if(hash == hash_action && !strcmp(name, "action")) {
1022 uint32_t vhash = simple_hash(value);
1024 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1025 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1026 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1027 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1028 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1029 #ifdef NETDATA_INTERNAL_CHECKS
1030 else error("unknown registry action '%s'", value);
1031 #endif /* NETDATA_INTERNAL_CHECKS */
1034 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1035 redirects = atoi(value);
1037 else if(hash == hash_machine && !strcmp(name, "machine"))
1038 machine_guid = value;
1040 else if(hash == hash_url && !strcmp(name, "url"))
1041 machine_url = value;
1043 else if(action == 'A') {
1044 if(hash == hash_name && !strcmp(name, "name"))
1047 else if(action == 'D') {
1048 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1051 else if(action == 'S') {
1052 if(hash == hash_for && !strcmp(name, "for"))
1053 search_machine_guid = value;
1055 else if(action == 'W') {
1056 if(hash == hash_to && !strcmp(name, "to"))
1057 to_person_guid = value;
1059 #ifdef NETDATA_INTERNAL_CHECKS
1060 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1061 #endif /* NETDATA_INTERNAL_CHECKS */
1064 if(web_donotrack_comply && w->donottrack) {
1065 buffer_flush(w->response.data);
1066 buffer_sprintf(w->response.data, "Your web browser is sending 'DNT: 1' (Do Not Track). The registry requires persistent cookies on your browser to work.");
1070 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1071 buffer_flush(w->response.data);
1072 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1073 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1076 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1077 buffer_flush(w->response.data);
1078 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1079 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1082 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1083 buffer_flush(w->response.data);
1084 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1085 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1088 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1089 buffer_flush(w->response.data);
1090 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1091 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1097 w->tracking_required = 1;
1098 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1099 buffer_flush(w->response.data);
1101 registry_set_cookie(w, "give-me-back-this-cookie-please");
1102 w->response.data->contenttype = CT_APPLICATION_JSON;
1103 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1107 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1108 * under certain conditions, when using CORS
1109 * so this is commented and we use application level redirects instead
1113 if(redirects > registry_verify_cookies_redirects()) {
1114 buffer_flush(w->response.data);
1115 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1119 char *encoded_url = url_encode(machine_url);
1121 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1125 char *encoded_name = url_encode(url_name);
1128 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1132 char *encoded_guid = url_encode(machine_guid);
1136 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1140 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1141 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1149 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1152 w->tracking_required = 1;
1153 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1156 w->tracking_required = 1;
1157 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1160 w->tracking_required = 1;
1161 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1164 return registry_request_hello_json(w);
1167 buffer_flush(w->response.data);
1168 buffer_sprintf(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1172 buffer_flush(w->response.data);
1173 buffer_sprintf(w->response.data, "Invalid or no registry action.");
1177 int web_client_api_request_v1(struct web_client *w, char *url) {
1178 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0;
1180 if(unlikely(hash_data == 0)) {
1181 hash_data = simple_hash("data");
1182 hash_chart = simple_hash("chart");
1183 hash_charts = simple_hash("charts");
1184 hash_registry = simple_hash("registry");
1185 hash_badge = simple_hash("badge.svg");
1189 char *tok = mystrsep(&url, "/?&");
1191 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1192 uint32_t hash = simple_hash(tok);
1194 if(hash == hash_data && !strcmp(tok, "data"))
1195 return web_client_api_request_v1_data(w, url);
1197 else if(hash == hash_chart && !strcmp(tok, "chart"))
1198 return web_client_api_request_v1_chart(w, url);
1200 else if(hash == hash_charts && !strcmp(tok, "charts"))
1201 return web_client_api_request_v1_charts(w, url);
1203 else if(hash == hash_registry && !strcmp(tok, "registry"))
1204 return web_client_api_request_v1_registry(w, url);
1206 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1207 return web_client_api_v1_badge(w, url);
1210 buffer_flush(w->response.data);
1211 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1216 buffer_flush(w->response.data);
1217 buffer_sprintf(w->response.data, "API v1 command?");
1222 int web_client_api_request(struct web_client *w, char *url)
1224 // get the api version
1225 char *tok = mystrsep(&url, "/?&");
1227 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1228 if(strcmp(tok, "v1") == 0)
1229 return web_client_api_request_v1(w, url);
1231 buffer_flush(w->response.data);
1232 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1237 buffer_flush(w->response.data);
1238 buffer_sprintf(w->response.data, "Which API version?");
1243 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1247 char *args = strchr(url, '?');
1253 // get the name of the data to show
1254 char *tok = mystrsep(&url, "/");
1257 // do we have such a data set?
1259 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1260 st = rrdset_find_byname(tok);
1261 if(!st) st = rrdset_find(tok);
1266 // try to send a file with that name
1267 buffer_flush(w->response.data);
1268 return(mysendfile(w, tok));
1272 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1274 // how many entries does the client want?
1275 int lines = rrd_default_history_entries;
1276 int group_count = 1;
1277 time_t after = 0, before = 0;
1278 int group_method = GROUP_AVERAGE;
1282 // parse the lines required
1283 tok = mystrsep(&url, "/");
1284 if(tok) lines = atoi(tok);
1285 if(lines < 1) lines = 1;
1288 // parse the group count required
1289 tok = mystrsep(&url, "/");
1290 if(tok && *tok) group_count = atoi(tok);
1291 if(group_count < 1) group_count = 1;
1292 //if(group_count > save_history / 20) group_count = save_history / 20;
1295 // parse the grouping method required
1296 tok = mystrsep(&url, "/");
1298 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1299 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1300 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1301 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1306 tok = mystrsep(&url, "/");
1307 if(tok && *tok) after = strtoul(tok, NULL, 10);
1308 if(after < 0) after = 0;
1311 // parse before time
1312 tok = mystrsep(&url, "/");
1313 if(tok && *tok) before = strtoul(tok, NULL, 10);
1314 if(before < 0) before = 0;
1318 tok = mystrsep(&url, "/");
1319 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1322 w->response.data->contenttype = CT_APPLICATION_JSON;
1323 buffer_flush(w->response.data);
1325 char *google_version = "0.6";
1326 char *google_reqId = "0";
1327 char *google_sig = "0";
1328 char *google_out = "json";
1329 char *google_responseHandler = "google.visualization.Query.setResponse";
1330 char *google_outFileName = NULL;
1331 time_t last_timestamp_in_data = 0;
1332 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1334 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1337 tok = mystrsep(&args, "&");
1339 char *name = mystrsep(&tok, "=");
1340 if(name && *name && strcmp(name, "tqx") == 0) {
1341 char *key = mystrsep(&tok, ":");
1342 char *value = mystrsep(&tok, ";");
1343 if(key && value && *key && *value) {
1344 if(strcmp(key, "version") == 0)
1345 google_version = value;
1347 else if(strcmp(key, "reqId") == 0)
1348 google_reqId = value;
1350 else if(strcmp(key, "sig") == 0)
1353 else if(strcmp(key, "out") == 0)
1356 else if(strcmp(key, "responseHandler") == 0)
1357 google_responseHandler = value;
1359 else if(strcmp(key, "outFileName") == 0)
1360 google_outFileName = value;
1366 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1367 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1370 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1371 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1373 // check the client wants json
1374 if(strcmp(google_out, "json") != 0) {
1375 buffer_sprintf(w->response.data,
1376 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'invalid_query',message:'output format is not supported',detailed_message:'the format %s requested is not supported by netdata.'}]});",
1377 google_responseHandler, google_version, google_reqId, google_out);
1383 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1384 buffer_sprintf(w->response.data,
1385 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1386 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1389 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1390 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1392 time_t timestamp_in_data = rrd_stats_json(datasource_type, st, w->response.data, lines, group_count, group_method, (unsigned long)after, (unsigned long)before, nonzero);
1394 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1395 if(timestamp_in_data > last_timestamp_in_data)
1396 buffer_strcat(w->response.data, "});");
1399 // the client already has the latest data
1400 buffer_flush(w->response.data);
1401 buffer_sprintf(w->response.data,
1402 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1403 google_responseHandler, google_version, google_reqId);
1410 const char *web_content_type_to_string(uint8_t contenttype) {
1411 switch(contenttype) {
1413 return "text/html; charset=utf-8";
1415 case CT_APPLICATION_XML:
1416 return "application/xml; charset=utf-8";
1418 case CT_APPLICATION_JSON:
1419 return "application/json; charset=utf-8";
1421 case CT_APPLICATION_X_JAVASCRIPT:
1422 return "application/x-javascript; charset=utf-8";
1425 return "text/css; charset=utf-8";
1428 return "text/xml; charset=utf-8";
1431 return "text/xsl; charset=utf-8";
1433 case CT_APPLICATION_OCTET_STREAM:
1434 return "application/octet-stream";
1436 case CT_IMAGE_SVG_XML:
1437 return "image/svg+xml";
1439 case CT_APPLICATION_X_FONT_TRUETYPE:
1440 return "application/x-font-truetype";
1442 case CT_APPLICATION_X_FONT_OPENTYPE:
1443 return "application/x-font-opentype";
1445 case CT_APPLICATION_FONT_WOFF:
1446 return "application/font-woff";
1448 case CT_APPLICATION_FONT_WOFF2:
1449 return "application/font-woff2";
1451 case CT_APPLICATION_VND_MS_FONTOBJ:
1452 return "application/vnd.ms-fontobject";
1458 return "image/jpeg";
1463 case CT_IMAGE_XICON:
1464 return "image/x-icon";
1470 return "image/icns";
1474 return "text/plain; charset=utf-8";
1479 const char *web_response_code_to_string(int code) {
1485 return "Temporary Redirect";
1488 return "Bad Request";
1497 return "Preconditions Failed";
1500 if(code >= 100 && code < 200)
1501 return "Informational";
1503 if(code >= 200 && code < 300)
1504 return "Successful";
1506 if(code >= 300 && code < 400)
1507 return "Redirection";
1509 if(code >= 400 && code < 500)
1510 return "Bad Request";
1512 if(code >= 500 && code < 600)
1513 return "Server Error";
1515 return "Undefined Error";
1519 static inline char *http_header_parse(struct web_client *w, char *s) {
1520 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1522 if(unlikely(!hash_origin)) {
1523 hash_origin = simple_uhash("Origin");
1524 hash_connection = simple_uhash("Connection");
1525 hash_accept_encoding = simple_uhash("Accept-Encoding");
1526 hash_donottrack = simple_uhash("DNT");
1532 while(*e && *e != ':') e++;
1539 char *v = e + 1, *ve;
1541 // skip leading spaces from value
1542 while(*v == ' ') v++;
1546 while(*ve && *ve != '\r') ve++;
1547 if(!*ve || ve[1] != '\n') {
1552 // terminate the value
1555 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1556 uint32_t hash = simple_uhash(s);
1558 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1559 strncpyz(w->origin, v, ORIGIN_MAX);
1561 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1562 if(strcasestr(v, "keep-alive"))
1565 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1566 if(*v == '0') w->donottrack = 0;
1567 else if(*v == '1') w->donottrack = 1;
1569 #ifdef NETDATA_WITH_ZLIB
1570 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1571 if(web_enable_gzip) {
1572 if(strcasestr(v, "gzip"))
1573 web_client_enable_deflate(w, 1);
1575 // does not seem to work
1576 // else if(strcasestr(v, "deflate"))
1577 // web_client_enable_deflate(w, 0);
1580 #endif /* NETDATA_WITH_ZLIB */
1587 // http_request_validate()
1589 // = 0 : all good, process the request
1590 // > 0 : request is not supported
1591 // < 0 : request is incomplete - wait for more data
1593 static inline int http_request_validate(struct web_client *w) {
1594 char *s = w->response.data->buffer, *encoded_url = NULL;
1596 // is is a valid request?
1597 if(!strncmp(s, "GET ", 4)) {
1598 encoded_url = s = &s[4];
1599 w->mode = WEB_CLIENT_MODE_NORMAL;
1601 else if(!strncmp(s, "OPTIONS ", 8)) {
1602 encoded_url = s = &s[8];
1603 w->mode = WEB_CLIENT_MODE_OPTIONS;
1606 w->wait_receive = 0;
1610 // find the SPACE + "HTTP/"
1612 // find the next space
1613 while (*s && *s != ' ') s++;
1615 // is it SPACE + "HTTP/" ?
1616 if(*s && !strncmp(s, " HTTP/", 6)) break;
1620 // incomplete requests
1622 w->wait_receive = 1;
1626 // we have the end of encoded_url - remember it
1629 // make sure we have complete request
1630 // complete requests contain: \r\n\r\n
1633 while(*s && *s++ != '\r');
1635 // did we reach the end?
1636 if(unlikely(!*s)) break;
1639 if(likely(*s++ == '\n')) {
1641 // is it again \r\n ? (header end)
1642 if(unlikely(*s == '\r' && s[1] == '\n')) {
1643 // a valid complete HTTP request found
1646 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1649 // copy the URL - we are going to overwrite parts of it
1650 // FIXME -- we should avoid it
1651 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1653 w->wait_receive = 0;
1657 // another header line
1658 s = http_header_parse(w, s);
1662 // incomplete request
1663 w->wait_receive = 1;
1667 void web_client_process(struct web_client *w) {
1668 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1669 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1671 if(unlikely(!hash_api)) {
1672 hash_api = simple_hash("api");
1673 hash_netdata_conf = simple_hash("netdata.conf");
1674 hash_data = simple_hash(WEB_PATH_DATA);
1675 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1676 hash_graph = simple_hash(WEB_PATH_GRAPH);
1677 hash_list = simple_hash("list");
1678 hash_all_json = simple_hash("all.json");
1679 hash_exit = simple_hash("exit");
1680 hash_debug = simple_hash("debug");
1681 hash_mirror = simple_hash("mirror");
1687 int what_to_do = http_request_validate(w);
1689 // wait for more data
1690 if(what_to_do < 0) {
1691 if(w->response.data->len > TOO_BIG_REQUEST) {
1692 strcpy(w->last_url, "too big request");
1694 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1697 buffer_flush(w->response.data);
1698 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1701 // wait for more data
1705 else if(what_to_do > 0) {
1706 strcpy(w->last_url, "not a valid request");
1708 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1711 buffer_flush(w->response.data);
1712 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1714 else { // what_to_do == 0
1715 gettimeofday(&w->tv_in, NULL);
1717 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1719 w->response.data->contenttype = CT_TEXT_PLAIN;
1720 buffer_flush(w->response.data);
1721 buffer_strcat(w->response.data, "OK");
1724 char *url = w->decoded_url;
1725 char *tok = mystrsep(&url, "/?");
1727 uint32_t hash = simple_hash(tok);
1728 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1730 if(hash == hash_api && strcmp(tok, "api") == 0) {
1731 // the client is requesting api access
1732 code = web_client_api_request(w, url);
1734 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1736 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1738 w->response.data->contenttype = CT_TEXT_PLAIN;
1739 buffer_flush(w->response.data);
1740 generate_config(w->response.data, 0);
1742 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1743 // the client is requesting rrd data -- OLD API
1744 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1746 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1747 // the client is requesting google datasource -- OLD API
1748 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1750 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1751 // the client is requesting an rrd graph -- OLD API
1753 // get the name of the data to show
1754 tok = mystrsep(&url, "/?&");
1756 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1758 // do we have such a data set?
1759 RRDSET *st = rrdset_find_byname(tok);
1760 if(!st) st = rrdset_find(tok);
1763 // try to send a file with that name
1764 buffer_flush(w->response.data);
1765 code = mysendfile(w, tok);
1769 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1770 w->response.data->contenttype = CT_APPLICATION_JSON;
1771 buffer_flush(w->response.data);
1772 rrd_stats_graph_json(st, url, w->response.data);
1777 buffer_flush(w->response.data);
1778 buffer_strcat(w->response.data, "Graph name?\r\n");
1781 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1785 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1787 buffer_flush(w->response.data);
1788 RRDSET *st = localhost.rrdset_root;
1790 for ( ; st ; st = st->next )
1791 buffer_sprintf(w->response.data, "%s\n", st->name);
1793 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1796 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1798 w->response.data->contenttype = CT_APPLICATION_JSON;
1799 buffer_flush(w->response.data);
1800 rrd_stats_all_json(w->response.data);
1802 #ifdef NETDATA_INTERNAL_CHECKS
1803 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1805 w->response.data->contenttype = CT_TEXT_PLAIN;
1806 buffer_flush(w->response.data);
1809 buffer_strcat(w->response.data, "ok, will do...");
1811 buffer_strcat(w->response.data, "I am doing it already");
1813 error("web request to exit received.");
1814 netdata_cleanup_and_exit(0);
1817 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
1818 buffer_flush(w->response.data);
1820 // get the name of the data to show
1821 tok = mystrsep(&url, "/?&");
1823 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1825 // do we have such a data set?
1826 RRDSET *st = rrdset_find_byname(tok);
1827 if(!st) st = rrdset_find(tok);
1830 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
1831 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
1835 debug_flags |= D_RRD_STATS;
1836 st->debug = !st->debug;
1837 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
1838 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
1843 buffer_flush(w->response.data);
1844 buffer_strcat(w->response.data, "debug which chart?\r\n");
1847 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
1850 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
1852 // replace the zero bytes with spaces
1853 buffer_char_replace(w->response.data, '\0', ' ');
1855 // just leave the buffer as is
1856 // it will be copied back to the client
1858 #endif /* NETDATA_INTERNAL_CHECKS */
1860 char filename[FILENAME_MAX+1];
1862 strncpyz(filename, w->last_url, FILENAME_MAX);
1863 tok = mystrsep(&url, "?");
1864 buffer_flush(w->response.data);
1865 code = mysendfile(w, (tok && *tok)?tok:"/");
1869 char filename[FILENAME_MAX+1];
1871 strncpyz(filename, w->last_url, FILENAME_MAX);
1872 tok = mystrsep(&url, "?");
1873 buffer_flush(w->response.data);
1874 code = mysendfile(w, (tok && *tok)?tok:"/");
1879 gettimeofday(&w->tv_ready, NULL);
1880 w->response.data->date = time(NULL);
1881 w->response.sent = 0;
1882 w->response.code = code;
1884 // prepare the HTTP response header
1885 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
1887 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
1888 const char *code_msg = web_response_code_to_string(code);
1891 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
1892 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
1894 buffer_sprintf(w->response.header_output,
1895 "HTTP/1.1 %d %s\r\n"
1896 "Connection: %s\r\n"
1897 "Server: NetData Embedded HTTP Server\r\n"
1898 "Access-Control-Allow-Origin: %s\r\n"
1899 "Access-Control-Allow-Credentials: true\r\n"
1900 "Content-Type: %s\r\n"
1903 , w->keepalive?"keep-alive":"close"
1905 , content_type_string
1909 if(w->cookie1[0] || w->cookie2[0]) {
1911 buffer_sprintf(w->response.header_output,
1912 "Set-Cookie: %s\r\n",
1917 buffer_sprintf(w->response.header_output,
1918 "Set-Cookie: %s\r\n",
1922 if(web_donotrack_comply)
1923 buffer_sprintf(w->response.header_output,
1924 "Tk: T;cookies\r\n");
1927 if(web_donotrack_comply) {
1928 if(w->tracking_required)
1929 buffer_sprintf(w->response.header_output,
1930 "Tk: T;cookies\r\n");
1932 buffer_sprintf(w->response.header_output,
1937 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1938 buffer_strcat(w->response.header_output,
1939 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
1940 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
1941 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
1945 if(buffer_strlen(w->response.header))
1946 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
1948 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
1949 buffer_sprintf(w->response.header_output,
1951 "Cache-Control: no-cache\r\n"
1954 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
1956 time_t et = w->response.data->date + (86400 * 14);
1957 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
1958 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
1960 buffer_sprintf(w->response.header_output,
1962 "Cache-Control: public\r\n"
1966 // if we know the content length, put it
1967 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
1968 buffer_sprintf(w->response.header_output,
1969 "Content-Length: %zu\r\n"
1970 , w->response.data->len? w->response.data->len: w->response.rlen
1972 else if(!w->response.zoutput)
1973 w->keepalive = 0; // content-length is required for keep-alive
1975 if(w->response.zoutput) {
1976 buffer_strcat(w->response.header_output,
1977 "Content-Encoding: gzip\r\n"
1978 "Transfer-Encoding: chunked\r\n"
1982 buffer_strcat(w->response.header_output, "\r\n");
1984 // sent the HTTP header
1985 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
1987 , buffer_strlen(w->response.header_output)
1988 , buffer_tostring(w->response.header_output)
1991 web_client_crock_socket(w);
1993 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
1994 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
1996 w->stats_sent_bytes += bytes;
1998 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2000 , buffer_strlen(w->response.header_output)
2003 WEB_CLIENT_IS_DEAD(w);
2007 w->stats_sent_bytes += bytes;
2009 // enable sending immediately if we have data
2010 if(w->response.data->len) w->wait_send = 1;
2011 else w->wait_send = 0;
2015 case WEB_CLIENT_MODE_OPTIONS:
2016 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2019 case WEB_CLIENT_MODE_NORMAL:
2020 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2023 case WEB_CLIENT_MODE_FILECOPY:
2024 if(w->response.rlen) {
2025 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2026 w->wait_receive = 1;
2029 // utilize the kernel sendfile() for copying the file to the socket.
2030 // this block of code can be commented, without anything missing.
2031 // when it is commented, the program will copy the data using async I/O.
2033 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2034 if(len != w->response.data->rbytes)
2035 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2037 web_client_reset(w);
2042 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2046 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2051 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2053 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2055 sprintf(buf, "%zX\r\n", len);
2057 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2059 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2060 w->stats_sent_bytes += bytes;
2063 else if(bytes == 0) {
2064 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2065 WEB_CLIENT_IS_DEAD(w);
2068 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2069 WEB_CLIENT_IS_DEAD(w);
2075 ssize_t web_client_send_chunk_close(struct web_client *w)
2077 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2079 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2081 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2082 w->stats_sent_bytes += bytes;
2085 else if(bytes == 0) {
2086 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2087 WEB_CLIENT_IS_DEAD(w);
2090 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2091 WEB_CLIENT_IS_DEAD(w);
2097 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2099 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2101 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2103 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2104 w->stats_sent_bytes += bytes;
2107 else if(bytes == 0) {
2108 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2109 WEB_CLIENT_IS_DEAD(w);
2112 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2113 WEB_CLIENT_IS_DEAD(w);
2119 #ifdef NETDATA_WITH_ZLIB
2120 ssize_t web_client_send_deflate(struct web_client *w)
2122 ssize_t len = 0, t = 0;
2124 // when using compression,
2125 // w->response.sent is the amount of bytes passed through compression
2127 debug(D_DEFLATE, "%llu: web_client_send_deflate(): w->response.data->len = %zu, w->response.sent = %zu, w->response.zhave = %zu, w->response.zsent = %zu, w->response.zstream.avail_in = %u, w->response.zstream.avail_out = %u, w->response.zstream.total_in = %lu, w->response.zstream.total_out = %lu.",
2128 w->id, w->response.data->len, w->response.sent, w->response.zhave, w->response.zsent, w->response.zstream.avail_in, w->response.zstream.avail_out, w->response.zstream.total_in, w->response.zstream.total_out);
2130 if(w->response.data->len - w->response.sent == 0 && w->response.zstream.avail_in == 0 && w->response.zhave == w->response.zsent && w->response.zstream.avail_out != 0) {
2131 // there is nothing to send
2133 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2135 // finalize the chunk
2136 if(w->response.sent != 0) {
2137 t = web_client_send_chunk_finalize(w);
2141 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2142 // we have to wait, more data will come
2143 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2148 if(unlikely(!w->keepalive)) {
2149 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2150 WEB_CLIENT_IS_DEAD(w);
2155 web_client_reset(w);
2156 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2160 if(w->response.zhave == w->response.zsent) {
2161 // compress more input data
2163 // close the previous open chunk
2164 if(w->response.sent != 0) {
2165 t = web_client_send_chunk_close(w);
2169 debug(D_DEFLATE, "%llu: Compressing %zu new bytes starting from %zu (and %u left behind).", w->id, (w->response.data->len - w->response.sent), w->response.sent, w->response.zstream.avail_in);
2171 // give the compressor all the data not passed through the compressor yet
2172 if(w->response.data->len > w->response.sent) {
2173 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2174 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2177 // reset the compressor output buffer
2178 w->response.zstream.next_out = w->response.zbuffer;
2179 w->response.zstream.avail_out = ZLIB_CHUNK;
2181 // ask for FINISH if we have all the input
2182 int flush = Z_SYNC_FLUSH;
2183 if(w->mode == WEB_CLIENT_MODE_NORMAL
2184 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2186 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2189 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2193 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2194 error("%llu: Compression failed. Closing down client.", w->id);
2195 web_client_reset(w);
2199 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2200 w->response.zsent = 0;
2202 // keep track of the bytes passed through the compressor
2203 w->response.sent = w->response.data->len;
2205 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2208 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2209 if(t2 < 0) return t2;
2213 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2215 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2217 w->stats_sent_bytes += len;
2218 w->response.zsent += len;
2220 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2223 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2224 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2226 WEB_CLIENT_IS_DEAD(w);
2229 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2230 WEB_CLIENT_IS_DEAD(w);
2235 #endif // NETDATA_WITH_ZLIB
2237 ssize_t web_client_send(struct web_client *w) {
2238 #ifdef NETDATA_WITH_ZLIB
2239 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2240 #endif // NETDATA_WITH_ZLIB
2244 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2245 // there is nothing to send
2247 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2249 // there can be two cases for this
2250 // A. we have done everything
2251 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2253 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2254 // we have to wait, more data will come
2255 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2260 if(unlikely(!w->keepalive)) {
2261 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2262 WEB_CLIENT_IS_DEAD(w);
2266 web_client_reset(w);
2267 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2271 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2272 if(likely(bytes > 0)) {
2273 w->stats_sent_bytes += bytes;
2274 w->response.sent += bytes;
2275 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2277 else if(likely(bytes == 0)) {
2278 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2279 WEB_CLIENT_IS_DEAD(w);
2282 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2283 WEB_CLIENT_IS_DEAD(w);
2289 ssize_t web_client_receive(struct web_client *w)
2291 // do we have any space for more data?
2292 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2294 ssize_t left = w->response.data->size - w->response.data->len;
2297 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2298 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2300 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2302 if(likely(bytes > 0)) {
2303 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2304 w->stats_received_bytes += bytes;
2306 size_t old = w->response.data->len;
2307 w->response.data->len += bytes;
2308 w->response.data->buffer[w->response.data->len] = '\0';
2310 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2311 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2313 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2316 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2317 w->wait_receive = 0;
2320 else if(likely(bytes == 0)) {
2321 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2323 // if we cannot read, it means we have an error on input.
2324 // if however, we are copying a file from ifd to ofd, we should not return an error.
2325 // in this case, the error should be generated when the file has been sent to the client.
2327 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2328 // we are copying data from ifd to ofd
2329 // let it finish copying...
2330 w->wait_receive = 0;
2332 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2333 if(w->ifd != w->ofd) close(w->ifd);
2337 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2338 WEB_CLIENT_IS_DEAD(w);
2342 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2343 WEB_CLIENT_IS_DEAD(w);
2350 // --------------------------------------------------------------------------------------
2351 // the thread of a single client
2353 // 1. waits for input and output, using async I/O
2354 // 2. it processes HTTP requests
2355 // 3. it generates HTTP responses
2356 // 4. it copies data from input to output if mode is FILECOPY
2358 void *web_client_main(void *ptr)
2360 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2361 error("Cannot set pthread cancel type to DEFERRED.");
2363 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2364 error("Cannot set pthread cancel state to ENABLE.");
2366 struct web_client *w = ptr;
2367 struct pollfd fds[2], *ifd, *ofd;
2368 int retval, fdmax = 0, timeout;
2370 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2373 if(unlikely(w->dead)) {
2374 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2377 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2378 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2382 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2383 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2387 if(w->ifd == w->ofd) {
2392 if(w->wait_receive) fds[0].events |= POLLIN;
2393 if(w->wait_send) fds[0].events |= POLLOUT;
2399 ifd = ofd = &fds[0];
2407 if(w->wait_receive) fds[0].events |= POLLIN;
2413 if(w->wait_send) fds[1].events |= POLLOUT;
2419 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2421 timeout = web_client_timeout * 1000;
2422 retval = poll(fds, fdmax, timeout);
2424 if(unlikely(retval == -1)) {
2425 if(errno == EAGAIN || errno == EINTR) {
2426 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2430 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2433 else if(unlikely(!retval)) {
2434 debug(D_WEB_CLIENT, "%llu: Timeout while waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2439 if(w->wait_send && ofd->revents & POLLOUT) {
2441 if(web_client_send(w) < 0) {
2442 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2447 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2449 if(web_client_receive(w) < 0) {
2450 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2454 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2455 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2456 web_client_process(w);
2460 if(unlikely(!used)) {
2461 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2466 web_client_reset(w);
2468 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2469 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2471 // close the sockets/files now
2472 // to free file descriptors
2473 if(w->ifd == w->ofd) {
2474 if(w->ifd != -1) close(w->ifd);
2477 if(w->ifd != -1) close(w->ifd);
2478 if(w->ofd != -1) close(w->ofd);