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;
168 sock->ssl_cert_auto_accept = session->ssl_cert_auto_accept;
171 sock->gnutls_priority = session->gnutls_priority;
173 if (session->ssl_type == SSL_TUNNEL) {
174 sock_set_nonblocking_mode(sock, FALSE);
175 if (!ssl_init_socket(sock)) {
176 g_warning("can't initialize SSL.");
177 log_error(LOG_PROTOCOL, _("SSL handshake failed\n"));
178 session->state = SESSION_ERROR;
184 /* we could have gotten a timeout while waiting for user input in
185 * an SSL certificate dialog */
186 if (session->state == SESSION_TIMEOUT)
189 sock_set_nonblocking_mode(sock, session->nonblocking);
191 debug_print("session (%p): connected\n", session);
193 session->state = SESSION_RECV;
194 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
202 *\brief child and parent: send DISCONNECT message to other process
204 *\param session Contains session information
208 gint session_disconnect(Session *session)
210 session_close(session);
217 *\param session Contains session information
219 void session_destroy(Session *session)
221 cm_return_if_fail(session != NULL);
222 cm_return_if_fail(session->destroy != NULL);
224 session_register_ping(session, NULL);
226 session_close(session);
227 session->destroy(session);
228 g_free(session->server);
229 g_string_free(session->read_msg_buf, TRUE);
230 g_byte_array_free(session->read_data_buf, TRUE);
231 g_free(session->read_data_terminator);
232 g_free(session->write_buf);
234 g_free(session->gnutls_priority);
237 debug_print("session (%p): destroyed\n", session);
242 gboolean session_is_running(Session *session)
244 return (session->state == SESSION_READY ||
245 session->state == SESSION_SEND ||
246 session->state == SESSION_RECV);
249 gboolean session_is_connected(Session *session)
251 return (session->state == SESSION_SEND ||
252 session->state == SESSION_RECV);
255 void session_set_access_time(Session *session)
257 session->last_access_time = time(NULL);
260 void session_set_timeout(Session *session, guint interval)
262 if (session->timeout_tag > 0)
263 g_source_remove(session->timeout_tag);
265 session->timeout_interval = interval;
267 #if GLIB_CHECK_VERSION(2,14,0)
268 if (interval % 1000 == 0)
269 session->timeout_tag =
270 g_timeout_add_seconds(interval/1000, session_timeout_cb, session);
273 session->timeout_tag =
274 g_timeout_add(interval, session_timeout_cb, session);
276 session->timeout_tag = 0;
279 static gboolean session_timeout_cb(gpointer data)
281 Session *session = SESSION(data);
283 g_warning("session timeout.\n");
285 if (session->io_tag > 0) {
286 g_source_remove(session->io_tag);
290 session->timeout_tag = 0;
291 session->state = SESSION_TIMEOUT;
296 void session_set_recv_message_notify(Session *session,
297 RecvMsgNotify notify_func, gpointer data)
299 session->recv_msg_notify = notify_func;
300 session->recv_msg_notify_data = data;
303 void session_set_recv_data_progressive_notify
305 RecvDataProgressiveNotify notify_func,
308 session->recv_data_progressive_notify = notify_func,
309 session->recv_data_progressive_notify_data = data;
312 void session_set_recv_data_notify(Session *session, RecvDataNotify notify_func,
315 session->recv_data_notify = notify_func;
316 session->recv_data_notify_data = data;
319 void session_set_send_data_progressive_notify
321 SendDataProgressiveNotify notify_func,
324 session->send_data_progressive_notify = notify_func;
325 session->send_data_progressive_notify_data = data;
328 void session_set_send_data_notify(Session *session, SendDataNotify notify_func,
331 session->send_data_notify = notify_func;
332 session->send_data_notify_data = data;
336 *\brief child and parent cleanup (child closes first)
338 *\param session Contains session information
342 static gint session_close(Session *session)
344 cm_return_val_if_fail(session != NULL, -1);
347 if (session->conn_id > 0) {
348 sock_connect_async_cancel(session->conn_id);
349 session->conn_id = 0;
350 debug_print("session (%p): connection cancelled\n", session);
354 session_set_timeout(session, 0);
356 if (session->io_tag > 0) {
357 g_source_remove(session->io_tag);
362 sock_close(session->sock);
363 session->sock = NULL;
364 session->state = SESSION_DISCONNECTED;
365 debug_print("session (%p): closed\n", session);
372 gint session_start_tls(Session *session)
376 nb_mode = sock_is_nonblocking_mode(session->sock);
378 session->sock->ssl_cert_auto_accept = session->ssl_cert_auto_accept;
381 sock_set_nonblocking_mode(session->sock, FALSE);
383 if (!ssl_init_socket_with_method(session->sock, SSL_METHOD_TLSv1)) {
384 g_warning("couldn't start TLS session.\n");
386 sock_set_nonblocking_mode(session->sock, session->nonblocking);
391 sock_set_nonblocking_mode(session->sock, session->nonblocking);
397 gint session_send_msg(Session *session, SessionMsgType type, const gchar *msg)
401 cm_return_val_if_fail(session->write_buf == NULL, -1);
402 cm_return_val_if_fail(msg != NULL, -1);
403 cm_return_val_if_fail(msg[0] != '\0', -1);
405 session->state = SESSION_SEND;
406 session->write_buf = g_strconcat(msg, "\r\n", NULL);
407 session->write_buf_p = session->write_buf;
408 session->write_buf_len = strlen(msg) + 2;
410 ret = session_write_msg_cb(session->sock, G_IO_OUT, session);
413 session->io_tag = sock_add_watch(session->sock, G_IO_OUT,
414 session_write_msg_cb, session);
415 else if (session->state == SESSION_ERROR)
421 gint session_recv_msg(Session *session)
423 cm_return_val_if_fail(session->read_msg_buf->len == 0, -1);
425 session->state = SESSION_RECV;
427 if (session->read_buf_len > 0)
428 g_idle_add(session_recv_msg_idle_cb, session);
430 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
431 session_read_msg_cb, session);
436 static gboolean session_recv_msg_idle_cb(gpointer data)
438 Session *session = SESSION(data);
441 ret = session_read_msg_cb(session->sock, G_IO_IN, session);
444 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
445 session_read_msg_cb, session);
451 *\brief parent (child?): send data to other process
453 *\param session Contains session information
460 gint session_send_data(Session *session, const guchar *data, guint size)
464 cm_return_val_if_fail(session->write_data == NULL, -1);
465 cm_return_val_if_fail(data != NULL, -1);
466 cm_return_val_if_fail(size != 0, -1);
468 session->state = SESSION_SEND;
470 session->write_data = data;
471 session->write_data_p = session->write_data;
472 session->write_data_len = size;
473 g_get_current_time(&session->tv_prev);
475 ret = session_write_data_cb(session->sock, G_IO_OUT, session);
478 session->io_tag = sock_add_watch(session->sock, G_IO_OUT,
479 session_write_data_cb,
481 else if (session->state == SESSION_ERROR)
487 gint session_recv_data(Session *session, guint size, const gchar *terminator)
489 cm_return_val_if_fail(session->read_data_buf->len == 0, -1);
491 session->state = SESSION_RECV;
493 g_free(session->read_data_terminator);
494 session->read_data_terminator = g_strdup(terminator);
495 g_get_current_time(&session->tv_prev);
497 if (session->read_buf_len > 0)
498 g_idle_add(session_recv_data_idle_cb, session);
500 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
501 session_read_data_cb, session);
506 static gboolean session_recv_data_idle_cb(gpointer data)
508 Session *session = SESSION(data);
511 ret = session_read_data_cb(session->sock, G_IO_IN, session);
514 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
515 session_read_data_cb, session);
520 static gboolean session_read_msg_cb(SockInfo *source, GIOCondition condition,
523 Session *session = SESSION(data);
524 gchar buf[SESSION_BUFFSIZE];
530 cm_return_val_if_fail(condition == G_IO_IN, FALSE);
532 session_set_timeout(session, session->timeout_interval);
534 if (session->read_buf_len == 0) {
538 read_len = sock_read(session->sock, session->read_buf,
539 SESSION_BUFFSIZE - 1);
541 if (read_len == -1 && session->state == SESSION_DISCONNECTED) {
542 g_warning ("sock_read: session disconnected\n");
543 if (session->io_tag > 0) {
544 g_source_remove(session->io_tag);
551 g_warning("sock_read: received EOF\n");
552 session->state = SESSION_EOF;
561 g_warning("sock_read: %s\n", g_strerror(errno));
562 session->state = SESSION_ERROR;
567 session->read_buf_len = read_len;
570 if ((newline = memchr(session->read_buf_p, '\n', session->read_buf_len))
572 line_len = newline - session->read_buf_p + 1;
574 line_len = session->read_buf_len;
579 memcpy(buf, session->read_buf_p, line_len);
580 buf[line_len] = '\0';
582 g_string_append(session->read_msg_buf, buf);
584 session->read_buf_len -= line_len;
585 if (session->read_buf_len == 0)
586 session->read_buf_p = session->read_buf;
588 session->read_buf_p += line_len;
590 /* incomplete read */
591 if (buf[line_len - 1] != '\n')
595 if (session->io_tag > 0) {
596 g_source_remove(session->io_tag);
601 msg = g_strdup(session->read_msg_buf->str);
603 g_string_truncate(session->read_msg_buf, 0);
605 ret = session->recv_msg(session, msg);
606 session->recv_msg_notify(session, msg, session->recv_msg_notify_data);
611 session->state = SESSION_ERROR;
616 static gboolean session_read_data_cb(SockInfo *source, GIOCondition condition,
619 Session *session = SESSION(data);
620 GByteArray *data_buf;
622 gboolean complete = FALSE;
626 cm_return_val_if_fail(condition == G_IO_IN, FALSE);
628 session_set_timeout(session, session->timeout_interval);
630 if (session->read_buf_len == 0) {
633 read_len = sock_read(session->sock, session->read_buf,
637 g_warning("sock_read: received EOF\n");
638 session->state = SESSION_EOF;
647 g_warning("sock_read: %s\n", g_strerror(errno));
648 session->state = SESSION_ERROR;
653 session->read_buf_len = read_len;
656 data_buf = session->read_data_buf;
657 terminator_len = strlen(session->read_data_terminator);
659 if (session->read_buf_len == 0)
662 g_byte_array_append(data_buf, session->read_buf_p,
663 session->read_buf_len);
665 session->read_buf_len = 0;
666 session->read_buf_p = session->read_buf;
668 /* check if data is terminated */
669 if (data_buf->len >= terminator_len) {
670 if (memcmp(data_buf->data, session->read_data_terminator,
671 terminator_len) == 0)
673 else if (data_buf->len >= terminator_len + 2 &&
674 memcmp(data_buf->data + data_buf->len -
675 (terminator_len + 2), "\r\n", 2) == 0 &&
676 memcmp(data_buf->data + data_buf->len -
677 terminator_len, session->read_data_terminator,
678 terminator_len) == 0)
682 /* incomplete read */
686 g_get_current_time(&tv_cur);
687 if (tv_cur.tv_sec - session->tv_prev.tv_sec > 0 ||
688 tv_cur.tv_usec - session->tv_prev.tv_usec >
689 UI_REFRESH_INTERVAL) {
690 session->recv_data_progressive_notify
691 (session, data_buf->len, 0,
692 session->recv_data_progressive_notify_data);
693 g_get_current_time(&session->tv_prev);
699 if (session->io_tag > 0) {
700 g_source_remove(session->io_tag);
704 data_len = data_buf->len - terminator_len;
707 ret = session->recv_data_finished(session, (gchar *)data_buf->data,
710 g_byte_array_set_size(data_buf, 0);
712 session->recv_data_notify(session, data_len,
713 session->recv_data_notify_data);
716 session->state = SESSION_ERROR;
721 static gint session_write_buf(Session *session)
726 cm_return_val_if_fail(session->write_buf != NULL, -1);
727 cm_return_val_if_fail(session->write_buf_p != NULL, -1);
728 cm_return_val_if_fail(session->write_buf_len > 0, -1);
730 to_write_len = session->write_buf_len -
731 (session->write_buf_p - session->write_buf);
732 to_write_len = MIN(to_write_len, SESSION_BUFFSIZE);
734 write_len = sock_write(session->sock, session->write_buf_p,
743 g_warning("sock_write: %s\n", g_strerror(errno));
744 session->state = SESSION_ERROR;
749 /* incomplete write */
750 if (session->write_buf_p - session->write_buf + write_len <
751 session->write_buf_len) {
752 session->write_buf_p += write_len;
756 g_free(session->write_buf);
757 session->write_buf = NULL;
758 session->write_buf_p = NULL;
759 session->write_buf_len = 0;
764 static gint session_write_data(Session *session)
769 cm_return_val_if_fail(session->write_data != NULL, -1);
770 cm_return_val_if_fail(session->write_data_p != NULL, -1);
771 cm_return_val_if_fail(session->write_data_len > 0, -1);
773 to_write_len = session->write_data_len -
774 (session->write_data_p - session->write_data);
775 to_write_len = MIN(to_write_len, SESSION_BUFFSIZE);
777 write_len = sock_write(session->sock, session->write_data_p,
786 g_warning("sock_write: %s\n", g_strerror(errno));
787 session->state = SESSION_ERROR;
792 /* incomplete write */
793 if (session->write_data_p - session->write_data + write_len <
794 session->write_data_len) {
795 session->write_data_p += write_len;
799 session->write_data = NULL;
800 session->write_data_p = NULL;
801 session->write_data_len = 0;
806 static gboolean session_write_msg_cb(SockInfo *source, GIOCondition condition,
809 Session *session = SESSION(data);
812 cm_return_val_if_fail(condition == G_IO_OUT, FALSE);
813 cm_return_val_if_fail(session->write_buf != NULL, FALSE);
814 cm_return_val_if_fail(session->write_buf_p != NULL, FALSE);
815 cm_return_val_if_fail(session->write_buf_len > 0, FALSE);
817 ret = session_write_buf(session);
820 session->state = SESSION_ERROR;
825 if (session->io_tag > 0) {
826 g_source_remove(session->io_tag);
830 session_recv_msg(session);
835 static gboolean session_write_data_cb(SockInfo *source,
836 GIOCondition condition, gpointer data)
838 Session *session = SESSION(data);
839 guint write_data_len;
842 cm_return_val_if_fail(condition == G_IO_OUT, FALSE);
843 cm_return_val_if_fail(session->write_data != NULL, FALSE);
844 cm_return_val_if_fail(session->write_data_p != NULL, FALSE);
845 cm_return_val_if_fail(session->write_data_len > 0, FALSE);
847 write_data_len = session->write_data_len;
849 ret = session_write_data(session);
852 session->state = SESSION_ERROR;
854 } else if (ret > 0) {
857 g_get_current_time(&tv_cur);
858 if (tv_cur.tv_sec - session->tv_prev.tv_sec > 0 ||
859 tv_cur.tv_usec - session->tv_prev.tv_usec >
860 UI_REFRESH_INTERVAL) {
861 session_set_timeout(session, session->timeout_interval);
862 session->send_data_progressive_notify
864 session->write_data_p - session->write_data,
866 session->send_data_progressive_notify_data);
867 g_get_current_time(&session->tv_prev);
872 if (session->io_tag > 0) {
873 g_source_remove(session->io_tag);
878 ret = session->send_data_finished(session, write_data_len);
879 session->send_data_notify(session, write_data_len,
880 session->send_data_notify_data);
885 void session_register_ping(Session *session, gboolean (*ping_cb)(gpointer data))
889 if (session->ping_tag > -1)
890 g_source_remove(session->ping_tag);
892 session->ping_tag = -1;
895 #if GLIB_CHECK_VERSION(2,14,0)
897 g_timeout_add_seconds(60, ping_cb, session);
900 g_timeout_add(60*1000, ping_cb, session);