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>
36 #include "giognutls.h"
40 #define DEFAULT_BUFFER_SIZE 2048
42 #define SESSION_FLAG_USE_TLS (1 << 0)
67 struct addrinfo *addr;
71 GIOChannel *transport_channel;
72 guint transport_watch;
78 guint8 *receive_buffer;
81 GString *current_header;
85 gboolean request_started;
87 enum chunk_state chunck_state;
94 GWebResultFunc result_func;
95 GWebInputFunc input_func;
111 char *user_agent_profile;
113 gboolean close_connection;
115 GWebDebugFunc debug_func;
119 static inline void debug(GWeb *web, const char *format, ...)
124 if (web->debug_func == NULL)
127 va_start(ap, format);
129 if (vsnprintf(str, sizeof(str), format, ap) > 0)
130 web->debug_func(str, web->debug_data);
135 static void free_session(struct web_session *session)
137 GWeb *web = session->web;
142 g_free(session->request);
144 if (session->resolv_action > 0)
145 g_resolv_cancel_lookup(web->resolv, session->resolv_action);
147 if (session->transport_watch > 0)
148 g_source_remove(session->transport_watch);
150 if (session->send_watch > 0)
151 g_source_remove(session->send_watch);
153 if (session->transport_channel != NULL)
154 g_io_channel_unref(session->transport_channel);
156 g_free(session->result.last_key);
158 if (session->result.headers != NULL)
159 g_hash_table_destroy(session->result.headers);
161 if (session->send_buffer != NULL)
162 g_string_free(session->send_buffer, TRUE);
164 if (session->current_header != NULL)
165 g_string_free(session->current_header, TRUE);
167 g_free(session->receive_buffer);
169 g_free(session->content_type);
171 g_free(session->host);
172 g_free(session->address);
173 if (session->addr != NULL)
174 freeaddrinfo(session->addr);
179 static void flush_sessions(GWeb *web)
183 for (list = g_list_first(web->session_list);
184 list; list = g_list_next(list))
185 free_session(list->data);
187 g_list_free(web->session_list);
188 web->session_list = NULL;
191 GWeb *g_web_new(int index)
198 web = g_try_new0(GWeb, 1);
204 web->next_query_id = 1;
207 web->session_list = NULL;
209 web->resolv = g_resolv_new(index);
210 if (web->resolv == NULL) {
215 web->accept_option = g_strdup("*/*");
216 web->user_agent = g_strdup_printf("GWeb/%s", VERSION);
217 web->close_connection = FALSE;
222 GWeb *g_web_ref(GWeb *web)
227 g_atomic_int_inc(&web->ref_count);
232 void g_web_unref(GWeb *web)
237 if (g_atomic_int_dec_and_test(&web->ref_count) == FALSE)
242 g_resolv_unref(web->resolv);
246 g_free(web->accept_option);
247 g_free(web->user_agent);
248 g_free(web->user_agent_profile);
249 g_free(web->http_version);
254 void g_web_set_debug(GWeb *web, GWebDebugFunc func, gpointer user_data)
259 web->debug_func = func;
260 web->debug_data = user_data;
262 g_resolv_set_debug(web->resolv, func, user_data);
265 gboolean g_web_set_proxy(GWeb *web, const char *proxy)
274 debug(web, "clearing proxy");
276 web->proxy = g_strdup(proxy);
277 debug(web, "setting proxy %s", web->proxy);
283 gboolean g_web_add_nameserver(GWeb *web, const char *address)
288 g_resolv_add_nameserver(web->resolv, address, 53, 0);
293 static gboolean set_accept_option(GWeb *web, const char *format, va_list args)
295 g_free(web->accept_option);
297 if (format == NULL) {
298 web->accept_option = NULL;
299 debug(web, "clearing accept option");
301 web->accept_option = g_strdup_vprintf(format, args);
302 debug(web, "setting accept %s", web->accept_option);
308 gboolean g_web_set_accept(GWeb *web, const char *format, ...)
316 va_start(args, format);
317 result = set_accept_option(web, format, args);
323 static gboolean set_user_agent(GWeb *web, const char *format, va_list args)
325 g_free(web->user_agent);
327 if (format == NULL) {
328 web->user_agent = NULL;
329 debug(web, "clearing user agent");
331 web->user_agent = g_strdup_vprintf(format, args);
332 debug(web, "setting user agent %s", web->user_agent);
338 gboolean g_web_set_user_agent(GWeb *web, const char *format, ...)
346 va_start(args, format);
347 result = set_user_agent(web, format, args);
353 gboolean g_web_set_ua_profile(GWeb *web, const char *profile)
358 g_free(web->user_agent_profile);
360 web->user_agent_profile = g_strdup(profile);
361 debug(web, "setting user agent profile %s", web->user_agent);
366 gboolean g_web_set_http_version(GWeb *web, const char *version)
371 g_free(web->http_version);
373 if (version == NULL) {
374 web->http_version = NULL;
375 debug(web, "clearing HTTP version");
377 web->http_version = g_strdup(version);
378 debug(web, "setting HTTP version %s", web->http_version);
384 void g_web_set_close_connection(GWeb *web, gboolean enabled)
389 web->close_connection = enabled;
392 gboolean g_web_get_close_connection(GWeb *web)
397 return web->close_connection;
400 static inline void call_result_func(struct web_session *session, guint16 status)
404 if (session->result_func == NULL)
408 session->result.status = status;
410 result = session->result_func(&session->result, session->user_data);
412 debug(session->web, "[result function] %s",
413 result == TRUE ? "continue" : "stop");
416 static gboolean process_send_buffer(struct web_session *session)
418 GString *buf = session->send_buffer;
419 gsize count, bytes_written;
425 if (session->request_started == TRUE &&
426 session->more_data == FALSE)
427 session->body_done = TRUE;
432 status = g_io_channel_write_chars(session->transport_channel,
433 buf->str, count, &bytes_written, NULL);
435 debug(session->web, "status %u bytes to write %zu bytes written %zu",
436 status, count, bytes_written);
438 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN)
441 g_string_erase(buf, 0, bytes_written);
446 static void process_next_chunk(struct web_session *session)
448 GString *buf = session->send_buffer;
452 if (session->input_func == NULL) {
453 session->more_data = FALSE;
457 session->more_data = session->input_func(&body, &length,
461 g_string_append_printf(buf, "%zx\r\n", length);
462 g_string_append_len(buf, (char *) body, length);
463 g_string_append(buf, "\r\n");
466 if (session->more_data == FALSE)
467 g_string_append(buf, "0\r\n\r\n");
470 static void start_request(struct web_session *session)
472 GString *buf = session->send_buffer;
477 debug(session->web, "request %s from %s",
478 session->request, session->host);
480 g_string_truncate(buf, 0);
482 if (session->web->http_version == NULL)
485 version = session->web->http_version;
487 if (session->content_type == NULL)
488 g_string_append_printf(buf, "GET %s HTTP/%s\r\n",
489 session->request, version);
491 g_string_append_printf(buf, "POST %s HTTP/%s\r\n",
492 session->request, version);
494 g_string_append_printf(buf, "Host: %s\r\n", session->host);
496 if (session->web->user_agent != NULL)
497 g_string_append_printf(buf, "User-Agent: %s\r\n",
498 session->web->user_agent);
500 if (session->web->user_agent_profile != NULL) {
501 g_string_append_printf(buf, "x-wap-profile: %s\r\n",
502 session->web->user_agent_profile);
505 if (session->web->accept_option != NULL)
506 g_string_append_printf(buf, "Accept: %s\r\n",
507 session->web->accept_option);
509 if (session->content_type != NULL) {
510 g_string_append_printf(buf, "Content-Type: %s\r\n",
511 session->content_type);
512 if (session->input_func == NULL) {
513 session->more_data = FALSE;
516 session->more_data = session->input_func(&body, &length,
518 if (session->more_data == FALSE)
519 g_string_append_printf(buf, "Content-Length: %zu\r\n",
522 g_string_append(buf, "Transfer-Encoding: chunked\r\n");
525 if (session->web->close_connection == TRUE)
526 g_string_append(buf, "Connection: close\r\n");
528 g_string_append(buf, "\r\n");
530 if (session->content_type != NULL && length > 0) {
531 if (session->more_data == TRUE) {
532 g_string_append_printf(buf, "%zx\r\n", length);
533 g_string_append_len(buf, (char *) body, length);
534 g_string_append(buf, "\r\n");
536 g_string_append_len(buf, (char *) body, length);
540 static gboolean send_data(GIOChannel *channel, GIOCondition cond,
543 struct web_session *session = user_data;
545 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
546 session->send_watch = 0;
550 if (process_send_buffer(session) == TRUE)
553 if (session->request_started == FALSE) {
554 session->request_started = TRUE;
555 start_request(session);
556 } else if (session->more_data == TRUE)
557 process_next_chunk(session);
559 process_send_buffer(session);
561 if (session->body_done == TRUE) {
562 session->send_watch = 0;
569 static int decode_chunked(struct web_session *session,
570 const guint8 *buf, gsize len)
572 const guint8 *ptr = buf;
580 switch (session->chunck_state) {
582 pos = memchr(ptr, '\n', len);
584 g_string_append_len(session->current_header,
590 if (count < 1 || ptr[count - 1] != '\r')
593 g_string_append_len(session->current_header,
594 (gchar *) ptr, count);
599 str = session->current_header->str;
601 counter = strtoul(str, NULL, 16);
602 if ((counter == 0 && errno == EINVAL) ||
603 counter == ULONG_MAX)
606 session->chunk_size = counter;
607 session->chunk_left = counter;
609 session->chunck_state = CHUNK_DATA;
616 session->chunck_state = CHUNK_N_BODY;
623 session->chunck_state = CHUNK_SIZE;
626 if (session->chunk_size == 0) {
627 debug(session->web, "Download Done in chunk");
628 g_string_truncate(session->current_header, 0);
632 if (session->chunk_left <= len) {
633 session->result.buffer = ptr;
634 session->result.length = session->chunk_left;
635 call_result_func(session, 0);
637 len -= session->chunk_left;
638 ptr += session->chunk_left;
640 session->total_len += session->chunk_left;
641 session->chunk_left = 0;
643 g_string_truncate(session->current_header, 0);
644 session->chunck_state = CHUNK_R_BODY;
648 session->result.buffer = ptr;
649 session->result.length = len;
650 call_result_func(session, 0);
652 session->chunk_left -= len;
653 session->total_len += len;
664 static int handle_body(struct web_session *session,
665 const guint8 *buf, gsize len)
669 debug(session->web, "[body] length %zu", len);
671 if (session->result.use_chunk == FALSE) {
673 session->result.buffer = buf;
674 session->result.length = len;
675 call_result_func(session, 0);
680 err = decode_chunked(session, buf, len);
682 debug(session->web, "Error in chunk decode %d", err);
684 session->result.buffer = NULL;
685 session->result.length = 0;
686 call_result_func(session, 400);
692 static void handle_multi_line(struct web_session *session)
698 str = session->current_header->str;
700 if (str[0] != ' ' && str[0] != '\t')
703 while (str[0] == ' ' || str[0] == '\t')
706 count = str - session->current_header->str;
708 g_string_erase(session->current_header, 0, count);
709 g_string_insert_c(session->current_header, 0, ' ');
712 value = g_hash_table_lookup(session->result.headers,
713 session->result.last_key);
715 g_string_insert(session->current_header, 0, value);
717 str = session->current_header->str;
719 g_hash_table_replace(session->result.headers,
720 g_strdup(session->result.last_key),
725 static void add_header_field(struct web_session *session)
733 str = session->current_header->str;
735 pos = memchr(str, ':', session->current_header->len);
742 /* remove preceding white spaces */
746 count = (char *) pos - str;
748 g_string_erase(session->current_header, 0, count);
750 value = g_hash_table_lookup(session->result.headers, key);
752 g_string_insert_c(session->current_header, 0, ' ');
753 g_string_insert_c(session->current_header, 0, ';');
755 g_string_insert(session->current_header, 0, value);
758 str = session->current_header->str;
759 g_hash_table_replace(session->result.headers, key,
762 g_free(session->result.last_key);
763 session->result.last_key = g_strdup(key);
767 static gboolean received_data(GIOChannel *channel, GIOCondition cond,
770 struct web_session *session = user_data;
771 guint8 *ptr = session->receive_buffer;
775 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
776 session->transport_watch = 0;
777 session->result.buffer = NULL;
778 session->result.length = 0;
779 call_result_func(session, 400);
783 status = g_io_channel_read_chars(channel,
784 (gchar *) session->receive_buffer,
785 session->receive_space - 1, &bytes_read, NULL);
787 debug(session->web, "bytes read %zu", bytes_read);
789 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN) {
790 session->transport_watch = 0;
791 session->result.buffer = NULL;
792 session->result.length = 0;
793 call_result_func(session, 0);
797 session->receive_buffer[bytes_read] = '\0';
799 if (session->header_done == TRUE) {
800 if (handle_body(session, session->receive_buffer,
802 session->transport_watch = 0;
808 while (bytes_read > 0) {
813 pos = memchr(ptr, '\n', bytes_read);
815 g_string_append_len(session->current_header,
816 (gchar *) ptr, bytes_read);
821 count = strlen((char *) ptr);
822 if (count > 0 && ptr[count - 1] == '\r') {
827 g_string_append_len(session->current_header,
828 (gchar *) ptr, count);
830 bytes_read -= count + 1;
836 if (session->current_header->len == 0) {
839 session->header_done = TRUE;
841 val = g_hash_table_lookup(session->result.headers,
842 "Transfer-Encoding");
844 val = g_strrstr(val, "chunked");
846 session->result.use_chunk = TRUE;
848 session->chunck_state = CHUNK_SIZE;
849 session->chunk_left = 0;
850 session->total_len = 0;
854 if (handle_body(session, ptr, bytes_read) < 0) {
855 session->transport_watch = 0;
861 str = session->current_header->str;
863 if (session->result.status == 0) {
866 if (sscanf(str, "HTTP/%*s %u %*s", &code) == 1)
867 session->result.status = code;
870 debug(session->web, "[header] %s", str);
872 /* handle multi-line header */
873 if (str[0] == ' ' || str[0] == '\t')
874 handle_multi_line(session);
876 add_header_field(session);
878 g_string_truncate(session->current_header, 0);
884 static int connect_session_transport(struct web_session *session)
889 sk = socket(session->addr->ai_family, SOCK_STREAM, IPPROTO_TCP);
893 if (session->flags & SESSION_FLAG_USE_TLS) {
894 debug(session->web, "using TLS encryption");
895 session->transport_channel = g_io_channel_gnutls_new(sk);
897 debug(session->web, "no encryption");
898 session->transport_channel = g_io_channel_unix_new(sk);
901 if (session->transport_channel == NULL) {
906 flags = g_io_channel_get_flags(session->transport_channel);
907 g_io_channel_set_flags(session->transport_channel,
908 flags | G_IO_FLAG_NONBLOCK, NULL);
910 g_io_channel_set_encoding(session->transport_channel, NULL, NULL);
911 g_io_channel_set_buffered(session->transport_channel, FALSE);
913 g_io_channel_set_close_on_unref(session->transport_channel, TRUE);
915 if (connect(sk, session->addr->ai_addr,
916 session->addr->ai_addrlen) < 0) {
917 if (errno != EINPROGRESS) {
923 session->transport_watch = g_io_add_watch(session->transport_channel,
924 G_IO_IN | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
925 received_data, session);
927 session->send_watch = g_io_add_watch(session->transport_channel,
928 G_IO_OUT | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
934 static int create_transport(struct web_session *session)
938 err = connect_session_transport(session);
942 debug(session->web, "creating session %s:%u",
943 session->address, session->port);
948 static int parse_url(struct web_session *session,
949 const char *url, const char *proxy)
951 char *scheme, *host, *port, *path;
953 scheme = g_strdup(url);
957 host = strstr(scheme, "://");
962 if (strcasecmp(scheme, "https") == 0) {
964 session->flags |= SESSION_FLAG_USE_TLS;
965 } else if (strcasecmp(scheme, "http") == 0) {
976 path = strchr(host, '/');
981 session->request = g_strdup_printf("/%s", path ? path : "");
983 session->request = g_strdup(url);
985 port = strrchr(host, ':');
988 int tmp = strtol(port + 1, &end, 10);
996 session->host = g_strdup(host);
998 session->host = g_strdup_printf("%s:%u", host, tmp);
1000 session->host = g_strdup(host);
1007 scheme = g_strdup(proxy);
1011 host = strstr(proxy, "://");
1016 if (strcasecmp(scheme, "http") != 0) {
1023 path = strchr(host, '/');
1027 port = strrchr(host, ':');
1030 int tmp = strtol(port + 1, &end, 10);
1034 session->port = tmp;
1038 session->address = g_strdup(host);
1045 static void resolv_result(GResolvResultStatus status,
1046 char **results, gpointer user_data)
1048 struct web_session *session = user_data;
1049 struct addrinfo hints;
1053 if (results == NULL || results[0] == NULL) {
1054 call_result_func(session, 404);
1058 debug(session->web, "address %s", results[0]);
1060 memset(&hints, 0, sizeof(struct addrinfo));
1061 hints.ai_flags = AI_NUMERICHOST;
1063 if (session->addr != NULL) {
1064 freeaddrinfo(session->addr);
1065 session->addr = NULL;
1068 port = g_strdup_printf("%u", session->port);
1069 ret = getaddrinfo(results[0], port, &hints, &session->addr);
1071 if (ret != 0 || session->addr == NULL) {
1072 call_result_func(session, 400);
1076 session->address = g_strdup(results[0]);
1078 if (create_transport(session) < 0) {
1079 call_result_func(session, 409);
1084 static guint do_request(GWeb *web, const char *url,
1085 const char *type, GWebInputFunc input,
1086 GWebResultFunc func, gpointer user_data)
1088 struct web_session *session;
1090 if (web == NULL || url == NULL)
1093 debug(web, "request %s", url);
1095 session = g_try_new0(struct web_session, 1);
1096 if (session == NULL)
1099 if (parse_url(session, url, web->proxy) < 0) {
1100 free_session(session);
1104 debug(web, "address %s", session->address);
1105 debug(web, "port %u", session->port);
1106 debug(web, "host %s", session->host);
1107 debug(web, "flags %lu", session->flags);
1108 debug(web, "request %s", session->request);
1111 session->content_type = g_strdup(type);
1113 debug(web, "content-type %s", session->content_type);
1118 session->result_func = func;
1119 session->input_func = input;
1120 session->user_data = user_data;
1122 session->receive_buffer = g_try_malloc(DEFAULT_BUFFER_SIZE);
1123 if (session->receive_buffer == NULL) {
1124 free_session(session);
1128 session->result.headers = g_hash_table_new_full(g_str_hash, g_str_equal,
1130 if (session->result.headers == NULL) {
1131 free_session(session);
1135 session->receive_space = DEFAULT_BUFFER_SIZE;
1136 session->send_buffer = g_string_sized_new(0);
1137 session->current_header = g_string_sized_new(0);
1138 session->header_done = FALSE;
1139 session->body_done = FALSE;
1141 if (session->address == NULL && inet_aton(session->host, NULL) == 0) {
1142 session->resolv_action = g_resolv_lookup_hostname(web->resolv,
1143 session->host, resolv_result, session);
1144 if (session->resolv_action == 0) {
1145 free_session(session);
1149 struct addrinfo hints;
1153 if (session->address == NULL)
1154 session->address = g_strdup(session->host);
1156 memset(&hints, 0, sizeof(struct addrinfo));
1157 hints.ai_flags = AI_NUMERICHOST;
1159 if (session->addr != NULL) {
1160 freeaddrinfo(session->addr);
1161 session->addr = NULL;
1164 port = g_strdup_printf("%u", session->port);
1165 ret = getaddrinfo(session->address, port, &hints,
1168 if (ret != 0 || session->addr == NULL) {
1169 free_session(session);
1173 if (create_transport(session) < 0) {
1174 free_session(session);
1179 web->session_list = g_list_append(web->session_list, session);
1181 return web->next_query_id++;
1184 guint g_web_request_get(GWeb *web, const char *url,
1185 GWebResultFunc func, gpointer user_data)
1187 return do_request(web, url, NULL, NULL, func, user_data);
1190 guint g_web_request_post(GWeb *web, const char *url,
1191 const char *type, GWebInputFunc input,
1192 GWebResultFunc func, gpointer user_data)
1194 return do_request(web, url, type, input, func, user_data);
1197 gboolean g_web_cancel_request(GWeb *web, guint id)
1205 guint16 g_web_result_get_status(GWebResult *result)
1210 return result->status;
1213 gboolean g_web_result_get_chunk(GWebResult *result,
1214 const guint8 **chunk, gsize *length)
1222 *chunk = result->buffer;
1225 *length = result->length;
1230 gboolean g_web_result_get_header(GWebResult *result,
1231 const char *header, const char **value)
1239 *value = g_hash_table_lookup(result->headers, header);
1247 struct _GWebParser {
1251 const char *token_str;
1256 GWebParserFunc func;
1260 GWebParser *g_web_parser_new(const char *begin, const char *end,
1261 GWebParserFunc func, gpointer user_data)
1265 parser = g_try_new0(GWebParser, 1);
1269 parser->ref_count = 1;
1271 parser->begin_token = g_strdup(begin);
1272 parser->end_token = g_strdup(end);
1274 if (parser->begin_token == NULL) {
1279 parser->func = func;
1280 parser->user_data = user_data;
1282 parser->token_str = parser->begin_token;
1283 parser->token_len = strlen(parser->token_str);
1284 parser->token_pos = 0;
1286 parser->intoken = FALSE;
1287 parser->content = g_string_sized_new(0);
1292 GWebParser *g_web_parser_ref(GWebParser *parser)
1297 g_atomic_int_inc(&parser->ref_count);
1302 void g_web_parser_unref(GWebParser *parser)
1307 if (g_atomic_int_dec_and_test(&parser->ref_count) == FALSE)
1310 g_string_free(parser->content, TRUE);
1312 g_free(parser->begin_token);
1313 g_free(parser->end_token);
1317 void g_web_parser_feed_data(GWebParser *parser,
1318 const guint8 *data, gsize length)
1320 const guint8 *ptr = data;
1325 while (length > 0) {
1326 guint8 chr = parser->token_str[parser->token_pos];
1328 if (parser->token_pos == 0) {
1331 pos = memchr(ptr, chr, length);
1333 if (parser->intoken == TRUE)
1334 g_string_append_len(parser->content,
1335 (gchar *) ptr, length);
1339 if (parser->intoken == TRUE)
1340 g_string_append_len(parser->content,
1341 (gchar *) ptr, (pos - ptr) + 1);
1343 length -= (pos - ptr) + 1;
1346 parser->token_pos++;
1350 if (parser->intoken == TRUE)
1351 g_string_append_c(parser->content, ptr[0]);
1353 if (ptr[0] != chr) {
1357 parser->token_pos = 0;
1364 parser->token_pos++;
1366 if (parser->token_pos == parser->token_len) {
1367 if (parser->intoken == FALSE) {
1368 g_string_append(parser->content,
1371 parser->intoken = TRUE;
1372 parser->token_str = parser->end_token;
1373 parser->token_len = strlen(parser->end_token);
1374 parser->token_pos = 0;
1377 str = g_string_free(parser->content, FALSE);
1378 parser->content = g_string_sized_new(0);
1380 parser->func(str, parser->user_data);
1383 parser->intoken = FALSE;
1384 parser->token_str = parser->begin_token;
1385 parser->token_len = strlen(parser->begin_token);
1386 parser->token_pos = 0;
1392 void g_web_parser_end_data(GWebParser *parser)