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)
69 GIOChannel *transport_channel;
70 guint transport_watch;
76 guint8 *receive_buffer;
79 GString *current_header;
83 gboolean request_started;
85 enum chunk_state chunck_state;
92 GWebResultFunc result_func;
93 GWebInputFunc input_func;
110 gboolean close_connection;
112 GWebDebugFunc debug_func;
116 static inline void debug(GWeb *web, const char *format, ...)
121 if (web->debug_func == NULL)
124 va_start(ap, format);
126 if (vsnprintf(str, sizeof(str), format, ap) > 0)
127 web->debug_func(str, web->debug_data);
132 static void free_session(struct web_session *session)
134 GWeb *web = session->web;
139 g_free(session->request);
141 if (session->resolv_action > 0)
142 g_resolv_cancel_lookup(web->resolv, session->resolv_action);
144 if (session->transport_watch > 0)
145 g_source_remove(session->transport_watch);
147 if (session->send_watch > 0)
148 g_source_remove(session->send_watch);
150 if (session->transport_channel != NULL)
151 g_io_channel_unref(session->transport_channel);
153 g_free(session->result.last_key);
154 g_hash_table_destroy(session->result.headers);
156 g_string_free(session->send_buffer, TRUE);
157 g_string_free(session->current_header, TRUE);
158 g_free(session->receive_buffer);
160 g_free(session->content_type);
162 g_free(session->host);
163 g_free(session->address);
167 static void flush_sessions(GWeb *web)
171 for (list = g_list_first(web->session_list);
172 list; list = g_list_next(list))
173 free_session(list->data);
175 g_list_free(web->session_list);
176 web->session_list = NULL;
179 GWeb *g_web_new(int index)
186 web = g_try_new0(GWeb, 1);
192 web->next_query_id = 1;
195 web->session_list = NULL;
197 web->resolv = g_resolv_new(index);
198 if (web->resolv == NULL) {
203 web->accept_option = g_strdup("*/*");
204 web->user_agent = g_strdup_printf("GWeb/%s", VERSION);
205 web->close_connection = FALSE;
210 GWeb *g_web_ref(GWeb *web)
215 g_atomic_int_inc(&web->ref_count);
220 void g_web_unref(GWeb *web)
225 if (g_atomic_int_dec_and_test(&web->ref_count) == FALSE)
230 g_resolv_unref(web->resolv);
234 g_free(web->accept_option);
235 g_free(web->user_agent);
236 g_free(web->http_version);
241 void g_web_set_debug(GWeb *web, GWebDebugFunc func, gpointer user_data)
246 web->debug_func = func;
247 web->debug_data = user_data;
249 g_resolv_set_debug(web->resolv, func, user_data);
252 gboolean g_web_set_proxy(GWeb *web, const char *proxy)
258 web->proxy = g_strdup(proxy);
263 gboolean g_web_add_nameserver(GWeb *web, const char *address)
268 g_resolv_add_nameserver(web->resolv, address, 53, 0);
273 static gboolean set_accept_option(GWeb *web, const char *format, va_list args)
275 g_free(web->accept_option);
277 if (format == NULL) {
278 web->accept_option = NULL;
279 debug(web, "clearing accept option");
281 web->accept_option = g_strdup_vprintf(format, args);
282 debug(web, "setting accept %s", web->accept_option);
288 gboolean g_web_set_accept(GWeb *web, const char *format, ...)
296 va_start(args, format);
297 result = set_accept_option(web, format, args);
303 static gboolean set_user_agent(GWeb *web, const char *format, va_list args)
305 g_free(web->user_agent);
307 if (format == NULL) {
308 web->user_agent = NULL;
309 debug(web, "clearing user agent");
311 web->user_agent = g_strdup_vprintf(format, args);
312 debug(web, "setting user agent %s", web->user_agent);
318 gboolean g_web_set_user_agent(GWeb *web, const char *format, ...)
326 va_start(args, format);
327 result = set_user_agent(web, format, args);
333 gboolean g_web_set_http_version(GWeb *web, const char *version)
338 g_free(web->http_version);
340 if (version == NULL) {
341 web->http_version = NULL;
342 debug(web, "clearing HTTP version");
344 web->http_version = g_strdup(version);
345 debug(web, "setting HTTP version %s", web->http_version);
351 void g_web_set_close_connection(GWeb *web, gboolean enabled)
356 web->close_connection = enabled;
359 gboolean g_web_get_close_connection(GWeb *web)
364 return web->close_connection;
367 static inline void call_result_func(struct web_session *session, guint16 status)
371 if (session->result_func == NULL)
375 session->result.status = status;
377 result = session->result_func(&session->result, session->user_data);
379 debug(session->web, "[result function] %s",
380 result == TRUE ? "continue" : "stop");
383 static gboolean process_send_buffer(struct web_session *session)
385 GString *buf = session->send_buffer;
386 gsize count, bytes_written;
392 if (session->request_started == TRUE &&
393 session->more_data == FALSE)
394 session->body_done = TRUE;
399 debug(session->web, "bytes to write %zu", count);
401 status = g_io_channel_write_chars(session->transport_channel,
402 buf->str, count, &bytes_written, NULL);
404 debug(session->web, "status %u bytes written %zu",
405 status, bytes_written);
407 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN)
410 g_string_erase(buf, 0, bytes_written);
415 static void process_next_chunk(struct web_session *session)
417 GString *buf = session->send_buffer;
421 if (session->input_func == NULL) {
422 session->more_data = FALSE;
426 session->more_data = session->input_func(&body, &length,
430 g_string_append_printf(buf, "%zx\r\n", length);
431 g_string_append_len(buf, (char *) body, length);
432 g_string_append(buf, "\r\n");
435 if (session->more_data == FALSE)
436 g_string_append(buf, "0\r\n\r\n");
439 static void start_request(struct web_session *session)
441 GString *buf = session->send_buffer;
446 debug(session->web, "request %s from %s",
447 session->request, session->host);
449 g_string_truncate(buf, 0);
451 if (session->web->http_version == NULL)
454 version = session->web->http_version;
456 if (session->content_type == NULL)
457 g_string_append_printf(buf, "GET %s HTTP/%s\r\n",
458 session->request, version);
460 g_string_append_printf(buf, "POST %s HTTP/%s\r\n",
461 session->request, version);
463 g_string_append_printf(buf, "Host: %s\r\n", session->host);
465 if (session->web->user_agent != NULL)
466 g_string_append_printf(buf, "User-Agent: %s\r\n",
467 session->web->user_agent);
469 if (session->web->accept_option != NULL)
470 g_string_append_printf(buf, "Accept: %s\r\n",
471 session->web->accept_option);
473 if (session->content_type != NULL) {
474 g_string_append_printf(buf, "Content-Type: %s\r\n",
475 session->content_type);
476 if (session->input_func == NULL) {
477 session->more_data = FALSE;
480 session->more_data = session->input_func(&body, &length,
482 if (session->more_data == FALSE)
483 g_string_append_printf(buf, "Content-Length: %zu\r\n",
486 g_string_append(buf, "Transfer-Encoding: chunked\r\n");
489 if (session->web->close_connection == TRUE)
490 g_string_append(buf, "Connection: close\r\n");
492 g_string_append(buf, "\r\n");
494 if (session->content_type != NULL && length > 0) {
495 if (session->more_data == TRUE) {
496 g_string_append_printf(buf, "%zx\r\n", length);
497 g_string_append_len(buf, (char *) body, length);
498 g_string_append(buf, "\r\n");
500 g_string_append_len(buf, (char *) body, length);
504 static gboolean send_data(GIOChannel *channel, GIOCondition cond,
507 struct web_session *session = user_data;
509 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
510 session->send_watch = 0;
514 if (process_send_buffer(session) == TRUE)
517 if (session->request_started == FALSE) {
518 session->request_started = TRUE;
519 start_request(session);
520 } else if (session->more_data == TRUE)
521 process_next_chunk(session);
523 process_send_buffer(session);
525 if (session->body_done == TRUE) {
526 session->send_watch = 0;
533 static int decode_chunked(struct web_session *session,
534 const guint8 *buf, gsize len)
536 const guint8 *ptr = buf;
544 switch (session->chunck_state) {
546 pos = memchr(ptr, '\n', len);
548 g_string_append_len(session->current_header,
554 if (count < 1 || ptr[count - 1] != '\r')
557 g_string_append_len(session->current_header,
558 (gchar *) ptr, count);
563 str = session->current_header->str;
565 counter = strtoul(str, NULL, 16);
566 if ((counter == 0 && errno == EINVAL) ||
567 counter == ULONG_MAX)
570 session->chunk_size = counter;
571 session->chunk_left = counter;
573 session->chunck_state = CHUNK_DATA;
580 session->chunck_state = CHUNK_N_BODY;
587 session->chunck_state = CHUNK_SIZE;
590 if (session->chunk_size == 0) {
591 debug(session->web, "Download Done in chunk");
592 g_string_truncate(session->current_header, 0);
596 if (session->chunk_left <= len) {
597 session->result.buffer = ptr;
598 session->result.length = session->chunk_left;
599 call_result_func(session, 0);
601 len -= session->chunk_left;
602 ptr += session->chunk_left;
604 session->total_len += session->chunk_left;
605 session->chunk_left = 0;
607 g_string_truncate(session->current_header, 0);
608 session->chunck_state = CHUNK_R_BODY;
612 session->result.buffer = ptr;
613 session->result.length = len;
614 call_result_func(session, 0);
616 session->chunk_left -= len;
617 session->total_len += len;
628 static int handle_body(struct web_session *session,
629 const guint8 *buf, gsize len)
633 debug(session->web, "[body] length %zu", len);
635 if (session->result.use_chunk == FALSE) {
637 session->result.buffer = buf;
638 session->result.length = len;
639 call_result_func(session, 0);
644 err = decode_chunked(session, buf, len);
646 debug(session->web, "Error in chunk decode %d", err);
648 session->result.buffer = NULL;
649 session->result.length = 0;
650 call_result_func(session, 400);
656 static gboolean received_data(GIOChannel *channel, GIOCondition cond,
659 struct web_session *session = user_data;
660 guint8 *ptr = session->receive_buffer;
664 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
665 session->transport_watch = 0;
666 session->result.buffer = NULL;
667 session->result.length = 0;
668 call_result_func(session, 400);
672 status = g_io_channel_read_chars(channel,
673 (gchar *) session->receive_buffer,
674 session->receive_space - 1, &bytes_read, NULL);
676 debug(session->web, "bytes read %zu", bytes_read);
678 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN) {
679 session->transport_watch = 0;
680 session->result.buffer = NULL;
681 session->result.length = 0;
682 call_result_func(session, 0);
686 session->receive_buffer[bytes_read] = '\0';
688 if (session->header_done == TRUE) {
689 if (handle_body(session, session->receive_buffer,
691 session->transport_watch = 0;
697 while (bytes_read > 0) {
702 pos = memchr(ptr, '\n', bytes_read);
704 g_string_append_len(session->current_header,
705 (gchar *) ptr, bytes_read);
710 count = strlen((char *) ptr);
711 if (count > 0 && ptr[count - 1] == '\r') {
716 g_string_append_len(session->current_header,
717 (gchar *) ptr, count);
719 bytes_read -= count + 1;
725 if (session->current_header->len == 0) {
728 session->header_done = TRUE;
730 val = g_hash_table_lookup(session->result.headers,
731 "Transfer-Encoding");
733 val = g_strrstr(val, "chunked");
735 session->result.use_chunk = TRUE;
737 session->chunck_state = CHUNK_SIZE;
738 session->chunk_left = 0;
739 session->total_len = 0;
743 if (handle_body(session, ptr, bytes_read) < 0) {
744 session->transport_watch = 0;
750 str = session->current_header->str;
752 if (session->result.status == 0) {
755 if (sscanf(str, "HTTP/%*s %u %*s", &code) == 1)
756 session->result.status = code;
759 debug(session->web, "[header] %s", str);
761 /* handle multi-line header */
762 if (str[0] == ' ' || str[0] == '\t') {
765 while (str[0] == ' ' || str[0] == '\t')
768 count = str - session->current_header->str;
770 g_string_erase(session->current_header,
772 g_string_insert_c(session->current_header,
776 value = g_hash_table_lookup(session->result.headers,
777 session->result.last_key);
779 g_string_insert(session->current_header,
782 str = session->current_header->str;
784 g_hash_table_replace(session->result.headers,
785 g_strdup(session->result.last_key),
789 pos = memchr(str, ':', session->current_header->len);
794 g_hash_table_replace(session->result.headers,
796 g_strdup((char *)pos));
798 g_free(session->result.last_key);
799 session->result.last_key = g_strdup(str);
803 g_string_truncate(session->current_header, 0);
809 static int connect_session_transport(struct web_session *session)
812 struct sockaddr_in sin;
815 sk = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
819 if (session->flags & SESSION_FLAG_USE_TLS) {
820 debug(session->web, "using TLS encryption");
821 session->transport_channel = g_io_channel_gnutls_new(sk);
823 debug(session->web, "no encryption");
824 session->transport_channel = g_io_channel_unix_new(sk);
827 if (session->transport_channel == NULL) {
832 flags = g_io_channel_get_flags(session->transport_channel);
833 g_io_channel_set_flags(session->transport_channel,
834 flags | G_IO_FLAG_NONBLOCK, NULL);
836 g_io_channel_set_encoding(session->transport_channel, NULL, NULL);
837 g_io_channel_set_buffered(session->transport_channel, FALSE);
839 g_io_channel_set_close_on_unref(session->transport_channel, TRUE);
841 memset(&sin, 0, sizeof(sin));
842 sin.sin_family = AF_INET;
843 sin.sin_port = htons(session->port);
844 sin.sin_addr.s_addr = inet_addr(session->address);
846 if (connect(sk, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
847 if (errno != EINPROGRESS) {
853 session->transport_watch = g_io_add_watch(session->transport_channel,
854 G_IO_IN | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
855 received_data, session);
857 session->send_watch = g_io_add_watch(session->transport_channel,
858 G_IO_OUT | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
864 static int create_transport(struct web_session *session)
868 err = connect_session_transport(session);
872 debug(session->web, "creating session %s:%u",
873 session->address, session->port);
878 static int parse_url(struct web_session *session, const char *url)
880 char *scheme, *host, *port, *path;
882 scheme = g_strdup(url);
886 host = strstr(scheme, "://");
891 if (strcasecmp(scheme, "https") == 0) {
893 session->flags |= SESSION_FLAG_USE_TLS;
894 } else if (strcasecmp(scheme, "http") == 0) {
905 path = strchr(host, '/');
909 session->request = g_strdup_printf("/%s", path ? path : "");
911 port = strrchr(host, ':');
914 int tmp = strtol(port + 1, &end, 10);
922 session->host = g_strdup(host);
929 static void resolv_result(GResolvResultStatus status,
930 char **results, gpointer user_data)
932 struct web_session *session = user_data;
934 if (results == NULL || results[0] == NULL) {
935 call_result_func(session, 404);
939 debug(session->web, "address %s", results[0]);
941 if (inet_aton(results[0], NULL) == 0) {
942 call_result_func(session, 400);
946 session->address = g_strdup(results[0]);
948 if (create_transport(session) < 0) {
949 call_result_func(session, 409);
954 static guint do_request(GWeb *web, const char *url,
955 const char *type, GWebInputFunc input,
956 GWebResultFunc func, gpointer user_data)
958 struct web_session *session;
960 if (web == NULL || url == NULL)
963 debug(web, "request %s", url);
965 session = g_try_new0(struct web_session, 1);
969 if (parse_url(session, url) < 0) {
970 free_session(session);
974 debug(web, "host %s:%u", session->host, session->port);
975 debug(web, "flags %lu", session->flags);
978 session->content_type = g_strdup(type);
980 debug(web, "content-type %s", session->content_type);
985 session->result_func = func;
986 session->input_func = input;
987 session->user_data = user_data;
989 session->receive_buffer = g_try_malloc(DEFAULT_BUFFER_SIZE);
990 if (session->receive_buffer == NULL) {
991 free_session(session);
995 session->result.headers = g_hash_table_new_full(g_str_hash, g_str_equal,
997 if (session->result.headers == NULL) {
998 free_session(session);
1002 session->receive_space = DEFAULT_BUFFER_SIZE;
1003 session->send_buffer = g_string_sized_new(0);
1004 session->current_header = g_string_sized_new(0);
1005 session->header_done = FALSE;
1006 session->body_done = FALSE;
1008 if (inet_aton(session->host, NULL) == 0) {
1009 session->resolv_action = g_resolv_lookup_hostname(web->resolv,
1010 session->host, resolv_result, session);
1011 if (session->resolv_action == 0) {
1012 free_session(session);
1016 session->address = g_strdup(session->host);
1018 if (create_transport(session) < 0) {
1019 free_session(session);
1024 web->session_list = g_list_append(web->session_list, session);
1026 return web->next_query_id++;
1029 guint g_web_request_get(GWeb *web, const char *url,
1030 GWebResultFunc func, gpointer user_data)
1032 return do_request(web, url, NULL, NULL, func, user_data);
1035 guint g_web_request_post(GWeb *web, const char *url,
1036 const char *type, GWebInputFunc input,
1037 GWebResultFunc func, gpointer user_data)
1039 return do_request(web, url, type, input, func, user_data);
1042 gboolean g_web_cancel_request(GWeb *web, guint id)
1050 guint16 g_web_result_get_status(GWebResult *result)
1055 return result->status;
1058 gboolean g_web_result_get_chunk(GWebResult *result,
1059 const guint8 **chunk, gsize *length)
1067 *chunk = result->buffer;
1070 *length = result->length;
1075 gboolean g_web_result_get_header(GWebResult *result,
1076 const char *header, const char **value)
1084 *value = g_hash_table_lookup(result->headers, header);
1092 struct _GWebParser {
1096 const char *token_str;
1101 GWebParserFunc func;
1105 GWebParser *g_web_parser_new(const char *begin, const char *end,
1106 GWebParserFunc func, gpointer user_data)
1110 parser = g_try_new0(GWebParser, 1);
1114 parser->ref_count = 1;
1116 parser->begin_token = g_strdup(begin);
1117 parser->end_token = g_strdup(end);
1119 if (parser->begin_token == NULL) {
1124 parser->func = func;
1125 parser->user_data = user_data;
1127 parser->token_str = parser->begin_token;
1128 parser->token_len = strlen(parser->token_str);
1129 parser->token_pos = 0;
1131 parser->intoken = FALSE;
1132 parser->content = g_string_sized_new(0);
1137 GWebParser *g_web_parser_ref(GWebParser *parser)
1142 g_atomic_int_inc(&parser->ref_count);
1147 void g_web_parser_unref(GWebParser *parser)
1152 if (g_atomic_int_dec_and_test(&parser->ref_count) == FALSE)
1155 g_string_free(parser->content, TRUE);
1157 g_free(parser->begin_token);
1158 g_free(parser->end_token);
1162 void g_web_parser_feed_data(GWebParser *parser,
1163 const guint8 *data, gsize length)
1165 const guint8 *ptr = data;
1170 while (length > 0) {
1171 guint8 chr = parser->token_str[parser->token_pos];
1173 if (parser->token_pos == 0) {
1176 pos = memchr(ptr, chr, length);
1178 if (parser->intoken == TRUE)
1179 g_string_append_len(parser->content,
1180 (gchar *) ptr, length);
1184 if (parser->intoken == TRUE)
1185 g_string_append_len(parser->content,
1186 (gchar *) ptr, (pos - ptr) + 1);
1188 length -= (pos - ptr) + 1;
1191 parser->token_pos++;
1195 if (parser->intoken == TRUE)
1196 g_string_append_c(parser->content, ptr[0]);
1198 if (ptr[0] != chr) {
1202 parser->token_pos = 0;
1209 parser->token_pos++;
1211 if (parser->token_pos == parser->token_len) {
1212 if (parser->intoken == FALSE) {
1213 g_string_append(parser->content,
1216 parser->intoken = TRUE;
1217 parser->token_str = parser->end_token;
1218 parser->token_len = strlen(parser->end_token);
1219 parser->token_pos = 0;
1222 str = g_string_free(parser->content, FALSE);
1223 parser->content = g_string_sized_new(0);
1225 parser->func(str, parser->user_data);
1228 parser->intoken = FALSE;
1229 parser->token_str = parser->begin_token;
1230 parser->token_len = strlen(parser->begin_token);
1231 parser->token_pos = 0;
1237 void g_web_parser_end_data(GWebParser *parser)