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 web_client_connected();
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 finished_web_request_statistics(usec_dt(&tv, &w->tv_in),
140 w->stats_received_bytes,
145 w->stats_received_bytes = 0;
146 w->stats_sent_bytes = 0;
149 // --------------------------------------------------------------------
152 log_access("%llu: (sent/all = %zu/%zu bytes %0.0f%%, prep/sent/total = %0.2f/%0.2f/%0.2f ms) %s: %d '%s'",
154 sent, size, -((size > 0) ? ((size - sent) / (double) size * 100.0) : 0.0),
155 usec_dt(&w->tv_ready, &w->tv_in) / 1000.0,
156 usec_dt(&tv, &w->tv_ready) / 1000.0,
157 usec_dt(&tv, &w->tv_in) / 1000.0,
158 (w->mode == WEB_CLIENT_MODE_FILECOPY) ? "filecopy" : ((w->mode == WEB_CLIENT_MODE_OPTIONS)
159 ? "options" : "data"),
165 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY)) {
166 if(w->ifd != w->ofd) {
167 debug(D_WEB_CLIENT, "%llu: Closing filecopy input file descriptor %d.", w->id, w->ifd);
168 if(w->ifd != -1) close(w->ifd);
173 w->last_url[0] = '\0';
174 w->cookie1[0] = '\0';
175 w->cookie2[0] = '\0';
179 w->mode = WEB_CLIENT_MODE_NORMAL;
183 w->tracking_required = 0;
185 w->decoded_url[0] = '\0';
187 buffer_reset(w->response.header_output);
188 buffer_reset(w->response.header);
189 buffer_reset(w->response.data);
190 w->response.rlen = 0;
191 w->response.sent = 0;
192 w->response.code = 0;
197 w->response.zoutput = 0;
199 // if we had enabled compression, release it
200 #ifdef NETDATA_WITH_ZLIB
201 if(w->response.zinitialized) {
202 debug(D_DEFLATE, "%llu: Freeing compression resources.", w->id);
203 deflateEnd(&w->response.zstream);
204 w->response.zsent = 0;
205 w->response.zhave = 0;
206 w->response.zstream.avail_in = 0;
207 w->response.zstream.avail_out = 0;
208 w->response.zstream.total_in = 0;
209 w->response.zstream.total_out = 0;
210 w->response.zinitialized = 0;
212 #endif // NETDATA_WITH_ZLIB
215 struct web_client *web_client_free(struct web_client *w) {
218 struct web_client *n = w->next;
219 if(w == web_clients) web_clients = n;
221 debug(D_WEB_CLIENT_ACCESS, "%llu: Closing web client from %s port %s.", w->id, w->client_ip, w->client_port);
223 if(w->prev) w->prev->next = w->next;
224 if(w->next) w->next->prev = w->prev;
225 if(w->response.header_output) buffer_free(w->response.header_output);
226 if(w->response.header) buffer_free(w->response.header);
227 if(w->response.data) buffer_free(w->response.data);
228 if(w->ifd != -1) close(w->ifd);
229 if(w->ofd != -1 && w->ofd != w->ifd) close(w->ofd);
232 web_client_disconnected();
237 uid_t web_files_uid(void) {
238 static char *web_owner = NULL;
239 static uid_t owner_uid = 0;
241 if(unlikely(!web_owner)) {
242 web_owner = config_get("global", "web files owner", config_get("global", "run as user", ""));
243 if(!web_owner || !*web_owner)
244 owner_uid = geteuid();
246 // getpwnam() is not thread safe,
247 // but we have called this function once
248 // while single threaded
249 struct passwd *pw = getpwnam(web_owner);
251 error("User '%s' is not present. Ignoring option.", web_owner);
252 owner_uid = geteuid();
255 debug(D_WEB_CLIENT, "Web files owner set to %s.", web_owner);
256 owner_uid = pw->pw_uid;
264 gid_t web_files_gid(void) {
265 static char *web_group = NULL;
266 static gid_t owner_gid = 0;
268 if(unlikely(!web_group)) {
269 web_group = config_get("global", "web files group", config_get("global", "web files owner", ""));
270 if(!web_group || !*web_group)
271 owner_gid = getegid();
273 // getgrnam() is not thread safe,
274 // but we have called this function once
275 // while single threaded
276 struct group *gr = getgrnam(web_group);
278 error("Group '%s' is not present. Ignoring option.", web_group);
279 owner_gid = getegid();
282 debug(D_WEB_CLIENT, "Web files group set to %s.", web_group);
283 owner_gid = gr->gr_gid;
291 int mysendfile(struct web_client *w, char *filename)
293 static char *web_dir = NULL;
295 // initialize our static data
296 if(unlikely(!web_dir)) web_dir = config_get("global", "web files directory", WEB_DIR);
298 debug(D_WEB_CLIENT, "%llu: Looking for file '%s/%s'", w->id, web_dir, filename);
300 // skip leading slashes
301 while (*filename == '/') filename++;
303 // if the filename contain known paths, skip them
304 if(strncmp(filename, WEB_PATH_FILE "/", strlen(WEB_PATH_FILE) + 1) == 0)
305 filename = &filename[strlen(WEB_PATH_FILE) + 1];
308 for(s = filename; *s ;s++) {
309 if( !isalnum(*s) && *s != '/' && *s != '.' && *s != '-' && *s != '_') {
310 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
311 buffer_sprintf(w->response.data, "File '%s' cannot be served. Filename contains invalid character '%c'", filename, *s);
316 // if the filename contains a .. refuse to serve it
317 if(strstr(filename, "..") != 0) {
318 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
319 buffer_sprintf(w->response.data, "File '%s' cannot be served. Relative filenames with '..' in them are not supported.", filename);
324 char webfilename[FILENAME_MAX + 1];
325 snprintfz(webfilename, FILENAME_MAX, "%s/%s", web_dir, filename);
327 // check if the file exists
329 if(lstat(webfilename, &stat) != 0) {
330 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
331 buffer_sprintf(w->response.data, "File '%s' does not exist, or is not accessible.", webfilename);
335 // check if the file is owned by expected user
336 if(stat.st_uid != web_files_uid()) {
337 error("%llu: File '%s' is owned by user %u (expected user %u). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
338 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
342 // check if the file is owned by expected group
343 if(stat.st_gid != web_files_gid()) {
344 error("%llu: File '%s' is owned by group %u (expected group %u). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
345 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
349 if((stat.st_mode & S_IFMT) == S_IFDIR) {
350 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
351 return mysendfile(w, webfilename);
354 if((stat.st_mode & S_IFMT) != S_IFREG) {
355 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
356 buffer_sprintf(w->response.data, "Access to file '%s' is not permitted.", webfilename);
361 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
365 if(errno == EBUSY || errno == EAGAIN) {
366 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
367 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
368 buffer_sprintf(w->response.data, "The file '%s' is currently busy. Please try again later.", webfilename);
372 error("%llu: Cannot open file '%s'.", w->id, webfilename);
373 buffer_sprintf(w->response.data, "Cannot open file '%s'.", webfilename);
377 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
378 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, webfilename);
380 // pick a Content-Type for the file
381 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
382 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
383 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
384 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
385 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
386 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
387 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
388 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
389 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
390 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
391 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
392 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
393 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
394 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
395 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
396 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
397 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
398 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
399 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
400 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
402 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);
404 w->mode = WEB_CLIENT_MODE_FILECOPY;
407 buffer_flush(w->response.data);
408 w->response.rlen = stat.st_size;
409 w->response.data->date = stat.st_mtim.tv_sec;
415 #ifdef NETDATA_WITH_ZLIB
416 void web_client_enable_deflate(struct web_client *w, int gzip) {
417 if(unlikely(w->response.zinitialized)) {
418 error("%llu: Compression has already be initialized for this client.", w->id);
422 if(unlikely(w->response.sent)) {
423 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
427 w->response.zstream.zalloc = Z_NULL;
428 w->response.zstream.zfree = Z_NULL;
429 w->response.zstream.opaque = Z_NULL;
431 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
432 w->response.zstream.avail_in = 0;
433 w->response.zstream.total_in = 0;
435 w->response.zstream.next_out = w->response.zbuffer;
436 w->response.zstream.avail_out = 0;
437 w->response.zstream.total_out = 0;
439 w->response.zstream.zalloc = Z_NULL;
440 w->response.zstream.zfree = Z_NULL;
441 w->response.zstream.opaque = Z_NULL;
443 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
444 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
448 // Select GZIP compression: windowbits = 15 + 16 = 31
449 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
450 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
454 w->response.zsent = 0;
455 w->response.zoutput = 1;
456 w->response.zinitialized = 1;
458 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
460 #endif // NETDATA_WITH_ZLIB
462 uint32_t web_client_api_request_v1_data_options(char *o)
464 uint32_t ret = 0x00000000;
467 while(o && *o && (tok = mystrsep(&o, ", |"))) {
470 if(!strcmp(tok, "nonzero"))
471 ret |= RRDR_OPTION_NONZERO;
472 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
473 ret |= RRDR_OPTION_REVERSED;
474 else if(!strcmp(tok, "jsonwrap"))
475 ret |= RRDR_OPTION_JSON_WRAP;
476 else if(!strcmp(tok, "min2max"))
477 ret |= RRDR_OPTION_MIN2MAX;
478 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
479 ret |= RRDR_OPTION_MILLISECONDS;
480 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
481 ret |= RRDR_OPTION_ABSOLUTE;
482 else if(!strcmp(tok, "seconds"))
483 ret |= RRDR_OPTION_SECONDS;
484 else if(!strcmp(tok, "null2zero"))
485 ret |= RRDR_OPTION_NULL2ZERO;
486 else if(!strcmp(tok, "objectrows"))
487 ret |= RRDR_OPTION_OBJECTSROWS;
488 else if(!strcmp(tok, "google_json"))
489 ret |= RRDR_OPTION_GOOGLE_JSON;
490 else if(!strcmp(tok, "percentage"))
491 ret |= RRDR_OPTION_PERCENTAGE;
492 else if(!strcmp(tok, "unaligned"))
493 ret |= RRDR_OPTION_NOT_ALIGNED;
499 uint32_t web_client_api_request_v1_data_format(char *name)
501 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
502 return DATASOURCE_DATATABLE_JSON;
504 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
505 return DATASOURCE_DATATABLE_JSONP;
507 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
508 return DATASOURCE_JSON;
510 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
511 return DATASOURCE_JSONP;
513 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
514 return DATASOURCE_SSV;
516 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
517 return DATASOURCE_CSV;
519 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
520 return DATASOURCE_TSV;
522 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
523 return DATASOURCE_HTML;
525 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
526 return DATASOURCE_JS_ARRAY;
528 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
529 return DATASOURCE_SSV_COMMA;
531 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
532 return DATASOURCE_CSV_JSON_ARRAY;
534 return DATASOURCE_JSON;
537 uint32_t web_client_api_request_v1_data_google_format(char *name)
539 if(!strcmp(name, "json"))
540 return DATASOURCE_DATATABLE_JSONP;
542 else if(!strcmp(name, "html"))
543 return DATASOURCE_HTML;
545 else if(!strcmp(name, "csv"))
546 return DATASOURCE_CSV;
548 else if(!strcmp(name, "tsv-excel"))
549 return DATASOURCE_TSV;
551 return DATASOURCE_JSON;
554 int web_client_api_request_v1_data_group(char *name, int def)
556 if(!strcmp(name, "max"))
559 else if(!strcmp(name, "average"))
560 return GROUP_AVERAGE;
562 else if(!strcmp(name, "sum"))
565 else if(!strcmp(name, "incremental-sum"))
566 return GROUP_INCREMENTAL_SUM;
571 int web_client_api_request_v1_charts(struct web_client *w, char *url)
575 buffer_flush(w->response.data);
576 w->response.data->contenttype = CT_APPLICATION_JSON;
577 rrd_stats_api_v1_charts(w->response.data);
581 int web_client_api_request_v1_chart(struct web_client *w, char *url)
586 buffer_flush(w->response.data);
589 char *value = mystrsep(&url, "?&[]");
590 if(!value || !*value) continue;
592 char *name = mystrsep(&value, "=");
593 if(!name || !*name) continue;
594 if(!value || !*value) continue;
596 // name and value are now the parameters
597 // they are not null and not empty
599 if(!strcmp(name, "chart")) chart = value;
601 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
606 if(!chart || !*chart) {
607 buffer_sprintf(w->response.data, "No chart id is given at the request.");
611 RRDSET *st = rrdset_find(chart);
612 if(!st) st = rrdset_find_byname(chart);
614 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
619 w->response.data->contenttype = CT_APPLICATION_JSON;
620 rrd_stats_api_v1_chart(st, w->response.data);
627 int web_client_api_v1_badge(struct web_client *w, char *url) {
629 buffer_flush(w->response.data);
631 BUFFER *dimensions = NULL;
633 const char *chart = NULL
637 , *multiply_str = NULL
641 , *label_color = NULL
642 , *value_color = NULL
643 , *refresh_str = NULL
644 , *precision_str = NULL;
646 int group = GROUP_AVERAGE;
647 uint32_t options = 0x00000000;
650 char *value = mystrsep(&url, "/?&[]");
651 if(!value || !*value) continue;
653 char *name = mystrsep(&value, "=");
654 if(!name || !*name) continue;
655 if(!value || !*value) continue;
657 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
659 // name and value are now the parameters
660 // they are not null and not empty
662 if(!strcmp(name, "chart")) chart = value;
663 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
665 dimensions = buffer_create(100);
667 buffer_strcat(dimensions, "|");
668 buffer_strcat(dimensions, value);
670 else if(!strcmp(name, "after")) after_str = value;
671 else if(!strcmp(name, "before")) before_str = value;
672 else if(!strcmp(name, "points")) points_str = value;
673 else if(!strcmp(name, "group")) {
674 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
676 else if(!strcmp(name, "options")) {
677 options |= web_client_api_request_v1_data_options(value);
679 else if(!strcmp(name, "label")) label = value;
680 else if(!strcmp(name, "units")) units = value;
681 else if(!strcmp(name, "label_color")) label_color = value;
682 else if(!strcmp(name, "value_color")) value_color = value;
683 else if(!strcmp(name, "multiply")) multiply_str = value;
684 else if(!strcmp(name, "divide")) divide_str = value;
685 else if(!strcmp(name, "refresh")) refresh_str = value;
686 else if(!strcmp(name, "precision")) precision_str = value;
689 if(!chart || !*chart) {
690 buffer_sprintf(w->response.data, "No chart id is given at the request.");
694 RRDSET *st = rrdset_find(chart);
695 if(!st) st = rrdset_find_byname(chart);
697 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
702 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
703 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
704 long long before = (before_str && *before_str )?atol(before_str):0;
705 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
706 int points = (points_str && *points_str )?atoi(points_str):1;
707 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
709 if(!multiply) multiply = 1;
710 if(!divide) divide = 1;
713 if(refresh_str && *refresh_str) {
714 if(!strcmp(refresh_str, "auto")) {
715 if(options & RRDR_OPTION_NOT_ALIGNED)
716 refresh = st->update_every;
718 refresh = (before - after);
719 if(refresh < 0) refresh = -refresh;
723 refresh = atoi(refresh_str);
724 if(refresh < 0) refresh = -refresh;
730 const char *dim = buffer_tostring(dimensions);
731 if(*dim == '|') dim++;
738 if(options & RRDR_OPTION_PERCENTAGE)
744 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'"
747 , (dimensions)?buffer_tostring(dimensions):""
755 time_t latest_timestamp = 0;
756 int value_is_null = 1;
757 calculated_number n = 0;
760 // if the collected value is too old, don't calculate its value
761 if(rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
762 ret = rrd2value(st, w->response.data, &n, (dimensions)?buffer_tostring(dimensions):NULL, points, after, before, group, options, &latest_timestamp, &value_is_null);
764 // if the value cannot be calculated, show empty badge
771 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
774 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null, precision);
778 buffer_free(dimensions);
782 // returns the HTTP code
783 int web_client_api_request_v1_data(struct web_client *w, char *url)
785 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
788 BUFFER *dimensions = NULL;
790 buffer_flush(w->response.data);
792 char *google_version = "0.6",
795 *google_out = "json",
796 *responseHandler = NULL,
799 time_t last_timestamp_in_data = 0, google_timestamp = 0;
804 , *points_str = NULL;
806 int group = GROUP_AVERAGE;
807 uint32_t format = DATASOURCE_JSON;
808 uint32_t options = 0x00000000;
811 char *value = mystrsep(&url, "?&[]");
812 if(!value || !*value) continue;
814 char *name = mystrsep(&value, "=");
815 if(!name || !*name) continue;
816 if(!value || !*value) continue;
818 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
820 // name and value are now the parameters
821 // they are not null and not empty
823 if(!strcmp(name, "chart")) chart = value;
824 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
825 if(!dimensions) dimensions = buffer_create(100);
826 buffer_strcat(dimensions, "|");
827 buffer_strcat(dimensions, value);
829 else if(!strcmp(name, "after")) after_str = value;
830 else if(!strcmp(name, "before")) before_str = value;
831 else if(!strcmp(name, "points")) points_str = value;
832 else if(!strcmp(name, "group")) {
833 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
835 else if(!strcmp(name, "format")) {
836 format = web_client_api_request_v1_data_format(value);
838 else if(!strcmp(name, "options")) {
839 options |= web_client_api_request_v1_data_options(value);
841 else if(!strcmp(name, "callback")) {
842 responseHandler = value;
844 else if(!strcmp(name, "filename")) {
847 else if(!strcmp(name, "tqx")) {
848 // parse Google Visualization API options
849 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
850 char *tqx_name, *tqx_value;
853 tqx_value = mystrsep(&value, ";");
854 if(!tqx_value || !*tqx_value) continue;
856 tqx_name = mystrsep(&tqx_value, ":");
857 if(!tqx_name || !*tqx_name) continue;
858 if(!tqx_value || !*tqx_value) continue;
860 if(!strcmp(tqx_name, "version"))
861 google_version = tqx_value;
862 else if(!strcmp(tqx_name, "reqId"))
863 google_reqId = tqx_value;
864 else if(!strcmp(tqx_name, "sig")) {
865 google_sig = tqx_value;
866 google_timestamp = strtoul(google_sig, NULL, 0);
868 else if(!strcmp(tqx_name, "out")) {
869 google_out = tqx_value;
870 format = web_client_api_request_v1_data_google_format(google_out);
872 else if(!strcmp(tqx_name, "responseHandler"))
873 responseHandler = tqx_value;
874 else if(!strcmp(tqx_name, "outFileName"))
875 outFileName = tqx_value;
880 if(!chart || !*chart) {
881 buffer_sprintf(w->response.data, "No chart id is given at the request.");
885 RRDSET *st = rrdset_find(chart);
886 if(!st) st = rrdset_find_byname(chart);
888 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
893 long long before = (before_str && *before_str)?atol(before_str):0;
894 long long after = (after_str && *after_str) ?atol(after_str):0;
895 int points = (points_str && *points_str)?atoi(points_str):0;
897 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'"
900 , (dimensions)?buffer_tostring(dimensions):""
909 if(outFileName && *outFileName) {
910 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
911 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
914 if(format == DATASOURCE_DATATABLE_JSONP) {
915 if(responseHandler == NULL)
916 responseHandler = "google.visualization.Query.setResponse";
918 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
919 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
922 buffer_sprintf(w->response.data,
923 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
924 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
926 else if(format == DATASOURCE_JSONP) {
927 if(responseHandler == NULL)
928 responseHandler = "callback";
930 buffer_strcat(w->response.data, responseHandler);
931 buffer_strcat(w->response.data, "(");
934 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
936 if(format == DATASOURCE_DATATABLE_JSONP) {
937 if(google_timestamp < last_timestamp_in_data)
938 buffer_strcat(w->response.data, "});");
941 // the client already has the latest data
942 buffer_flush(w->response.data);
943 buffer_sprintf(w->response.data,
944 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
945 responseHandler, google_version, google_reqId);
948 else if(format == DATASOURCE_JSONP)
949 buffer_strcat(w->response.data, ");");
952 if(dimensions) buffer_free(dimensions);
956 int web_client_api_request_v1_registry(struct web_client *w, char *url)
958 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
959 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
960 hash_to = 0 /*, hash_redirects = 0 */;
962 if(unlikely(!hash_action)) {
963 hash_action = simple_hash("action");
964 hash_access = simple_hash("access");
965 hash_hello = simple_hash("hello");
966 hash_delete = simple_hash("delete");
967 hash_search = simple_hash("search");
968 hash_switch = simple_hash("switch");
969 hash_machine = simple_hash("machine");
970 hash_url = simple_hash("url");
971 hash_name = simple_hash("name");
972 hash_delete_url = simple_hash("delete_url");
973 hash_for = simple_hash("for");
974 hash_to = simple_hash("to");
976 hash_redirects = simple_hash("redirects");
980 char person_guid[36 + 1] = "";
982 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
985 // The browser may send multiple cookies with our id
987 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
989 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
992 char *machine_guid = NULL,
995 *search_machine_guid = NULL,
997 *to_person_guid = NULL;
1003 char *value = mystrsep(&url, "?&[]");
1004 if (!value || !*value) continue;
1006 char *name = mystrsep(&value, "=");
1007 if (!name || !*name) continue;
1008 if (!value || !*value) continue;
1010 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1012 uint32_t hash = simple_hash(name);
1014 if(hash == hash_action && !strcmp(name, "action")) {
1015 uint32_t vhash = simple_hash(value);
1017 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1018 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1019 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1020 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1021 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1022 #ifdef NETDATA_INTERNAL_CHECKS
1023 else error("unknown registry action '%s'", value);
1024 #endif /* NETDATA_INTERNAL_CHECKS */
1027 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1028 redirects = atoi(value);
1030 else if(hash == hash_machine && !strcmp(name, "machine"))
1031 machine_guid = value;
1033 else if(hash == hash_url && !strcmp(name, "url"))
1034 machine_url = value;
1036 else if(action == 'A') {
1037 if(hash == hash_name && !strcmp(name, "name"))
1040 else if(action == 'D') {
1041 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1044 else if(action == 'S') {
1045 if(hash == hash_for && !strcmp(name, "for"))
1046 search_machine_guid = value;
1048 else if(action == 'W') {
1049 if(hash == hash_to && !strcmp(name, "to"))
1050 to_person_guid = value;
1052 #ifdef NETDATA_INTERNAL_CHECKS
1053 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1054 #endif /* NETDATA_INTERNAL_CHECKS */
1057 if(web_donotrack_comply && w->donottrack) {
1058 buffer_flush(w->response.data);
1059 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.");
1063 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1064 buffer_flush(w->response.data);
1065 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1066 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1069 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1070 buffer_flush(w->response.data);
1071 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1072 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1075 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1076 buffer_flush(w->response.data);
1077 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1078 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1081 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1082 buffer_flush(w->response.data);
1083 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1084 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1090 w->tracking_required = 1;
1091 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1092 buffer_flush(w->response.data);
1094 registry_set_cookie(w, "give-me-back-this-cookie-please");
1095 w->response.data->contenttype = CT_APPLICATION_JSON;
1096 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1100 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1101 * under certain conditions, when using CORS
1102 * so this is commented and we use application level redirects instead
1106 if(redirects > registry_verify_cookies_redirects()) {
1107 buffer_flush(w->response.data);
1108 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1112 char *encoded_url = url_encode(machine_url);
1114 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1118 char *encoded_name = url_encode(url_name);
1121 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1125 char *encoded_guid = url_encode(machine_guid);
1129 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1133 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1134 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1142 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1145 w->tracking_required = 1;
1146 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1149 w->tracking_required = 1;
1150 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1153 w->tracking_required = 1;
1154 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1157 return registry_request_hello_json(w);
1160 buffer_flush(w->response.data);
1161 buffer_sprintf(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1165 buffer_flush(w->response.data);
1166 buffer_sprintf(w->response.data, "Invalid or no registry action.");
1170 int web_client_api_request_v1(struct web_client *w, char *url) {
1171 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0;
1173 if(unlikely(hash_data == 0)) {
1174 hash_data = simple_hash("data");
1175 hash_chart = simple_hash("chart");
1176 hash_charts = simple_hash("charts");
1177 hash_registry = simple_hash("registry");
1178 hash_badge = simple_hash("badge.svg");
1182 char *tok = mystrsep(&url, "/?&");
1184 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1185 uint32_t hash = simple_hash(tok);
1187 if(hash == hash_data && !strcmp(tok, "data"))
1188 return web_client_api_request_v1_data(w, url);
1190 else if(hash == hash_chart && !strcmp(tok, "chart"))
1191 return web_client_api_request_v1_chart(w, url);
1193 else if(hash == hash_charts && !strcmp(tok, "charts"))
1194 return web_client_api_request_v1_charts(w, url);
1196 else if(hash == hash_registry && !strcmp(tok, "registry"))
1197 return web_client_api_request_v1_registry(w, url);
1199 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1200 return web_client_api_v1_badge(w, url);
1203 buffer_flush(w->response.data);
1204 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1209 buffer_flush(w->response.data);
1210 buffer_sprintf(w->response.data, "API v1 command?");
1215 int web_client_api_request(struct web_client *w, char *url)
1217 // get the api version
1218 char *tok = mystrsep(&url, "/?&");
1220 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1221 if(strcmp(tok, "v1") == 0)
1222 return web_client_api_request_v1(w, url);
1224 buffer_flush(w->response.data);
1225 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1230 buffer_flush(w->response.data);
1231 buffer_sprintf(w->response.data, "Which API version?");
1236 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1240 char *args = strchr(url, '?');
1246 // get the name of the data to show
1247 char *tok = mystrsep(&url, "/");
1250 // do we have such a data set?
1252 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1253 st = rrdset_find_byname(tok);
1254 if(!st) st = rrdset_find(tok);
1259 // try to send a file with that name
1260 buffer_flush(w->response.data);
1261 return(mysendfile(w, tok));
1265 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1267 // how many entries does the client want?
1268 int lines = rrd_default_history_entries;
1269 int group_count = 1;
1270 time_t after = 0, before = 0;
1271 int group_method = GROUP_AVERAGE;
1275 // parse the lines required
1276 tok = mystrsep(&url, "/");
1277 if(tok) lines = atoi(tok);
1278 if(lines < 1) lines = 1;
1281 // parse the group count required
1282 tok = mystrsep(&url, "/");
1283 if(tok && *tok) group_count = atoi(tok);
1284 if(group_count < 1) group_count = 1;
1285 //if(group_count > save_history / 20) group_count = save_history / 20;
1288 // parse the grouping method required
1289 tok = mystrsep(&url, "/");
1291 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1292 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1293 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1294 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1299 tok = mystrsep(&url, "/");
1300 if(tok && *tok) after = strtoul(tok, NULL, 10);
1301 if(after < 0) after = 0;
1304 // parse before time
1305 tok = mystrsep(&url, "/");
1306 if(tok && *tok) before = strtoul(tok, NULL, 10);
1307 if(before < 0) before = 0;
1311 tok = mystrsep(&url, "/");
1312 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1315 w->response.data->contenttype = CT_APPLICATION_JSON;
1316 buffer_flush(w->response.data);
1318 char *google_version = "0.6";
1319 char *google_reqId = "0";
1320 char *google_sig = "0";
1321 char *google_out = "json";
1322 char *google_responseHandler = "google.visualization.Query.setResponse";
1323 char *google_outFileName = NULL;
1324 time_t last_timestamp_in_data = 0;
1325 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1327 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1330 tok = mystrsep(&args, "&");
1332 char *name = mystrsep(&tok, "=");
1333 if(name && *name && strcmp(name, "tqx") == 0) {
1334 char *key = mystrsep(&tok, ":");
1335 char *value = mystrsep(&tok, ";");
1336 if(key && value && *key && *value) {
1337 if(strcmp(key, "version") == 0)
1338 google_version = value;
1340 else if(strcmp(key, "reqId") == 0)
1341 google_reqId = value;
1343 else if(strcmp(key, "sig") == 0)
1346 else if(strcmp(key, "out") == 0)
1349 else if(strcmp(key, "responseHandler") == 0)
1350 google_responseHandler = value;
1352 else if(strcmp(key, "outFileName") == 0)
1353 google_outFileName = value;
1359 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1360 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1363 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1364 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1366 // check the client wants json
1367 if(strcmp(google_out, "json") != 0) {
1368 buffer_sprintf(w->response.data,
1369 "%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.'}]});",
1370 google_responseHandler, google_version, google_reqId, google_out);
1376 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1377 buffer_sprintf(w->response.data,
1378 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1379 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1382 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1383 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1385 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);
1387 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1388 if(timestamp_in_data > last_timestamp_in_data)
1389 buffer_strcat(w->response.data, "});");
1392 // the client already has the latest data
1393 buffer_flush(w->response.data);
1394 buffer_sprintf(w->response.data,
1395 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1396 google_responseHandler, google_version, google_reqId);
1403 const char *web_content_type_to_string(uint8_t contenttype) {
1404 switch(contenttype) {
1406 return "text/html; charset=utf-8";
1408 case CT_APPLICATION_XML:
1409 return "application/xml; charset=utf-8";
1411 case CT_APPLICATION_JSON:
1412 return "application/json; charset=utf-8";
1414 case CT_APPLICATION_X_JAVASCRIPT:
1415 return "application/x-javascript; charset=utf-8";
1418 return "text/css; charset=utf-8";
1421 return "text/xml; charset=utf-8";
1424 return "text/xsl; charset=utf-8";
1426 case CT_APPLICATION_OCTET_STREAM:
1427 return "application/octet-stream";
1429 case CT_IMAGE_SVG_XML:
1430 return "image/svg+xml";
1432 case CT_APPLICATION_X_FONT_TRUETYPE:
1433 return "application/x-font-truetype";
1435 case CT_APPLICATION_X_FONT_OPENTYPE:
1436 return "application/x-font-opentype";
1438 case CT_APPLICATION_FONT_WOFF:
1439 return "application/font-woff";
1441 case CT_APPLICATION_FONT_WOFF2:
1442 return "application/font-woff2";
1444 case CT_APPLICATION_VND_MS_FONTOBJ:
1445 return "application/vnd.ms-fontobject";
1451 return "image/jpeg";
1456 case CT_IMAGE_XICON:
1457 return "image/x-icon";
1463 return "image/icns";
1467 return "text/plain; charset=utf-8";
1472 const char *web_response_code_to_string(int code) {
1478 return "Temporary Redirect";
1481 return "Bad Request";
1490 return "Preconditions Failed";
1493 if(code >= 100 && code < 200)
1494 return "Informational";
1496 if(code >= 200 && code < 300)
1497 return "Successful";
1499 if(code >= 300 && code < 400)
1500 return "Redirection";
1502 if(code >= 400 && code < 500)
1503 return "Bad Request";
1505 if(code >= 500 && code < 600)
1506 return "Server Error";
1508 return "Undefined Error";
1512 static inline char *http_header_parse(struct web_client *w, char *s) {
1513 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1515 if(unlikely(!hash_origin)) {
1516 hash_origin = simple_uhash("Origin");
1517 hash_connection = simple_uhash("Connection");
1518 hash_accept_encoding = simple_uhash("Accept-Encoding");
1519 hash_donottrack = simple_uhash("DNT");
1525 while(*e && *e != ':') e++;
1532 char *v = e + 1, *ve;
1534 // skip leading spaces from value
1535 while(*v == ' ') v++;
1539 while(*ve && *ve != '\r') ve++;
1540 if(!*ve || ve[1] != '\n') {
1545 // terminate the value
1548 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1549 uint32_t hash = simple_uhash(s);
1551 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1552 strncpyz(w->origin, v, ORIGIN_MAX);
1554 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1555 if(strcasestr(v, "keep-alive"))
1558 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1559 if(*v == '0') w->donottrack = 0;
1560 else if(*v == '1') w->donottrack = 1;
1562 #ifdef NETDATA_WITH_ZLIB
1563 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1564 if(web_enable_gzip) {
1565 if(strcasestr(v, "gzip"))
1566 web_client_enable_deflate(w, 1);
1568 // does not seem to work
1569 // else if(strcasestr(v, "deflate"))
1570 // web_client_enable_deflate(w, 0);
1573 #endif /* NETDATA_WITH_ZLIB */
1580 // http_request_validate()
1582 // = 0 : all good, process the request
1583 // > 0 : request is not supported
1584 // < 0 : request is incomplete - wait for more data
1586 static inline int http_request_validate(struct web_client *w) {
1587 char *s = w->response.data->buffer, *encoded_url = NULL;
1589 // is is a valid request?
1590 if(!strncmp(s, "GET ", 4)) {
1591 encoded_url = s = &s[4];
1592 w->mode = WEB_CLIENT_MODE_NORMAL;
1594 else if(!strncmp(s, "OPTIONS ", 8)) {
1595 encoded_url = s = &s[8];
1596 w->mode = WEB_CLIENT_MODE_OPTIONS;
1599 w->wait_receive = 0;
1603 // find the SPACE + "HTTP/"
1605 // find the next space
1606 while (*s && *s != ' ') s++;
1608 // is it SPACE + "HTTP/" ?
1609 if(*s && !strncmp(s, " HTTP/", 6)) break;
1613 // incomplete requests
1615 w->wait_receive = 1;
1619 // we have the end of encoded_url - remember it
1622 // make sure we have complete request
1623 // complete requests contain: \r\n\r\n
1626 while(*s && *s++ != '\r');
1628 // did we reach the end?
1629 if(unlikely(!*s)) break;
1632 if(likely(*s++ == '\n')) {
1634 // is it again \r\n ? (header end)
1635 if(unlikely(*s == '\r' && s[1] == '\n')) {
1636 // a valid complete HTTP request found
1639 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1642 // copy the URL - we are going to overwrite parts of it
1643 // FIXME -- we should avoid it
1644 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1646 w->wait_receive = 0;
1650 // another header line
1651 s = http_header_parse(w, s);
1655 // incomplete request
1656 w->wait_receive = 1;
1660 void web_client_process(struct web_client *w) {
1661 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1662 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1665 gettimeofday(&w->tv_in, NULL);
1667 if(unlikely(!hash_api)) {
1668 hash_api = simple_hash("api");
1669 hash_netdata_conf = simple_hash("netdata.conf");
1670 hash_data = simple_hash(WEB_PATH_DATA);
1671 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1672 hash_graph = simple_hash(WEB_PATH_GRAPH);
1673 hash_list = simple_hash("list");
1674 hash_all_json = simple_hash("all.json");
1675 hash_exit = simple_hash("exit");
1676 hash_debug = simple_hash("debug");
1677 hash_mirror = simple_hash("mirror");
1683 int what_to_do = http_request_validate(w);
1685 // wait for more data
1686 if(what_to_do < 0) {
1687 if(w->response.data->len > TOO_BIG_REQUEST) {
1688 strcpy(w->last_url, "too big request");
1690 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1693 buffer_flush(w->response.data);
1694 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1697 // wait for more data
1701 else if(what_to_do > 0) {
1702 // strcpy(w->last_url, "not a valid request");
1704 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1707 buffer_flush(w->response.data);
1708 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1710 else { // what_to_do == 0
1711 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1713 w->response.data->contenttype = CT_TEXT_PLAIN;
1714 buffer_flush(w->response.data);
1715 buffer_strcat(w->response.data, "OK");
1718 char *url = w->decoded_url;
1719 char *tok = mystrsep(&url, "/?");
1721 uint32_t hash = simple_hash(tok);
1722 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1724 if(hash == hash_api && strcmp(tok, "api") == 0) {
1725 // the client is requesting api access
1726 code = web_client_api_request(w, url);
1728 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1730 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1732 w->response.data->contenttype = CT_TEXT_PLAIN;
1733 buffer_flush(w->response.data);
1734 generate_config(w->response.data, 0);
1736 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1737 // the client is requesting rrd data -- OLD API
1738 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1740 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1741 // the client is requesting google datasource -- OLD API
1742 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1744 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1745 // the client is requesting an rrd graph -- OLD API
1747 // get the name of the data to show
1748 tok = mystrsep(&url, "/?&");
1750 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1752 // do we have such a data set?
1753 RRDSET *st = rrdset_find_byname(tok);
1754 if(!st) st = rrdset_find(tok);
1757 // try to send a file with that name
1758 buffer_flush(w->response.data);
1759 code = mysendfile(w, tok);
1763 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1764 w->response.data->contenttype = CT_APPLICATION_JSON;
1765 buffer_flush(w->response.data);
1766 rrd_stats_graph_json(st, url, w->response.data);
1771 buffer_flush(w->response.data);
1772 buffer_strcat(w->response.data, "Graph name?\r\n");
1775 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1779 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1781 buffer_flush(w->response.data);
1782 RRDSET *st = localhost.rrdset_root;
1784 for ( ; st ; st = st->next )
1785 buffer_sprintf(w->response.data, "%s\n", st->name);
1787 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1790 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1792 w->response.data->contenttype = CT_APPLICATION_JSON;
1793 buffer_flush(w->response.data);
1794 rrd_stats_all_json(w->response.data);
1796 #ifdef NETDATA_INTERNAL_CHECKS
1797 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1799 w->response.data->contenttype = CT_TEXT_PLAIN;
1800 buffer_flush(w->response.data);
1803 buffer_strcat(w->response.data, "ok, will do...");
1805 buffer_strcat(w->response.data, "I am doing it already");
1807 error("web request to exit received.");
1808 netdata_cleanup_and_exit(0);
1811 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
1812 buffer_flush(w->response.data);
1814 // get the name of the data to show
1815 tok = mystrsep(&url, "/?&");
1817 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1819 // do we have such a data set?
1820 RRDSET *st = rrdset_find_byname(tok);
1821 if(!st) st = rrdset_find(tok);
1824 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
1825 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
1829 debug_flags |= D_RRD_STATS;
1830 st->debug = !st->debug;
1831 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
1832 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
1837 buffer_flush(w->response.data);
1838 buffer_strcat(w->response.data, "debug which chart?\r\n");
1841 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
1844 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
1846 // replace the zero bytes with spaces
1847 buffer_char_replace(w->response.data, '\0', ' ');
1849 // just leave the buffer as is
1850 // it will be copied back to the client
1852 #endif /* NETDATA_INTERNAL_CHECKS */
1854 char filename[FILENAME_MAX+1];
1856 strncpyz(filename, w->last_url, FILENAME_MAX);
1857 tok = mystrsep(&url, "?");
1858 buffer_flush(w->response.data);
1859 code = mysendfile(w, (tok && *tok)?tok:"/");
1863 char filename[FILENAME_MAX+1];
1865 strncpyz(filename, w->last_url, FILENAME_MAX);
1866 tok = mystrsep(&url, "?");
1867 buffer_flush(w->response.data);
1868 code = mysendfile(w, (tok && *tok)?tok:"/");
1873 gettimeofday(&w->tv_ready, NULL);
1874 w->response.data->date = time(NULL);
1875 w->response.sent = 0;
1876 w->response.code = code;
1878 // prepare the HTTP response header
1879 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
1881 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
1882 const char *code_msg = web_response_code_to_string(code);
1885 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
1886 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
1888 buffer_sprintf(w->response.header_output,
1889 "HTTP/1.1 %d %s\r\n"
1890 "Connection: %s\r\n"
1891 "Server: NetData Embedded HTTP Server\r\n"
1892 "Access-Control-Allow-Origin: %s\r\n"
1893 "Access-Control-Allow-Credentials: true\r\n"
1894 "Content-Type: %s\r\n"
1897 , w->keepalive?"keep-alive":"close"
1899 , content_type_string
1903 if(w->cookie1[0] || w->cookie2[0]) {
1905 buffer_sprintf(w->response.header_output,
1906 "Set-Cookie: %s\r\n",
1911 buffer_sprintf(w->response.header_output,
1912 "Set-Cookie: %s\r\n",
1916 if(web_donotrack_comply)
1917 buffer_sprintf(w->response.header_output,
1918 "Tk: T;cookies\r\n");
1921 if(web_donotrack_comply) {
1922 if(w->tracking_required)
1923 buffer_sprintf(w->response.header_output,
1924 "Tk: T;cookies\r\n");
1926 buffer_sprintf(w->response.header_output,
1931 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1932 buffer_strcat(w->response.header_output,
1933 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
1934 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
1935 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
1939 if(buffer_strlen(w->response.header))
1940 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
1942 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
1943 buffer_sprintf(w->response.header_output,
1945 "Cache-Control: no-cache\r\n"
1948 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
1950 time_t et = w->response.data->date + (86400 * 14);
1951 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
1952 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
1954 buffer_sprintf(w->response.header_output,
1956 "Cache-Control: public\r\n"
1960 // if we know the content length, put it
1961 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
1962 buffer_sprintf(w->response.header_output,
1963 "Content-Length: %zu\r\n"
1964 , w->response.data->len? w->response.data->len: w->response.rlen
1966 else if(!w->response.zoutput)
1967 w->keepalive = 0; // content-length is required for keep-alive
1969 if(w->response.zoutput) {
1970 buffer_strcat(w->response.header_output,
1971 "Content-Encoding: gzip\r\n"
1972 "Transfer-Encoding: chunked\r\n"
1976 buffer_strcat(w->response.header_output, "\r\n");
1978 // sent the HTTP header
1979 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
1981 , buffer_strlen(w->response.header_output)
1982 , buffer_tostring(w->response.header_output)
1985 web_client_crock_socket(w);
1987 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
1988 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
1990 w->stats_sent_bytes += bytes;
1992 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
1994 , buffer_strlen(w->response.header_output)
1997 WEB_CLIENT_IS_DEAD(w);
2001 w->stats_sent_bytes += bytes;
2003 // enable sending immediately if we have data
2004 if(w->response.data->len) w->wait_send = 1;
2005 else w->wait_send = 0;
2009 case WEB_CLIENT_MODE_OPTIONS:
2010 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2013 case WEB_CLIENT_MODE_NORMAL:
2014 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2017 case WEB_CLIENT_MODE_FILECOPY:
2018 if(w->response.rlen) {
2019 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2020 w->wait_receive = 1;
2023 // utilize the kernel sendfile() for copying the file to the socket.
2024 // this block of code can be commented, without anything missing.
2025 // when it is commented, the program will copy the data using async I/O.
2027 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2028 if(len != w->response.data->rbytes)
2029 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2031 web_client_reset(w);
2036 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2040 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2045 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2047 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2049 sprintf(buf, "%zX\r\n", len);
2051 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2053 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2054 w->stats_sent_bytes += bytes;
2057 else if(bytes == 0) {
2058 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2059 WEB_CLIENT_IS_DEAD(w);
2062 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2063 WEB_CLIENT_IS_DEAD(w);
2069 ssize_t web_client_send_chunk_close(struct web_client *w)
2071 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2073 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2075 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2076 w->stats_sent_bytes += bytes;
2079 else if(bytes == 0) {
2080 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2081 WEB_CLIENT_IS_DEAD(w);
2084 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2085 WEB_CLIENT_IS_DEAD(w);
2091 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2093 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2095 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2097 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2098 w->stats_sent_bytes += bytes;
2101 else if(bytes == 0) {
2102 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2103 WEB_CLIENT_IS_DEAD(w);
2106 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2107 WEB_CLIENT_IS_DEAD(w);
2113 #ifdef NETDATA_WITH_ZLIB
2114 ssize_t web_client_send_deflate(struct web_client *w)
2116 ssize_t len = 0, t = 0;
2118 // when using compression,
2119 // w->response.sent is the amount of bytes passed through compression
2121 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.",
2122 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);
2124 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) {
2125 // there is nothing to send
2127 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2129 // finalize the chunk
2130 if(w->response.sent != 0) {
2131 t = web_client_send_chunk_finalize(w);
2135 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2136 // we have to wait, more data will come
2137 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2142 if(unlikely(!w->keepalive)) {
2143 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2144 WEB_CLIENT_IS_DEAD(w);
2149 web_client_reset(w);
2150 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2154 if(w->response.zhave == w->response.zsent) {
2155 // compress more input data
2157 // close the previous open chunk
2158 if(w->response.sent != 0) {
2159 t = web_client_send_chunk_close(w);
2163 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);
2165 // give the compressor all the data not passed through the compressor yet
2166 if(w->response.data->len > w->response.sent) {
2167 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2168 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2171 // reset the compressor output buffer
2172 w->response.zstream.next_out = w->response.zbuffer;
2173 w->response.zstream.avail_out = ZLIB_CHUNK;
2175 // ask for FINISH if we have all the input
2176 int flush = Z_SYNC_FLUSH;
2177 if(w->mode == WEB_CLIENT_MODE_NORMAL
2178 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2180 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2183 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2187 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2188 error("%llu: Compression failed. Closing down client.", w->id);
2189 web_client_reset(w);
2193 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2194 w->response.zsent = 0;
2196 // keep track of the bytes passed through the compressor
2197 w->response.sent = w->response.data->len;
2199 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2202 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2203 if(t2 < 0) return t2;
2207 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2209 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2211 w->stats_sent_bytes += len;
2212 w->response.zsent += len;
2214 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2217 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2218 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2220 WEB_CLIENT_IS_DEAD(w);
2223 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2224 WEB_CLIENT_IS_DEAD(w);
2229 #endif // NETDATA_WITH_ZLIB
2231 ssize_t web_client_send(struct web_client *w) {
2232 #ifdef NETDATA_WITH_ZLIB
2233 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2234 #endif // NETDATA_WITH_ZLIB
2238 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2239 // there is nothing to send
2241 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2243 // there can be two cases for this
2244 // A. we have done everything
2245 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2247 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2248 // we have to wait, more data will come
2249 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2254 if(unlikely(!w->keepalive)) {
2255 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2256 WEB_CLIENT_IS_DEAD(w);
2260 web_client_reset(w);
2261 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2265 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2266 if(likely(bytes > 0)) {
2267 w->stats_sent_bytes += bytes;
2268 w->response.sent += bytes;
2269 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2271 else if(likely(bytes == 0)) {
2272 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2273 WEB_CLIENT_IS_DEAD(w);
2276 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2277 WEB_CLIENT_IS_DEAD(w);
2283 ssize_t web_client_receive(struct web_client *w)
2285 // do we have any space for more data?
2286 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2288 ssize_t left = w->response.data->size - w->response.data->len;
2291 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2292 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2294 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2296 if(likely(bytes > 0)) {
2297 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2298 w->stats_received_bytes += bytes;
2300 size_t old = w->response.data->len;
2301 w->response.data->len += bytes;
2302 w->response.data->buffer[w->response.data->len] = '\0';
2304 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2305 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2307 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2310 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2311 w->wait_receive = 0;
2314 else if(likely(bytes == 0)) {
2315 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2317 // if we cannot read, it means we have an error on input.
2318 // if however, we are copying a file from ifd to ofd, we should not return an error.
2319 // in this case, the error should be generated when the file has been sent to the client.
2321 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2322 // we are copying data from ifd to ofd
2323 // let it finish copying...
2324 w->wait_receive = 0;
2326 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2327 if(w->ifd != w->ofd) close(w->ifd);
2331 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2332 WEB_CLIENT_IS_DEAD(w);
2336 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2337 WEB_CLIENT_IS_DEAD(w);
2344 // --------------------------------------------------------------------------------------
2345 // the thread of a single client
2347 // 1. waits for input and output, using async I/O
2348 // 2. it processes HTTP requests
2349 // 3. it generates HTTP responses
2350 // 4. it copies data from input to output if mode is FILECOPY
2352 void *web_client_main(void *ptr)
2354 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2355 error("Cannot set pthread cancel type to DEFERRED.");
2357 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2358 error("Cannot set pthread cancel state to ENABLE.");
2360 struct web_client *w = ptr;
2361 struct pollfd fds[2], *ifd, *ofd;
2362 int retval, fdmax = 0, timeout;
2364 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2367 if(unlikely(w->dead)) {
2368 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2371 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2372 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2376 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2377 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2381 if(w->ifd == w->ofd) {
2386 if(w->wait_receive) fds[0].events |= POLLIN;
2387 if(w->wait_send) fds[0].events |= POLLOUT;
2393 ifd = ofd = &fds[0];
2401 if(w->wait_receive) fds[0].events |= POLLIN;
2407 if(w->wait_send) fds[1].events |= POLLOUT;
2413 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2415 timeout = web_client_timeout * 1000;
2416 retval = poll(fds, fdmax, timeout);
2418 if(unlikely(retval == -1)) {
2419 if(errno == EAGAIN || errno == EINTR) {
2420 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2424 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2427 else if(unlikely(!retval)) {
2428 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":"");
2433 if(w->wait_send && ofd->revents & POLLOUT) {
2435 if(web_client_send(w) < 0) {
2436 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2441 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2443 if(web_client_receive(w) < 0) {
2444 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2448 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2449 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2450 web_client_process(w);
2454 if(unlikely(!used)) {
2455 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2460 web_client_reset(w);
2462 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2463 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2465 // close the sockets/files now
2466 // to free file descriptors
2467 if(w->ifd == w->ofd) {
2468 if(w->ifd != -1) close(w->ifd);
2471 if(w->ifd != -1) close(w->ifd);
2472 if(w->ofd != -1) close(w->ofd);