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;
418 w->response.data->date = stat.st_mtimespec.tv_sec;
420 w->response.data->date = stat.st_mtim.tv_sec;
421 #endif /* __APPLE__ */
422 buffer_cacheable(w->response.data);
428 #ifdef NETDATA_WITH_ZLIB
429 void web_client_enable_deflate(struct web_client *w, int gzip) {
430 if(unlikely(w->response.zinitialized)) {
431 debug(D_DEFLATE, "%llu: Compression has already be initialized for this client.", w->id);
435 if(unlikely(w->response.sent)) {
436 error("%llu: Cannot enable compression in the middle of a conversation.", w->id);
440 w->response.zstream.zalloc = Z_NULL;
441 w->response.zstream.zfree = Z_NULL;
442 w->response.zstream.opaque = Z_NULL;
444 w->response.zstream.next_in = (Bytef *)w->response.data->buffer;
445 w->response.zstream.avail_in = 0;
446 w->response.zstream.total_in = 0;
448 w->response.zstream.next_out = w->response.zbuffer;
449 w->response.zstream.avail_out = 0;
450 w->response.zstream.total_out = 0;
452 w->response.zstream.zalloc = Z_NULL;
453 w->response.zstream.zfree = Z_NULL;
454 w->response.zstream.opaque = Z_NULL;
456 // if(deflateInit(&w->response.zstream, Z_DEFAULT_COMPRESSION) != Z_OK) {
457 // error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
461 // Select GZIP compression: windowbits = 15 + 16 = 31
462 if(deflateInit2(&w->response.zstream, web_gzip_level, Z_DEFLATED, 15 + ((gzip)?16:0), 8, web_gzip_strategy) != Z_OK) {
463 error("%llu: Failed to initialize zlib. Proceeding without compression.", w->id);
467 w->response.zsent = 0;
468 w->response.zoutput = 1;
469 w->response.zinitialized = 1;
471 debug(D_DEFLATE, "%llu: Initialized compression.", w->id);
473 #endif // NETDATA_WITH_ZLIB
475 void buffer_data_options2string(BUFFER *wb, uint32_t options) {
478 if(options & RRDR_OPTION_NONZERO) {
479 if(count++) buffer_strcat(wb, " ");
480 buffer_strcat(wb, "nonzero");
483 if(options & RRDR_OPTION_REVERSED) {
484 if(count++) buffer_strcat(wb, " ");
485 buffer_strcat(wb, "flip");
488 if(options & RRDR_OPTION_JSON_WRAP) {
489 if(count++) buffer_strcat(wb, " ");
490 buffer_strcat(wb, "jsonwrap");
493 if(options & RRDR_OPTION_MIN2MAX) {
494 if(count++) buffer_strcat(wb, " ");
495 buffer_strcat(wb, "min2max");
498 if(options & RRDR_OPTION_MILLISECONDS) {
499 if(count++) buffer_strcat(wb, " ");
500 buffer_strcat(wb, "ms");
503 if(options & RRDR_OPTION_ABSOLUTE) {
504 if(count++) buffer_strcat(wb, " ");
505 buffer_strcat(wb, "absolute");
508 if(options & RRDR_OPTION_SECONDS) {
509 if(count++) buffer_strcat(wb, " ");
510 buffer_strcat(wb, "seconds");
513 if(options & RRDR_OPTION_NULL2ZERO) {
514 if(count++) buffer_strcat(wb, " ");
515 buffer_strcat(wb, "null2zero");
518 if(options & RRDR_OPTION_OBJECTSROWS) {
519 if(count++) buffer_strcat(wb, " ");
520 buffer_strcat(wb, "objectrows");
523 if(options & RRDR_OPTION_GOOGLE_JSON) {
524 if(count++) buffer_strcat(wb, " ");
525 buffer_strcat(wb, "google_json");
528 if(options & RRDR_OPTION_PERCENTAGE) {
529 if(count++) buffer_strcat(wb, " ");
530 buffer_strcat(wb, "percentage");
533 if(options & RRDR_OPTION_NOT_ALIGNED) {
534 if(count++) buffer_strcat(wb, " ");
535 buffer_strcat(wb, "unaligned");
539 uint32_t web_client_api_request_v1_data_options(char *o)
541 uint32_t ret = 0x00000000;
544 while(o && *o && (tok = mystrsep(&o, ", |"))) {
547 if(!strcmp(tok, "nonzero"))
548 ret |= RRDR_OPTION_NONZERO;
549 else if(!strcmp(tok, "flip") || !strcmp(tok, "reversed") || !strcmp(tok, "reverse"))
550 ret |= RRDR_OPTION_REVERSED;
551 else if(!strcmp(tok, "jsonwrap"))
552 ret |= RRDR_OPTION_JSON_WRAP;
553 else if(!strcmp(tok, "min2max"))
554 ret |= RRDR_OPTION_MIN2MAX;
555 else if(!strcmp(tok, "ms") || !strcmp(tok, "milliseconds"))
556 ret |= RRDR_OPTION_MILLISECONDS;
557 else if(!strcmp(tok, "abs") || !strcmp(tok, "absolute") || !strcmp(tok, "absolute_sum") || !strcmp(tok, "absolute-sum"))
558 ret |= RRDR_OPTION_ABSOLUTE;
559 else if(!strcmp(tok, "seconds"))
560 ret |= RRDR_OPTION_SECONDS;
561 else if(!strcmp(tok, "null2zero"))
562 ret |= RRDR_OPTION_NULL2ZERO;
563 else if(!strcmp(tok, "objectrows"))
564 ret |= RRDR_OPTION_OBJECTSROWS;
565 else if(!strcmp(tok, "google_json"))
566 ret |= RRDR_OPTION_GOOGLE_JSON;
567 else if(!strcmp(tok, "percentage"))
568 ret |= RRDR_OPTION_PERCENTAGE;
569 else if(!strcmp(tok, "unaligned"))
570 ret |= RRDR_OPTION_NOT_ALIGNED;
576 uint32_t web_client_api_request_v1_data_format(char *name)
578 if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSON)) // datatable
579 return DATASOURCE_DATATABLE_JSON;
581 else if(!strcmp(name, DATASOURCE_FORMAT_DATATABLE_JSONP)) // datasource
582 return DATASOURCE_DATATABLE_JSONP;
584 else if(!strcmp(name, DATASOURCE_FORMAT_JSON)) // json
585 return DATASOURCE_JSON;
587 else if(!strcmp(name, DATASOURCE_FORMAT_JSONP)) // jsonp
588 return DATASOURCE_JSONP;
590 else if(!strcmp(name, DATASOURCE_FORMAT_SSV)) // ssv
591 return DATASOURCE_SSV;
593 else if(!strcmp(name, DATASOURCE_FORMAT_CSV)) // csv
594 return DATASOURCE_CSV;
596 else if(!strcmp(name, DATASOURCE_FORMAT_TSV) || !strcmp(name, "tsv-excel")) // tsv
597 return DATASOURCE_TSV;
599 else if(!strcmp(name, DATASOURCE_FORMAT_HTML)) // html
600 return DATASOURCE_HTML;
602 else if(!strcmp(name, DATASOURCE_FORMAT_JS_ARRAY)) // array
603 return DATASOURCE_JS_ARRAY;
605 else if(!strcmp(name, DATASOURCE_FORMAT_SSV_COMMA)) // ssvcomma
606 return DATASOURCE_SSV_COMMA;
608 else if(!strcmp(name, DATASOURCE_FORMAT_CSV_JSON_ARRAY)) // csvjsonarray
609 return DATASOURCE_CSV_JSON_ARRAY;
611 return DATASOURCE_JSON;
614 uint32_t web_client_api_request_v1_data_google_format(char *name)
616 if(!strcmp(name, "json"))
617 return DATASOURCE_DATATABLE_JSONP;
619 else if(!strcmp(name, "html"))
620 return DATASOURCE_HTML;
622 else if(!strcmp(name, "csv"))
623 return DATASOURCE_CSV;
625 else if(!strcmp(name, "tsv-excel"))
626 return DATASOURCE_TSV;
628 return DATASOURCE_JSON;
631 const char *group_method2string(int group) {
633 case GROUP_UNDEFINED:
648 case GROUP_INCREMENTAL_SUM:
649 return "incremental-sum";
652 return "unknown-group-method";
656 int web_client_api_request_v1_data_group(char *name, int def)
658 if(!strcmp(name, "average"))
659 return GROUP_AVERAGE;
661 else if(!strcmp(name, "min"))
664 else if(!strcmp(name, "max"))
667 else if(!strcmp(name, "sum"))
670 else if(!strcmp(name, "incremental-sum"))
671 return GROUP_INCREMENTAL_SUM;
676 int web_client_api_request_v1_alarms(struct web_client *w, char *url)
681 char *value = mystrsep(&url, "?&");
682 if (!value || !*value) continue;
684 if(!strcmp(value, "all")) all = 1;
685 else if(!strcmp(value, "active")) all = 0;
688 buffer_flush(w->response.data);
689 w->response.data->contenttype = CT_APPLICATION_JSON;
690 health_alarms2json(&localhost, w->response.data, all);
694 int web_client_api_request_v1_alarm_log(struct web_client *w, char *url)
699 char *value = mystrsep(&url, "?&");
700 if (!value || !*value) continue;
702 char *name = mystrsep(&value, "=");
703 if(!name || !*name) continue;
704 if(!value || !*value) continue;
706 if(!strcmp(name, "after")) after = strtoul(value, NULL, 0);
709 buffer_flush(w->response.data);
710 w->response.data->contenttype = CT_APPLICATION_JSON;
711 health_alarm_log2json(&localhost, w->response.data, after);
715 int web_client_api_request_single_chart(struct web_client *w, char *url, void callback(RRDSET *st, BUFFER *buf))
720 buffer_flush(w->response.data);
723 char *value = mystrsep(&url, "?&");
724 if(!value || !*value) continue;
726 char *name = mystrsep(&value, "=");
727 if(!name || !*name) continue;
728 if(!value || !*value) continue;
730 // name and value are now the parameters
731 // they are not null and not empty
733 if(!strcmp(name, "chart")) chart = value;
735 /// buffer_sprintf(w->response.data, "Unknown parameter '%s' in request.", name);
740 if(!chart || !*chart) {
741 buffer_sprintf(w->response.data, "No chart id is given at the request.");
745 RRDSET *st = rrdset_find(chart);
746 if(!st) st = rrdset_find_byname(chart);
748 buffer_strcat(w->response.data, "Chart is not found: ");
749 buffer_strcat_htmlescape(w->response.data, chart);
754 w->response.data->contenttype = CT_APPLICATION_JSON;
755 callback(st, w->response.data);
762 int web_client_api_request_v1_alarm_variables(struct web_client *w, char *url)
764 return web_client_api_request_single_chart(w, url, health_api_v1_chart_variables2json);
767 int web_client_api_request_v1_charts(struct web_client *w, char *url)
771 buffer_flush(w->response.data);
772 w->response.data->contenttype = CT_APPLICATION_JSON;
773 rrd_stats_api_v1_charts(w->response.data);
777 int web_client_api_request_v1_allmetrics(struct web_client *w, char *url)
782 char *value = mystrsep(&url, "?&");
783 if (!value || !*value) continue;
785 char *name = mystrsep(&value, "=");
786 if(!name || !*name) continue;
787 if(!value || !*value) continue;
789 if(!strcmp(name, "format")) {
790 if(!strcmp(value, RAWMETRICS_FORMAT_BASH))
791 format = RAWMETRICS_BASH;
792 else if(!strcmp(value, RAWMETRICS_FORMAT_PROMETHEUS))
793 format = RAWMETRICS_PROMETHEUS;
797 buffer_flush(w->response.data);
798 buffer_no_cacheable(w->response.data);
799 w->response.data->contenttype = CT_TEXT_PLAIN;
802 //case RAWMETRICS_BASH:
803 // rrd_stats_api_v1_charts_allmetrics_bash(w->response.data);
806 case RAWMETRICS_PROMETHEUS:
807 rrd_stats_api_v1_charts_allmetrics_prometheus(w->response.data);
811 buffer_strcat(w->response.data, "Which format? Only '" RAWMETRICS_FORMAT_PROMETHEUS "' is currently supported.");
816 int web_client_api_request_v1_chart(struct web_client *w, char *url)
818 return web_client_api_request_single_chart(w, url, rrd_stats_api_v1_chart);
821 int web_client_api_request_v1_badge(struct web_client *w, char *url) {
823 buffer_flush(w->response.data);
825 BUFFER *dimensions = NULL;
827 const char *chart = NULL
831 , *multiply_str = NULL
835 , *label_color = NULL
836 , *value_color = NULL
837 , *refresh_str = NULL
838 , *precision_str = NULL
841 int group = GROUP_AVERAGE;
842 uint32_t options = 0x00000000;
845 char *value = mystrsep(&url, "/?&");
846 if(!value || !*value) continue;
848 char *name = mystrsep(&value, "=");
849 if(!name || !*name) continue;
850 if(!value || !*value) continue;
852 debug(D_WEB_CLIENT, "%llu: API v1 badge.svg query param '%s' with value '%s'", w->id, name, value);
854 // name and value are now the parameters
855 // they are not null and not empty
857 if(!strcmp(name, "chart")) chart = value;
858 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
860 dimensions = buffer_create(100);
862 buffer_strcat(dimensions, "|");
863 buffer_strcat(dimensions, value);
865 else if(!strcmp(name, "after")) after_str = value;
866 else if(!strcmp(name, "before")) before_str = value;
867 else if(!strcmp(name, "points")) points_str = value;
868 else if(!strcmp(name, "group")) {
869 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
871 else if(!strcmp(name, "options")) {
872 options |= web_client_api_request_v1_data_options(value);
874 else if(!strcmp(name, "label")) label = value;
875 else if(!strcmp(name, "units")) units = value;
876 else if(!strcmp(name, "label_color")) label_color = value;
877 else if(!strcmp(name, "value_color")) value_color = value;
878 else if(!strcmp(name, "multiply")) multiply_str = value;
879 else if(!strcmp(name, "divide")) divide_str = value;
880 else if(!strcmp(name, "refresh")) refresh_str = value;
881 else if(!strcmp(name, "precision")) precision_str = value;
882 else if(!strcmp(name, "alarm")) alarm = value;
885 if(!chart || !*chart) {
886 buffer_no_cacheable(w->response.data);
887 buffer_sprintf(w->response.data, "No chart id is given at the request.");
891 RRDSET *st = rrdset_find(chart);
892 if(!st) st = rrdset_find_byname(chart);
894 buffer_no_cacheable(w->response.data);
895 buffer_svg(w->response.data, "chart not found", 0, "", NULL, NULL, 1, -1);
902 rc = rrdcalc_find(st, alarm);
904 buffer_no_cacheable(w->response.data);
905 buffer_svg(w->response.data, "alarm not found", 0, "", NULL, NULL, 1, -1);
911 long long multiply = (multiply_str && *multiply_str )?atol(multiply_str):1;
912 long long divide = (divide_str && *divide_str )?atol(divide_str):1;
913 long long before = (before_str && *before_str )?atol(before_str):0;
914 long long after = (after_str && *after_str )?atol(after_str):-st->update_every;
915 int points = (points_str && *points_str )?atoi(points_str):1;
916 int precision = (precision_str && *precision_str)?atoi(precision_str):-1;
918 if(!multiply) multiply = 1;
919 if(!divide) divide = 1;
922 if(refresh_str && *refresh_str) {
923 if(!strcmp(refresh_str, "auto")) {
924 if(rc) refresh = rc->update_every;
925 else if(options & RRDR_OPTION_NOT_ALIGNED)
926 refresh = st->update_every;
928 refresh = (int)(before - after);
929 if(refresh < 0) refresh = -refresh;
933 refresh = atoi(refresh_str);
934 if(refresh < 0) refresh = -refresh;
940 char *s = (char *)alarm;
942 if(*s == '_') *s = ' ';
947 else if(dimensions) {
948 const char *dim = buffer_tostring(dimensions);
949 if(*dim == '|') dim++;
962 else if(options & RRDR_OPTION_PERCENTAGE)
968 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'"
972 , (dimensions)?buffer_tostring(dimensions):""
981 calculated_number n = rc->value;
982 if(isnan(n) || isinf(n)) n = 0;
985 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
986 w->response.data->expires = now_realtime_sec() + refresh;
988 else buffer_no_cacheable(w->response.data);
992 case RRDCALC_STATUS_CRITICAL:
996 case RRDCALC_STATUS_WARNING:
997 value_color = "orange";
1000 case RRDCALC_STATUS_CLEAR:
1001 value_color = "brightgreen";
1004 case RRDCALC_STATUS_UNDEFINED:
1005 value_color = "lightgrey";
1008 case RRDCALC_STATUS_UNINITIALIZED:
1009 value_color = "#000";
1013 value_color = "grey";
1018 buffer_svg(w->response.data,
1020 rc->value * multiply / divide,
1029 time_t latest_timestamp = 0;
1030 int value_is_null = 1;
1031 calculated_number n = 0;
1034 // if the collected value is too old, don't calculate its value
1035 if (rrdset_last_entry_t(st) >= (now_realtime_sec() - (st->update_every * st->gap_when_lost_iterations_above)))
1039 (dimensions) ? buffer_tostring(dimensions) : NULL,
1049 // if the value cannot be calculated, show empty badge
1051 buffer_no_cacheable(w->response.data);
1056 else if (refresh > 0) {
1057 buffer_sprintf(w->response.header, "Refresh: %d\r\n", refresh);
1058 w->response.data->expires = now_realtime_sec() + refresh;
1060 else buffer_no_cacheable(w->response.data);
1063 buffer_svg(w->response.data,
1065 n * multiply / divide,
1075 buffer_free(dimensions);
1079 // returns the HTTP code
1080 int web_client_api_request_v1_data(struct web_client *w, char *url)
1082 debug(D_WEB_CLIENT, "%llu: API v1 data with URL '%s'", w->id, url);
1085 BUFFER *dimensions = NULL;
1087 buffer_flush(w->response.data);
1089 char *google_version = "0.6",
1090 *google_reqId = "0",
1092 *google_out = "json",
1093 *responseHandler = NULL,
1094 *outFileName = NULL;
1096 time_t last_timestamp_in_data = 0, google_timestamp = 0;
1099 , *before_str = NULL
1101 , *points_str = NULL;
1103 int group = GROUP_AVERAGE;
1104 uint32_t format = DATASOURCE_JSON;
1105 uint32_t options = 0x00000000;
1108 char *value = mystrsep(&url, "?&");
1109 if(!value || !*value) continue;
1111 char *name = mystrsep(&value, "=");
1112 if(!name || !*name) continue;
1113 if(!value || !*value) continue;
1115 debug(D_WEB_CLIENT, "%llu: API v1 data query param '%s' with value '%s'", w->id, name, value);
1117 // name and value are now the parameters
1118 // they are not null and not empty
1120 if(!strcmp(name, "chart")) chart = value;
1121 else if(!strcmp(name, "dimension") || !strcmp(name, "dim") || !strcmp(name, "dimensions") || !strcmp(name, "dims")) {
1122 if(!dimensions) dimensions = buffer_create(100);
1123 buffer_strcat(dimensions, "|");
1124 buffer_strcat(dimensions, value);
1126 else if(!strcmp(name, "after")) after_str = value;
1127 else if(!strcmp(name, "before")) before_str = value;
1128 else if(!strcmp(name, "points")) points_str = value;
1129 else if(!strcmp(name, "group")) {
1130 group = web_client_api_request_v1_data_group(value, GROUP_AVERAGE);
1132 else if(!strcmp(name, "format")) {
1133 format = web_client_api_request_v1_data_format(value);
1135 else if(!strcmp(name, "options")) {
1136 options |= web_client_api_request_v1_data_options(value);
1138 else if(!strcmp(name, "callback")) {
1139 responseHandler = value;
1141 else if(!strcmp(name, "filename")) {
1142 outFileName = value;
1144 else if(!strcmp(name, "tqx")) {
1145 // parse Google Visualization API options
1146 // https://developers.google.com/chart/interactive/docs/dev/implementing_data_source
1147 char *tqx_name, *tqx_value;
1150 tqx_value = mystrsep(&value, ";");
1151 if(!tqx_value || !*tqx_value) continue;
1153 tqx_name = mystrsep(&tqx_value, ":");
1154 if(!tqx_name || !*tqx_name) continue;
1155 if(!tqx_value || !*tqx_value) continue;
1157 if(!strcmp(tqx_name, "version"))
1158 google_version = tqx_value;
1159 else if(!strcmp(tqx_name, "reqId"))
1160 google_reqId = tqx_value;
1161 else if(!strcmp(tqx_name, "sig")) {
1162 google_sig = tqx_value;
1163 google_timestamp = strtoul(google_sig, NULL, 0);
1165 else if(!strcmp(tqx_name, "out")) {
1166 google_out = tqx_value;
1167 format = web_client_api_request_v1_data_google_format(google_out);
1169 else if(!strcmp(tqx_name, "responseHandler"))
1170 responseHandler = tqx_value;
1171 else if(!strcmp(tqx_name, "outFileName"))
1172 outFileName = tqx_value;
1177 if(!chart || !*chart) {
1178 buffer_sprintf(w->response.data, "No chart id is given at the request.");
1182 RRDSET *st = rrdset_find(chart);
1183 if(!st) st = rrdset_find_byname(chart);
1185 buffer_strcat(w->response.data, "Chart is not found: ");
1186 buffer_strcat_htmlescape(w->response.data, chart);
1191 long long before = (before_str && *before_str)?atol(before_str):0;
1192 long long after = (after_str && *after_str) ?atol(after_str):0;
1193 int points = (points_str && *points_str)?atoi(points_str):0;
1195 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'"
1198 , (dimensions)?buffer_tostring(dimensions):""
1207 if(outFileName && *outFileName) {
1208 buffer_sprintf(w->response.header, "Content-Disposition: attachment; filename=\"%s\"\r\n", outFileName);
1209 debug(D_WEB_CLIENT, "%llu: generating outfilename header: '%s'", w->id, outFileName);
1212 if(format == DATASOURCE_DATATABLE_JSONP) {
1213 if(responseHandler == NULL)
1214 responseHandler = "google.visualization.Query.setResponse";
1216 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSON/JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1217 w->id, google_version, google_reqId, google_sig, google_out, responseHandler, outFileName
1220 buffer_sprintf(w->response.data,
1221 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1222 responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1224 else if(format == DATASOURCE_JSONP) {
1225 if(responseHandler == NULL)
1226 responseHandler = "callback";
1228 buffer_strcat(w->response.data, responseHandler);
1229 buffer_strcat(w->response.data, "(");
1232 ret = rrd2format(st, w->response.data, dimensions, format, points, after, before, group, options, &last_timestamp_in_data);
1234 if(format == DATASOURCE_DATATABLE_JSONP) {
1235 if(google_timestamp < last_timestamp_in_data)
1236 buffer_strcat(w->response.data, "});");
1239 // the client already has the latest data
1240 buffer_flush(w->response.data);
1241 buffer_sprintf(w->response.data,
1242 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1243 responseHandler, google_version, google_reqId);
1246 else if(format == DATASOURCE_JSONP)
1247 buffer_strcat(w->response.data, ");");
1250 if(dimensions) buffer_free(dimensions);
1255 int web_client_api_request_v1_registry(struct web_client *w, char *url)
1257 static uint32_t hash_action = 0, hash_access = 0, hash_hello = 0, hash_delete = 0, hash_search = 0,
1258 hash_switch = 0, hash_machine = 0, hash_url = 0, hash_name = 0, hash_delete_url = 0, hash_for = 0,
1259 hash_to = 0 /*, hash_redirects = 0 */;
1261 if(unlikely(!hash_action)) {
1262 hash_action = simple_hash("action");
1263 hash_access = simple_hash("access");
1264 hash_hello = simple_hash("hello");
1265 hash_delete = simple_hash("delete");
1266 hash_search = simple_hash("search");
1267 hash_switch = simple_hash("switch");
1268 hash_machine = simple_hash("machine");
1269 hash_url = simple_hash("url");
1270 hash_name = simple_hash("name");
1271 hash_delete_url = simple_hash("delete_url");
1272 hash_for = simple_hash("for");
1273 hash_to = simple_hash("to");
1275 hash_redirects = simple_hash("redirects");
1279 char person_guid[GUID_LEN + 1] = "";
1281 debug(D_WEB_CLIENT, "%llu: API v1 registry with URL '%s'", w->id, url);
1284 // The browser may send multiple cookies with our id
1286 char *cookie = strstr(w->response.data->buffer, NETDATA_REGISTRY_COOKIE_NAME "=");
1288 strncpyz(person_guid, &cookie[sizeof(NETDATA_REGISTRY_COOKIE_NAME)], 36);
1291 char *machine_guid = NULL,
1292 *machine_url = NULL,
1294 *search_machine_guid = NULL,
1296 *to_person_guid = NULL;
1302 char *value = mystrsep(&url, "?&");
1303 if (!value || !*value) continue;
1305 char *name = mystrsep(&value, "=");
1306 if (!name || !*name) continue;
1307 if (!value || !*value) continue;
1309 debug(D_WEB_CLIENT, "%llu: API v1 registry query param '%s' with value '%s'", w->id, name, value);
1311 uint32_t hash = simple_hash(name);
1313 if(hash == hash_action && !strcmp(name, "action")) {
1314 uint32_t vhash = simple_hash(value);
1316 if(vhash == hash_access && !strcmp(value, "access")) action = 'A';
1317 else if(vhash == hash_hello && !strcmp(value, "hello")) action = 'H';
1318 else if(vhash == hash_delete && !strcmp(value, "delete")) action = 'D';
1319 else if(vhash == hash_search && !strcmp(value, "search")) action = 'S';
1320 else if(vhash == hash_switch && !strcmp(value, "switch")) action = 'W';
1321 #ifdef NETDATA_INTERNAL_CHECKS
1322 else error("unknown registry action '%s'", value);
1323 #endif /* NETDATA_INTERNAL_CHECKS */
1326 else if(hash == hash_redirects && !strcmp(name, "redirects"))
1327 redirects = atoi(value);
1329 else if(hash == hash_machine && !strcmp(name, "machine"))
1330 machine_guid = value;
1332 else if(hash == hash_url && !strcmp(name, "url"))
1333 machine_url = value;
1335 else if(action == 'A') {
1336 if(hash == hash_name && !strcmp(name, "name"))
1339 else if(action == 'D') {
1340 if(hash == hash_delete_url && !strcmp(name, "delete_url"))
1343 else if(action == 'S') {
1344 if(hash == hash_for && !strcmp(name, "for"))
1345 search_machine_guid = value;
1347 else if(action == 'W') {
1348 if(hash == hash_to && !strcmp(name, "to"))
1349 to_person_guid = value;
1351 #ifdef NETDATA_INTERNAL_CHECKS
1352 else error("unused registry URL parameter '%s' with value '%s'", name, value);
1353 #endif /* NETDATA_INTERNAL_CHECKS */
1356 if(web_donotrack_comply && w->donottrack) {
1357 buffer_flush(w->response.data);
1358 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.");
1362 if(action == 'A' && (!machine_guid || !machine_url || !url_name)) {
1363 error("Invalid registry request - access requires these parameters: machine ('%s'), url ('%s'), name ('%s')",
1364 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", url_name?url_name:"UNSET");
1365 buffer_flush(w->response.data);
1366 buffer_strcat(w->response.data, "Invalid registry Access request.");
1369 else if(action == 'D' && (!machine_guid || !machine_url || !delete_url)) {
1370 error("Invalid registry request - delete requires these parameters: machine ('%s'), url ('%s'), delete_url ('%s')",
1371 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", delete_url?delete_url:"UNSET");
1372 buffer_flush(w->response.data);
1373 buffer_strcat(w->response.data, "Invalid registry Delete request.");
1376 else if(action == 'S' && (!machine_guid || !machine_url || !search_machine_guid)) {
1377 error("Invalid registry request - search requires these parameters: machine ('%s'), url ('%s'), for ('%s')",
1378 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", search_machine_guid?search_machine_guid:"UNSET");
1379 buffer_flush(w->response.data);
1380 buffer_strcat(w->response.data, "Invalid registry Search request.");
1383 else if(action == 'W' && (!machine_guid || !machine_url || !to_person_guid)) {
1384 error("Invalid registry request - switching identity requires these parameters: machine ('%s'), url ('%s'), to ('%s')",
1385 machine_guid?machine_guid:"UNSET", machine_url?machine_url:"UNSET", to_person_guid?to_person_guid:"UNSET");
1386 buffer_flush(w->response.data);
1387 buffer_strcat(w->response.data, "Invalid registry Switch request.");
1393 w->tracking_required = 1;
1394 return registry_request_access_json(w, person_guid, machine_guid, machine_url, url_name, now_realtime_sec());
1397 w->tracking_required = 1;
1398 return registry_request_delete_json(w, person_guid, machine_guid, machine_url, delete_url, now_realtime_sec());
1401 w->tracking_required = 1;
1402 return registry_request_search_json(w, person_guid, machine_guid, machine_url, search_machine_guid, now_realtime_sec());
1405 w->tracking_required = 1;
1406 return registry_request_switch_json(w, person_guid, machine_guid, machine_url, to_person_guid, now_realtime_sec());
1409 return registry_request_hello_json(w);
1412 buffer_flush(w->response.data);
1413 buffer_strcat(w->response.data, "Invalid registry request - you need to set an action: hello, access, delete, search");
1418 int web_client_api_request_v1(struct web_client *w, char *url) {
1419 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, hash_raw = 0;
1421 if(unlikely(hash_data == 0)) {
1422 hash_data = simple_hash("data");
1423 hash_chart = simple_hash("chart");
1424 hash_charts = simple_hash("charts");
1425 hash_registry = simple_hash("registry");
1426 hash_badge = simple_hash("badge.svg");
1427 hash_alarms = simple_hash("alarms");
1428 hash_alarm_log = simple_hash("alarm_log");
1429 hash_alarm_variables = simple_hash("alarm_variables");
1430 hash_raw = simple_hash("allmetrics");
1434 char *tok = mystrsep(&url, "/?&");
1436 debug(D_WEB_CLIENT, "%llu: Searching for API v1 command '%s'.", w->id, tok);
1437 uint32_t hash = simple_hash(tok);
1439 if(hash == hash_data && !strcmp(tok, "data"))
1440 return web_client_api_request_v1_data(w, url);
1442 else if(hash == hash_chart && !strcmp(tok, "chart"))
1443 return web_client_api_request_v1_chart(w, url);
1445 else if(hash == hash_charts && !strcmp(tok, "charts"))
1446 return web_client_api_request_v1_charts(w, url);
1448 else if(hash == hash_registry && !strcmp(tok, "registry"))
1449 return web_client_api_request_v1_registry(w, url);
1451 else if(hash == hash_badge && !strcmp(tok, "badge.svg"))
1452 return web_client_api_request_v1_badge(w, url);
1454 else if(hash == hash_alarms && !strcmp(tok, "alarms"))
1455 return web_client_api_request_v1_alarms(w, url);
1457 else if(hash == hash_alarm_log && !strcmp(tok, "alarm_log"))
1458 return web_client_api_request_v1_alarm_log(w, url);
1460 else if(hash == hash_alarm_variables && !strcmp(tok, "alarm_variables"))
1461 return web_client_api_request_v1_alarm_variables(w, url);
1463 else if(hash == hash_raw && !strcmp(tok, "allmetrics"))
1464 return web_client_api_request_v1_allmetrics(w, url);
1467 buffer_flush(w->response.data);
1468 buffer_strcat(w->response.data, "Unsupported v1 API command: ");
1469 buffer_strcat_htmlescape(w->response.data, tok);
1474 buffer_flush(w->response.data);
1475 buffer_sprintf(w->response.data, "Which API v1 command?");
1480 int web_client_api_request(struct web_client *w, char *url)
1482 // get the api version
1483 char *tok = mystrsep(&url, "/?&");
1485 debug(D_WEB_CLIENT, "%llu: Searching for API version '%s'.", w->id, tok);
1486 if(strcmp(tok, "v1") == 0)
1487 return web_client_api_request_v1(w, url);
1489 buffer_flush(w->response.data);
1490 buffer_strcat(w->response.data, "Unsupported API version: ");
1491 buffer_strcat_htmlescape(w->response.data, tok);
1496 buffer_flush(w->response.data);
1497 buffer_sprintf(w->response.data, "Which API version?");
1502 int web_client_api_old_data_request(struct web_client *w, char *url, int datasource_type)
1505 buffer_flush(w->response.data);
1506 buffer_sprintf(w->response.data, "Incomplete request.");
1512 char *args = strchr(url, '?');
1518 // get the name of the data to show
1519 char *tok = mystrsep(&url, "/");
1522 // do we have such a data set?
1524 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
1525 st = rrdset_find_byname(tok);
1526 if(!st) st = rrdset_find(tok);
1531 // try to send a file with that name
1532 buffer_flush(w->response.data);
1533 return(mysendfile(w, tok));
1537 debug(D_WEB_CLIENT, "%llu: Found RRD data with name '%s'.", w->id, tok);
1539 // how many entries does the client want?
1540 int lines = rrd_default_history_entries;
1541 int group_count = 1;
1542 time_t after = 0, before = 0;
1543 int group_method = GROUP_AVERAGE;
1547 // parse the lines required
1548 tok = mystrsep(&url, "/");
1549 if(tok) lines = atoi(tok);
1550 if(lines < 1) lines = 1;
1553 // parse the group count required
1554 tok = mystrsep(&url, "/");
1555 if(tok && *tok) group_count = atoi(tok);
1556 if(group_count < 1) group_count = 1;
1557 //if(group_count > save_history / 20) group_count = save_history / 20;
1560 // parse the grouping method required
1561 tok = mystrsep(&url, "/");
1563 if(strcmp(tok, "max") == 0) group_method = GROUP_MAX;
1564 else if(strcmp(tok, "average") == 0) group_method = GROUP_AVERAGE;
1565 else if(strcmp(tok, "sum") == 0) group_method = GROUP_SUM;
1566 else debug(D_WEB_CLIENT, "%llu: Unknown group method '%s'", w->id, tok);
1571 tok = mystrsep(&url, "/");
1572 if(tok && *tok) after = strtoul(tok, NULL, 10);
1573 if(after < 0) after = 0;
1576 // parse before time
1577 tok = mystrsep(&url, "/");
1578 if(tok && *tok) before = strtoul(tok, NULL, 10);
1579 if(before < 0) before = 0;
1583 tok = mystrsep(&url, "/");
1584 if(tok && *tok && strcmp(tok, "nonzero") == 0) nonzero = 1;
1587 w->response.data->contenttype = CT_APPLICATION_JSON;
1588 buffer_flush(w->response.data);
1590 char *google_version = "0.6";
1591 char *google_reqId = "0";
1592 char *google_sig = "0";
1593 char *google_out = "json";
1594 char *google_responseHandler = "google.visualization.Query.setResponse";
1595 char *google_outFileName = NULL;
1596 time_t last_timestamp_in_data = 0;
1597 if(datasource_type == DATASOURCE_DATATABLE_JSON || datasource_type == DATASOURCE_DATATABLE_JSONP) {
1599 w->response.data->contenttype = CT_APPLICATION_X_JAVASCRIPT;
1602 tok = mystrsep(&args, "&");
1604 char *name = mystrsep(&tok, "=");
1605 if(name && *name && strcmp(name, "tqx") == 0) {
1606 char *key = mystrsep(&tok, ":");
1607 char *value = mystrsep(&tok, ";");
1608 if(key && value && *key && *value) {
1609 if(strcmp(key, "version") == 0)
1610 google_version = value;
1612 else if(strcmp(key, "reqId") == 0)
1613 google_reqId = value;
1615 else if(strcmp(key, "sig") == 0)
1618 else if(strcmp(key, "out") == 0)
1621 else if(strcmp(key, "responseHandler") == 0)
1622 google_responseHandler = value;
1624 else if(strcmp(key, "outFileName") == 0)
1625 google_outFileName = value;
1631 debug(D_WEB_CLIENT_ACCESS, "%llu: GOOGLE JSONP: version = '%s', reqId = '%s', sig = '%s', out = '%s', responseHandler = '%s', outFileName = '%s'",
1632 w->id, google_version, google_reqId, google_sig, google_out, google_responseHandler, google_outFileName
1635 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1636 last_timestamp_in_data = strtoul(google_sig, NULL, 0);
1638 // check the client wants json
1639 if(strcmp(google_out, "json") != 0) {
1640 buffer_sprintf(w->response.data,
1641 "%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.'}]});",
1642 google_responseHandler, google_version, google_reqId, google_out);
1648 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1649 buffer_sprintf(w->response.data,
1650 "%s({version:'%s',reqId:'%s',status:'ok',sig:'%ld',table:",
1651 google_responseHandler, google_version, google_reqId, st->last_updated.tv_sec);
1654 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending RRD data '%s' (id %s, %d lines, %d group, %d group_method, %ld after, %ld before).",
1655 w->id, st->name, st->id, lines, group_count, group_method, after, before);
1657 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);
1659 if(datasource_type == DATASOURCE_DATATABLE_JSONP) {
1660 if(timestamp_in_data > last_timestamp_in_data)
1661 buffer_strcat(w->response.data, "});");
1664 // the client already has the latest data
1665 buffer_flush(w->response.data);
1666 buffer_sprintf(w->response.data,
1667 "%s({version:'%s',reqId:'%s',status:'error',errors:[{reason:'not_modified',message:'Data not modified'}]});",
1668 google_responseHandler, google_version, google_reqId);
1675 const char *web_content_type_to_string(uint8_t contenttype) {
1676 switch(contenttype) {
1678 return "text/html; charset=utf-8";
1680 case CT_APPLICATION_XML:
1681 return "application/xml; charset=utf-8";
1683 case CT_APPLICATION_JSON:
1684 return "application/json; charset=utf-8";
1686 case CT_APPLICATION_X_JAVASCRIPT:
1687 return "application/x-javascript; charset=utf-8";
1690 return "text/css; charset=utf-8";
1693 return "text/xml; charset=utf-8";
1696 return "text/xsl; charset=utf-8";
1698 case CT_APPLICATION_OCTET_STREAM:
1699 return "application/octet-stream";
1701 case CT_IMAGE_SVG_XML:
1702 return "image/svg+xml";
1704 case CT_APPLICATION_X_FONT_TRUETYPE:
1705 return "application/x-font-truetype";
1707 case CT_APPLICATION_X_FONT_OPENTYPE:
1708 return "application/x-font-opentype";
1710 case CT_APPLICATION_FONT_WOFF:
1711 return "application/font-woff";
1713 case CT_APPLICATION_FONT_WOFF2:
1714 return "application/font-woff2";
1716 case CT_APPLICATION_VND_MS_FONTOBJ:
1717 return "application/vnd.ms-fontobject";
1723 return "image/jpeg";
1728 case CT_IMAGE_XICON:
1729 return "image/x-icon";
1735 return "image/icns";
1739 return "text/plain; charset=utf-8";
1744 const char *web_response_code_to_string(int code) {
1750 return "Temporary Redirect";
1753 return "Bad Request";
1762 return "Preconditions Failed";
1765 if(code >= 100 && code < 200)
1766 return "Informational";
1768 if(code >= 200 && code < 300)
1769 return "Successful";
1771 if(code >= 300 && code < 400)
1772 return "Redirection";
1774 if(code >= 400 && code < 500)
1775 return "Bad Request";
1777 if(code >= 500 && code < 600)
1778 return "Server Error";
1780 return "Undefined Error";
1784 static inline char *http_header_parse(struct web_client *w, char *s) {
1785 static uint32_t hash_origin = 0, hash_connection = 0, hash_accept_encoding = 0, hash_donottrack = 0;
1787 if(unlikely(!hash_origin)) {
1788 hash_origin = simple_uhash("Origin");
1789 hash_connection = simple_uhash("Connection");
1790 hash_accept_encoding = simple_uhash("Accept-Encoding");
1791 hash_donottrack = simple_uhash("DNT");
1797 while(*e && *e != ':') e++;
1804 char *v = e + 1, *ve;
1806 // skip leading spaces from value
1807 while(*v == ' ') v++;
1811 while(*ve && *ve != '\r') ve++;
1812 if(!*ve || ve[1] != '\n') {
1817 // terminate the value
1820 // fprintf(stderr, "HEADER: '%s' = '%s'\n", s, v);
1821 uint32_t hash = simple_uhash(s);
1823 if(hash == hash_origin && !strcasecmp(s, "Origin"))
1824 strncpyz(w->origin, v, ORIGIN_MAX);
1826 else if(hash == hash_connection && !strcasecmp(s, "Connection")) {
1827 if(strcasestr(v, "keep-alive"))
1830 else if(web_donotrack_comply && hash == hash_donottrack && !strcasecmp(s, "DNT")) {
1831 if(*v == '0') w->donottrack = 0;
1832 else if(*v == '1') w->donottrack = 1;
1834 #ifdef NETDATA_WITH_ZLIB
1835 else if(hash == hash_accept_encoding && !strcasecmp(s, "Accept-Encoding")) {
1836 if(web_enable_gzip) {
1837 if(strcasestr(v, "gzip"))
1838 web_client_enable_deflate(w, 1);
1840 // does not seem to work
1841 // else if(strcasestr(v, "deflate"))
1842 // web_client_enable_deflate(w, 0);
1845 #endif /* NETDATA_WITH_ZLIB */
1852 // http_request_validate()
1854 // = 0 : all good, process the request
1855 // > 0 : request is not supported
1856 // < 0 : request is incomplete - wait for more data
1858 static inline int http_request_validate(struct web_client *w) {
1859 char *s = w->response.data->buffer, *encoded_url = NULL;
1861 // is is a valid request?
1862 if(!strncmp(s, "GET ", 4)) {
1863 encoded_url = s = &s[4];
1864 w->mode = WEB_CLIENT_MODE_NORMAL;
1866 else if(!strncmp(s, "OPTIONS ", 8)) {
1867 encoded_url = s = &s[8];
1868 w->mode = WEB_CLIENT_MODE_OPTIONS;
1871 w->wait_receive = 0;
1875 // find the SPACE + "HTTP/"
1877 // find the next space
1878 while (*s && *s != ' ') s++;
1880 // is it SPACE + "HTTP/" ?
1881 if(*s && !strncmp(s, " HTTP/", 6)) break;
1885 // incomplete requests
1887 w->wait_receive = 1;
1891 // we have the end of encoded_url - remember it
1894 // make sure we have complete request
1895 // complete requests contain: \r\n\r\n
1898 while(*s && *s++ != '\r');
1900 // did we reach the end?
1901 if(unlikely(!*s)) break;
1904 if(likely(*s++ == '\n')) {
1906 // is it again \r\n ? (header end)
1907 if(unlikely(*s == '\r' && s[1] == '\n')) {
1908 // a valid complete HTTP request found
1911 url_decode_r(w->decoded_url, encoded_url, URL_MAX + 1);
1914 // copy the URL - we are going to overwrite parts of it
1915 // FIXME -- we should avoid it
1916 strncpyz(w->last_url, w->decoded_url, URL_MAX);
1918 w->wait_receive = 0;
1922 // another header line
1923 s = http_header_parse(w, s);
1927 // incomplete request
1928 w->wait_receive = 1;
1932 void web_client_process(struct web_client *w) {
1935 hash_netdata_conf = 0,
1937 hash_datasource = 0,
1942 #ifdef NETDATA_INTERNAL_CHECKS
1943 static uint32_t hash_exit = 0, hash_debug = 0, hash_mirror = 0;
1947 now_realtime_timeval(&w->tv_in);
1949 if(unlikely(!hash_api)) {
1950 hash_api = simple_hash("api");
1951 hash_netdata_conf = simple_hash("netdata.conf");
1952 hash_data = simple_hash(WEB_PATH_DATA);
1953 hash_datasource = simple_hash(WEB_PATH_DATASOURCE);
1954 hash_graph = simple_hash(WEB_PATH_GRAPH);
1955 hash_list = simple_hash("list");
1956 hash_all_json = simple_hash("all.json");
1957 #ifdef NETDATA_INTERNAL_CHECKS
1958 hash_exit = simple_hash("exit");
1959 hash_debug = simple_hash("debug");
1960 hash_mirror = simple_hash("mirror");
1967 int what_to_do = http_request_validate(w);
1969 // wait for more data
1970 if(what_to_do < 0) {
1971 if(w->response.data->len > TOO_BIG_REQUEST) {
1972 strcpy(w->last_url, "too big request");
1974 debug(D_WEB_CLIENT_ACCESS, "%llu: Received request is too big (%zu bytes).", w->id, w->response.data->len);
1977 buffer_flush(w->response.data);
1978 buffer_sprintf(w->response.data, "Received request is too big (%zu bytes).\r\n", w->response.data->len);
1981 // wait for more data
1985 else if(what_to_do > 0) {
1986 // strcpy(w->last_url, "not a valid request");
1988 debug(D_WEB_CLIENT_ACCESS, "%llu: Cannot understand '%s'.", w->id, w->response.data->buffer);
1991 buffer_flush(w->response.data);
1992 buffer_strcat(w->response.data, "I don't understand you...\r\n");
1994 else { // what_to_do == 0
1995 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
1997 w->response.data->contenttype = CT_TEXT_PLAIN;
1998 buffer_flush(w->response.data);
1999 buffer_strcat(w->response.data, "OK");
2002 char *url = w->decoded_url;
2003 char *tok = mystrsep(&url, "/?");
2005 uint32_t hash = simple_hash(tok);
2006 debug(D_WEB_CLIENT, "%llu: Processing command '%s'.", w->id, tok);
2008 if(hash == hash_api && strcmp(tok, "api") == 0) {
2009 // the client is requesting api access
2010 code = web_client_api_request(w, url);
2012 else if(hash == hash_netdata_conf && strcmp(tok, "netdata.conf") == 0) {
2014 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending netdata.conf ...", w->id);
2016 w->response.data->contenttype = CT_TEXT_PLAIN;
2017 buffer_flush(w->response.data);
2018 generate_config(w->response.data, 0);
2020 else if(hash == hash_data && strcmp(tok, WEB_PATH_DATA) == 0) { // "data"
2021 // the client is requesting rrd data -- OLD API
2022 code = web_client_api_old_data_request(w, url, DATASOURCE_JSON);
2024 else if(hash == hash_datasource && strcmp(tok, WEB_PATH_DATASOURCE) == 0) { // "datasource"
2025 // the client is requesting google datasource -- OLD API
2026 code = web_client_api_old_data_request(w, url, DATASOURCE_DATATABLE_JSONP);
2028 else if(hash == hash_graph && strcmp(tok, WEB_PATH_GRAPH) == 0) { // "graph"
2029 // the client is requesting an rrd graph -- OLD API
2031 // get the name of the data to show
2032 tok = mystrsep(&url, "/?&");
2034 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2036 // do we have such a data set?
2037 RRDSET *st = rrdset_find_byname(tok);
2038 if(!st) st = rrdset_find(tok);
2041 // try to send a file with that name
2042 buffer_flush(w->response.data);
2043 code = mysendfile(w, tok);
2047 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending %s.json of RRD_STATS...", w->id, st->name);
2048 w->response.data->contenttype = CT_APPLICATION_JSON;
2049 buffer_flush(w->response.data);
2050 rrd_stats_graph_json(st, url, w->response.data);
2055 buffer_flush(w->response.data);
2056 buffer_strcat(w->response.data, "Graph name?\r\n");
2059 else if(hash == hash_list && strcmp(tok, "list") == 0) {
2063 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending list of RRD_STATS...", w->id);
2065 buffer_flush(w->response.data);
2066 RRDSET *st = localhost.rrdset_root;
2068 for ( ; st ; st = st->next )
2069 buffer_sprintf(w->response.data, "%s\n", st->name);
2071 else if(hash == hash_all_json && strcmp(tok, "all.json") == 0) {
2074 debug(D_WEB_CLIENT_ACCESS, "%llu: Sending JSON list of all monitors of RRD_STATS...", w->id);
2076 w->response.data->contenttype = CT_APPLICATION_JSON;
2077 buffer_flush(w->response.data);
2078 rrd_stats_all_json(w->response.data);
2080 #ifdef NETDATA_INTERNAL_CHECKS
2081 else if(hash == hash_exit && strcmp(tok, "exit") == 0) {
2083 w->response.data->contenttype = CT_TEXT_PLAIN;
2084 buffer_flush(w->response.data);
2087 buffer_strcat(w->response.data, "ok, will do...");
2089 buffer_strcat(w->response.data, "I am doing it already");
2091 error("web request to exit received.");
2092 netdata_cleanup_and_exit(0);
2095 else if(hash == hash_debug && strcmp(tok, "debug") == 0) {
2096 buffer_flush(w->response.data);
2098 // get the name of the data to show
2099 tok = mystrsep(&url, "/?&");
2101 debug(D_WEB_CLIENT, "%llu: Searching for RRD data with name '%s'.", w->id, tok);
2103 // do we have such a data set?
2104 RRDSET *st = rrdset_find_byname(tok);
2105 if(!st) st = rrdset_find(tok);
2108 buffer_strcat(w->response.data, "Chart is not found: ");
2109 buffer_strcat_htmlescape(w->response.data, tok);
2110 debug(D_WEB_CLIENT_ACCESS, "%llu: %s is not found.", w->id, tok);
2114 debug_flags |= D_RRD_STATS;
2115 st->debug = !st->debug;
2116 buffer_sprintf(w->response.data, "Chart has now debug %s: ", st->debug?"enabled":"disabled");
2117 buffer_strcat_htmlescape(w->response.data, tok);
2118 debug(D_WEB_CLIENT_ACCESS, "%llu: debug for %s is %s.", w->id, tok, st->debug?"enabled":"disabled");
2123 buffer_flush(w->response.data);
2124 buffer_strcat(w->response.data, "debug which chart?\r\n");
2127 else if(hash == hash_mirror && strcmp(tok, "mirror") == 0) {
2130 debug(D_WEB_CLIENT_ACCESS, "%llu: Mirroring...", w->id);
2132 // replace the zero bytes with spaces
2133 buffer_char_replace(w->response.data, '\0', ' ');
2135 // just leave the buffer as is
2136 // it will be copied back to the client
2138 #endif /* NETDATA_INTERNAL_CHECKS */
2140 char filename[FILENAME_MAX+1];
2142 strncpyz(filename, w->last_url, FILENAME_MAX);
2143 tok = mystrsep(&url, "?");
2144 buffer_flush(w->response.data);
2145 code = mysendfile(w, (tok && *tok)?tok:"/");
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:"/");
2159 now_realtime_timeval(&w->tv_ready);
2160 w->response.sent = 0;
2161 w->response.code = code;
2163 // set a proper last modified date
2164 if(unlikely(!w->response.data->date))
2165 w->response.data->date = w->tv_ready.tv_sec;
2167 if(unlikely(code != 200))
2168 buffer_no_cacheable(w->response.data);
2170 // set a proper expiration date, if not already set
2171 if(unlikely(!w->response.data->expires)) {
2172 if(w->response.data->options & WB_CONTENT_NO_CACHEABLE)
2173 w->response.data->expires = w->tv_ready.tv_sec + rrd_update_every;
2175 w->response.data->expires = w->tv_ready.tv_sec + 86400;
2178 // prepare the HTTP response header
2179 debug(D_WEB_CLIENT, "%llu: Generating HTTP header with response %d.", w->id, code);
2181 const char *content_type_string = web_content_type_to_string(w->response.data->contenttype);
2182 const char *code_msg = web_response_code_to_string(code);
2184 // prepare the last modified and expiration dates
2185 char date[32], edate[32];
2187 struct tm tmbuf, *tm;
2189 tm = gmtime_r(&w->response.data->date, &tmbuf);
2190 strftime(date, sizeof(date), "%a, %d %b %Y %H:%M:%S %Z", tm);
2192 tm = gmtime_r(&w->response.data->expires, &tmbuf);
2193 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", tm);
2196 buffer_sprintf(w->response.header_output,
2197 "HTTP/1.1 %d %s\r\n"
2198 "Connection: %s\r\n"
2199 "Server: NetData Embedded HTTP Server\r\n"
2200 "Access-Control-Allow-Origin: %s\r\n"
2201 "Access-Control-Allow-Credentials: true\r\n"
2202 "Content-Type: %s\r\n"
2205 , w->keepalive?"keep-alive":"close"
2207 , content_type_string
2211 if(w->cookie1[0] || w->cookie2[0]) {
2213 buffer_sprintf(w->response.header_output,
2214 "Set-Cookie: %s\r\n",
2219 buffer_sprintf(w->response.header_output,
2220 "Set-Cookie: %s\r\n",
2224 if(web_donotrack_comply)
2225 buffer_sprintf(w->response.header_output,
2226 "Tk: T;cookies\r\n");
2229 if(web_donotrack_comply) {
2230 if(w->tracking_required)
2231 buffer_sprintf(w->response.header_output,
2232 "Tk: T;cookies\r\n");
2234 buffer_sprintf(w->response.header_output,
2239 if(w->mode == WEB_CLIENT_MODE_OPTIONS) {
2240 buffer_strcat(w->response.header_output,
2241 "Access-Control-Allow-Methods: GET, OPTIONS\r\n"
2242 "Access-Control-Allow-Headers: accept, x-requested-with, origin, content-type, cookie, pragma, cache-control\r\n"
2243 "Access-Control-Max-Age: 1209600\r\n" // 86400 * 14
2247 buffer_sprintf(w->response.header_output,
2248 "Cache-Control: %s\r\n"
2250 (w->response.data->options & WB_CONTENT_NO_CACHEABLE)?"no-cache":"public",
2254 // copy a possibly available custom header
2255 if(unlikely(buffer_strlen(w->response.header)))
2256 buffer_strcat(w->response.header_output, buffer_tostring(w->response.header));
2258 // headers related to the transfer method
2259 if(likely(w->response.zoutput)) {
2260 buffer_strcat(w->response.header_output,
2261 "Content-Encoding: gzip\r\n"
2262 "Transfer-Encoding: chunked\r\n"
2266 if(likely((w->response.data->len || w->response.rlen))) {
2267 // we know the content length, put it
2268 buffer_sprintf(w->response.header_output, "Content-Length: %zu\r\n", w->response.data->len? w->response.data->len: w->response.rlen);
2271 // we don't know the content length, disable keep-alive
2276 // end of HTTP header
2277 buffer_strcat(w->response.header_output, "\r\n");
2279 // sent the HTTP header
2280 debug(D_WEB_DATA, "%llu: Sending response HTTP header of size %zu: '%s'"
2282 , buffer_strlen(w->response.header_output)
2283 , buffer_tostring(w->response.header_output)
2286 web_client_crock_socket(w);
2288 bytes = send(w->ofd, buffer_tostring(w->response.header_output), buffer_strlen(w->response.header_output), 0);
2289 if(bytes != (ssize_t) buffer_strlen(w->response.header_output)) {
2291 w->stats_sent_bytes += bytes;
2293 debug(D_WEB_CLIENT, "%llu: HTTP Header failed to be sent (I sent %zu bytes but the system sent %zd bytes). Closing web client."
2295 , buffer_strlen(w->response.header_output)
2298 WEB_CLIENT_IS_DEAD(w);
2302 w->stats_sent_bytes += bytes;
2304 // enable sending immediately if we have data
2305 if(w->response.data->len) w->wait_send = 1;
2306 else w->wait_send = 0;
2310 case WEB_CLIENT_MODE_OPTIONS:
2311 debug(D_WEB_CLIENT, "%llu: Done preparing the OPTIONS response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2314 case WEB_CLIENT_MODE_NORMAL:
2315 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Sending data (%zu bytes) to client.", w->id, w->response.data->len);
2318 case WEB_CLIENT_MODE_FILECOPY:
2319 if(w->response.rlen) {
2320 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending data file of %zu bytes to client.", w->id, w->response.rlen);
2321 w->wait_receive = 1;
2324 // utilize the kernel sendfile() for copying the file to the socket.
2325 // this block of code can be commented, without anything missing.
2326 // when it is commented, the program will copy the data using async I/O.
2328 long len = sendfile(w->ofd, w->ifd, NULL, w->response.data->rbytes);
2329 if(len != w->response.data->rbytes)
2330 error("%llu: sendfile() should copy %ld bytes, but copied %ld. Falling back to manual copy.", w->id, w->response.data->rbytes, len);
2332 web_client_reset(w);
2337 debug(D_WEB_CLIENT, "%llu: Done preparing the response. Will be sending an unknown amount of bytes to client.", w->id);
2341 fatal("%llu: Unknown client mode %d.", w->id, w->mode);
2346 ssize_t web_client_send_chunk_header(struct web_client *w, size_t len)
2348 debug(D_DEFLATE, "%llu: OPEN CHUNK of %zu bytes (hex: %zx).", w->id, len, len);
2350 sprintf(buf, "%zX\r\n", len);
2352 ssize_t bytes = send(w->ofd, buf, strlen(buf), 0);
2354 debug(D_DEFLATE, "%llu: Sent chunk header %zd bytes.", w->id, bytes);
2355 w->stats_sent_bytes += bytes;
2358 else if(bytes == 0) {
2359 debug(D_WEB_CLIENT, "%llu: Did not send chunk header to the client.", w->id);
2360 WEB_CLIENT_IS_DEAD(w);
2363 debug(D_WEB_CLIENT, "%llu: Failed to send chunk header to client.", w->id);
2364 WEB_CLIENT_IS_DEAD(w);
2370 ssize_t web_client_send_chunk_close(struct web_client *w)
2372 //debug(D_DEFLATE, "%llu: CLOSE CHUNK.", w->id);
2374 ssize_t bytes = send(w->ofd, "\r\n", 2, 0);
2376 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2377 w->stats_sent_bytes += bytes;
2380 else if(bytes == 0) {
2381 debug(D_WEB_CLIENT, "%llu: Did not send chunk suffix to the client.", w->id);
2382 WEB_CLIENT_IS_DEAD(w);
2385 debug(D_WEB_CLIENT, "%llu: Failed to send chunk suffix to client.", w->id);
2386 WEB_CLIENT_IS_DEAD(w);
2392 ssize_t web_client_send_chunk_finalize(struct web_client *w)
2394 //debug(D_DEFLATE, "%llu: FINALIZE CHUNK.", w->id);
2396 ssize_t bytes = send(w->ofd, "\r\n0\r\n\r\n", 7, 0);
2398 debug(D_DEFLATE, "%llu: Sent chunk suffix %zd bytes.", w->id, bytes);
2399 w->stats_sent_bytes += bytes;
2402 else if(bytes == 0) {
2403 debug(D_WEB_CLIENT, "%llu: Did not send chunk finalize suffix to the client.", w->id);
2404 WEB_CLIENT_IS_DEAD(w);
2407 debug(D_WEB_CLIENT, "%llu: Failed to send chunk finalize suffix to client.", w->id);
2408 WEB_CLIENT_IS_DEAD(w);
2414 #ifdef NETDATA_WITH_ZLIB
2415 ssize_t web_client_send_deflate(struct web_client *w)
2417 ssize_t len = 0, t = 0;
2419 // when using compression,
2420 // w->response.sent is the amount of bytes passed through compression
2422 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.",
2423 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);
2425 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) {
2426 // there is nothing to send
2428 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2430 // finalize the chunk
2431 if(w->response.sent != 0) {
2432 t = web_client_send_chunk_finalize(w);
2436 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2437 // we have to wait, more data will come
2438 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2443 if(unlikely(!w->keepalive)) {
2444 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2445 WEB_CLIENT_IS_DEAD(w);
2450 web_client_reset(w);
2451 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket.", w->id);
2455 if(w->response.zhave == w->response.zsent) {
2456 // compress more input data
2458 // close the previous open chunk
2459 if(w->response.sent != 0) {
2460 t = web_client_send_chunk_close(w);
2464 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);
2466 // give the compressor all the data not passed through the compressor yet
2467 if(w->response.data->len > w->response.sent) {
2468 w->response.zstream.next_in = (Bytef *)&w->response.data->buffer[w->response.sent - w->response.zstream.avail_in];
2469 w->response.zstream.avail_in += (uInt) (w->response.data->len - w->response.sent);
2472 // reset the compressor output buffer
2473 w->response.zstream.next_out = w->response.zbuffer;
2474 w->response.zstream.avail_out = ZLIB_CHUNK;
2476 // ask for FINISH if we have all the input
2477 int flush = Z_SYNC_FLUSH;
2478 if(w->mode == WEB_CLIENT_MODE_NORMAL
2479 || (w->mode == WEB_CLIENT_MODE_FILECOPY && !w->wait_receive && w->response.data->len == w->response.rlen)) {
2481 debug(D_DEFLATE, "%llu: Requesting Z_FINISH, if possible.", w->id);
2484 debug(D_DEFLATE, "%llu: Requesting Z_SYNC_FLUSH.", w->id);
2488 if(deflate(&w->response.zstream, flush) == Z_STREAM_ERROR) {
2489 error("%llu: Compression failed. Closing down client.", w->id);
2490 web_client_reset(w);
2494 w->response.zhave = ZLIB_CHUNK - w->response.zstream.avail_out;
2495 w->response.zsent = 0;
2497 // keep track of the bytes passed through the compressor
2498 w->response.sent = w->response.data->len;
2500 debug(D_DEFLATE, "%llu: Compression produced %zu bytes.", w->id, w->response.zhave);
2503 ssize_t t2 = web_client_send_chunk_header(w, w->response.zhave);
2504 if(t2 < 0) return t2;
2508 debug(D_WEB_CLIENT, "%llu: Sending %zu bytes of data (+%zd of chunk header).", w->id, w->response.zhave - w->response.zsent, t);
2510 len = send(w->ofd, &w->response.zbuffer[w->response.zsent], (size_t) (w->response.zhave - w->response.zsent), MSG_DONTWAIT);
2512 w->stats_sent_bytes += len;
2513 w->response.zsent += len;
2515 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, len);
2518 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client (zhave = %zu, zsent = %zu, need to send = %zu).",
2519 w->id, w->response.zhave, w->response.zsent, w->response.zhave - w->response.zsent);
2521 WEB_CLIENT_IS_DEAD(w);
2524 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2525 WEB_CLIENT_IS_DEAD(w);
2530 #endif // NETDATA_WITH_ZLIB
2532 ssize_t web_client_send(struct web_client *w) {
2533 #ifdef NETDATA_WITH_ZLIB
2534 if(likely(w->response.zoutput)) return web_client_send_deflate(w);
2535 #endif // NETDATA_WITH_ZLIB
2539 if(unlikely(w->response.data->len - w->response.sent == 0)) {
2540 // there is nothing to send
2542 debug(D_WEB_CLIENT, "%llu: Out of output data.", w->id);
2544 // there can be two cases for this
2545 // A. we have done everything
2546 // B. we temporarily have nothing to send, waiting for the buffer to be filled by ifd
2548 if(w->mode == WEB_CLIENT_MODE_FILECOPY && w->wait_receive && w->response.rlen && w->response.rlen > w->response.data->len) {
2549 // we have to wait, more data will come
2550 debug(D_WEB_CLIENT, "%llu: Waiting for more data to become available.", w->id);
2555 if(unlikely(!w->keepalive)) {
2556 debug(D_WEB_CLIENT, "%llu: Closing (keep-alive is not enabled). %zu bytes sent.", w->id, w->response.sent);
2557 WEB_CLIENT_IS_DEAD(w);
2561 web_client_reset(w);
2562 debug(D_WEB_CLIENT, "%llu: Done sending all data on socket. Waiting for next request on the same socket.", w->id);
2566 bytes = send(w->ofd, &w->response.data->buffer[w->response.sent], w->response.data->len - w->response.sent, MSG_DONTWAIT);
2567 if(likely(bytes > 0)) {
2568 w->stats_sent_bytes += bytes;
2569 w->response.sent += bytes;
2570 debug(D_WEB_CLIENT, "%llu: Sent %zd bytes.", w->id, bytes);
2572 else if(likely(bytes == 0)) {
2573 debug(D_WEB_CLIENT, "%llu: Did not send any bytes to the client.", w->id);
2574 WEB_CLIENT_IS_DEAD(w);
2577 debug(D_WEB_CLIENT, "%llu: Failed to send data to client.", w->id);
2578 WEB_CLIENT_IS_DEAD(w);
2584 ssize_t web_client_receive(struct web_client *w)
2586 // do we have any space for more data?
2587 buffer_need_bytes(w->response.data, WEB_REQUEST_LENGTH);
2589 ssize_t left = w->response.data->size - w->response.data->len;
2592 if(unlikely(w->mode == WEB_CLIENT_MODE_FILECOPY))
2593 bytes = read(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1));
2595 bytes = recv(w->ifd, &w->response.data->buffer[w->response.data->len], (size_t) (left - 1), MSG_DONTWAIT);
2597 if(likely(bytes > 0)) {
2598 if(w->mode != WEB_CLIENT_MODE_FILECOPY)
2599 w->stats_received_bytes += bytes;
2601 size_t old = w->response.data->len;
2602 w->response.data->len += bytes;
2603 w->response.data->buffer[w->response.data->len] = '\0';
2605 debug(D_WEB_CLIENT, "%llu: Received %zd bytes.", w->id, bytes);
2606 debug(D_WEB_DATA, "%llu: Received data: '%s'.", w->id, &w->response.data->buffer[old]);
2608 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2611 if(w->response.rlen && w->response.data->len >= w->response.rlen)
2612 w->wait_receive = 0;
2615 else if(likely(bytes == 0)) {
2616 debug(D_WEB_CLIENT, "%llu: Out of input data.", w->id);
2618 // if we cannot read, it means we have an error on input.
2619 // if however, we are copying a file from ifd to ofd, we should not return an error.
2620 // in this case, the error should be generated when the file has been sent to the client.
2622 if(w->mode == WEB_CLIENT_MODE_FILECOPY) {
2623 // we are copying data from ifd to ofd
2624 // let it finish copying...
2625 w->wait_receive = 0;
2627 debug(D_WEB_CLIENT, "%llu: Read the whole file.", w->id);
2628 if(w->ifd != w->ofd) close(w->ifd);
2632 debug(D_WEB_CLIENT, "%llu: failed to receive data.", w->id);
2633 WEB_CLIENT_IS_DEAD(w);
2637 debug(D_WEB_CLIENT, "%llu: receive data failed.", w->id);
2638 WEB_CLIENT_IS_DEAD(w);
2645 // --------------------------------------------------------------------------------------
2646 // the thread of a single client
2648 // 1. waits for input and output, using async I/O
2649 // 2. it processes HTTP requests
2650 // 3. it generates HTTP responses
2651 // 4. it copies data from input to output if mode is FILECOPY
2653 void *web_client_main(void *ptr)
2655 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
2656 error("Cannot set pthread cancel type to DEFERRED.");
2658 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
2659 error("Cannot set pthread cancel state to ENABLE.");
2661 struct web_client *w = ptr;
2662 struct pollfd fds[2], *ifd, *ofd;
2663 int retval, fdmax = 0, timeout;
2665 log_access("%llu: %s port %s connected on thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2668 if(unlikely(w->dead)) {
2669 debug(D_WEB_CLIENT, "%llu: client is dead.", w->id);
2672 else if(unlikely(!w->wait_receive && !w->wait_send)) {
2673 debug(D_WEB_CLIENT, "%llu: client is not set for neither receiving nor sending data.", w->id);
2677 if(unlikely(w->ifd < 0 || w->ofd < 0)) {
2678 error("%llu: invalid file descriptor, ifd = %d, ofd = %d (required 0 <= fd", w->id, w->ifd, w->ofd);
2682 if(w->ifd == w->ofd) {
2687 if(w->wait_receive) fds[0].events |= POLLIN;
2688 if(w->wait_send) fds[0].events |= POLLOUT;
2694 ifd = ofd = &fds[0];
2702 if(w->wait_receive) fds[0].events |= POLLIN;
2708 if(w->wait_send) fds[1].events |= POLLOUT;
2714 debug(D_WEB_CLIENT, "%llu: Waiting socket async I/O for %s %s", w->id, w->wait_receive?"INPUT":"", w->wait_send?"OUTPUT":"");
2716 timeout = web_client_timeout * 1000;
2717 retval = poll(fds, fdmax, timeout);
2719 if(unlikely(retval == -1)) {
2720 if(errno == EAGAIN || errno == EINTR) {
2721 debug(D_WEB_CLIENT, "%llu: EAGAIN received.", w->id);
2725 debug(D_WEB_CLIENT, "%llu: LISTENER: poll() failed (input fd = %d, output fd = %d). Closing client.", w->id, w->ifd, w->ofd);
2728 else if(unlikely(!retval)) {
2729 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":"");
2734 if(w->wait_send && ofd->revents & POLLOUT) {
2736 if(web_client_send(w) < 0) {
2737 debug(D_WEB_CLIENT, "%llu: Cannot send data to client. Closing client.", w->id);
2742 if(w->wait_receive && (ifd->revents & POLLIN || ifd->revents & POLLPRI)) {
2744 if(web_client_receive(w) < 0) {
2745 debug(D_WEB_CLIENT, "%llu: Cannot receive data from client. Closing client.", w->id);
2749 if(w->mode == WEB_CLIENT_MODE_NORMAL) {
2750 debug(D_WEB_CLIENT, "%llu: Attempting to process received data.", w->id);
2751 web_client_process(w);
2755 if(unlikely(!used)) {
2756 debug(D_WEB_CLIENT_ACCESS, "%llu: Received error on socket.", w->id);
2761 web_client_reset(w);
2763 log_access("%llu: %s port %s disconnected from thread task id %d", w->id, w->client_ip, w->client_port, gettid());
2764 debug(D_WEB_CLIENT, "%llu: done...", w->id);
2766 // close the sockets/files now
2767 // to free file descriptors
2768 if(w->ifd == w->ofd) {
2769 if(w->ifd != -1) close(w->ifd);
2772 if(w->ifd != -1) close(w->ifd);
2773 if(w->ofd != -1) close(w->ofd);