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 static 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 static 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: Resetting client.", w->id);
126 if(likely(w->last_url[0])) {
128 now_realtime_timeval(&tv);
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(dt_usec(&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 dt_usec(&w->tv_ready, &w->tv_in) / 1000.0,
156 dt_usec(&tv, &w->tv_ready) / 1000.0,
157 dt_usec(&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, "Filename contains invalid characters: ");
312 buffer_strcat_htmlescape(w->response.data, filename);
317 // if the filename contains a .. refuse to serve it
318 if(strstr(filename, "..") != 0) {
319 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not acceptable.", w->id, filename);
320 buffer_strcat(w->response.data, "Relative filenames are not supported: ");
321 buffer_strcat_htmlescape(w->response.data, filename);
326 char webfilename[FILENAME_MAX + 1];
327 snprintfz(webfilename, FILENAME_MAX, "%s/%s", web_dir, filename);
329 // check if the file exists
331 if(lstat(webfilename, &stat) != 0) {
332 debug(D_WEB_CLIENT_ACCESS, "%llu: File '%s' is not found.", w->id, webfilename);
333 buffer_strcat(w->response.data, "File does not exist, or is not accessible: ");
334 buffer_strcat_htmlescape(w->response.data, webfilename);
338 // check if the file is owned by expected user
339 if(stat.st_uid != web_files_uid()) {
340 error("%llu: File '%s' is owned by user %u (expected user %u). Access Denied.", w->id, webfilename, stat.st_uid, web_files_uid());
341 buffer_strcat(w->response.data, "Access to file is not permitted: ");
342 buffer_strcat_htmlescape(w->response.data, webfilename);
346 // check if the file is owned by expected group
347 if(stat.st_gid != web_files_gid()) {
348 error("%llu: File '%s' is owned by group %u (expected group %u). Access Denied.", w->id, webfilename, stat.st_gid, web_files_gid());
349 buffer_strcat(w->response.data, "Access to file is not permitted: ");
350 buffer_strcat_htmlescape(w->response.data, webfilename);
354 if((stat.st_mode & S_IFMT) == S_IFDIR) {
355 snprintfz(webfilename, FILENAME_MAX, "%s/index.html", filename);
356 return mysendfile(w, webfilename);
359 if((stat.st_mode & S_IFMT) != S_IFREG) {
360 error("%llu: File '%s' is not a regular file. Access Denied.", w->id, webfilename);
361 buffer_strcat(w->response.data, "Access to file is not permitted: ");
362 buffer_strcat_htmlescape(w->response.data, webfilename);
367 w->ifd = open(webfilename, O_NONBLOCK, O_RDONLY);
371 if(errno == EBUSY || errno == EAGAIN) {
372 error("%llu: File '%s' is busy, sending 307 Moved Temporarily to force retry.", w->id, webfilename);
373 buffer_sprintf(w->response.header, "Location: /" WEB_PATH_FILE "/%s\r\n", filename);
374 buffer_strcat(w->response.data, "File is currently busy, please try again later: ");
375 buffer_strcat_htmlescape(w->response.data, webfilename);
379 error("%llu: Cannot open file '%s'.", w->id, webfilename);
380 buffer_strcat(w->response.data, "Cannot open file: ");
381 buffer_strcat_htmlescape(w->response.data, webfilename);
385 if(fcntl(w->ifd, F_SETFL, O_NONBLOCK) < 0)
386 error("%llu: Cannot set O_NONBLOCK on file '%s'.", w->id, webfilename);
388 // pick a Content-Type for the file
389 if(strstr(filename, ".html") != NULL) w->response.data->contenttype = CT_TEXT_HTML;
390 else if(strstr(filename, ".js") != NULL) w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
391 else if(strstr(filename, ".css") != NULL) w->response.data->contenttype = CT_TEXT_CSS;
392 else if(strstr(filename, ".xml") != NULL) w->response.data->contenttype = CT_TEXT_XML;
393 else if(strstr(filename, ".xsl") != NULL) w->response.data->contenttype = CT_TEXT_XSL;
394 else if(strstr(filename, ".txt") != NULL) w->response.data->contenttype = CT_TEXT_PLAIN;
395 else if(strstr(filename, ".svg") != NULL) w->response.data->contenttype = CT_IMAGE_SVG_XML;
396 else if(strstr(filename, ".ttf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_TRUETYPE;
397 else if(strstr(filename, ".otf") != NULL) w->response.data->contenttype = CT_APPLICATION_X_FONT_OPENTYPE;
398 else if(strstr(filename, ".woff2")!= NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF2;
399 else if(strstr(filename, ".woff") != NULL) w->response.data->contenttype = CT_APPLICATION_FONT_WOFF;
400 else if(strstr(filename, ".eot") != NULL) w->response.data->contenttype = CT_APPLICATION_VND_MS_FONTOBJ;
401 else if(strstr(filename, ".png") != NULL) w->response.data->contenttype = CT_IMAGE_PNG;
402 else if(strstr(filename, ".jpg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
403 else if(strstr(filename, ".jpeg") != NULL) w->response.data->contenttype = CT_IMAGE_JPG;
404 else if(strstr(filename, ".gif") != NULL) w->response.data->contenttype = CT_IMAGE_GIF;
405 else if(strstr(filename, ".bmp") != NULL) w->response.data->contenttype = CT_IMAGE_BMP;
406 else if(strstr(filename, ".ico") != NULL) w->response.data->contenttype = CT_IMAGE_XICON;
407 else if(strstr(filename, ".icns") != NULL) w->response.data->contenttype = CT_IMAGE_ICNS;
408 else w->response.data->contenttype = CT_APPLICATION_OCTET_STREAM;
410 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);
412 w->mode = WEB_CLIENT_MODE_FILECOPY;
415 buffer_flush(w->response.data);
416 w->response.rlen = stat.st_size;
417 w->response.data->date = stat.st_mtim.tv_sec;
418 buffer_cacheable(w->response.data);
424 #ifdef NETDATA_WITH_ZLIB
425 void web_client_enable_deflate(struct web_client *w, int gzip) {
426 if(unlikely(w->response.zinitialized)) {
427 debug(D_DEFLATE, "%llu: Compression has already be initialized for this client.", w->id);
431 if(unlikely(w->response.sent)) {
432 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
436 w->response.zstream.zalloc = Z_NULL;
437 w->response.zstream.zfree = Z_NULL;
438 w->response.zstream.opaque = Z_NULL;
440 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
441 w->response.zstream.avail_in = 0;
442 w->response.zstream.total_in = 0;
444 w->response.zstream.next_out = w->response.zbuffer;
445 w->response.zstream.avail_out = 0;
446 w->response.zstream.total_out = 0;
448 w->response.zstream.zalloc = Z_NULL;
449 w->response.zstream.zfree = Z_NULL;
450 w->response.zstream.opaque = Z_NULL;
452 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
453 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
457 // Select GZIP compression: windowbits = 15 + 16 = 31
458 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
459 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
463 w->response.zsent = 0;
464 w->response.zoutput = 1;
465 w->response.zinitialized = 1;
467 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
469 #endif // NETDATA_WITH_ZLIB
471 void buffer_data_options2string(BUFFER *wb, uint32_t options) {
474 if(options & RRDR_OPTION_NONZERO) {
475 if(count++) buffer_strcat(wb, " ");
476 buffer_strcat(wb, "nonzero");
479 if(options & RRDR_OPTION_REVERSED) {
480 if(count++) buffer_strcat(wb, " ");
481 buffer_strcat(wb, "flip");
484 if(options & RRDR_OPTION_JSON_WRAP) {
485 if(count++) buffer_strcat(wb, " ");
486 buffer_strcat(wb, "jsonwrap");
489 if(options & RRDR_OPTION_MIN2MAX) {
490 if(count++) buffer_strcat(wb, " ");
491 buffer_strcat(wb, "min2max");
494 if(options & RRDR_OPTION_MILLISECONDS) {
495 if(count++) buffer_strcat(wb, " ");
496 buffer_strcat(wb, "ms");
499 if(options & RRDR_OPTION_ABSOLUTE) {
500 if(count++) buffer_strcat(wb, " ");
501 buffer_strcat(wb, "absolute");
504 if(options & RRDR_OPTION_SECONDS) {
505 if(count++) buffer_strcat(wb, " ");
506 buffer_strcat(wb, "seconds");
509 if(options & RRDR_OPTION_NULL2ZERO) {
510 if(count++) buffer_strcat(wb, " ");
511 buffer_strcat(wb, "null2zero");
514 if(options & RRDR_OPTION_OBJECTSROWS) {
515 if(count++) buffer_strcat(wb, " ");
516 buffer_strcat(wb, "objectrows");
519 if(options & RRDR_OPTION_GOOGLE_JSON) {
520 if(count++) buffer_strcat(wb, " ");
521 buffer_strcat(wb, "google_json");
524 if(options & RRDR_OPTION_PERCENTAGE) {
525 if(count++) buffer_strcat(wb, " ");
526 buffer_strcat(wb, "percentage");
529 if(options & RRDR_OPTION_NOT_ALIGNED) {
530 if(count++) buffer_strcat(wb, " ");
531 buffer_strcat(wb, "unaligned");
535 uint32_t web_client_api_request_v1_data_options(char *o)
537 uint32_t ret = 0x00000000;
540 while(o && *o && (tok = mystrsep(&o, ", |"))) {
543 if(!strcmp(tok, "nonzero"))
544 ret |= RRDR_OPTION_NONZERO;
545 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
546 ret |= RRDR_OPTION_REVERSED;
547 else if(!strcmp(tok, "jsonwrap"))
548 ret |= RRDR_OPTION_JSON_WRAP;
549 else if(!strcmp(tok, "min2max"))
550 ret |= RRDR_OPTION_MIN2MAX;
551 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
552 ret |= RRDR_OPTION_MILLISECONDS;
553 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
554 ret |= RRDR_OPTION_ABSOLUTE;
555 else if(!strcmp(tok, "seconds"))
556 ret |= RRDR_OPTION_SECONDS;
557 else if(!strcmp(tok, "null2zero"))
558 ret |= RRDR_OPTION_NULL2ZERO;
559 else if(!strcmp(tok, "objectrows"))
560 ret |= RRDR_OPTION_OBJECTSROWS;
561 else if(!strcmp(tok, "google_json"))
562 ret |= RRDR_OPTION_GOOGLE_JSON;
563 else if(!strcmp(tok, "percentage"))
564 ret |= RRDR_OPTION_PERCENTAGE;
565 else if(!strcmp(tok, "unaligned"))
566 ret |= RRDR_OPTION_NOT_ALIGNED;
572 uint32_t web_client_api_request_v1_data_format(char *name)
574 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
575 return DATASOURCE_DATATABLE_JSON;
577 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
578 return DATASOURCE_DATATABLE_JSONP;
580 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
581 return DATASOURCE_JSON;
583 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
584 return DATASOURCE_JSONP;
586 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
587 return DATASOURCE_SSV;
589 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
590 return DATASOURCE_CSV;
592 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
593 return DATASOURCE_TSV;
595 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
596 return DATASOURCE_HTML;
598 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
599 return DATASOURCE_JS_ARRAY;
601 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
602 return DATASOURCE_SSV_COMMA;
604 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
605 return DATASOURCE_CSV_JSON_ARRAY;
607 return DATASOURCE_JSON;
610 uint32_t web_client_api_request_v1_data_google_format(char *name)
612 if(!strcmp(name, "json"))
613 return DATASOURCE_DATATABLE_JSONP;
615 else if(!strcmp(name, "html"))
616 return DATASOURCE_HTML;
618 else if(!strcmp(name, "csv"))
619 return DATASOURCE_CSV;
621 else if(!strcmp(name, "tsv-excel"))
622 return DATASOURCE_TSV;
624 return DATASOURCE_JSON;
627 const char *group_method2string(int group) {
629 case GROUP_UNDEFINED:
644 case GROUP_INCREMENTAL_SUM:
645 return "incremental-sum";
648 return "unknown-group-method";
652 int web_client_api_request_v1_data_group(char *name, int def)
654 if(!strcmp(name, "average"))
655 return GROUP_AVERAGE;
657 else if(!strcmp(name, "min"))
660 else if(!strcmp(name, "max"))
663 else if(!strcmp(name, "sum"))
666 else if(!strcmp(name, "incremental-sum"))
667 return GROUP_INCREMENTAL_SUM;
672 int web_client_api_request_v1_alarms(struct web_client *w, char *url)
677 char *value = mystrsep(&url, "?&");
678 if (!value || !*value) continue;
680 if(!strcmp(value, "all")) all = 1;
681 else if(!strcmp(value, "active")) all = 0;
684 buffer_flush(w->response.data);
685 w->response.data->contenttype = CT_APPLICATION_JSON;
686 health_alarms2json(&localhost, w->response.data, all);
690 int web_client_api_request_v1_alarm_log(struct web_client *w, char *url)
695 char *value = mystrsep(&url, "?&");
696 if (!value || !*value) continue;
698 char *name = mystrsep(&value, "=");
699 if(!name || !*name) continue;
700 if(!value || !*value) continue;
702 if(!strcmp(name, "after")) after = strtoul(value, NULL, 0);
705 buffer_flush(w->response.data);
706 w->response.data->contenttype = CT_APPLICATION_JSON;
707 health_alarm_log2json(&localhost, w->response.data, after);
711 int web_client_api_request_single_chart(struct web_client *w, char *url, void callback(RRDSET *st, BUFFER *buf))
716 buffer_flush(w->response.data);
719 char *value = mystrsep(&url, "?&");
720 if(!value || !*value) continue;
722 char *name = mystrsep(&value, "=");
723 if(!name || !*name) continue;
724 if(!value || !*value) continue;
726 // name and value are now the parameters
727 // they are not null and not empty
729 if(!strcmp(name, "chart")) chart = value;
731 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
736 if(!chart || !*chart) {
737 buffer_sprintf(w->response.data, "No chart id is given at the request.");
741 RRDSET *st = rrdset_find(chart);
742 if(!st) st = rrdset_find_byname(chart);
744 buffer_strcat(w->response.data, "Chart is not found: ");
745 buffer_strcat_htmlescape(w->response.data, chart);
750 w->response.data->contenttype = CT_APPLICATION_JSON;
751 callback(st, w->response.data);
758 int web_client_api_request_v1_alarm_variables(struct web_client *w, char *url)
760 return web_client_api_request_single_chart(w, url, health_api_v1_chart_variables2json);
763 int web_client_api_request_v1_charts(struct web_client *w, char *url)
767 buffer_flush(w->response.data);
768 w->response.data->contenttype = CT_APPLICATION_JSON;
769 rrd_stats_api_v1_charts(w->response.data);
773 int web_client_api_request_v1_chart(struct web_client *w, char *url)
775 return web_client_api_request_single_chart(w, url, rrd_stats_api_v1_chart);
778 int web_client_api_request_v1_badge(struct web_client *w, char *url) {
780 buffer_flush(w->response.data);
782 BUFFER *dimensions = NULL;
784 const char *chart = NULL
788 , *multiply_str = NULL
792 , *label_color = NULL
793 , *value_color = NULL
794 , *refresh_str = NULL
795 , *precision_str = NULL
798 int group = GROUP_AVERAGE;
799 uint32_t options = 0x00000000;
802 char *value = mystrsep(&url, "/?&");
803 if(!value || !*value) continue;
805 char *name = mystrsep(&value, "=");
806 if(!name || !*name) continue;
807 if(!value || !*value) continue;
809 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
811 // name and value are now the parameters
812 // they are not null and not empty
814 if(!strcmp(name, "chart")) chart = value;
815 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
817 dimensions = buffer_create(100);
819 buffer_strcat(dimensions, "|");
820 buffer_strcat(dimensions, value);
822 else if(!strcmp(name, "after")) after_str = value;
823 else if(!strcmp(name, "before")) before_str = value;
824 else if(!strcmp(name, "points")) points_str = value;
825 else if(!strcmp(name, "group")) {
826 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
828 else if(!strcmp(name, "options")) {
829 options |= web_client_api_request_v1_data_options(value);
831 else if(!strcmp(name, "label")) label = value;
832 else if(!strcmp(name, "units")) units = value;
833 else if(!strcmp(name, "label_color")) label_color = value;
834 else if(!strcmp(name, "value_color")) value_color = value;
835 else if(!strcmp(name, "multiply")) multiply_str = value;
836 else if(!strcmp(name, "divide")) divide_str = value;
837 else if(!strcmp(name, "refresh")) refresh_str = value;
838 else if(!strcmp(name, "precision")) precision_str = value;
839 else if(!strcmp(name, "alarm")) alarm = value;
842 if(!chart || !*chart) {
843 buffer_no_cacheable(w->response.data);
844 buffer_sprintf(w->response.data, "No chart id is given at the request.");
848 RRDSET *st = rrdset_find(chart);
849 if(!st) st = rrdset_find_byname(chart);
851 buffer_no_cacheable(w->response.data);
852 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
859 rc = rrdcalc_find(st, alarm);
861 buffer_no_cacheable(w->response.data);
862 buffer_svg(w->response.data, "alarm not found", 0, "", NULL, NULL, 1, -1);
868 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
869 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
870 long long before = (before_str && *before_str )?atol(before_str):0;
871 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
872 int points = (points_str && *points_str )?atoi(points_str):1;
873 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
875 if(!multiply) multiply = 1;
876 if(!divide) divide = 1;
879 if(refresh_str && *refresh_str) {
880 if(!strcmp(refresh_str, "auto")) {
881 if(rc) refresh = rc->update_every;
882 else if(options & RRDR_OPTION_NOT_ALIGNED)
883 refresh = st->update_every;
885 refresh = (int)(before - after);
886 if(refresh < 0) refresh = -refresh;
890 refresh = atoi(refresh_str);
891 if(refresh < 0) refresh = -refresh;
897 char *s = (char *)alarm;
899 if(*s == '_') *s = ' ';
904 else if(dimensions) {
905 const char *dim = buffer_tostring(dimensions);
906 if(*dim == '|') dim++;
919 else if(options & RRDR_OPTION_PERCENTAGE)
925 debug(D_WEB_CLIENT, "%llu: API command 'badge.svg' for chart '%s', alarm '%s', dimensions '%s', after '%lld', before '%lld', points '%d', group '%d', options '0x%08x'"
929 , (dimensions)?buffer_tostring(dimensions):""
938 calculated_number n = rc->value;
939 if(isnan(n) || isinf(n)) n = 0;
942 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
943 w->response.data->expires = now_realtime_sec() + refresh;
945 else buffer_no_cacheable(w->response.data);
949 case RRDCALC_STATUS_CRITICAL:
953 case RRDCALC_STATUS_WARNING:
954 value_color = "orange";
957 case RRDCALC_STATUS_CLEAR:
958 value_color = "brightgreen";
961 case RRDCALC_STATUS_UNDEFINED:
962 value_color = "lightgrey";
965 case RRDCALC_STATUS_UNINITIALIZED:
966 value_color = "#000";
970 value_color = "grey";
975 buffer_svg(w->response.data,
977 rc->value * multiply / divide,
986 time_t latest_timestamp = 0;
987 int value_is_null = 1;
988 calculated_number n = 0;
991 // if the collected value is too old, don't calculate its value
992 if (rrdset_last_entry_t(st) >= (now_realtime_sec() - (st->update_every * st->gap_when_lost_iterations_above)))
996 (dimensions) ? buffer_tostring(dimensions) : NULL,
1006 // if the value cannot be calculated, show empty badge
1008 buffer_no_cacheable(w->response.data);
1013 else if (refresh > 0) {
1014 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
1015 w->response.data->expires = now_realtime_sec() + refresh;
1017 else buffer_no_cacheable(w->response.data);
1020 buffer_svg(w->response.data,
1022 n * multiply / divide,
1032 buffer_free(dimensions);
1036 // returns the HTTP code
1037 int web_client_api_request_v1_data(struct web_client *w, char *url)
1039 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
1042 BUFFER *dimensions = NULL;
1044 buffer_flush(w->response.data);
1046 char *google_version = "0.6",
1047 *google_reqId = "0",
1049 *google_out = "json",
1050 *responseHandler = NULL,
1051 *outFileName = NULL;
1053 time_t last_timestamp_in_data = 0, google_timestamp = 0;
1056 , *before_str = NULL
1058 , *points_str = NULL;
1060 int group = GROUP_AVERAGE;
1061 uint32_t format = DATASOURCE_JSON;
1062 uint32_t options = 0x00000000;
1065 char *value = mystrsep(&url, "?&");
1066 if(!value || !*value) continue;
1068 char *name = mystrsep(&value, "=");
1069 if(!name || !*name) continue;
1070 if(!value || !*value) continue;
1072 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
1074 // name and value are now the parameters
1075 // they are not null and not empty
1077 if(!strcmp(name, "chart")) chart = value;
1078 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
1079 if(!dimensions) dimensions = buffer_create(100);
1080 buffer_strcat(dimensions, "|");
1081 buffer_strcat(dimensions, value);
1083 else if(!strcmp(name, "after")) after_str = value;
1084 else if(!strcmp(name, "before")) before_str = value;
1085 else if(!strcmp(name, "points")) points_str = value;
1086 else if(!strcmp(name, "group")) {
1087 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
1089 else if(!strcmp(name, "format")) {
1090 format = web_client_api_request_v1_data_format(value);
1092 else if(!strcmp(name, "options")) {
1093 options |= web_client_api_request_v1_data_options(value);
1095 else if(!strcmp(name, "callback")) {
1096 responseHandler = value;
1098 else if(!strcmp(name, "filename")) {
1099 outFileName = value;
1101 else if(!strcmp(name, "tqx")) {
1102 // parse Google Visualization API options
1103 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
1104 char *tqx_name, *tqx_value;
1107 tqx_value = mystrsep(&value, ";");
1108 if(!tqx_value || !*tqx_value) continue;
1110 tqx_name = mystrsep(&tqx_value, ":");
1111 if(!tqx_name || !*tqx_name) continue;
1112 if(!tqx_value || !*tqx_value) continue;
1114 if(!strcmp(tqx_name, "version"))
1115 google_version = tqx_value;
1116 else if(!strcmp(tqx_name, "reqId"))
1117 google_reqId = tqx_value;
1118 else if(!strcmp(tqx_name, "sig")) {
1119 google_sig = tqx_value;
1120 google_timestamp = strtoul(google_sig, NULL, 0);
1122 else if(!strcmp(tqx_name, "out")) {
1123 google_out = tqx_value;
1124 format = web_client_api_request_v1_data_google_format(google_out);
1126 else if(!strcmp(tqx_name, "responseHandler"))
1127 responseHandler = tqx_value;
1128 else if(!strcmp(tqx_name, "outFileName"))
1129 outFileName = tqx_value;
1134 if(!chart || !*chart) {
1135 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1139 RRDSET *st = rrdset_find(chart);
1140 if(!st) st = rrdset_find_byname(chart);
1142 buffer_strcat(w->response.data, "Chart is not found: ");
1143 buffer_strcat_htmlescape(w->response.data, chart);
1148 long long before = (before_str && *before_str)?atol(before_str):0;
1149 long long after = (after_str && *after_str) ?atol(after_str):0;
1150 int points = (points_str && *points_str)?atoi(points_str):0;
1152 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'"
1155 , (dimensions)?buffer_tostring(dimensions):""
1164 if(outFileName && *outFileName) {
1165 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1166 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1169 if(format == DATASOURCE_DATATABLE_JSONP) {
1170 if(responseHandler == NULL)
1171 responseHandler = "google.visualization.Query.setResponse";
1173 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1174 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1177 buffer_sprintf(w->response.data,
1178 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1179 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1181 else if(format == DATASOURCE_JSONP) {
1182 if(responseHandler == NULL)
1183 responseHandler = "callback";
1185 buffer_strcat(w->response.data, responseHandler);
1186 buffer_strcat(w->response.data, "(");
1189 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1191 if(format == DATASOURCE_DATATABLE_JSONP) {
1192 if(google_timestamp < last_timestamp_in_data)
1193 buffer_strcat(w->response.data, "});");
1196 // the client already has the latest data
1197 buffer_flush(w->response.data);
1198 buffer_sprintf(w->response.data,
1199 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1200 responseHandler, google_version, google_reqId);
1203 else if(format == DATASOURCE_JSONP)
1204 buffer_strcat(w->response.data, ");");
1207 if(dimensions) buffer_free(dimensions);
1212 #define REGISTRY_VERIFY_COOKIES_GUID "give-me-back-this-cookie-now--please"
1214 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1216 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1217 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1218 hash_to = 0 /*, hash_redirects = 0 */;
1220 if(unlikely(!hash_action)) {
1221 hash_action = simple_hash("action");
1222 hash_access = simple_hash("access");
1223 hash_hello = simple_hash("hello");
1224 hash_delete = simple_hash("delete");
1225 hash_search = simple_hash("search");
1226 hash_switch = simple_hash("switch");
1227 hash_machine = simple_hash("machine");
1228 hash_url = simple_hash("url");
1229 hash_name = simple_hash("name");
1230 hash_delete_url = simple_hash("delete_url");
1231 hash_for = simple_hash("for");
1232 hash_to = simple_hash("to");
1234 hash_redirects = simple_hash("redirects");
1238 char person_guid[36 + 1] = "";
1240 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1243 // The browser may send multiple cookies with our id
1245 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1247 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1250 char *machine_guid = NULL,
1251 *machine_url = NULL,
1253 *search_machine_guid = NULL,
1255 *to_person_guid = NULL;
1261 char *value = mystrsep(&url, "?&");
1262 if (!value || !*value) continue;
1264 char *name = mystrsep(&value, "=");
1265 if (!name || !*name) continue;
1266 if (!value || !*value) continue;
1268 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1270 uint32_t hash = simple_hash(name);
1272 if(hash == hash_action && !strcmp(name, "action")) {
1273 uint32_t vhash = simple_hash(value);
1275 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1276 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1277 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1278 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1279 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1280 #ifdef NETDATA_INTERNAL_CHECKS
1281 else error("unknown registry action '%s'", value);
1282 #endif /* NETDATA_INTERNAL_CHECKS */
1285 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1286 redirects = atoi(value);
1288 else if(hash == hash_machine && !strcmp(name, "machine"))
1289 machine_guid = value;
1291 else if(hash == hash_url && !strcmp(name, "url"))
1292 machine_url = value;
1294 else if(action == 'A') {
1295 if(hash == hash_name && !strcmp(name, "name"))
1298 else if(action == 'D') {
1299 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1302 else if(action == 'S') {
1303 if(hash == hash_for && !strcmp(name, "for"))
1304 search_machine_guid = value;
1306 else if(action == 'W') {
1307 if(hash == hash_to && !strcmp(name, "to"))
1308 to_person_guid = value;
1310 #ifdef NETDATA_INTERNAL_CHECKS
1311 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1312 #endif /* NETDATA_INTERNAL_CHECKS */
1315 if(web_donotrack_comply && w->donottrack) {
1316 buffer_flush(w->response.data);
1317 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.");
1321 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1322 error("Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1323 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1324 buffer_flush(w->response.data);
1325 buffer_strcat(w->response.data, "Invalid registry Access request.");
1328 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1329 error("Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1330 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1331 buffer_flush(w->response.data);
1332 buffer_strcat(w->response.data, "Invalid registry Delete request.");
1335 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1336 error("Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1337 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1338 buffer_flush(w->response.data);
1339 buffer_strcat(w->response.data, "Invalid registry Search request.");
1342 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1343 error("Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1344 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1345 buffer_flush(w->response.data);
1346 buffer_strcat(w->response.data, "Invalid registry Switch request.");
1352 w->tracking_required = 1;
1353 if(registry_verify_cookies_redirects() > 0 && (!cookie || !person_guid[0])) {
1354 buffer_flush(w->response.data);
1355 registry_set_cookie(w, REGISTRY_VERIFY_COOKIES_GUID);
1356 w->response.data->contenttype = CT_APPLICATION_JSON;
1357 buffer_sprintf(w->response.data, "{ \"status\": \"redirect\", \"registry\": \"%s\" }", registry_to_announce());
1361 * it seems that web browsers are ignoring 307 (Moved Temporarily)
1362 * under certain conditions, when using CORS
1363 * so this is commented and we use application level redirects instead
1367 if(redirects > registry_verify_cookies_redirects()) {
1368 buffer_flush(w->response.data);
1369 buffer_sprintf(w->response.data, "Your browser does not support cookies");
1373 char *encoded_url = url_encode(machine_url);
1375 error("%llu: Cannot URL encode string '%s'", w->id, machine_url);
1379 char *encoded_name = url_encode(url_name);
1382 error("%llu: Cannot URL encode string '%s'", w->id, url_name);
1386 char *encoded_guid = url_encode(machine_guid);
1390 error("%llu: Cannot URL encode string '%s'", w->id, machine_guid);
1394 buffer_sprintf(w->response.header, "Location: %s/api/v1/registry?action=access&machine=%s&name=%s&url=%s&redirects=%d\r\n",
1395 registry_to_announce(), encoded_guid, encoded_name, encoded_url, redirects);
1404 if(unlikely(cookie && person_guid[0] && !strcmp(person_guid, REGISTRY_VERIFY_COOKIES_GUID)))
1405 person_guid[0] = '\0';
1407 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, now_realtime_sec());
1410 w->tracking_required = 1;
1411 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, now_realtime_sec());
1414 w->tracking_required = 1;
1415 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, now_realtime_sec());
1418 w->tracking_required = 1;
1419 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, now_realtime_sec());
1422 return registry_request_hello_json(w);
1425 buffer_flush(w->response.data);
1426 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1431 int web_client_api_request_v1(struct web_client *w, char *url) {
1432 static uint32_t hash_data = 0, hash_chart = 0, hash_charts = 0, hash_registry = 0, hash_badge = 0, hash_alarms = 0, hash_alarm_log = 0, hash_alarm_variables = 0;
1434 if(unlikely(hash_data == 0)) {
1435 hash_data = simple_hash("data");
1436 hash_chart = simple_hash("chart");
1437 hash_charts = simple_hash("charts");
1438 hash_registry = simple_hash("registry");
1439 hash_badge = simple_hash("badge.svg");
1440 hash_alarms = simple_hash("alarms");
1441 hash_alarm_log = simple_hash("alarm_log");
1442 hash_alarm_variables = simple_hash("alarm_variables");
1446 char *tok = mystrsep(&url, "/?&");
1448 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1449 uint32_t hash = simple_hash(tok);
1451 if(hash == hash_data && !strcmp(tok, "data"))
1452 return web_client_api_request_v1_data(w, url);
1454 else if(hash == hash_chart && !strcmp(tok, "chart"))
1455 return web_client_api_request_v1_chart(w, url);
1457 else if(hash == hash_charts && !strcmp(tok, "charts"))
1458 return web_client_api_request_v1_charts(w, url);
1460 else if(hash == hash_registry && !strcmp(tok, "registry"))
1461 return web_client_api_request_v1_registry(w, url);
1463 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1464 return web_client_api_request_v1_badge(w, url);
1466 else if(hash == hash_alarms && !strcmp(tok, "alarms"))
1467 return web_client_api_request_v1_alarms(w, url);
1469 else if(hash == hash_alarm_log && !strcmp(tok, "alarm_log"))
1470 return web_client_api_request_v1_alarm_log(w, url);
1472 else if(hash == hash_alarm_variables && !strcmp(tok, "alarm_variables"))
1473 return web_client_api_request_v1_alarm_variables(w, url);
1476 buffer_flush(w->response.data);
1477 buffer_strcat(w->response.data, "Unsupported v1 API command: ");
1478 buffer_strcat_htmlescape(w->response.data, tok);
1483 buffer_flush(w->response.data);
1484 buffer_sprintf(w->response.data, "Which API v1 command?");
1489 int web_client_api_request(struct web_client *w, char *url)
1491 // get the api version
1492 char *tok = mystrsep(&url, "/?&");
1494 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1495 if(strcmp(tok, "v1") == 0)
1496 return web_client_api_request_v1(w, url);
1498 buffer_flush(w->response.data);
1499 buffer_strcat(w->response.data, "Unsupported API version: ");
1500 buffer_strcat_htmlescape(w->response.data, tok);
1505 buffer_flush(w->response.data);
1506 buffer_sprintf(w->response.data, "Which API version?");
1511 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1514 buffer_flush(w->response.data);
1515 buffer_sprintf(w->response.data, "Incomplete request.");
1521 char *args = strchr(url, '?');
1527 // get the name of the data to show
1528 char *tok = mystrsep(&url, "/");
1531 // do we have such a data set?
1533 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1534 st = rrdset_find_byname(tok);
1535 if(!st) st = rrdset_find(tok);
1540 // try to send a file with that name
1541 buffer_flush(w->response.data);
1542 return(mysendfile(w, tok));
1546 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1548 // how many entries does the client want?
1549 int lines = rrd_default_history_entries;
1550 int group_count = 1;
1551 time_t after = 0, before = 0;
1552 int group_method = GROUP_AVERAGE;
1556 // parse the lines required
1557 tok = mystrsep(&url, "/");
1558 if(tok) lines = atoi(tok);
1559 if(lines < 1) lines = 1;
1562 // parse the group count required
1563 tok = mystrsep(&url, "/");
1564 if(tok && *tok) group_count = atoi(tok);
1565 if(group_count < 1) group_count = 1;
1566 //if(group_count > save_history / 20) group_count = save_history / 20;
1569 // parse the grouping method required
1570 tok = mystrsep(&url, "/");
1572 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1573 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1574 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1575 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1580 tok = mystrsep(&url, "/");
1581 if(tok && *tok) after = strtoul(tok, NULL, 10);
1582 if(after < 0) after = 0;
1585 // parse before time
1586 tok = mystrsep(&url, "/");
1587 if(tok && *tok) before = strtoul(tok, NULL, 10);
1588 if(before < 0) before = 0;
1592 tok = mystrsep(&url, "/");
1593 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1596 w->response.data->contenttype = CT_APPLICATION_JSON;
1597 buffer_flush(w->response.data);
1599 char *google_version = "0.6";
1600 char *google_reqId = "0";
1601 char *google_sig = "0";
1602 char *google_out = "json";
1603 char *google_responseHandler = "google.visualization.Query.setResponse";
1604 char *google_outFileName = NULL;
1605 time_t last_timestamp_in_data = 0;
1606 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1608 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1611 tok = mystrsep(&args, "&");
1613 char *name = mystrsep(&tok, "=");
1614 if(name && *name && strcmp(name, "tqx") == 0) {
1615 char *key = mystrsep(&tok, ":");
1616 char *value = mystrsep(&tok, ";");
1617 if(key && value && *key && *value) {
1618 if(strcmp(key, "version") == 0)
1619 google_version = value;
1621 else if(strcmp(key, "reqId") == 0)
1622 google_reqId = value;
1624 else if(strcmp(key, "sig") == 0)
1627 else if(strcmp(key, "out") == 0)
1630 else if(strcmp(key, "responseHandler") == 0)
1631 google_responseHandler = value;
1633 else if(strcmp(key, "outFileName") == 0)
1634 google_outFileName = value;
1640 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1641 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1644 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1645 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1647 // check the client wants json
1648 if(strcmp(google_out, "json") != 0) {
1649 buffer_sprintf(w->response.data,
1650 "%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.'}]});",
1651 google_responseHandler, google_version, google_reqId, google_out);
1657 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1658 buffer_sprintf(w->response.data,
1659 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1660 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1663 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1664 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1666 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);
1668 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1669 if(timestamp_in_data > last_timestamp_in_data)
1670 buffer_strcat(w->response.data, "});");
1673 // the client already has the latest data
1674 buffer_flush(w->response.data);
1675 buffer_sprintf(w->response.data,
1676 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1677 google_responseHandler, google_version, google_reqId);
1684 const char *web_content_type_to_string(uint8_t contenttype) {
1685 switch(contenttype) {
1687 return "text/html; charset=utf-8";
1689 case CT_APPLICATION_XML:
1690 return "application/xml; charset=utf-8";
1692 case CT_APPLICATION_JSON:
1693 return "application/json; charset=utf-8";
1695 case CT_APPLICATION_X_JAVASCRIPT:
1696 return "application/x-javascript; charset=utf-8";
1699 return "text/css; charset=utf-8";
1702 return "text/xml; charset=utf-8";
1705 return "text/xsl; charset=utf-8";
1707 case CT_APPLICATION_OCTET_STREAM:
1708 return "application/octet-stream";
1710 case CT_IMAGE_SVG_XML:
1711 return "image/svg+xml";
1713 case CT_APPLICATION_X_FONT_TRUETYPE:
1714 return "application/x-font-truetype";
1716 case CT_APPLICATION_X_FONT_OPENTYPE:
1717 return "application/x-font-opentype";
1719 case CT_APPLICATION_FONT_WOFF:
1720 return "application/font-woff";
1722 case CT_APPLICATION_FONT_WOFF2:
1723 return "application/font-woff2";
1725 case CT_APPLICATION_VND_MS_FONTOBJ:
1726 return "application/vnd.ms-fontobject";
1732 return "image/jpeg";
1737 case CT_IMAGE_XICON:
1738 return "image/x-icon";
1744 return "image/icns";
1748 return "text/plain; charset=utf-8";
1753 const char *web_response_code_to_string(int code) {
1759 return "Temporary Redirect";
1762 return "Bad Request";
1771 return "Preconditions Failed";
1774 if(code >= 100 && code < 200)
1775 return "Informational";
1777 if(code >= 200 && code < 300)
1778 return "Successful";
1780 if(code >= 300 && code < 400)
1781 return "Redirection";
1783 if(code >= 400 && code < 500)
1784 return "Bad Request";
1786 if(code >= 500 && code < 600)
1787 return "Server Error";
1789 return "Undefined Error";
1793 static inline char *http_header_parse(struct web_client *w, char *s) {
1794 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1796 if(unlikely(!hash_origin)) {
1797 hash_origin = simple_uhash("Origin");
1798 hash_connection = simple_uhash("Connection");
1799 hash_accept_encoding = simple_uhash("Accept-Encoding");
1800 hash_donottrack = simple_uhash("DNT");
1806 while(*e && *e != ':') e++;
1813 char *v = e + 1, *ve;
1815 // skip leading spaces from value
1816 while(*v == ' ') v++;
1820 while(*ve && *ve != '\r') ve++;
1821 if(!*ve || ve[1] != '\n') {
1826 // terminate the value
1829 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1830 uint32_t hash = simple_uhash(s);
1832 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1833 strncpyz(w->origin, v, ORIGIN_MAX);
1835 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1836 if(strcasestr(v, "keep-alive"))
1839 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1840 if(*v == '0') w->donottrack = 0;
1841 else if(*v == '1') w->donottrack = 1;
1843 #ifdef NETDATA_WITH_ZLIB
1844 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1845 if(web_enable_gzip) {
1846 if(strcasestr(v, "gzip"))
1847 web_client_enable_deflate(w, 1);
1849 // does not seem to work
1850 // else if(strcasestr(v, "deflate"))
1851 // web_client_enable_deflate(w, 0);
1854 #endif /* NETDATA_WITH_ZLIB */
1861 // http_request_validate()
1863 // = 0 : all good, process the request
1864 // > 0 : request is not supported
1865 // < 0 : request is incomplete - wait for more data
1867 static inline int http_request_validate(struct web_client *w) {
1868 char *s = w->response.data->buffer, *encoded_url = NULL;
1870 // is is a valid request?
1871 if(!strncmp(s, "GET ", 4)) {
1872 encoded_url = s = &s[4];
1873 w->mode = WEB_CLIENT_MODE_NORMAL;
1875 else if(!strncmp(s, "OPTIONS ", 8)) {
1876 encoded_url = s = &s[8];
1877 w->mode = WEB_CLIENT_MODE_OPTIONS;
1880 w->wait_receive = 0;
1884 // find the SPACE + "HTTP/"
1886 // find the next space
1887 while (*s && *s != ' ') s++;
1889 // is it SPACE + "HTTP/" ?
1890 if(*s && !strncmp(s, " HTTP/", 6)) break;
1894 // incomplete requests
1896 w->wait_receive = 1;
1900 // we have the end of encoded_url - remember it
1903 // make sure we have complete request
1904 // complete requests contain: \r\n\r\n
1907 while(*s && *s++ != '\r');
1909 // did we reach the end?
1910 if(unlikely(!*s)) break;
1913 if(likely(*s++ == '\n')) {
1915 // is it again \r\n ? (header end)
1916 if(unlikely(*s == '\r' && s[1] == '\n')) {
1917 // a valid complete HTTP request found
1920 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1923 // copy the URL - we are going to overwrite parts of it
1924 // FIXME -- we should avoid it
1925 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1927 w->wait_receive = 0;
1931 // another header line
1932 s = http_header_parse(w, s);
1936 // incomplete request
1937 w->wait_receive = 1;
1941 void web_client_process(struct web_client *w) {
1944 hash_netdata_conf = 0,
1946 hash_datasource = 0,
1951 #ifdef NETDATA_INTERNAL_CHECKS
1952 static uint32_t hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1956 now_realtime_timeval(&w->tv_in);
1958 if(unlikely(!hash_api)) {
1959 hash_api = simple_hash("api");
1960 hash_netdata_conf = simple_hash("netdata.conf");
1961 hash_data = simple_hash(WEB_PATH_DATA);
1962 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1963 hash_graph = simple_hash(WEB_PATH_GRAPH);
1964 hash_list = simple_hash("list");
1965 hash_all_json = simple_hash("all.json");
1966 #ifdef NETDATA_INTERNAL_CHECKS
1967 hash_exit = simple_hash("exit");
1968 hash_debug = simple_hash("debug");
1969 hash_mirror = simple_hash("mirror");
1976 int what_to_do = http_request_validate(w);
1978 // wait for more data
1979 if(what_to_do < 0) {
1980 if(w->response.data->len > TOO_BIG_REQUEST) {
1981 strcpy(w->last_url, "too big request");
1983 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1986 buffer_flush(w->response.data);
1987 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1990 // wait for more data
1994 else if(what_to_do > 0) {
1995 // strcpy(w->last_url, "not a valid request");
1997 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
2000 buffer_flush(w->response.data);
2001 buffer_strcat(w->response.data, "I don't understand you...\r\n");
2003 else { // what_to_do == 0
2004 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2006 w->response.data->contenttype = CT_TEXT_PLAIN;
2007 buffer_flush(w->response.data);
2008 buffer_strcat(w->response.data, "OK");
2011 char *url = w->decoded_url;
2012 char *tok = mystrsep(&url, "/?");
2014 uint32_t hash = simple_hash(tok);
2015 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
2017 if(hash == hash_api && strcmp(tok, "api") == 0) {
2018 // the client is requesting api access
2019 code = web_client_api_request(w, url);
2021 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
2023 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
2025 w->response.data->contenttype = CT_TEXT_PLAIN;
2026 buffer_flush(w->response.data);
2027 generate_config(w->response.data, 0);
2029 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
2030 // the client is requesting rrd data -- OLD API
2031 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
2033 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
2034 // the client is requesting google datasource -- OLD API
2035 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
2037 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
2038 // the client is requesting an rrd graph -- OLD API
2040 // get the name of the data to show
2041 tok = mystrsep(&url, "/?&");
2043 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2045 // do we have such a data set?
2046 RRDSET *st = rrdset_find_byname(tok);
2047 if(!st) st = rrdset_find(tok);
2050 // try to send a file with that name
2051 buffer_flush(w->response.data);
2052 code = mysendfile(w, tok);
2056 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
2057 w->response.data->contenttype = CT_APPLICATION_JSON;
2058 buffer_flush(w->response.data);
2059 rrd_stats_graph_json(st, url, w->response.data);
2064 buffer_flush(w->response.data);
2065 buffer_strcat(w->response.data, "Graph name?\r\n");
2068 else if(hash == hash_list && strcmp(tok, "list") == 0) {
2072 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
2074 buffer_flush(w->response.data);
2075 RRDSET *st = localhost.rrdset_root;
2077 for ( ; st ; st = st->next )
2078 buffer_sprintf(w->response.data, "%s\n", st->name);
2080 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
2083 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
2085 w->response.data->contenttype = CT_APPLICATION_JSON;
2086 buffer_flush(w->response.data);
2087 rrd_stats_all_json(w->response.data);
2089 #ifdef NETDATA_INTERNAL_CHECKS
2090 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
2092 w->response.data->contenttype = CT_TEXT_PLAIN;
2093 buffer_flush(w->response.data);
2096 buffer_strcat(w->response.data, "ok, will do...");
2098 buffer_strcat(w->response.data, "I am doing it already");
2100 error("web request to exit received.");
2101 netdata_cleanup_and_exit(0);
2104 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
2105 buffer_flush(w->response.data);
2107 // get the name of the data to show
2108 tok = mystrsep(&url, "/?&");
2110 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2112 // do we have such a data set?
2113 RRDSET *st = rrdset_find_byname(tok);
2114 if(!st) st = rrdset_find(tok);
2117 buffer_strcat(w->response.data, "Chart is not found: ");
2118 buffer_strcat_htmlescape(w->response.data, tok);
2119 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
2123 debug_flags |= D_RRD_STATS;
2124 st->debug = !st->debug;
2125 buffer_sprintf(w->response.data, "Chart has now debug %s: ", st->debug?"enabled":"disabled");
2126 buffer_strcat_htmlescape(w->response.data, tok);
2127 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
2132 buffer_flush(w->response.data);
2133 buffer_strcat(w->response.data, "debug which chart?\r\n");
2136 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
2139 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
2141 // replace the zero bytes with spaces
2142 buffer_char_replace(w->response.data, '\0', ' ');
2144 // just leave the buffer as is
2145 // it will be copied back to the client
2147 #endif /* NETDATA_INTERNAL_CHECKS */
2149 char filename[FILENAME_MAX+1];
2151 strncpyz(filename, w->last_url, FILENAME_MAX);
2152 tok = mystrsep(&url, "?");
2153 buffer_flush(w->response.data);
2154 code = mysendfile(w, (tok && *tok)?tok:"/");
2158 char filename[FILENAME_MAX+1];
2160 strncpyz(filename, w->last_url, FILENAME_MAX);
2161 tok = mystrsep(&url, "?");
2162 buffer_flush(w->response.data);
2163 code = mysendfile(w, (tok && *tok)?tok:"/");
2168 now_realtime_timeval(&w->tv_ready);
2169 w->response.sent = 0;
2170 w->response.code = code;
2172 // set a proper last modified date
2173 if(unlikely(!w->response.data->date))
2174 w->response.data->date = w->tv_ready.tv_sec;
2176 if(unlikely(code != 200))
2177 buffer_no_cacheable(w->response.data);
2179 // set a proper expiration date, if not already set
2180 if(unlikely(!w->response.data->expires)) {
2181 if(w->response.data->options & WB_CONTENT_NO_CACHEABLE)
2182 w->response.data->expires = w->tv_ready.tv_sec + rrd_update_every;
2184 w->response.data->expires = w->tv_ready.tv_sec + 86400;
2187 // prepare the HTTP response header
2188 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
2190 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
2191 const char *code_msg = web_response_code_to_string(code);
2193 // prepare the last modified and expiration dates
2194 char date[32], edate[32];
2196 struct tm tmbuf, *tm;
2198 tm = gmtime_r(&w->response.data->date, &tmbuf);
2199 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
2201 tm = gmtime_r(&w->response.data->expires, &tmbuf);
2202 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", tm);
2205 buffer_sprintf(w->response.header_output,
2206 "HTTP/1.1 %d %s\r\n"
2207 "Connection: %s\r\n"
2208 "Server: NetData Embedded HTTP Server\r\n"
2209 "Access-Control-Allow-Origin: %s\r\n"
2210 "Access-Control-Allow-Credentials: true\r\n"
2211 "Content-Type: %s\r\n"
2214 , w->keepalive?"keep-alive":"close"
2216 , content_type_string
2220 if(w->cookie1[0] || w->cookie2[0]) {
2222 buffer_sprintf(w->response.header_output,
2223 "Set-Cookie: %s\r\n",
2228 buffer_sprintf(w->response.header_output,
2229 "Set-Cookie: %s\r\n",
2233 if(web_donotrack_comply)
2234 buffer_sprintf(w->response.header_output,
2235 "Tk: T;cookies\r\n");
2238 if(web_donotrack_comply) {
2239 if(w->tracking_required)
2240 buffer_sprintf(w->response.header_output,
2241 "Tk: T;cookies\r\n");
2243 buffer_sprintf(w->response.header_output,
2248 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2249 buffer_strcat(w->response.header_output,
2250 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2251 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie, pragma, cache-control\r\n"
2252 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2256 buffer_sprintf(w->response.header_output,
2257 "Cache-Control: %s\r\n"
2259 (w->response.data->options & WB_CONTENT_NO_CACHEABLE)?"no-cache":"public",
2263 // copy a possibly available custom header
2264 if(unlikely(buffer_strlen(w->response.header)))
2265 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2267 // headers related to the transfer method
2268 if(likely(w->response.zoutput)) {
2269 buffer_strcat(w->response.header_output,
2270 "Content-Encoding: gzip\r\n"
2271 "Transfer-Encoding: chunked\r\n"
2275 if(likely((w->response.data->len || w->response.rlen))) {
2276 // we know the content length, put it
2277 buffer_sprintf(w->response.header_output, "Content-Length: %zu\r\n", w->response.data->len? w->response.data->len: w->response.rlen);
2280 // we don't know the content length, disable keep-alive
2285 // end of HTTP header
2286 buffer_strcat(w->response.header_output, "\r\n");
2288 // sent the HTTP header
2289 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2291 , buffer_strlen(w->response.header_output)
2292 , buffer_tostring(w->response.header_output)
2295 web_client_crock_socket(w);
2297 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2298 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2300 w->stats_sent_bytes += bytes;
2302 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2304 , buffer_strlen(w->response.header_output)
2307 WEB_CLIENT_IS_DEAD(w);
2311 w->stats_sent_bytes += bytes;
2313 // enable sending immediately if we have data
2314 if(w->response.data->len) w->wait_send = 1;
2315 else w->wait_send = 0;
2319 case WEB_CLIENT_MODE_OPTIONS:
2320 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2323 case WEB_CLIENT_MODE_NORMAL:
2324 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2327 case WEB_CLIENT_MODE_FILECOPY:
2328 if(w->response.rlen) {
2329 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2330 w->wait_receive = 1;
2333 // utilize the kernel sendfile() for copying the file to the socket.
2334 // this block of code can be commented, without anything missing.
2335 // when it is commented, the program will copy the data using async I/O.
2337 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2338 if(len != w->response.data->rbytes)
2339 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2341 web_client_reset(w);
2346 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2350 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2355 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2357 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2359 sprintf(buf, "%zX\r\n", len);
2361 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2363 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2364 w->stats_sent_bytes += bytes;
2367 else if(bytes == 0) {
2368 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2369 WEB_CLIENT_IS_DEAD(w);
2372 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2373 WEB_CLIENT_IS_DEAD(w);
2379 ssize_t web_client_send_chunk_close(struct web_client *w)
2381 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2383 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2385 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2386 w->stats_sent_bytes += bytes;
2389 else if(bytes == 0) {
2390 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2391 WEB_CLIENT_IS_DEAD(w);
2394 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2395 WEB_CLIENT_IS_DEAD(w);
2401 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2403 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2405 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2407 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2408 w->stats_sent_bytes += bytes;
2411 else if(bytes == 0) {
2412 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2413 WEB_CLIENT_IS_DEAD(w);
2416 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2417 WEB_CLIENT_IS_DEAD(w);
2423 #ifdef NETDATA_WITH_ZLIB
2424 ssize_t web_client_send_deflate(struct web_client *w)
2426 ssize_t len = 0, t = 0;
2428 // when using compression,
2429 // w->response.sent is the amount of bytes passed through compression
2431 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.",
2432 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);
2434 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) {
2435 // there is nothing to send
2437 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2439 // finalize the chunk
2440 if(w->response.sent != 0) {
2441 t = web_client_send_chunk_finalize(w);
2445 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2446 // we have to wait, more data will come
2447 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2452 if(unlikely(!w->keepalive)) {
2453 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2454 WEB_CLIENT_IS_DEAD(w);
2459 web_client_reset(w);
2460 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2464 if(w->response.zhave == w->response.zsent) {
2465 // compress more input data
2467 // close the previous open chunk
2468 if(w->response.sent != 0) {
2469 t = web_client_send_chunk_close(w);
2473 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);
2475 // give the compressor all the data not passed through the compressor yet
2476 if(w->response.data->len > w->response.sent) {
2477 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2478 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2481 // reset the compressor output buffer
2482 w->response.zstream.next_out = w->response.zbuffer;
2483 w->response.zstream.avail_out = ZLIB_CHUNK;
2485 // ask for FINISH if we have all the input
2486 int flush = Z_SYNC_FLUSH;
2487 if(w->mode == WEB_CLIENT_MODE_NORMAL
2488 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2490 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2493 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2497 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2498 error("%llu: Compression failed. Closing down client.", w->id);
2499 web_client_reset(w);
2503 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2504 w->response.zsent = 0;
2506 // keep track of the bytes passed through the compressor
2507 w->response.sent = w->response.data->len;
2509 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2512 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2513 if(t2 < 0) return t2;
2517 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2519 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2521 w->stats_sent_bytes += len;
2522 w->response.zsent += len;
2524 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2527 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2528 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2530 WEB_CLIENT_IS_DEAD(w);
2533 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2534 WEB_CLIENT_IS_DEAD(w);
2539 #endif // NETDATA_WITH_ZLIB
2541 ssize_t web_client_send(struct web_client *w) {
2542 #ifdef NETDATA_WITH_ZLIB
2543 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2544 #endif // NETDATA_WITH_ZLIB
2548 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2549 // there is nothing to send
2551 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2553 // there can be two cases for this
2554 // A. we have done everything
2555 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2557 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2558 // we have to wait, more data will come
2559 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2564 if(unlikely(!w->keepalive)) {
2565 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2566 WEB_CLIENT_IS_DEAD(w);
2570 web_client_reset(w);
2571 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2575 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2576 if(likely(bytes > 0)) {
2577 w->stats_sent_bytes += bytes;
2578 w->response.sent += bytes;
2579 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2581 else if(likely(bytes == 0)) {
2582 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2583 WEB_CLIENT_IS_DEAD(w);
2586 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2587 WEB_CLIENT_IS_DEAD(w);
2593 ssize_t web_client_receive(struct web_client *w)
2595 // do we have any space for more data?
2596 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2598 ssize_t left = w->response.data->size - w->response.data->len;
2601 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2602 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2604 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2606 if(likely(bytes > 0)) {
2607 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2608 w->stats_received_bytes += bytes;
2610 size_t old = w->response.data->len;
2611 w->response.data->len += bytes;
2612 w->response.data->buffer[w->response.data->len] = '\0';
2614 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2615 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2617 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2620 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2621 w->wait_receive = 0;
2624 else if(likely(bytes == 0)) {
2625 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2627 // if we cannot read, it means we have an error on input.
2628 // if however, we are copying a file from ifd to ofd, we should not return an error.
2629 // in this case, the error should be generated when the file has been sent to the client.
2631 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2632 // we are copying data from ifd to ofd
2633 // let it finish copying...
2634 w->wait_receive = 0;
2636 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2637 if(w->ifd != w->ofd) close(w->ifd);
2641 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2642 WEB_CLIENT_IS_DEAD(w);
2646 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2647 WEB_CLIENT_IS_DEAD(w);
2654 // --------------------------------------------------------------------------------------
2655 // the thread of a single client
2657 // 1. waits for input and output, using async I/O
2658 // 2. it processes HTTP requests
2659 // 3. it generates HTTP responses
2660 // 4. it copies data from input to output if mode is FILECOPY
2662 void *web_client_main(void *ptr)
2664 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2665 error("Cannot set pthread cancel type to DEFERRED.");
2667 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2668 error("Cannot set pthread cancel state to ENABLE.");
2670 struct web_client *w = ptr;
2671 struct pollfd fds[2], *ifd, *ofd;
2672 int retval, fdmax = 0, timeout;
2674 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2677 if(unlikely(w->dead)) {
2678 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2681 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2682 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2686 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2687 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2691 if(w->ifd == w->ofd) {
2696 if(w->wait_receive) fds[0].events |= POLLIN;
2697 if(w->wait_send) fds[0].events |= POLLOUT;
2703 ifd = ofd = &fds[0];
2711 if(w->wait_receive) fds[0].events |= POLLIN;
2717 if(w->wait_send) fds[1].events |= POLLOUT;
2723 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2725 timeout = web_client_timeout * 1000;
2726 retval = poll(fds, fdmax, timeout);
2728 if(unlikely(retval == -1)) {
2729 if(errno == EAGAIN || errno == EINTR) {
2730 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2734 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2737 else if(unlikely(!retval)) {
2738 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":"");
2743 if(w->wait_send && ofd->revents & POLLOUT) {
2745 if(web_client_send(w) < 0) {
2746 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2751 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2753 if(web_client_receive(w) < 0) {
2754 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2758 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2759 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2760 web_client_process(w);
2764 if(unlikely(!used)) {
2765 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2770 web_client_reset(w);
2772 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2773 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2775 // close the sockets/files now
2776 // to free file descriptors
2777 if(w->ifd == w->ofd) {
2778 if(w->ifd != -1) close(w->ifd);
2781 if(w->ifd != -1) close(w->ifd);
2782 if(w->ofd != -1) close(w->ofd);