2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2012 Hiroyuki Yamamoto and the Claws Mail team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "claws-features.h"
28 #include <glib/gi18n.h>
41 static gint session_connect_cb (SockInfo *sock,
43 static gint session_close (Session *session);
45 static gboolean session_timeout_cb (gpointer data);
47 static gboolean session_recv_msg_idle_cb (gpointer data);
48 static gboolean session_recv_data_idle_cb (gpointer data);
50 static gboolean session_read_msg_cb (SockInfo *source,
51 GIOCondition condition,
53 static gboolean session_read_data_cb (SockInfo *source,
54 GIOCondition condition,
56 static gboolean session_write_msg_cb (SockInfo *source,
57 GIOCondition condition,
59 static gboolean session_write_data_cb (SockInfo *source,
60 GIOCondition condition,
64 void session_init(Session *session, const void *prefs_account, gboolean is_smtp)
66 session->type = SESSION_UNKNOWN;
68 session->server = NULL;
71 session->ssl_type = SSL_NONE;
73 session->nonblocking = TRUE;
74 session->state = SESSION_READY;
75 session->last_access_time = time(NULL);
77 g_get_current_time(&session->tv_prev);
83 session->read_buf_p = session->read_buf;
84 session->read_buf_len = 0;
86 session->read_msg_buf = g_string_sized_new(1024);
87 session->read_data_buf = g_byte_array_new();
89 session->write_buf = NULL;
90 session->write_buf_p = NULL;
91 session->write_buf_len = 0;
93 session->write_data = NULL;
94 session->write_data_p = NULL;
95 session->write_data_len = 0;
97 session->timeout_tag = 0;
98 session->timeout_interval = 0;
100 session->data = NULL;
101 session->account = prefs_account;
102 session->is_smtp = is_smtp;
104 session->ping_tag = -1;
108 *\brief Set up parent and child process
109 * Childloop: Read commands from parent,
110 * send to server, get answer, pass to parent
112 *\param session Contains session information
113 * server to connect to
117 * -1 : pipe / fork errors (parent)
118 * 1 : connection error (child)
120 gint session_connect(Session *session, const gchar *server, gushort port)
123 session->server = g_strdup(server);
124 session->port = port;
126 session->conn_id = sock_connect_async(server, port, session_connect_cb,
128 if (session->conn_id < 0) {
129 g_warning("can't connect to server.");
130 session_close(session);
138 session->server = g_strdup(server);
139 session->port = port;
141 sock = sock_connect(server, port);
143 g_warning("can't connect to server.");
144 session_close(session);
147 sock->is_smtp = session->is_smtp;
149 return session_connect_cb(sock, session);
153 static gint session_connect_cb(SockInfo *sock, gpointer data)
155 Session *session = SESSION(data);
157 session->conn_id = 0;
160 g_warning("can't connect to server.");
161 session->state = SESSION_ERROR;
165 session->sock = sock;
166 sock->account = session->account;
167 sock->is_smtp = session->is_smtp;
169 sock->gnutls_priority = session->gnutls_priority;
171 if (session->ssl_type == SSL_TUNNEL) {
172 sock_set_nonblocking_mode(sock, FALSE);
173 if (!ssl_init_socket(sock)) {
174 g_warning("can't initialize SSL.");
175 log_error(LOG_PROTOCOL, _("SSL handshake failed\n"));
176 session->state = SESSION_ERROR;
182 /* we could have gotten a timeout while waiting for user input in
183 * an SSL certificate dialog */
184 if (session->state == SESSION_TIMEOUT)
187 sock_set_nonblocking_mode(sock, session->nonblocking);
189 debug_print("session (%p): connected\n", session);
191 session->state = SESSION_RECV;
192 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
200 *\brief child and parent: send DISCONNECT message to other process
202 *\param session Contains session information
206 gint session_disconnect(Session *session)
208 session_close(session);
215 *\param session Contains session information
217 void session_destroy(Session *session)
219 cm_return_if_fail(session != NULL);
220 cm_return_if_fail(session->destroy != NULL);
222 session_register_ping(session, NULL);
224 session_close(session);
225 session->destroy(session);
226 g_free(session->server);
227 g_string_free(session->read_msg_buf, TRUE);
228 g_byte_array_free(session->read_data_buf, TRUE);
229 g_free(session->read_data_terminator);
230 g_free(session->write_buf);
232 g_free(session->gnutls_priority);
235 debug_print("session (%p): destroyed\n", session);
240 gboolean session_is_running(Session *session)
242 return (session->state == SESSION_READY ||
243 session->state == SESSION_SEND ||
244 session->state == SESSION_RECV);
247 gboolean session_is_connected(Session *session)
249 return (session->state == SESSION_SEND ||
250 session->state == SESSION_RECV);
253 void session_set_access_time(Session *session)
255 session->last_access_time = time(NULL);
258 void session_set_timeout(Session *session, guint interval)
260 if (session->timeout_tag > 0)
261 g_source_remove(session->timeout_tag);
263 session->timeout_interval = interval;
265 #if GLIB_CHECK_VERSION(2,14,0)
266 if (interval % 1000 == 0)
267 session->timeout_tag =
268 g_timeout_add_seconds(interval/1000, session_timeout_cb, session);
271 session->timeout_tag =
272 g_timeout_add(interval, session_timeout_cb, session);
274 session->timeout_tag = 0;
277 static gboolean session_timeout_cb(gpointer data)
279 Session *session = SESSION(data);
281 g_warning("session timeout.\n");
283 if (session->io_tag > 0) {
284 g_source_remove(session->io_tag);
288 session->timeout_tag = 0;
289 session->state = SESSION_TIMEOUT;
294 void session_set_recv_message_notify(Session *session,
295 RecvMsgNotify notify_func, gpointer data)
297 session->recv_msg_notify = notify_func;
298 session->recv_msg_notify_data = data;
301 void session_set_recv_data_progressive_notify
303 RecvDataProgressiveNotify notify_func,
306 session->recv_data_progressive_notify = notify_func,
307 session->recv_data_progressive_notify_data = data;
310 void session_set_recv_data_notify(Session *session, RecvDataNotify notify_func,
313 session->recv_data_notify = notify_func;
314 session->recv_data_notify_data = data;
317 void session_set_send_data_progressive_notify
319 SendDataProgressiveNotify notify_func,
322 session->send_data_progressive_notify = notify_func;
323 session->send_data_progressive_notify_data = data;
326 void session_set_send_data_notify(Session *session, SendDataNotify notify_func,
329 session->send_data_notify = notify_func;
330 session->send_data_notify_data = data;
334 *\brief child and parent cleanup (child closes first)
336 *\param session Contains session information
340 static gint session_close(Session *session)
342 cm_return_val_if_fail(session != NULL, -1);
345 if (session->conn_id > 0) {
346 sock_connect_async_cancel(session->conn_id);
347 session->conn_id = 0;
348 debug_print("session (%p): connection cancelled\n", session);
352 session_set_timeout(session, 0);
354 if (session->io_tag > 0) {
355 g_source_remove(session->io_tag);
360 sock_close(session->sock);
361 session->sock = NULL;
362 session->state = SESSION_DISCONNECTED;
363 debug_print("session (%p): closed\n", session);
370 gint session_start_tls(Session *session)
374 nb_mode = sock_is_nonblocking_mode(session->sock);
377 sock_set_nonblocking_mode(session->sock, FALSE);
379 if (!ssl_init_socket_with_method(session->sock, SSL_METHOD_TLSv1)) {
380 g_warning("couldn't start TLS session.\n");
382 sock_set_nonblocking_mode(session->sock, session->nonblocking);
387 sock_set_nonblocking_mode(session->sock, session->nonblocking);
393 gint session_send_msg(Session *session, SessionMsgType type, const gchar *msg)
397 cm_return_val_if_fail(session->write_buf == NULL, -1);
398 cm_return_val_if_fail(msg != NULL, -1);
399 cm_return_val_if_fail(msg[0] != '\0', -1);
401 session->state = SESSION_SEND;
402 session->write_buf = g_strconcat(msg, "\r\n", NULL);
403 session->write_buf_p = session->write_buf;
404 session->write_buf_len = strlen(msg) + 2;
406 ret = session_write_msg_cb(session->sock, G_IO_OUT, session);
409 session->io_tag = sock_add_watch(session->sock, G_IO_OUT,
410 session_write_msg_cb, session);
411 else if (session->state == SESSION_ERROR)
417 gint session_recv_msg(Session *session)
419 cm_return_val_if_fail(session->read_msg_buf->len == 0, -1);
421 session->state = SESSION_RECV;
423 if (session->read_buf_len > 0)
424 g_idle_add(session_recv_msg_idle_cb, session);
426 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
427 session_read_msg_cb, session);
432 static gboolean session_recv_msg_idle_cb(gpointer data)
434 Session *session = SESSION(data);
437 ret = session_read_msg_cb(session->sock, G_IO_IN, session);
440 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
441 session_read_msg_cb, session);
447 *\brief parent (child?): send data to other process
449 *\param session Contains session information
456 gint session_send_data(Session *session, const guchar *data, guint size)
460 cm_return_val_if_fail(session->write_data == NULL, -1);
461 cm_return_val_if_fail(data != NULL, -1);
462 cm_return_val_if_fail(size != 0, -1);
464 session->state = SESSION_SEND;
466 session->write_data = data;
467 session->write_data_p = session->write_data;
468 session->write_data_len = size;
469 g_get_current_time(&session->tv_prev);
471 ret = session_write_data_cb(session->sock, G_IO_OUT, session);
474 session->io_tag = sock_add_watch(session->sock, G_IO_OUT,
475 session_write_data_cb,
477 else if (session->state == SESSION_ERROR)
483 gint session_recv_data(Session *session, guint size, const gchar *terminator)
485 cm_return_val_if_fail(session->read_data_buf->len == 0, -1);
487 session->state = SESSION_RECV;
489 g_free(session->read_data_terminator);
490 session->read_data_terminator = g_strdup(terminator);
491 g_get_current_time(&session->tv_prev);
493 if (session->read_buf_len > 0)
494 g_idle_add(session_recv_data_idle_cb, session);
496 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
497 session_read_data_cb, session);
502 static gboolean session_recv_data_idle_cb(gpointer data)
504 Session *session = SESSION(data);
507 ret = session_read_data_cb(session->sock, G_IO_IN, session);
510 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
511 session_read_data_cb, session);
516 static gboolean session_read_msg_cb(SockInfo *source, GIOCondition condition,
519 Session *session = SESSION(data);
520 gchar buf[SESSION_BUFFSIZE];
526 cm_return_val_if_fail(condition == G_IO_IN, FALSE);
528 session_set_timeout(session, session->timeout_interval);
530 if (session->read_buf_len == 0) {
533 read_len = sock_read(session->sock, session->read_buf,
534 SESSION_BUFFSIZE - 1);
536 if (read_len == -1 && session->state == SESSION_DISCONNECTED) {
537 g_warning ("sock_read: session disconnected\n");
538 if (session->io_tag > 0) {
539 g_source_remove(session->io_tag);
546 g_warning("sock_read: received EOF\n");
547 session->state = SESSION_EOF;
556 g_warning("sock_read: %s\n", g_strerror(errno));
557 session->state = SESSION_ERROR;
562 session->read_buf_len = read_len;
565 if ((newline = memchr(session->read_buf_p, '\n', session->read_buf_len))
567 line_len = newline - session->read_buf_p + 1;
569 line_len = session->read_buf_len;
574 memcpy(buf, session->read_buf_p, line_len);
575 buf[line_len] = '\0';
577 g_string_append(session->read_msg_buf, buf);
579 session->read_buf_len -= line_len;
580 if (session->read_buf_len == 0)
581 session->read_buf_p = session->read_buf;
583 session->read_buf_p += line_len;
585 /* incomplete read */
586 if (buf[line_len - 1] != '\n')
590 if (session->io_tag > 0) {
591 g_source_remove(session->io_tag);
596 msg = g_strdup(session->read_msg_buf->str);
598 g_string_truncate(session->read_msg_buf, 0);
600 ret = session->recv_msg(session, msg);
601 session->recv_msg_notify(session, msg, session->recv_msg_notify_data);
606 session->state = SESSION_ERROR;
611 static gboolean session_read_data_cb(SockInfo *source, GIOCondition condition,
614 Session *session = SESSION(data);
615 GByteArray *data_buf;
617 gboolean complete = FALSE;
621 cm_return_val_if_fail(condition == G_IO_IN, FALSE);
623 session_set_timeout(session, session->timeout_interval);
625 if (session->read_buf_len == 0) {
628 read_len = sock_read(session->sock, session->read_buf,
632 g_warning("sock_read: received EOF\n");
633 session->state = SESSION_EOF;
642 g_warning("sock_read: %s\n", g_strerror(errno));
643 session->state = SESSION_ERROR;
648 session->read_buf_len = read_len;
651 data_buf = session->read_data_buf;
652 terminator_len = strlen(session->read_data_terminator);
654 if (session->read_buf_len == 0)
657 g_byte_array_append(data_buf, session->read_buf_p,
658 session->read_buf_len);
660 session->read_buf_len = 0;
661 session->read_buf_p = session->read_buf;
663 /* check if data is terminated */
664 if (data_buf->len >= terminator_len) {
665 if (memcmp(data_buf->data, session->read_data_terminator,
666 terminator_len) == 0)
668 else if (data_buf->len >= terminator_len + 2 &&
669 memcmp(data_buf->data + data_buf->len -
670 (terminator_len + 2), "\r\n", 2) == 0 &&
671 memcmp(data_buf->data + data_buf->len -
672 terminator_len, session->read_data_terminator,
673 terminator_len) == 0)
677 /* incomplete read */
681 g_get_current_time(&tv_cur);
682 if (tv_cur.tv_sec - session->tv_prev.tv_sec > 0 ||
683 tv_cur.tv_usec - session->tv_prev.tv_usec >
684 UI_REFRESH_INTERVAL) {
685 session->recv_data_progressive_notify
686 (session, data_buf->len, 0,
687 session->recv_data_progressive_notify_data);
688 g_get_current_time(&session->tv_prev);
694 if (session->io_tag > 0) {
695 g_source_remove(session->io_tag);
699 data_len = data_buf->len - terminator_len;
702 ret = session->recv_data_finished(session, (gchar *)data_buf->data,
705 g_byte_array_set_size(data_buf, 0);
707 session->recv_data_notify(session, data_len,
708 session->recv_data_notify_data);
711 session->state = SESSION_ERROR;
716 static gint session_write_buf(Session *session)
721 cm_return_val_if_fail(session->write_buf != NULL, -1);
722 cm_return_val_if_fail(session->write_buf_p != NULL, -1);
723 cm_return_val_if_fail(session->write_buf_len > 0, -1);
725 to_write_len = session->write_buf_len -
726 (session->write_buf_p - session->write_buf);
727 to_write_len = MIN(to_write_len, SESSION_BUFFSIZE);
729 write_len = sock_write(session->sock, session->write_buf_p,
738 g_warning("sock_write: %s\n", g_strerror(errno));
739 session->state = SESSION_ERROR;
744 /* incomplete write */
745 if (session->write_buf_p - session->write_buf + write_len <
746 session->write_buf_len) {
747 session->write_buf_p += write_len;
751 g_free(session->write_buf);
752 session->write_buf = NULL;
753 session->write_buf_p = NULL;
754 session->write_buf_len = 0;
759 static gint session_write_data(Session *session)
764 cm_return_val_if_fail(session->write_data != NULL, -1);
765 cm_return_val_if_fail(session->write_data_p != NULL, -1);
766 cm_return_val_if_fail(session->write_data_len > 0, -1);
768 to_write_len = session->write_data_len -
769 (session->write_data_p - session->write_data);
770 to_write_len = MIN(to_write_len, SESSION_BUFFSIZE);
772 write_len = sock_write(session->sock, session->write_data_p,
781 g_warning("sock_write: %s\n", g_strerror(errno));
782 session->state = SESSION_ERROR;
787 /* incomplete write */
788 if (session->write_data_p - session->write_data + write_len <
789 session->write_data_len) {
790 session->write_data_p += write_len;
794 session->write_data = NULL;
795 session->write_data_p = NULL;
796 session->write_data_len = 0;
801 static gboolean session_write_msg_cb(SockInfo *source, GIOCondition condition,
804 Session *session = SESSION(data);
807 cm_return_val_if_fail(condition == G_IO_OUT, FALSE);
808 cm_return_val_if_fail(session->write_buf != NULL, FALSE);
809 cm_return_val_if_fail(session->write_buf_p != NULL, FALSE);
810 cm_return_val_if_fail(session->write_buf_len > 0, FALSE);
812 ret = session_write_buf(session);
815 session->state = SESSION_ERROR;
820 if (session->io_tag > 0) {
821 g_source_remove(session->io_tag);
825 session_recv_msg(session);
830 static gboolean session_write_data_cb(SockInfo *source,
831 GIOCondition condition, gpointer data)
833 Session *session = SESSION(data);
834 guint write_data_len;
837 cm_return_val_if_fail(condition == G_IO_OUT, FALSE);
838 cm_return_val_if_fail(session->write_data != NULL, FALSE);
839 cm_return_val_if_fail(session->write_data_p != NULL, FALSE);
840 cm_return_val_if_fail(session->write_data_len > 0, FALSE);
842 write_data_len = session->write_data_len;
844 ret = session_write_data(session);
847 session->state = SESSION_ERROR;
849 } else if (ret > 0) {
852 g_get_current_time(&tv_cur);
853 if (tv_cur.tv_sec - session->tv_prev.tv_sec > 0 ||
854 tv_cur.tv_usec - session->tv_prev.tv_usec >
855 UI_REFRESH_INTERVAL) {
856 session_set_timeout(session, session->timeout_interval);
857 session->send_data_progressive_notify
859 session->write_data_p - session->write_data,
861 session->send_data_progressive_notify_data);
862 g_get_current_time(&session->tv_prev);
867 if (session->io_tag > 0) {
868 g_source_remove(session->io_tag);
873 ret = session->send_data_finished(session, write_data_len);
874 session->send_data_notify(session, write_data_len,
875 session->send_data_notify_data);
880 void session_register_ping(Session *session, gboolean (*ping_cb)(gpointer data))
884 if (session->ping_tag > -1)
885 g_source_remove(session->ping_tag);
887 session->ping_tag = -1;
890 #if GLIB_CHECK_VERSION(2,14,0)
892 g_timeout_add_seconds(60, ping_cb, session);
895 g_timeout_add(60*1000, ping_cb, session);