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)
261 debug(web, "clearing proxy");
263 web->proxy = g_strdup(proxy);
264 debug(web, "setting proxy %s", web->proxy);
270 gboolean g_web_add_nameserver(GWeb *web, const char *address)
275 g_resolv_add_nameserver(web->resolv, address, 53, 0);
280 static gboolean set_accept_option(GWeb *web, const char *format, va_list args)
282 g_free(web->accept_option);
284 if (format == NULL) {
285 web->accept_option = NULL;
286 debug(web, "clearing accept option");
288 web->accept_option = g_strdup_vprintf(format, args);
289 debug(web, "setting accept %s", web->accept_option);
295 gboolean g_web_set_accept(GWeb *web, const char *format, ...)
303 va_start(args, format);
304 result = set_accept_option(web, format, args);
310 static gboolean set_user_agent(GWeb *web, const char *format, va_list args)
312 g_free(web->user_agent);
314 if (format == NULL) {
315 web->user_agent = NULL;
316 debug(web, "clearing user agent");
318 web->user_agent = g_strdup_vprintf(format, args);
319 debug(web, "setting user agent %s", web->user_agent);
325 gboolean g_web_set_user_agent(GWeb *web, const char *format, ...)
333 va_start(args, format);
334 result = set_user_agent(web, format, args);
340 gboolean g_web_set_http_version(GWeb *web, const char *version)
345 g_free(web->http_version);
347 if (version == NULL) {
348 web->http_version = NULL;
349 debug(web, "clearing HTTP version");
351 web->http_version = g_strdup(version);
352 debug(web, "setting HTTP version %s", web->http_version);
358 void g_web_set_close_connection(GWeb *web, gboolean enabled)
363 web->close_connection = enabled;
366 gboolean g_web_get_close_connection(GWeb *web)
371 return web->close_connection;
374 static inline void call_result_func(struct web_session *session, guint16 status)
378 if (session->result_func == NULL)
382 session->result.status = status;
384 result = session->result_func(&session->result, session->user_data);
386 debug(session->web, "[result function] %s",
387 result == TRUE ? "continue" : "stop");
390 static gboolean process_send_buffer(struct web_session *session)
392 GString *buf = session->send_buffer;
393 gsize count, bytes_written;
399 if (session->request_started == TRUE &&
400 session->more_data == FALSE)
401 session->body_done = TRUE;
406 debug(session->web, "bytes to write %zu", count);
408 status = g_io_channel_write_chars(session->transport_channel,
409 buf->str, count, &bytes_written, NULL);
411 debug(session->web, "status %u bytes written %zu",
412 status, bytes_written);
414 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN)
417 g_string_erase(buf, 0, bytes_written);
422 static void process_next_chunk(struct web_session *session)
424 GString *buf = session->send_buffer;
428 if (session->input_func == NULL) {
429 session->more_data = FALSE;
433 session->more_data = session->input_func(&body, &length,
437 g_string_append_printf(buf, "%zx\r\n", length);
438 g_string_append_len(buf, (char *) body, length);
439 g_string_append(buf, "\r\n");
442 if (session->more_data == FALSE)
443 g_string_append(buf, "0\r\n\r\n");
446 static void start_request(struct web_session *session)
448 GString *buf = session->send_buffer;
453 debug(session->web, "request %s from %s",
454 session->request, session->host);
456 g_string_truncate(buf, 0);
458 if (session->web->http_version == NULL)
461 version = session->web->http_version;
463 if (session->content_type == NULL)
464 g_string_append_printf(buf, "GET %s HTTP/%s\r\n",
465 session->request, version);
467 g_string_append_printf(buf, "POST %s HTTP/%s\r\n",
468 session->request, version);
470 g_string_append_printf(buf, "Host: %s\r\n", session->host);
472 if (session->web->user_agent != NULL)
473 g_string_append_printf(buf, "User-Agent: %s\r\n",
474 session->web->user_agent);
476 if (session->web->accept_option != NULL)
477 g_string_append_printf(buf, "Accept: %s\r\n",
478 session->web->accept_option);
480 if (session->content_type != NULL) {
481 g_string_append_printf(buf, "Content-Type: %s\r\n",
482 session->content_type);
483 if (session->input_func == NULL) {
484 session->more_data = FALSE;
487 session->more_data = session->input_func(&body, &length,
489 if (session->more_data == FALSE)
490 g_string_append_printf(buf, "Content-Length: %zu\r\n",
493 g_string_append(buf, "Transfer-Encoding: chunked\r\n");
496 if (session->web->close_connection == TRUE)
497 g_string_append(buf, "Connection: close\r\n");
499 g_string_append(buf, "\r\n");
501 if (session->content_type != NULL && length > 0) {
502 if (session->more_data == TRUE) {
503 g_string_append_printf(buf, "%zx\r\n", length);
504 g_string_append_len(buf, (char *) body, length);
505 g_string_append(buf, "\r\n");
507 g_string_append_len(buf, (char *) body, length);
511 static gboolean send_data(GIOChannel *channel, GIOCondition cond,
514 struct web_session *session = user_data;
516 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
517 session->send_watch = 0;
521 if (process_send_buffer(session) == TRUE)
524 if (session->request_started == FALSE) {
525 session->request_started = TRUE;
526 start_request(session);
527 } else if (session->more_data == TRUE)
528 process_next_chunk(session);
530 process_send_buffer(session);
532 if (session->body_done == TRUE) {
533 session->send_watch = 0;
540 static int decode_chunked(struct web_session *session,
541 const guint8 *buf, gsize len)
543 const guint8 *ptr = buf;
551 switch (session->chunck_state) {
553 pos = memchr(ptr, '\n', len);
555 g_string_append_len(session->current_header,
561 if (count < 1 || ptr[count - 1] != '\r')
564 g_string_append_len(session->current_header,
565 (gchar *) ptr, count);
570 str = session->current_header->str;
572 counter = strtoul(str, NULL, 16);
573 if ((counter == 0 && errno == EINVAL) ||
574 counter == ULONG_MAX)
577 session->chunk_size = counter;
578 session->chunk_left = counter;
580 session->chunck_state = CHUNK_DATA;
587 session->chunck_state = CHUNK_N_BODY;
594 session->chunck_state = CHUNK_SIZE;
597 if (session->chunk_size == 0) {
598 debug(session->web, "Download Done in chunk");
599 g_string_truncate(session->current_header, 0);
603 if (session->chunk_left <= len) {
604 session->result.buffer = ptr;
605 session->result.length = session->chunk_left;
606 call_result_func(session, 0);
608 len -= session->chunk_left;
609 ptr += session->chunk_left;
611 session->total_len += session->chunk_left;
612 session->chunk_left = 0;
614 g_string_truncate(session->current_header, 0);
615 session->chunck_state = CHUNK_R_BODY;
619 session->result.buffer = ptr;
620 session->result.length = len;
621 call_result_func(session, 0);
623 session->chunk_left -= len;
624 session->total_len += len;
635 static int handle_body(struct web_session *session,
636 const guint8 *buf, gsize len)
640 debug(session->web, "[body] length %zu", len);
642 if (session->result.use_chunk == FALSE) {
644 session->result.buffer = buf;
645 session->result.length = len;
646 call_result_func(session, 0);
651 err = decode_chunked(session, buf, len);
653 debug(session->web, "Error in chunk decode %d", err);
655 session->result.buffer = NULL;
656 session->result.length = 0;
657 call_result_func(session, 400);
663 static void handle_multi_line(struct web_session *session)
669 str = session->current_header->str;
671 if (str[0] != ' ' && str[0] != '\t')
674 while (str[0] == ' ' || str[0] == '\t')
677 count = str - session->current_header->str;
679 g_string_erase(session->current_header, 0, count);
680 g_string_insert_c(session->current_header, 0, ' ');
683 value = g_hash_table_lookup(session->result.headers,
684 session->result.last_key);
686 g_string_insert(session->current_header, 0, value);
688 str = session->current_header->str;
690 g_hash_table_replace(session->result.headers,
691 g_strdup(session->result.last_key),
696 static void add_header_field(struct web_session *session)
704 str = session->current_header->str;
706 pos = memchr(str, ':', session->current_header->len);
713 /* remove preceding white spaces */
717 count = (char *) pos - str;
719 g_string_erase(session->current_header, 0, count);
721 value = g_hash_table_lookup(session->result.headers, key);
723 g_string_insert_c(session->current_header, 0, ' ');
724 g_string_insert_c(session->current_header, 0, ';');
726 g_string_insert(session->current_header, 0, value);
729 str = session->current_header->str;
730 g_hash_table_replace(session->result.headers, key,
733 g_free(session->result.last_key);
734 session->result.last_key = g_strdup(key);
738 static gboolean received_data(GIOChannel *channel, GIOCondition cond,
741 struct web_session *session = user_data;
742 guint8 *ptr = session->receive_buffer;
746 if (cond & (G_IO_NVAL | G_IO_ERR | G_IO_HUP)) {
747 session->transport_watch = 0;
748 session->result.buffer = NULL;
749 session->result.length = 0;
750 call_result_func(session, 400);
754 status = g_io_channel_read_chars(channel,
755 (gchar *) session->receive_buffer,
756 session->receive_space - 1, &bytes_read, NULL);
758 debug(session->web, "bytes read %zu", bytes_read);
760 if (status != G_IO_STATUS_NORMAL && status != G_IO_STATUS_AGAIN) {
761 session->transport_watch = 0;
762 session->result.buffer = NULL;
763 session->result.length = 0;
764 call_result_func(session, 0);
768 session->receive_buffer[bytes_read] = '\0';
770 if (session->header_done == TRUE) {
771 if (handle_body(session, session->receive_buffer,
773 session->transport_watch = 0;
779 while (bytes_read > 0) {
784 pos = memchr(ptr, '\n', bytes_read);
786 g_string_append_len(session->current_header,
787 (gchar *) ptr, bytes_read);
792 count = strlen((char *) ptr);
793 if (count > 0 && ptr[count - 1] == '\r') {
798 g_string_append_len(session->current_header,
799 (gchar *) ptr, count);
801 bytes_read -= count + 1;
807 if (session->current_header->len == 0) {
810 session->header_done = TRUE;
812 val = g_hash_table_lookup(session->result.headers,
813 "Transfer-Encoding");
815 val = g_strrstr(val, "chunked");
817 session->result.use_chunk = TRUE;
819 session->chunck_state = CHUNK_SIZE;
820 session->chunk_left = 0;
821 session->total_len = 0;
825 if (handle_body(session, ptr, bytes_read) < 0) {
826 session->transport_watch = 0;
832 str = session->current_header->str;
834 if (session->result.status == 0) {
837 if (sscanf(str, "HTTP/%*s %u %*s", &code) == 1)
838 session->result.status = code;
841 debug(session->web, "[header] %s", str);
843 /* handle multi-line header */
844 if (str[0] == ' ' || str[0] == '\t')
845 handle_multi_line(session);
847 add_header_field(session);
849 g_string_truncate(session->current_header, 0);
855 static int connect_session_transport(struct web_session *session)
858 struct sockaddr_in sin;
861 sk = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
865 if (session->flags & SESSION_FLAG_USE_TLS) {
866 debug(session->web, "using TLS encryption");
867 session->transport_channel = g_io_channel_gnutls_new(sk);
869 debug(session->web, "no encryption");
870 session->transport_channel = g_io_channel_unix_new(sk);
873 if (session->transport_channel == NULL) {
878 flags = g_io_channel_get_flags(session->transport_channel);
879 g_io_channel_set_flags(session->transport_channel,
880 flags | G_IO_FLAG_NONBLOCK, NULL);
882 g_io_channel_set_encoding(session->transport_channel, NULL, NULL);
883 g_io_channel_set_buffered(session->transport_channel, FALSE);
885 g_io_channel_set_close_on_unref(session->transport_channel, TRUE);
887 memset(&sin, 0, sizeof(sin));
888 sin.sin_family = AF_INET;
889 sin.sin_port = htons(session->port);
890 sin.sin_addr.s_addr = inet_addr(session->address);
892 if (connect(sk, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
893 if (errno != EINPROGRESS) {
899 session->transport_watch = g_io_add_watch(session->transport_channel,
900 G_IO_IN | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
901 received_data, session);
903 session->send_watch = g_io_add_watch(session->transport_channel,
904 G_IO_OUT | G_IO_HUP | G_IO_NVAL | G_IO_ERR,
910 static int create_transport(struct web_session *session)
914 err = connect_session_transport(session);
918 debug(session->web, "creating session %s:%u",
919 session->address, session->port);
924 static int parse_url(struct web_session *session,
925 const char *url, const char *proxy)
927 char *scheme, *host, *port, *path;
929 scheme = g_strdup(url);
933 host = strstr(scheme, "://");
938 if (strcasecmp(scheme, "https") == 0) {
940 session->flags |= SESSION_FLAG_USE_TLS;
941 } else if (strcasecmp(scheme, "http") == 0) {
952 path = strchr(host, '/');
957 session->request = g_strdup_printf("/%s", path ? path : "");
959 session->request = g_strdup(url);
961 port = strrchr(host, ':');
964 int tmp = strtol(port + 1, &end, 10);
972 session->host = g_strdup(host);
974 session->host = g_strdup_printf("%s:%u", host, tmp);
976 session->host = g_strdup(host);
983 scheme = g_strdup(proxy);
987 host = strstr(proxy, "://");
992 if (strcasecmp(scheme, "http") != 0) {
999 path = strchr(host, '/');
1003 port = strrchr(host, ':');
1006 int tmp = strtol(port + 1, &end, 10);
1010 session->port = tmp;
1014 session->address = g_strdup(host);
1021 static void resolv_result(GResolvResultStatus status,
1022 char **results, gpointer user_data)
1024 struct web_session *session = user_data;
1026 if (results == NULL || results[0] == NULL) {
1027 call_result_func(session, 404);
1031 debug(session->web, "address %s", results[0]);
1033 if (inet_aton(results[0], NULL) == 0) {
1034 call_result_func(session, 400);
1038 session->address = g_strdup(results[0]);
1040 if (create_transport(session) < 0) {
1041 call_result_func(session, 409);
1046 static guint do_request(GWeb *web, const char *url,
1047 const char *type, GWebInputFunc input,
1048 GWebResultFunc func, gpointer user_data)
1050 struct web_session *session;
1052 if (web == NULL || url == NULL)
1055 debug(web, "request %s", url);
1057 session = g_try_new0(struct web_session, 1);
1058 if (session == NULL)
1061 if (parse_url(session, url, web->proxy) < 0) {
1062 free_session(session);
1066 debug(web, "address %s", session->address);
1067 debug(web, "port %u", session->port);
1068 debug(web, "host %s", session->host);
1069 debug(web, "flags %lu", session->flags);
1070 debug(web, "request %s", session->request);
1073 session->content_type = g_strdup(type);
1075 debug(web, "content-type %s", session->content_type);
1080 session->result_func = func;
1081 session->input_func = input;
1082 session->user_data = user_data;
1084 session->receive_buffer = g_try_malloc(DEFAULT_BUFFER_SIZE);
1085 if (session->receive_buffer == NULL) {
1086 free_session(session);
1090 session->result.headers = g_hash_table_new_full(g_str_hash, g_str_equal,
1092 if (session->result.headers == NULL) {
1093 free_session(session);
1097 session->receive_space = DEFAULT_BUFFER_SIZE;
1098 session->send_buffer = g_string_sized_new(0);
1099 session->current_header = g_string_sized_new(0);
1100 session->header_done = FALSE;
1101 session->body_done = FALSE;
1103 if (session->address == NULL && inet_aton(session->host, NULL) == 0) {
1104 session->resolv_action = g_resolv_lookup_hostname(web->resolv,
1105 session->host, resolv_result, session);
1106 if (session->resolv_action == 0) {
1107 free_session(session);
1111 if (session->address == NULL)
1112 session->address = g_strdup(session->host);
1114 if (create_transport(session) < 0) {
1115 free_session(session);
1120 web->session_list = g_list_append(web->session_list, session);
1122 return web->next_query_id++;
1125 guint g_web_request_get(GWeb *web, const char *url,
1126 GWebResultFunc func, gpointer user_data)
1128 return do_request(web, url, NULL, NULL, func, user_data);
1131 guint g_web_request_post(GWeb *web, const char *url,
1132 const char *type, GWebInputFunc input,
1133 GWebResultFunc func, gpointer user_data)
1135 return do_request(web, url, type, input, func, user_data);
1138 gboolean g_web_cancel_request(GWeb *web, guint id)
1146 guint16 g_web_result_get_status(GWebResult *result)
1151 return result->status;
1154 gboolean g_web_result_get_chunk(GWebResult *result,
1155 const guint8 **chunk, gsize *length)
1163 *chunk = result->buffer;
1166 *length = result->length;
1171 gboolean g_web_result_get_header(GWebResult *result,
1172 const char *header, const char **value)
1180 *value = g_hash_table_lookup(result->headers, header);
1188 struct _GWebParser {
1192 const char *token_str;
1197 GWebParserFunc func;
1201 GWebParser *g_web_parser_new(const char *begin, const char *end,
1202 GWebParserFunc func, gpointer user_data)
1206 parser = g_try_new0(GWebParser, 1);
1210 parser->ref_count = 1;
1212 parser->begin_token = g_strdup(begin);
1213 parser->end_token = g_strdup(end);
1215 if (parser->begin_token == NULL) {
1220 parser->func = func;
1221 parser->user_data = user_data;
1223 parser->token_str = parser->begin_token;
1224 parser->token_len = strlen(parser->token_str);
1225 parser->token_pos = 0;
1227 parser->intoken = FALSE;
1228 parser->content = g_string_sized_new(0);
1233 GWebParser *g_web_parser_ref(GWebParser *parser)
1238 g_atomic_int_inc(&parser->ref_count);
1243 void g_web_parser_unref(GWebParser *parser)
1248 if (g_atomic_int_dec_and_test(&parser->ref_count) == FALSE)
1251 g_string_free(parser->content, TRUE);
1253 g_free(parser->begin_token);
1254 g_free(parser->end_token);
1258 void g_web_parser_feed_data(GWebParser *parser,
1259 const guint8 *data, gsize length)
1261 const guint8 *ptr = data;
1266 while (length > 0) {
1267 guint8 chr = parser->token_str[parser->token_pos];
1269 if (parser->token_pos == 0) {
1272 pos = memchr(ptr, chr, length);
1274 if (parser->intoken == TRUE)
1275 g_string_append_len(parser->content,
1276 (gchar *) ptr, length);
1280 if (parser->intoken == TRUE)
1281 g_string_append_len(parser->content,
1282 (gchar *) ptr, (pos - ptr) + 1);
1284 length -= (pos - ptr) + 1;
1287 parser->token_pos++;
1291 if (parser->intoken == TRUE)
1292 g_string_append_c(parser->content, ptr[0]);
1294 if (ptr[0] != chr) {
1298 parser->token_pos = 0;
1305 parser->token_pos++;
1307 if (parser->token_pos == parser->token_len) {
1308 if (parser->intoken == FALSE) {
1309 g_string_append(parser->content,
1312 parser->intoken = TRUE;
1313 parser->token_str = parser->end_token;
1314 parser->token_len = strlen(parser->end_token);
1315 parser->token_pos = 0;
1318 str = g_string_free(parser->content, FALSE);
1319 parser->content = g_string_sized_new(0);
1321 parser->func(str, parser->user_data);
1324 parser->intoken = FALSE;
1325 parser->token_str = parser->begin_token;
1326 parser->token_len = strlen(parser->begin_token);
1327 parser->token_pos = 0;
1333 void g_web_parser_end_data(GWebParser *parser)