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, "average"))
557 return GROUP_AVERAGE;
559 else if(!strcmp(name, "min"))
562 else if(!strcmp(name, "max"))
565 else if(!strcmp(name, "sum"))
568 else if(!strcmp(name, "incremental-sum"))
569 return GROUP_INCREMENTAL_SUM;
574 int web_client_api_request_v1_charts(struct web_client *w, char *url)
578 buffer_flush(w->response.data);
579 w->response.data->contenttype = CT_APPLICATION_JSON;
580 rrd_stats_api_v1_charts(w->response.data);
584 int web_client_api_request_v1_chart(struct web_client *w, char *url)
589 buffer_flush(w->response.data);
592 char *value = mystrsep(&url, "?&[]");
593 if(!value || !*value) continue;
595 char *name = mystrsep(&value, "=");
596 if(!name || !*name) continue;
597 if(!value || !*value) continue;
599 // name and value are now the parameters
600 // they are not null and not empty
602 if(!strcmp(name, "chart")) chart = value;
604 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
609 if(!chart || !*chart) {
610 buffer_sprintf(w->response.data, "No chart id is given at the request.");
614 RRDSET *st = rrdset_find(chart);
615 if(!st) st = rrdset_find_byname(chart);
617 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
622 w->response.data->contenttype = CT_APPLICATION_JSON;
623 rrd_stats_api_v1_chart(st, w->response.data);
630 int web_client_api_v1_badge(struct web_client *w, char *url) {
632 buffer_flush(w->response.data);
634 BUFFER *dimensions = NULL;
636 const char *chart = NULL
640 , *multiply_str = NULL
644 , *label_color = NULL
645 , *value_color = NULL
646 , *refresh_str = NULL
647 , *precision_str = NULL;
649 int group = GROUP_AVERAGE;
650 uint32_t options = 0x00000000;
653 char *value = mystrsep(&url, "/?&[]");
654 if(!value || !*value) continue;
656 char *name = mystrsep(&value, "=");
657 if(!name || !*name) continue;
658 if(!value || !*value) continue;
660 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
662 // name and value are now the parameters
663 // they are not null and not empty
665 if(!strcmp(name, "chart")) chart = value;
666 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
668 dimensions = buffer_create(100);
670 buffer_strcat(dimensions, "|");
671 buffer_strcat(dimensions, value);
673 else if(!strcmp(name, "after")) after_str = value;
674 else if(!strcmp(name, "before")) before_str = value;
675 else if(!strcmp(name, "points")) points_str = value;
676 else if(!strcmp(name, "group")) {
677 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
679 else if(!strcmp(name, "options")) {
680 options |= web_client_api_request_v1_data_options(value);
682 else if(!strcmp(name, "label")) label = value;
683 else if(!strcmp(name, "units")) units = value;
684 else if(!strcmp(name, "label_color")) label_color = value;
685 else if(!strcmp(name, "value_color")) value_color = value;
686 else if(!strcmp(name, "multiply")) multiply_str = value;
687 else if(!strcmp(name, "divide")) divide_str = value;
688 else if(!strcmp(name, "refresh")) refresh_str = value;
689 else if(!strcmp(name, "precision")) precision_str = value;
692 if(!chart || !*chart) {
693 buffer_sprintf(w->response.data, "No chart id is given at the request.");
697 RRDSET *st = rrdset_find(chart);
698 if(!st) st = rrdset_find_byname(chart);
700 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
705 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
706 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
707 long long before = (before_str && *before_str )?atol(before_str):0;
708 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
709 int points = (points_str && *points_str )?atoi(points_str):1;
710 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
712 if(!multiply) multiply = 1;
713 if(!divide) divide = 1;
716 if(refresh_str && *refresh_str) {
717 if(!strcmp(refresh_str, "auto")) {
718 if(options & RRDR_OPTION_NOT_ALIGNED)
719 refresh = st->update_every;
721 refresh = (before - after);
722 if(refresh < 0) refresh = -refresh;
726 refresh = atoi(refresh_str);
727 if(refresh < 0) refresh = -refresh;
733 const char *dim = buffer_tostring(dimensions);
734 if(*dim == '|') dim++;
741 if(options & RRDR_OPTION_PERCENTAGE)
747 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'"
750 , (dimensions)?buffer_tostring(dimensions):""
758 time_t latest_timestamp = 0;
759 int value_is_null = 1;
760 calculated_number n = 0;
763 // if the collected value is too old, don't calculate its value
764 if(rrdset_last_entry_t(st) >= (time(NULL) - (st->update_every * st->gap_when_lost_iterations_above)))
765 ret = rrd2value(st, w->response.data, &n, (dimensions)?buffer_tostring(dimensions):NULL, points, after, before, group, options, &latest_timestamp, &value_is_null);
767 // if the value cannot be calculated, show empty badge
774 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
777 buffer_svg(w->response.data, label, n * multiply / divide, units, label_color, value_color, value_is_null, precision);
781 buffer_free(dimensions);
785 // returns the HTTP code
786 int web_client_api_request_v1_data(struct web_client *w, char *url)
788 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
791 BUFFER *dimensions = NULL;
793 buffer_flush(w->response.data);
795 char *google_version = "0.6",
798 *google_out = "json",
799 *responseHandler = NULL,
802 time_t last_timestamp_in_data = 0, google_timestamp = 0;
807 , *points_str = NULL;
809 int group = GROUP_AVERAGE;
810 uint32_t format = DATASOURCE_JSON;
811 uint32_t options = 0x00000000;
814 char *value = mystrsep(&url, "?&[]");
815 if(!value || !*value) continue;
817 char *name = mystrsep(&value, "=");
818 if(!name || !*name) continue;
819 if(!value || !*value) continue;
821 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
823 // name and value are now the parameters
824 // they are not null and not empty
826 if(!strcmp(name, "chart")) chart = value;
827 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
828 if(!dimensions) dimensions = buffer_create(100);
829 buffer_strcat(dimensions, "|");
830 buffer_strcat(dimensions, value);
832 else if(!strcmp(name, "after")) after_str = value;
833 else if(!strcmp(name, "before")) before_str = value;
834 else if(!strcmp(name, "points")) points_str = value;
835 else if(!strcmp(name, "group")) {
836 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
838 else if(!strcmp(name, "format")) {
839 format = web_client_api_request_v1_data_format(value);
841 else if(!strcmp(name, "options")) {
842 options |= web_client_api_request_v1_data_options(value);
844 else if(!strcmp(name, "callback")) {
845 responseHandler = value;
847 else if(!strcmp(name, "filename")) {
850 else if(!strcmp(name, "tqx")) {
851 // parse Google Visualization API options
852 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
853 char *tqx_name, *tqx_value;
856 tqx_value = mystrsep(&value, ";");
857 if(!tqx_value || !*tqx_value) continue;
859 tqx_name = mystrsep(&tqx_value, ":");
860 if(!tqx_name || !*tqx_name) continue;
861 if(!tqx_value || !*tqx_value) continue;
863 if(!strcmp(tqx_name, "version"))
864 google_version = tqx_value;
865 else if(!strcmp(tqx_name, "reqId"))
866 google_reqId = tqx_value;
867 else if(!strcmp(tqx_name, "sig")) {
868 google_sig = tqx_value;
869 google_timestamp = strtoul(google_sig, NULL, 0);
871 else if(!strcmp(tqx_name, "out")) {
872 google_out = tqx_value;
873 format = web_client_api_request_v1_data_google_format(google_out);
875 else if(!strcmp(tqx_name, "responseHandler"))
876 responseHandler = tqx_value;
877 else if(!strcmp(tqx_name, "outFileName"))
878 outFileName = tqx_value;
883 if(!chart || !*chart) {
884 buffer_sprintf(w->response.data, "No chart id is given at the request.");
888 RRDSET *st = rrdset_find(chart);
889 if(!st) st = rrdset_find_byname(chart);
891 buffer_sprintf(w->response.data, "Chart '%s' is not found.", chart);
896 long long before = (before_str && *before_str)?atol(before_str):0;
897 long long after = (after_str && *after_str) ?atol(after_str):0;
898 int points = (points_str && *points_str)?atoi(points_str):0;
900 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'"
903 , (dimensions)?buffer_tostring(dimensions):""
912 if(outFileName && *outFileName) {
913 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
914 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
917 if(format == DATASOURCE_DATATABLE_JSONP) {
918 if(responseHandler == NULL)
919 responseHandler = "google.visualization.Query.setResponse";
921 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
922 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
925 buffer_sprintf(w->response.data,
926 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
927 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
929 else if(format == DATASOURCE_JSONP) {
930 if(responseHandler == NULL)
931 responseHandler = "callback";
933 buffer_strcat(w->response.data, responseHandler);
934 buffer_strcat(w->response.data, "(");
937 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
939 if(format == DATASOURCE_DATATABLE_JSONP) {
940 if(google_timestamp < last_timestamp_in_data)
941 buffer_strcat(w->response.data, "});");
944 // the client already has the latest data
945 buffer_flush(w->response.data);
946 buffer_sprintf(w->response.data,
947 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
948 responseHandler, google_version, google_reqId);
951 else if(format == DATASOURCE_JSONP)
952 buffer_strcat(w->response.data, ");");
955 if(dimensions) buffer_free(dimensions);
959 int web_client_api_request_v1_registry(struct web_client *w, char *url)
961 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
962 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
963 hash_to = 0 /*, hash_redirects = 0 */;
965 if(unlikely(!hash_action)) {
966 hash_action = simple_hash("action");
967 hash_access = simple_hash("access");
968 hash_hello = simple_hash("hello");
969 hash_delete = simple_hash("delete");
970 hash_search = simple_hash("search");
971 hash_switch = simple_hash("switch");
972 hash_machine = simple_hash("machine");
973 hash_url = simple_hash("url");
974 hash_name = simple_hash("name");
975 hash_delete_url = simple_hash("delete_url");
976 hash_for = simple_hash("for");
977 hash_to = simple_hash("to");
979 hash_redirects = simple_hash("redirects");
983 char person_guid[36 + 1] = "";
985 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
988 // The browser may send multiple cookies with our id
990 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
992 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
995 char *machine_guid = NULL,
998 *search_machine_guid = NULL,
1000 *to_person_guid = NULL;
1006 char *value = mystrsep(&url, "?&[]");
1007 if (!value || !*value) continue;
1009 char *name = mystrsep(&value, "=");
1010 if (!name || !*name) continue;
1011 if (!value || !*value) continue;
1013 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1015 uint32_t hash = simple_hash(name);
1017 if(hash == hash_action && !strcmp(name, "action")) {
1018 uint32_t vhash = simple_hash(value);
1020 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1021 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1022 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1023 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1024 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1025 #ifdef NETDATA_INTERNAL_CHECKS
1026 else error("unknown registry action '%s'", value);
1027 #endif /* NETDATA_INTERNAL_CHECKS */
1030 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1031 redirects = atoi(value);
1033 else if(hash == hash_machine && !strcmp(name, "machine"))
1034 machine_guid = value;
1036 else if(hash == hash_url && !strcmp(name, "url"))
1037 machine_url = value;
1039 else if(action == 'A') {
1040 if(hash == hash_name && !strcmp(name, "name"))
1043 else if(action == 'D') {
1044 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1047 else if(action == 'S') {
1048 if(hash == hash_for && !strcmp(name, "for"))
1049 search_machine_guid = value;
1051 else if(action == 'W') {
1052 if(hash == hash_to && !strcmp(name, "to"))
1053 to_person_guid = value;
1055 #ifdef NETDATA_INTERNAL_CHECKS
1056 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1057 #endif /* NETDATA_INTERNAL_CHECKS */
1060 if(web_donotrack_comply && w->donottrack) {
1061 buffer_flush(w->response.data);
1062 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.");
1066 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1067 buffer_flush(w->response.data);
1068 buffer_sprintf(w->response.data, "Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1069 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1072 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1073 buffer_flush(w->response.data);
1074 buffer_sprintf(w->response.data, "Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1075 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1078 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1079 buffer_flush(w->response.data);
1080 buffer_sprintf(w->response.data, "Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1081 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1084 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1085 buffer_flush(w->response.data);
1086 buffer_sprintf(w->response.data, "Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1087 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1093 w->tracking_required = 1;
1094 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1095 buffer_flush(w->response.data);
1097 registry_set_cookie(w, "give-me-back-this-cookie-please");
1098 w->response.data->contenttype = CT_APPLICATION_JSON;
1099 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1103 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1104 * under certain conditions, when using CORS
1105 * so this is commented and we use application level redirects instead
1109 if(redirects > registry_verify_cookies_redirects()) {
1110 buffer_flush(w->response.data);
1111 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1115 char *encoded_url = url_encode(machine_url);
1117 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1121 char *encoded_name = url_encode(url_name);
1124 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1128 char *encoded_guid = url_encode(machine_guid);
1132 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1136 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1137 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1145 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, time(NULL));
1148 w->tracking_required = 1;
1149 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, time(NULL));
1152 w->tracking_required = 1;
1153 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, time(NULL));
1156 w->tracking_required = 1;
1157 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, time(NULL));
1160 return registry_request_hello_json(w);
1163 buffer_flush(w->response.data);
1164 buffer_sprintf(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1168 buffer_flush(w->response.data);
1169 buffer_sprintf(w->response.data, "Invalid or no registry action.");
1173 int web_client_api_request_v1(struct web_client *w, char *url) {
1174 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0;
1176 if(unlikely(hash_data == 0)) {
1177 hash_data = simple_hash("data");
1178 hash_chart = simple_hash("chart");
1179 hash_charts = simple_hash("charts");
1180 hash_registry = simple_hash("registry");
1181 hash_badge = simple_hash("badge.svg");
1185 char *tok = mystrsep(&url, "/?&");
1187 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1188 uint32_t hash = simple_hash(tok);
1190 if(hash == hash_data && !strcmp(tok, "data"))
1191 return web_client_api_request_v1_data(w, url);
1193 else if(hash == hash_chart && !strcmp(tok, "chart"))
1194 return web_client_api_request_v1_chart(w, url);
1196 else if(hash == hash_charts && !strcmp(tok, "charts"))
1197 return web_client_api_request_v1_charts(w, url);
1199 else if(hash == hash_registry && !strcmp(tok, "registry"))
1200 return web_client_api_request_v1_registry(w, url);
1202 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1203 return web_client_api_v1_badge(w, url);
1206 buffer_flush(w->response.data);
1207 buffer_sprintf(w->response.data, "Unsupported v1 API command: %s", tok);
1212 buffer_flush(w->response.data);
1213 buffer_sprintf(w->response.data, "API v1 command?");
1218 int web_client_api_request(struct web_client *w, char *url)
1220 // get the api version
1221 char *tok = mystrsep(&url, "/?&");
1223 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1224 if(strcmp(tok, "v1") == 0)
1225 return web_client_api_request_v1(w, url);
1227 buffer_flush(w->response.data);
1228 buffer_sprintf(w->response.data, "Unsupported API version: %s", tok);
1233 buffer_flush(w->response.data);
1234 buffer_sprintf(w->response.data, "Which API version?");
1239 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1243 char *args = strchr(url, '?');
1249 // get the name of the data to show
1250 char *tok = mystrsep(&url, "/");
1253 // do we have such a data set?
1255 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1256 st = rrdset_find_byname(tok);
1257 if(!st) st = rrdset_find(tok);
1262 // try to send a file with that name
1263 buffer_flush(w->response.data);
1264 return(mysendfile(w, tok));
1268 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1270 // how many entries does the client want?
1271 int lines = rrd_default_history_entries;
1272 int group_count = 1;
1273 time_t after = 0, before = 0;
1274 int group_method = GROUP_AVERAGE;
1278 // parse the lines required
1279 tok = mystrsep(&url, "/");
1280 if(tok) lines = atoi(tok);
1281 if(lines < 1) lines = 1;
1284 // parse the group count required
1285 tok = mystrsep(&url, "/");
1286 if(tok && *tok) group_count = atoi(tok);
1287 if(group_count < 1) group_count = 1;
1288 //if(group_count > save_history / 20) group_count = save_history / 20;
1291 // parse the grouping method required
1292 tok = mystrsep(&url, "/");
1294 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1295 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1296 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1297 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1302 tok = mystrsep(&url, "/");
1303 if(tok && *tok) after = strtoul(tok, NULL, 10);
1304 if(after < 0) after = 0;
1307 // parse before time
1308 tok = mystrsep(&url, "/");
1309 if(tok && *tok) before = strtoul(tok, NULL, 10);
1310 if(before < 0) before = 0;
1314 tok = mystrsep(&url, "/");
1315 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1318 w->response.data->contenttype = CT_APPLICATION_JSON;
1319 buffer_flush(w->response.data);
1321 char *google_version = "0.6";
1322 char *google_reqId = "0";
1323 char *google_sig = "0";
1324 char *google_out = "json";
1325 char *google_responseHandler = "google.visualization.Query.setResponse";
1326 char *google_outFileName = NULL;
1327 time_t last_timestamp_in_data = 0;
1328 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1330 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1333 tok = mystrsep(&args, "&");
1335 char *name = mystrsep(&tok, "=");
1336 if(name && *name && strcmp(name, "tqx") == 0) {
1337 char *key = mystrsep(&tok, ":");
1338 char *value = mystrsep(&tok, ";");
1339 if(key && value && *key && *value) {
1340 if(strcmp(key, "version") == 0)
1341 google_version = value;
1343 else if(strcmp(key, "reqId") == 0)
1344 google_reqId = value;
1346 else if(strcmp(key, "sig") == 0)
1349 else if(strcmp(key, "out") == 0)
1352 else if(strcmp(key, "responseHandler") == 0)
1353 google_responseHandler = value;
1355 else if(strcmp(key, "outFileName") == 0)
1356 google_outFileName = value;
1362 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1363 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1366 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1367 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1369 // check the client wants json
1370 if(strcmp(google_out, "json") != 0) {
1371 buffer_sprintf(w->response.data,
1372 "%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.'}]});",
1373 google_responseHandler, google_version, google_reqId, google_out);
1379 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1380 buffer_sprintf(w->response.data,
1381 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1382 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1385 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1386 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1388 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);
1390 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1391 if(timestamp_in_data > last_timestamp_in_data)
1392 buffer_strcat(w->response.data, "});");
1395 // the client already has the latest data
1396 buffer_flush(w->response.data);
1397 buffer_sprintf(w->response.data,
1398 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1399 google_responseHandler, google_version, google_reqId);
1406 const char *web_content_type_to_string(uint8_t contenttype) {
1407 switch(contenttype) {
1409 return "text/html; charset=utf-8";
1411 case CT_APPLICATION_XML:
1412 return "application/xml; charset=utf-8";
1414 case CT_APPLICATION_JSON:
1415 return "application/json; charset=utf-8";
1417 case CT_APPLICATION_X_JAVASCRIPT:
1418 return "application/x-javascript; charset=utf-8";
1421 return "text/css; charset=utf-8";
1424 return "text/xml; charset=utf-8";
1427 return "text/xsl; charset=utf-8";
1429 case CT_APPLICATION_OCTET_STREAM:
1430 return "application/octet-stream";
1432 case CT_IMAGE_SVG_XML:
1433 return "image/svg+xml";
1435 case CT_APPLICATION_X_FONT_TRUETYPE:
1436 return "application/x-font-truetype";
1438 case CT_APPLICATION_X_FONT_OPENTYPE:
1439 return "application/x-font-opentype";
1441 case CT_APPLICATION_FONT_WOFF:
1442 return "application/font-woff";
1444 case CT_APPLICATION_FONT_WOFF2:
1445 return "application/font-woff2";
1447 case CT_APPLICATION_VND_MS_FONTOBJ:
1448 return "application/vnd.ms-fontobject";
1454 return "image/jpeg";
1459 case CT_IMAGE_XICON:
1460 return "image/x-icon";
1466 return "image/icns";
1470 return "text/plain; charset=utf-8";
1475 const char *web_response_code_to_string(int code) {
1481 return "Temporary Redirect";
1484 return "Bad Request";
1493 return "Preconditions Failed";
1496 if(code >= 100 && code < 200)
1497 return "Informational";
1499 if(code >= 200 && code < 300)
1500 return "Successful";
1502 if(code >= 300 && code < 400)
1503 return "Redirection";
1505 if(code >= 400 && code < 500)
1506 return "Bad Request";
1508 if(code >= 500 && code < 600)
1509 return "Server Error";
1511 return "Undefined Error";
1515 static inline char *http_header_parse(struct web_client *w, char *s) {
1516 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1518 if(unlikely(!hash_origin)) {
1519 hash_origin = simple_uhash("Origin");
1520 hash_connection = simple_uhash("Connection");
1521 hash_accept_encoding = simple_uhash("Accept-Encoding");
1522 hash_donottrack = simple_uhash("DNT");
1528 while(*e && *e != ':') e++;
1535 char *v = e + 1, *ve;
1537 // skip leading spaces from value
1538 while(*v == ' ') v++;
1542 while(*ve && *ve != '\r') ve++;
1543 if(!*ve || ve[1] != '\n') {
1548 // terminate the value
1551 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1552 uint32_t hash = simple_uhash(s);
1554 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1555 strncpyz(w->origin, v, ORIGIN_MAX);
1557 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1558 if(strcasestr(v, "keep-alive"))
1561 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1562 if(*v == '0') w->donottrack = 0;
1563 else if(*v == '1') w->donottrack = 1;
1565 #ifdef NETDATA_WITH_ZLIB
1566 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1567 if(web_enable_gzip) {
1568 if(strcasestr(v, "gzip"))
1569 web_client_enable_deflate(w, 1);
1571 // does not seem to work
1572 // else if(strcasestr(v, "deflate"))
1573 // web_client_enable_deflate(w, 0);
1576 #endif /* NETDATA_WITH_ZLIB */
1583 // http_request_validate()
1585 // = 0 : all good, process the request
1586 // > 0 : request is not supported
1587 // < 0 : request is incomplete - wait for more data
1589 static inline int http_request_validate(struct web_client *w) {
1590 char *s = w->response.data->buffer, *encoded_url = NULL;
1592 // is is a valid request?
1593 if(!strncmp(s, "GET ", 4)) {
1594 encoded_url = s = &s[4];
1595 w->mode = WEB_CLIENT_MODE_NORMAL;
1597 else if(!strncmp(s, "OPTIONS ", 8)) {
1598 encoded_url = s = &s[8];
1599 w->mode = WEB_CLIENT_MODE_OPTIONS;
1602 w->wait_receive = 0;
1606 // find the SPACE + "HTTP/"
1608 // find the next space
1609 while (*s && *s != ' ') s++;
1611 // is it SPACE + "HTTP/" ?
1612 if(*s && !strncmp(s, " HTTP/", 6)) break;
1616 // incomplete requests
1618 w->wait_receive = 1;
1622 // we have the end of encoded_url - remember it
1625 // make sure we have complete request
1626 // complete requests contain: \r\n\r\n
1629 while(*s && *s++ != '\r');
1631 // did we reach the end?
1632 if(unlikely(!*s)) break;
1635 if(likely(*s++ == '\n')) {
1637 // is it again \r\n ? (header end)
1638 if(unlikely(*s == '\r' && s[1] == '\n')) {
1639 // a valid complete HTTP request found
1642 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1645 // copy the URL - we are going to overwrite parts of it
1646 // FIXME -- we should avoid it
1647 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1649 w->wait_receive = 0;
1653 // another header line
1654 s = http_header_parse(w, s);
1658 // incomplete request
1659 w->wait_receive = 1;
1663 void web_client_process(struct web_client *w) {
1664 static uint32_t hash_api = 0, hash_netdata_conf = 0, hash_data = 0, hash_datasource = 0, hash_graph = 0,
1665 hash_list = 0, hash_all_json = 0, hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1668 gettimeofday(&w->tv_in, NULL);
1670 if(unlikely(!hash_api)) {
1671 hash_api = simple_hash("api");
1672 hash_netdata_conf = simple_hash("netdata.conf");
1673 hash_data = simple_hash(WEB_PATH_DATA);
1674 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1675 hash_graph = simple_hash(WEB_PATH_GRAPH);
1676 hash_list = simple_hash("list");
1677 hash_all_json = simple_hash("all.json");
1678 hash_exit = simple_hash("exit");
1679 hash_debug = simple_hash("debug");
1680 hash_mirror = simple_hash("mirror");
1686 int what_to_do = http_request_validate(w);
1688 // wait for more data
1689 if(what_to_do < 0) {
1690 if(w->response.data->len > TOO_BIG_REQUEST) {
1691 strcpy(w->last_url, "too big request");
1693 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1696 buffer_flush(w->response.data);
1697 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1700 // wait for more data
1704 else if(what_to_do > 0) {
1705 // strcpy(w->last_url, "not a valid request");
1707 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1710 buffer_flush(w->response.data);
1711 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1713 else { // what_to_do == 0
1714 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1716 w->response.data->contenttype = CT_TEXT_PLAIN;
1717 buffer_flush(w->response.data);
1718 buffer_strcat(w->response.data, "OK");
1721 char *url = w->decoded_url;
1722 char *tok = mystrsep(&url, "/?");
1724 uint32_t hash = simple_hash(tok);
1725 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
1727 if(hash == hash_api && strcmp(tok, "api") == 0) {
1728 // the client is requesting api access
1729 code = web_client_api_request(w, url);
1731 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
1733 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
1735 w->response.data->contenttype = CT_TEXT_PLAIN;
1736 buffer_flush(w->response.data);
1737 generate_config(w->response.data, 0);
1739 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
1740 // the client is requesting rrd data -- OLD API
1741 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
1743 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
1744 // the client is requesting google datasource -- OLD API
1745 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
1747 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
1748 // the client is requesting an rrd graph -- OLD API
1750 // get the name of the data to show
1751 tok = mystrsep(&url, "/?&");
1753 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1755 // do we have such a data set?
1756 RRDSET *st = rrdset_find_byname(tok);
1757 if(!st) st = rrdset_find(tok);
1760 // try to send a file with that name
1761 buffer_flush(w->response.data);
1762 code = mysendfile(w, tok);
1766 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
1767 w->response.data->contenttype = CT_APPLICATION_JSON;
1768 buffer_flush(w->response.data);
1769 rrd_stats_graph_json(st, url, w->response.data);
1774 buffer_flush(w->response.data);
1775 buffer_strcat(w->response.data, "Graph name?\r\n");
1778 else if(hash == hash_list && strcmp(tok, "list") == 0) {
1782 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
1784 buffer_flush(w->response.data);
1785 RRDSET *st = localhost.rrdset_root;
1787 for ( ; st ; st = st->next )
1788 buffer_sprintf(w->response.data, "%s\n", st->name);
1790 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
1793 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
1795 w->response.data->contenttype = CT_APPLICATION_JSON;
1796 buffer_flush(w->response.data);
1797 rrd_stats_all_json(w->response.data);
1799 #ifdef NETDATA_INTERNAL_CHECKS
1800 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
1802 w->response.data->contenttype = CT_TEXT_PLAIN;
1803 buffer_flush(w->response.data);
1806 buffer_strcat(w->response.data, "ok, will do...");
1808 buffer_strcat(w->response.data, "I am doing it already");
1810 error("web request to exit received.");
1811 netdata_cleanup_and_exit(0);
1814 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
1815 buffer_flush(w->response.data);
1817 // get the name of the data to show
1818 tok = mystrsep(&url, "/?&");
1820 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1822 // do we have such a data set?
1823 RRDSET *st = rrdset_find_byname(tok);
1824 if(!st) st = rrdset_find(tok);
1827 buffer_sprintf(w->response.data, "Chart %s is not found.\r\n", tok);
1828 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
1832 debug_flags |= D_RRD_STATS;
1833 st->debug = !st->debug;
1834 buffer_sprintf(w->response.data, "Chart %s has now debug %s.\r\n", tok, st->debug?"enabled":"disabled");
1835 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
1840 buffer_flush(w->response.data);
1841 buffer_strcat(w->response.data, "debug which chart?\r\n");
1844 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
1847 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
1849 // replace the zero bytes with spaces
1850 buffer_char_replace(w->response.data, '\0', ' ');
1852 // just leave the buffer as is
1853 // it will be copied back to the client
1855 #endif /* NETDATA_INTERNAL_CHECKS */
1857 char filename[FILENAME_MAX+1];
1859 strncpyz(filename, w->last_url, FILENAME_MAX);
1860 tok = mystrsep(&url, "?");
1861 buffer_flush(w->response.data);
1862 code = mysendfile(w, (tok && *tok)?tok:"/");
1866 char filename[FILENAME_MAX+1];
1868 strncpyz(filename, w->last_url, FILENAME_MAX);
1869 tok = mystrsep(&url, "?");
1870 buffer_flush(w->response.data);
1871 code = mysendfile(w, (tok && *tok)?tok:"/");
1876 gettimeofday(&w->tv_ready, NULL);
1877 w->response.data->date = time(NULL);
1878 w->response.sent = 0;
1879 w->response.code = code;
1881 // prepare the HTTP response header
1882 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
1884 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
1885 const char *code_msg = web_response_code_to_string(code);
1888 struct tm tmbuf, *tm = gmtime_r(&w->response.data->date, &tmbuf);
1889 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
1891 buffer_sprintf(w->response.header_output,
1892 "HTTP/1.1 %d %s\r\n"
1893 "Connection: %s\r\n"
1894 "Server: NetData Embedded HTTP Server\r\n"
1895 "Access-Control-Allow-Origin: %s\r\n"
1896 "Access-Control-Allow-Credentials: true\r\n"
1897 "Content-Type: %s\r\n"
1900 , w->keepalive?"keep-alive":"close"
1902 , content_type_string
1906 if(w->cookie1[0] || w->cookie2[0]) {
1908 buffer_sprintf(w->response.header_output,
1909 "Set-Cookie: %s\r\n",
1914 buffer_sprintf(w->response.header_output,
1915 "Set-Cookie: %s\r\n",
1919 if(web_donotrack_comply)
1920 buffer_sprintf(w->response.header_output,
1921 "Tk: T;cookies\r\n");
1924 if(web_donotrack_comply) {
1925 if(w->tracking_required)
1926 buffer_sprintf(w->response.header_output,
1927 "Tk: T;cookies\r\n");
1929 buffer_sprintf(w->response.header_output,
1934 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1935 buffer_strcat(w->response.header_output,
1936 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
1937 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie\r\n"
1938 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
1942 if(buffer_strlen(w->response.header))
1943 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
1945 if(w->mode == WEB_CLIENT_MODE_NORMAL && (w->response.data->options & WB_CONTENT_NO_CACHEABLE)) {
1946 buffer_sprintf(w->response.header_output,
1948 "Cache-Control: no-cache\r\n"
1951 else if(w->mode != WEB_CLIENT_MODE_OPTIONS) {
1953 time_t et = w->response.data->date + (86400 * 14);
1954 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
1955 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
1957 buffer_sprintf(w->response.header_output,
1959 "Cache-Control: public\r\n"
1963 // if we know the content length, put it
1964 if(!w->response.zoutput && (w->response.data->len || w->response.rlen))
1965 buffer_sprintf(w->response.header_output,
1966 "Content-Length: %zu\r\n"
1967 , w->response.data->len? w->response.data->len: w->response.rlen
1969 else if(!w->response.zoutput)
1970 w->keepalive = 0; // content-length is required for keep-alive
1972 if(w->response.zoutput) {
1973 buffer_strcat(w->response.header_output,
1974 "Content-Encoding: gzip\r\n"
1975 "Transfer-Encoding: chunked\r\n"
1979 buffer_strcat(w->response.header_output, "\r\n");
1981 // sent the HTTP header
1982 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
1984 , buffer_strlen(w->response.header_output)
1985 , buffer_tostring(w->response.header_output)
1988 web_client_crock_socket(w);
1990 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
1991 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
1993 w->stats_sent_bytes += bytes;
1995 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
1997 , buffer_strlen(w->response.header_output)
2000 WEB_CLIENT_IS_DEAD(w);
2004 w->stats_sent_bytes += bytes;
2006 // enable sending immediately if we have data
2007 if(w->response.data->len) w->wait_send = 1;
2008 else w->wait_send = 0;
2012 case WEB_CLIENT_MODE_OPTIONS:
2013 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2016 case WEB_CLIENT_MODE_NORMAL:
2017 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2020 case WEB_CLIENT_MODE_FILECOPY:
2021 if(w->response.rlen) {
2022 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2023 w->wait_receive = 1;
2026 // utilize the kernel sendfile() for copying the file to the socket.
2027 // this block of code can be commented, without anything missing.
2028 // when it is commented, the program will copy the data using async I/O.
2030 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2031 if(len != w->response.data->rbytes)
2032 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2034 web_client_reset(w);
2039 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2043 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2048 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2050 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2052 sprintf(buf, "%zX\r\n", len);
2054 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2056 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2057 w->stats_sent_bytes += bytes;
2060 else if(bytes == 0) {
2061 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2062 WEB_CLIENT_IS_DEAD(w);
2065 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2066 WEB_CLIENT_IS_DEAD(w);
2072 ssize_t web_client_send_chunk_close(struct web_client *w)
2074 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2076 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2078 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2079 w->stats_sent_bytes += bytes;
2082 else if(bytes == 0) {
2083 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2084 WEB_CLIENT_IS_DEAD(w);
2087 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2088 WEB_CLIENT_IS_DEAD(w);
2094 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2096 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2098 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2100 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2101 w->stats_sent_bytes += bytes;
2104 else if(bytes == 0) {
2105 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2106 WEB_CLIENT_IS_DEAD(w);
2109 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2110 WEB_CLIENT_IS_DEAD(w);
2116 #ifdef NETDATA_WITH_ZLIB
2117 ssize_t web_client_send_deflate(struct web_client *w)
2119 ssize_t len = 0, t = 0;
2121 // when using compression,
2122 // w->response.sent is the amount of bytes passed through compression
2124 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.",
2125 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);
2127 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) {
2128 // there is nothing to send
2130 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2132 // finalize the chunk
2133 if(w->response.sent != 0) {
2134 t = web_client_send_chunk_finalize(w);
2138 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2139 // we have to wait, more data will come
2140 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2145 if(unlikely(!w->keepalive)) {
2146 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2147 WEB_CLIENT_IS_DEAD(w);
2152 web_client_reset(w);
2153 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2157 if(w->response.zhave == w->response.zsent) {
2158 // compress more input data
2160 // close the previous open chunk
2161 if(w->response.sent != 0) {
2162 t = web_client_send_chunk_close(w);
2166 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);
2168 // give the compressor all the data not passed through the compressor yet
2169 if(w->response.data->len > w->response.sent) {
2170 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2171 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2174 // reset the compressor output buffer
2175 w->response.zstream.next_out = w->response.zbuffer;
2176 w->response.zstream.avail_out = ZLIB_CHUNK;
2178 // ask for FINISH if we have all the input
2179 int flush = Z_SYNC_FLUSH;
2180 if(w->mode == WEB_CLIENT_MODE_NORMAL
2181 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2183 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2186 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2190 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2191 error("%llu: Compression failed. Closing down client.", w->id);
2192 web_client_reset(w);
2196 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2197 w->response.zsent = 0;
2199 // keep track of the bytes passed through the compressor
2200 w->response.sent = w->response.data->len;
2202 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2205 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2206 if(t2 < 0) return t2;
2210 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2212 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2214 w->stats_sent_bytes += len;
2215 w->response.zsent += len;
2217 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2220 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2221 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2223 WEB_CLIENT_IS_DEAD(w);
2226 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2227 WEB_CLIENT_IS_DEAD(w);
2232 #endif // NETDATA_WITH_ZLIB
2234 ssize_t web_client_send(struct web_client *w) {
2235 #ifdef NETDATA_WITH_ZLIB
2236 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2237 #endif // NETDATA_WITH_ZLIB
2241 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2242 // there is nothing to send
2244 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2246 // there can be two cases for this
2247 // A. we have done everything
2248 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2250 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2251 // we have to wait, more data will come
2252 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2257 if(unlikely(!w->keepalive)) {
2258 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2259 WEB_CLIENT_IS_DEAD(w);
2263 web_client_reset(w);
2264 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2268 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2269 if(likely(bytes > 0)) {
2270 w->stats_sent_bytes += bytes;
2271 w->response.sent += bytes;
2272 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2274 else if(likely(bytes == 0)) {
2275 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2276 WEB_CLIENT_IS_DEAD(w);
2279 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2280 WEB_CLIENT_IS_DEAD(w);
2286 ssize_t web_client_receive(struct web_client *w)
2288 // do we have any space for more data?
2289 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2291 ssize_t left = w->response.data->size - w->response.data->len;
2294 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2295 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2297 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2299 if(likely(bytes > 0)) {
2300 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2301 w->stats_received_bytes += bytes;
2303 size_t old = w->response.data->len;
2304 w->response.data->len += bytes;
2305 w->response.data->buffer[w->response.data->len] = '\0';
2307 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2308 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2310 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2313 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2314 w->wait_receive = 0;
2317 else if(likely(bytes == 0)) {
2318 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2320 // if we cannot read, it means we have an error on input.
2321 // if however, we are copying a file from ifd to ofd, we should not return an error.
2322 // in this case, the error should be generated when the file has been sent to the client.
2324 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2325 // we are copying data from ifd to ofd
2326 // let it finish copying...
2327 w->wait_receive = 0;
2329 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2330 if(w->ifd != w->ofd) close(w->ifd);
2334 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2335 WEB_CLIENT_IS_DEAD(w);
2339 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2340 WEB_CLIENT_IS_DEAD(w);
2347 // --------------------------------------------------------------------------------------
2348 // the thread of a single client
2350 // 1. waits for input and output, using async I/O
2351 // 2. it processes HTTP requests
2352 // 3. it generates HTTP responses
2353 // 4. it copies data from input to output if mode is FILECOPY
2355 void *web_client_main(void *ptr)
2357 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2358 error("Cannot set pthread cancel type to DEFERRED.");
2360 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2361 error("Cannot set pthread cancel state to ENABLE.");
2363 struct web_client *w = ptr;
2364 struct pollfd fds[2], *ifd, *ofd;
2365 int retval, fdmax = 0, timeout;
2367 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2370 if(unlikely(w->dead)) {
2371 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2374 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2375 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2379 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2380 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2384 if(w->ifd == w->ofd) {
2389 if(w->wait_receive) fds[0].events |= POLLIN;
2390 if(w->wait_send) fds[0].events |= POLLOUT;
2396 ifd = ofd = &fds[0];
2404 if(w->wait_receive) fds[0].events |= POLLIN;
2410 if(w->wait_send) fds[1].events |= POLLOUT;
2416 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2418 timeout = web_client_timeout * 1000;
2419 retval = poll(fds, fdmax, timeout);
2421 if(unlikely(retval == -1)) {
2422 if(errno == EAGAIN || errno == EINTR) {
2423 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2427 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2430 else if(unlikely(!retval)) {
2431 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":"");
2436 if(w->wait_send && ofd->revents & POLLOUT) {
2438 if(web_client_send(w) < 0) {
2439 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2444 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2446 if(web_client_receive(w) < 0) {
2447 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2451 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2452 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2453 web_client_process(w);
2457 if(unlikely(!used)) {
2458 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2463 web_client_reset(w);
2465 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2466 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2468 // close the sockets/files now
2469 // to free file descriptors
2470 if(w->ifd == w->ofd) {
2471 if(w->ifd != -1) close(w->ifd);
2474 if(w->ifd != -1) close(w->ifd);
2475 if(w->ofd != -1) close(w->ofd);