3 * Web service library with GLib integration
5 * Copyright (C) 2009-2010 Intel Corporation. All rights reserved.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
32 #include <sys/socket.h>
33 #include <arpa/inet.h>
35 #include "giognutls.h"
39 #define DEFAULT_BUFFER_SIZE 2048
41 #define SESSION_FLAG_USE_TLS (1 << 0)
67 GIOChannel *transport_channel;
68 guint transport_watch;
74 guint8 *receive_buffer;
77 GString *current_header;
81 gboolean request_started;
83 enum chunk_state chunck_state;
90 GWebResultFunc result_func;
91 GWebInputFunc input_func;
108 gboolean close_connection;
110 GWebDebugFunc debug_func;
114 static inline void debug(GWeb *web, const char *format, ...)
119 if (web->debug_func == NULL)
122 va_start(ap, format);
124 if (vsnprintf(str, sizeof(str), format, ap) > 0)
125 web->debug_func(str, web->debug_data);
130 static void free_session(struct web_session *session)
132 GWeb *web = session->web;
137 g_free(session->request);
139 if (session->resolv_action > 0)
140 g_resolv_cancel_lookup(web->resolv, session->resolv_action);
142 if (session->transport_watch > 0)
143 g_source_remove(session->transport_watch);
145 if (session->send_watch > 0)
146 g_source_remove(session->send_watch);
148 if (session->transport_channel != NULL)
149 g_io_channel_unref(session->transport_channel);
151 g_string_free(session->send_buffer, TRUE);
152 g_string_free(session->current_header, TRUE);
153 g_free(session->receive_buffer);
155 g_free(session->content_type);
157 g_free(session->host);
158 g_free(session->address);
162 static void flush_sessions(GWeb *web)
166 for (list = g_list_first(web->session_list);
167 list; list = g_list_next(list))
168 free_session(list->data);
170 g_list_free(web->session_list);
171 web->session_list = NULL;
174 GWeb *g_web_new(int index)
181 web = g_try_new0(GWeb, 1);
187 web->next_query_id = 1;
190 web->session_list = NULL;
192 web->resolv = g_resolv_new(index);
193 if (web->resolv == NULL) {
198 web->accept_option = g_strdup("*/*");
199 web->user_agent = g_strdup_printf("GWeb/%s", VERSION);
200 web->close_connection = FALSE;
205 GWeb *g_web_ref(GWeb *web)
210 g_atomic_int_inc(&web->ref_count);
215 void g_web_unref(GWeb *web)
220 if (g_atomic_int_dec_and_test(&web->ref_count) == FALSE)
225 g_resolv_unref(web->resolv);
229 g_free(web->accept_option);
230 g_free(web->user_agent);
231 g_free(web->http_version);
236 void g_web_set_debug(GWeb *web, GWebDebugFunc func, gpointer user_data)
241 web->debug_func = func;
242 web->debug_data = user_data;
244 g_resolv_set_debug(web->resolv, func, user_data);
247 gboolean g_web_set_proxy(GWeb *web, const char *proxy)
253 web->proxy = g_strdup(proxy);
258 gboolean g_web_add_nameserver(GWeb *web, const char *address)
263 g_resolv_add_nameserver(web->resolv, address, 53, 0);
268 static gboolean set_accept_option(GWeb *web, const char *format, va_list args)
270 g_free(web->accept_option);
272 if (format == NULL) {
273 web->accept_option = NULL;
274 debug(web, "clearing accept option");
276 web->accept_option = g_strdup_vprintf(format, args);
277 debug(web, "setting accept %s", web->accept_option);
283 gboolean g_web_set_accept(GWeb *web, const char *format, ...)
291 va_start(args, format);
292 result = set_accept_option(web, format, args);
298 static gboolean set_user_agent(GWeb *web, const char *format, va_list args)
300 g_free(web->user_agent);
302 if (format == NULL) {
303 web->user_agent = NULL;
304 debug(web, "clearing user agent");
306 web->user_agent = g_strdup_vprintf(format, args);
307 debug(web, "setting user agent %s", web->user_agent);
313 gboolean g_web_set_user_agent(GWeb *web, const char *format, ...)
321 va_start(args, format);
322 result = set_user_agent(web, format, args);
328 gboolean g_web_set_http_version(GWeb *web, const char *version)
333 g_free(web->http_version);
335 if (version == NULL) {
336 web->http_version = NULL;
337 debug(web, "clearing HTTP version");
339 web->http_version = g_strdup(version);
340 debug(web, "setting HTTP version %s", web->http_version);
346 void g_web_set_close_connection(GWeb *web, gboolean enabled)
351 web->close_connection = enabled;
354 gboolean g_web_get_close_connection(GWeb *web)
359 return web->close_connection;
362 static inline void call_result_func(struct web_session *session, guint16 status)
366 if (session->result_func == NULL)
370 session->result.status = status;
372 result = session->result_func(&session->result, session->user_data);
374 debug(session->web, "[result function] %s",
375 result == TRUE ? "continue" : "stop");
378 static gboolean process_send_buffer(struct web_session *session)
380 GString *buf = session->send_buffer;
381 gsize count, bytes_written;
387 if (session->more_data == FALSE)
388 session->body_done = TRUE;
393 debug(session->web, "bytes to write %zu", count);
395 status = g_io_channel_write_chars(session->transport_channel,
396 buf->str, count, &bytes_written, NULL);
398 debug(session->web, "status %u bytes written %zu",
399 status, bytes_written);
401 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN)
404 g_string_erase(buf, 0, bytes_written);
409 static void process_next_chunk(struct web_session *session)
411 GString *buf = session->send_buffer;
415 if (session->input_func == NULL) {
416 session->more_data = FALSE;
420 session->more_data = session->input_func(&body, &length,
424 g_string_append_printf(buf, "%zx\r\n", length);
425 g_string_append_len(buf, (char *) body, length);
426 g_string_append(buf, "\r\n");
429 if (session->more_data == FALSE)
430 g_string_append(buf, "0\r\n\r\n");
433 static void start_request(struct web_session *session)
435 GString *buf = session->send_buffer;
440 debug(session->web, "request %s from %s",
441 session->request, session->host);
443 g_string_truncate(buf, 0);
445 if (session->web->http_version == NULL)
448 version = session->web->http_version;
450 if (session->content_type == NULL)
451 g_string_append_printf(buf, "GET %s HTTP/%s\r\n",
452 session->request, version);
454 g_string_append_printf(buf, "POST %s HTTP/%s\r\n",
455 session->request, version);
457 g_string_append_printf(buf, "Host: %s\r\n", session->host);
459 if (session->web->user_agent != NULL)
460 g_string_append_printf(buf, "User-Agent: %s\r\n",
461 session->web->user_agent);
463 if (session->web->accept_option != NULL)
464 g_string_append_printf(buf, "Accept: %s\r\n",
465 session->web->accept_option);
467 if (session->content_type != NULL) {
468 g_string_append_printf(buf, "Content-Type: %s\r\n",
469 session->content_type);
470 if (session->input_func == NULL) {
471 session->more_data = FALSE;
474 session->more_data = session->input_func(&body, &length,
476 if (session->more_data == FALSE)
477 g_string_append_printf(buf, "Content-Length: %zu\r\n",
480 g_string_append(buf, "Transfer-Encoding: chunked\r\n");
483 if (session->web->close_connection == TRUE)
484 g_string_append(buf, "Connection: close\r\n");
486 g_string_append(buf, "\r\n");
488 if (session->content_type != NULL && length > 0) {
489 if (session->more_data == TRUE) {
490 g_string_append_printf(buf, "%zx\r\n", length);
491 g_string_append_len(buf, (char *) body, length);
492 g_string_append(buf, "\r\n");
494 g_string_append_len(buf, (char *) body, length);
498 static gboolean send_data(GIOChannel *channel, GIOCondition cond,
501 struct web_session *session = user_data;
503 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
504 session->send_watch = 0;
508 if (process_send_buffer(session) == TRUE)
511 if (session->request_started == FALSE) {
512 session->request_started = TRUE;
513 start_request(session);
514 } else if (session->more_data == TRUE)
515 process_next_chunk(session);
517 process_send_buffer(session);
519 if (session->body_done == TRUE) {
520 session->send_watch = 0;
527 static int decode_chunked(struct web_session *session,
528 const guint8 *buf, gsize len)
530 const guint8 *ptr = buf;
538 switch (session->chunck_state) {
540 pos = memchr(ptr, '\n', len);
542 g_string_append_len(session->current_header,
548 if (count < 1 || ptr[count - 1] != '\r')
551 g_string_append_len(session->current_header,
552 (gchar *) ptr, count);
557 str = session->current_header->str;
559 counter = strtoul(str, NULL, 16);
560 if ((counter == 0 && errno == EINVAL) ||
561 counter == ULONG_MAX)
564 session->chunk_size = counter;
565 session->chunk_left = counter;
567 session->chunck_state = CHUNK_DATA;
574 session->chunck_state = CHUNK_N_BODY;
581 session->chunck_state = CHUNK_SIZE;
584 if (session->chunk_size == 0) {
585 debug(session->web, "Download Done in chunk");
586 g_string_truncate(session->current_header, 0);
590 if (session->chunk_left <= len) {
591 session->result.buffer = ptr;
592 session->result.length = session->chunk_left;
593 call_result_func(session, 0);
595 len -= session->chunk_left;
596 ptr += session->chunk_left;
598 session->total_len += session->chunk_left;
599 session->chunk_left = 0;
601 g_string_truncate(session->current_header, 0);
602 session->chunck_state = CHUNK_R_BODY;
606 session->result.buffer = ptr;
607 session->result.length = len;
608 call_result_func(session, 0);
610 session->chunk_left -= len;
611 session->total_len += len;
622 static int handle_body(struct web_session *session,
623 const guint8 *buf, gsize len)
627 debug(session->web, "[body] length %zu", len);
629 if (session->result.use_chunk == FALSE) {
630 session->result.buffer = buf;
631 session->result.length = len;
632 call_result_func(session, 0);
636 err = decode_chunked(session, buf, len);
638 debug(session->web, "Error in chunk decode %d", err);
640 session->result.buffer = NULL;
641 session->result.length = 0;
642 call_result_func(session, 400);
648 static gboolean received_data(GIOChannel *channel, GIOCondition cond,
651 struct web_session *session = user_data;
652 guint8 *ptr = session->receive_buffer;
656 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
657 session->transport_watch = 0;
658 session->result.buffer = NULL;
659 session->result.length = 0;
660 call_result_func(session, 400);
664 status = g_io_channel_read_chars(channel,
665 (gchar *) session->receive_buffer,
666 session->receive_space - 1, &bytes_read, NULL);
668 debug(session->web, "bytes read %zu", bytes_read);
670 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN) {
671 session->transport_watch = 0;
672 session->result.buffer = NULL;
673 session->result.length = 0;
674 call_result_func(session, 0);
678 session->receive_buffer[bytes_read] = '\0';
680 if (session->header_done == TRUE) {
681 if (handle_body(session, session->receive_buffer,
683 session->transport_watch = 0;
689 while (bytes_read > 0) {
694 pos = memchr(ptr, '\n', bytes_read);
696 g_string_append_len(session->current_header,
697 (gchar *) ptr, bytes_read);
702 count = strlen((char *) ptr);
703 if (count > 0 && ptr[count - 1] == '\r') {
708 g_string_append_len(session->current_header,
709 (gchar *) ptr, count);
711 bytes_read -= count + 1;
717 if (session->current_header->len == 0) {
718 session->header_done = TRUE;
719 if (handle_body(session, ptr, bytes_read) < 0) {
720 session->transport_watch = 0;
726 str = session->current_header->str;
728 if (session->result.status == 0) {
731 if (sscanf(str, "HTTP/%*s %u %*s", &code) == 1)
732 session->result.status = code;
733 } else if (session->result.use_chunk == FALSE &&
734 g_ascii_strncasecmp("Transfer-Encoding:",
738 val = g_strrstr(str + 18, "chunked");
740 session->result.use_chunk = TRUE;
742 session->chunck_state = CHUNK_SIZE;
743 session->chunk_left = 0;
744 session->chunk_left = 0;
745 session->total_len = 0;
749 debug(session->web, "[header] %s", str);
751 g_string_truncate(session->current_header, 0);
757 static int connect_session_transport(struct web_session *session)
760 struct sockaddr_in sin;
763 sk = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
767 if (session->flags & SESSION_FLAG_USE_TLS)
768 session->transport_channel = g_io_channel_gnutls_new(sk);
770 session->transport_channel = g_io_channel_unix_new(sk);
772 if (session->transport_channel == NULL) {
777 flags = g_io_channel_get_flags(session->transport_channel);
778 g_io_channel_set_flags(session->transport_channel,
779 flags | G_IO_FLAG_NONBLOCK, NULL);
781 g_io_channel_set_encoding(session->transport_channel, NULL, NULL);
782 g_io_channel_set_buffered(session->transport_channel, FALSE);
784 g_io_channel_set_close_on_unref(session->transport_channel, TRUE);
786 memset(&sin, 0, sizeof(sin));
787 sin.sin_family = AF_INET;
788 sin.sin_port = htons(session->port);
789 sin.sin_addr.s_addr = inet_addr(session->address);
791 if (connect(sk, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
792 if (errno != EINPROGRESS) {
798 session->transport_watch = g_io_add_watch(session->transport_channel,
799 G_IO_IN | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
800 received_data, session);
802 session->send_watch = g_io_add_watch(session->transport_channel,
803 G_IO_OUT | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
809 static int create_transport(struct web_session *session)
813 err = connect_session_transport(session);
817 debug(session->web, "creating session %s:%u",
818 session->address, session->port);
823 static int parse_url(struct web_session *session, const char *url)
825 char *scheme, *host, *port, *path;
827 scheme = g_strdup(url);
831 host = strstr(scheme, "://");
836 if (strcasecmp(scheme, "https") == 0) {
838 session->flags |= SESSION_FLAG_USE_TLS;
839 } else if (strcasecmp(scheme, "http") == 0) {
850 path = strchr(host, '/');
854 session->request = g_strdup_printf("/%s", path ? path : "");
856 port = strrchr(host, ':');
859 int tmp = strtol(port + 1, &end, 10);
867 session->host = g_strdup(host);
874 static void resolv_result(GResolvResultStatus status,
875 char **results, gpointer user_data)
877 struct web_session *session = user_data;
879 if (results == NULL || results[0] == NULL) {
880 call_result_func(session, 404);
884 debug(session->web, "address %s", results[0]);
886 if (inet_aton(results[0], NULL) == 0) {
887 call_result_func(session, 400);
891 session->address = g_strdup(results[0]);
893 if (create_transport(session) < 0) {
894 call_result_func(session, 409);
899 static guint do_request(GWeb *web, const char *url,
900 const char *type, GWebInputFunc input,
901 GWebResultFunc func, gpointer user_data)
903 struct web_session *session;
905 if (web == NULL || url == NULL)
908 debug(web, "request %s", url);
910 session = g_try_new0(struct web_session, 1);
914 if (parse_url(session, url) < 0) {
915 free_session(session);
919 debug(web, "host %s:%u", session->host, session->port);
920 debug(web, "flags %lu", session->flags);
923 session->content_type = g_strdup(type);
925 debug(web, "content-type %s", session->content_type);
930 session->result_func = func;
931 session->input_func = input;
932 session->user_data = user_data;
934 session->receive_buffer = g_try_malloc(DEFAULT_BUFFER_SIZE);
935 if (session->receive_buffer == NULL) {
936 free_session(session);
940 session->receive_space = DEFAULT_BUFFER_SIZE;
941 session->send_buffer = g_string_sized_new(0);
942 session->current_header = g_string_sized_new(0);
943 session->header_done = FALSE;
944 session->body_done = FALSE;
946 if (inet_aton(session->host, NULL) == 0) {
947 session->resolv_action = g_resolv_lookup_hostname(web->resolv,
948 session->host, resolv_result, session);
949 if (session->resolv_action == 0) {
950 free_session(session);
954 session->address = g_strdup(session->host);
956 if (create_transport(session) < 0) {
957 free_session(session);
962 web->session_list = g_list_append(web->session_list, session);
964 return web->next_query_id++;
967 guint g_web_request_get(GWeb *web, const char *url,
968 GWebResultFunc func, gpointer user_data)
970 return do_request(web, url, NULL, NULL, func, user_data);
973 guint g_web_request_post(GWeb *web, const char *url,
974 const char *type, GWebInputFunc input,
975 GWebResultFunc func, gpointer user_data)
977 return do_request(web, url, type, input, func, user_data);
980 gboolean g_web_cancel_request(GWeb *web, guint id)
988 guint16 g_web_result_get_status(GWebResult *result)
993 return result->status;
996 gboolean g_web_result_get_chunk(GWebResult *result,
997 const guint8 **chunk, gsize *length)
1005 *chunk = result->buffer;
1008 *length = result->length;
1013 struct _GWebParser {
1017 const char *token_str;
1022 GWebParserFunc func;
1026 GWebParser *g_web_parser_new(const char *begin, const char *end,
1027 GWebParserFunc func, gpointer user_data)
1031 parser = g_try_new0(GWebParser, 1);
1035 parser->ref_count = 1;
1037 parser->begin_token = g_strdup(begin);
1038 parser->end_token = g_strdup(end);
1040 if (parser->begin_token == NULL) {
1045 parser->func = func;
1046 parser->user_data = user_data;
1048 parser->token_str = parser->begin_token;
1049 parser->token_len = strlen(parser->token_str);
1050 parser->token_pos = 0;
1052 parser->intoken = FALSE;
1053 parser->content = g_string_sized_new(0);
1058 GWebParser *g_web_parser_ref(GWebParser *parser)
1063 g_atomic_int_inc(&parser->ref_count);
1068 void g_web_parser_unref(GWebParser *parser)
1073 if (g_atomic_int_dec_and_test(&parser->ref_count) == FALSE)
1076 g_string_free(parser->content, TRUE);
1078 g_free(parser->begin_token);
1079 g_free(parser->end_token);
1083 void g_web_parser_feed_data(GWebParser *parser,
1084 const guint8 *data, gsize length)
1086 const guint8 *ptr = data;
1091 while (length > 0) {
1092 guint8 chr = parser->token_str[parser->token_pos];
1094 if (parser->token_pos == 0) {
1097 pos = memchr(ptr, chr, length);
1099 if (parser->intoken == TRUE)
1100 g_string_append_len(parser->content,
1101 (gchar *) ptr, length);
1105 if (parser->intoken == TRUE)
1106 g_string_append_len(parser->content,
1107 (gchar *) ptr, (pos - ptr) + 1);
1109 length -= (pos - ptr) + 1;
1112 parser->token_pos++;
1116 if (parser->intoken == TRUE)
1117 g_string_append_c(parser->content, ptr[0]);
1119 if (ptr[0] != chr) {
1123 parser->token_pos = 0;
1130 parser->token_pos++;
1132 if (parser->token_pos == parser->token_len) {
1133 if (parser->intoken == FALSE) {
1134 g_string_append(parser->content,
1137 parser->intoken = TRUE;
1138 parser->token_str = parser->end_token;
1139 parser->token_len = strlen(parser->end_token);
1140 parser->token_pos = 0;
1143 str = g_string_free(parser->content, FALSE);
1144 parser->content = g_string_sized_new(0);
1146 parser->func(str, parser->user_data);
1149 parser->intoken = FALSE;
1150 parser->token_str = parser->begin_token;
1151 parser->token_len = strlen(parser->begin_token);
1152 parser->token_pos = 0;
1158 void g_web_parser_end_data(GWebParser *parser)