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 (interval % 1000 == 0)
268 session->timeout_tag =
269 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);
376 session->sock->ssl_cert_auto_accept = session->ssl_cert_auto_accept;
377 session->sock->gnutls_priority = session->gnutls_priority;
380 sock_set_nonblocking_mode(session->sock, FALSE);
382 if (!ssl_init_socket(session->sock)) {
383 g_warning("couldn't start TLS session.\n");
385 sock_set_nonblocking_mode(session->sock, session->nonblocking);
390 sock_set_nonblocking_mode(session->sock, session->nonblocking);
396 gint session_send_msg(Session *session, SessionMsgType type, const gchar *msg)
400 cm_return_val_if_fail(session->write_buf == NULL, -1);
401 cm_return_val_if_fail(msg != NULL, -1);
402 cm_return_val_if_fail(msg[0] != '\0', -1);
404 session->state = SESSION_SEND;
405 session->write_buf = g_strconcat(msg, "\r\n", NULL);
406 session->write_buf_p = session->write_buf;
407 session->write_buf_len = strlen(msg) + 2;
409 ret = session_write_msg_cb(session->sock, G_IO_OUT, session);
412 session->io_tag = sock_add_watch(session->sock, G_IO_OUT,
413 session_write_msg_cb, session);
414 else if (session->state == SESSION_ERROR)
420 gint session_recv_msg(Session *session)
422 cm_return_val_if_fail(session->read_msg_buf->len == 0, -1);
424 session->state = SESSION_RECV;
426 if (session->read_buf_len > 0)
427 g_idle_add(session_recv_msg_idle_cb, session);
429 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
430 session_read_msg_cb, session);
435 static gboolean session_recv_msg_idle_cb(gpointer data)
437 Session *session = SESSION(data);
440 ret = session_read_msg_cb(session->sock, G_IO_IN, session);
443 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
444 session_read_msg_cb, session);
450 *\brief parent (child?): send data to other process
452 *\param session Contains session information
459 gint session_send_data(Session *session, const guchar *data, guint size)
463 cm_return_val_if_fail(session->write_data == NULL, -1);
464 cm_return_val_if_fail(data != NULL, -1);
465 cm_return_val_if_fail(size != 0, -1);
467 session->state = SESSION_SEND;
469 session->write_data = data;
470 session->write_data_p = session->write_data;
471 session->write_data_len = size;
472 g_get_current_time(&session->tv_prev);
474 ret = session_write_data_cb(session->sock, G_IO_OUT, session);
477 session->io_tag = sock_add_watch(session->sock, G_IO_OUT,
478 session_write_data_cb,
480 else if (session->state == SESSION_ERROR)
486 gint session_recv_data(Session *session, guint size, const gchar *terminator)
488 cm_return_val_if_fail(session->read_data_buf->len == 0, -1);
490 session->state = SESSION_RECV;
492 g_free(session->read_data_terminator);
493 session->read_data_terminator = g_strdup(terminator);
494 g_get_current_time(&session->tv_prev);
496 if (session->read_buf_len > 0)
497 g_idle_add(session_recv_data_idle_cb, session);
499 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
500 session_read_data_cb, session);
505 static gboolean session_recv_data_idle_cb(gpointer data)
507 Session *session = SESSION(data);
510 ret = session_read_data_cb(session->sock, G_IO_IN, session);
513 session->io_tag = sock_add_watch(session->sock, G_IO_IN,
514 session_read_data_cb, session);
519 static gboolean session_read_msg_cb(SockInfo *source, GIOCondition condition,
522 Session *session = SESSION(data);
523 gchar buf[SESSION_BUFFSIZE];
529 cm_return_val_if_fail(condition == G_IO_IN, FALSE);
531 session_set_timeout(session, session->timeout_interval);
533 if (session->read_buf_len == 0) {
537 read_len = sock_read(session->sock, session->read_buf,
538 SESSION_BUFFSIZE - 1);
540 if (read_len == -1 && session->state == SESSION_DISCONNECTED) {
541 g_warning ("sock_read: session disconnected\n");
542 if (session->io_tag > 0) {
543 g_source_remove(session->io_tag);
550 g_warning("sock_read: received EOF\n");
551 session->state = SESSION_EOF;
560 g_warning("sock_read: %s\n", g_strerror(errno));
561 session->state = SESSION_ERROR;
566 session->read_buf_len = read_len;
569 if ((newline = memchr(session->read_buf_p, '\n', session->read_buf_len))
571 line_len = newline - session->read_buf_p + 1;
573 line_len = session->read_buf_len;
578 memcpy(buf, session->read_buf_p, line_len);
579 buf[line_len] = '\0';
581 g_string_append(session->read_msg_buf, buf);
583 session->read_buf_len -= line_len;
584 if (session->read_buf_len == 0)
585 session->read_buf_p = session->read_buf;
587 session->read_buf_p += line_len;
589 /* incomplete read */
590 if (buf[line_len - 1] != '\n')
594 if (session->io_tag > 0) {
595 g_source_remove(session->io_tag);
600 msg = g_strdup(session->read_msg_buf->str);
602 g_string_truncate(session->read_msg_buf, 0);
604 ret = session->recv_msg(session, msg);
605 session->recv_msg_notify(session, msg, session->recv_msg_notify_data);
610 session->state = SESSION_ERROR;
615 static gboolean session_read_data_cb(SockInfo *source, GIOCondition condition,
618 Session *session = SESSION(data);
619 GByteArray *data_buf;
621 gboolean complete = FALSE;
625 cm_return_val_if_fail(condition == G_IO_IN, FALSE);
627 session_set_timeout(session, session->timeout_interval);
629 if (session->read_buf_len == 0) {
632 read_len = sock_read(session->sock, session->read_buf,
636 g_warning("sock_read: received EOF\n");
637 session->state = SESSION_EOF;
646 g_warning("sock_read: %s\n", g_strerror(errno));
647 session->state = SESSION_ERROR;
652 session->read_buf_len = read_len;
655 data_buf = session->read_data_buf;
656 terminator_len = strlen(session->read_data_terminator);
658 if (session->read_buf_len == 0)
661 g_byte_array_append(data_buf, session->read_buf_p,
662 session->read_buf_len);
664 session->read_buf_len = 0;
665 session->read_buf_p = session->read_buf;
667 /* check if data is terminated */
668 if (data_buf->len >= terminator_len) {
669 if (memcmp(data_buf->data, session->read_data_terminator,
670 terminator_len) == 0)
672 else if (data_buf->len >= terminator_len + 2 &&
673 memcmp(data_buf->data + data_buf->len -
674 (terminator_len + 2), "\r\n", 2) == 0 &&
675 memcmp(data_buf->data + data_buf->len -
676 terminator_len, session->read_data_terminator,
677 terminator_len) == 0)
681 /* incomplete read */
685 g_get_current_time(&tv_cur);
686 if (tv_cur.tv_sec - session->tv_prev.tv_sec > 0 ||
687 tv_cur.tv_usec - session->tv_prev.tv_usec >
688 UI_REFRESH_INTERVAL) {
689 session->recv_data_progressive_notify
690 (session, data_buf->len, 0,
691 session->recv_data_progressive_notify_data);
692 g_get_current_time(&session->tv_prev);
698 if (session->io_tag > 0) {
699 g_source_remove(session->io_tag);
703 data_len = data_buf->len - terminator_len;
706 ret = session->recv_data_finished(session, (gchar *)data_buf->data,
709 g_byte_array_set_size(data_buf, 0);
711 session->recv_data_notify(session, data_len,
712 session->recv_data_notify_data);
715 session->state = SESSION_ERROR;
720 static gint session_write_buf(Session *session)
725 cm_return_val_if_fail(session->write_buf != NULL, -1);
726 cm_return_val_if_fail(session->write_buf_p != NULL, -1);
727 cm_return_val_if_fail(session->write_buf_len > 0, -1);
729 to_write_len = session->write_buf_len -
730 (session->write_buf_p - session->write_buf);
731 to_write_len = MIN(to_write_len, SESSION_BUFFSIZE);
733 write_len = sock_write(session->sock, session->write_buf_p,
742 g_warning("sock_write: %s\n", g_strerror(errno));
743 session->state = SESSION_ERROR;
748 /* incomplete write */
749 if (session->write_buf_p - session->write_buf + write_len <
750 session->write_buf_len) {
751 session->write_buf_p += write_len;
755 g_free(session->write_buf);
756 session->write_buf = NULL;
757 session->write_buf_p = NULL;
758 session->write_buf_len = 0;
763 static gint session_write_data(Session *session)
768 cm_return_val_if_fail(session->write_data != NULL, -1);
769 cm_return_val_if_fail(session->write_data_p != NULL, -1);
770 cm_return_val_if_fail(session->write_data_len > 0, -1);
772 to_write_len = session->write_data_len -
773 (session->write_data_p - session->write_data);
774 to_write_len = MIN(to_write_len, SESSION_BUFFSIZE);
776 write_len = sock_write(session->sock, session->write_data_p,
785 g_warning("sock_write: %s\n", g_strerror(errno));
786 session->state = SESSION_ERROR;
791 /* incomplete write */
792 if (session->write_data_p - session->write_data + write_len <
793 session->write_data_len) {
794 session->write_data_p += write_len;
798 session->write_data = NULL;
799 session->write_data_p = NULL;
800 session->write_data_len = 0;
805 static gboolean session_write_msg_cb(SockInfo *source, GIOCondition condition,
808 Session *session = SESSION(data);
811 cm_return_val_if_fail(condition == G_IO_OUT, FALSE);
812 cm_return_val_if_fail(session->write_buf != NULL, FALSE);
813 cm_return_val_if_fail(session->write_buf_p != NULL, FALSE);
814 cm_return_val_if_fail(session->write_buf_len > 0, FALSE);
816 ret = session_write_buf(session);
819 session->state = SESSION_ERROR;
824 if (session->io_tag > 0) {
825 g_source_remove(session->io_tag);
829 session_recv_msg(session);
834 static gboolean session_write_data_cb(SockInfo *source,
835 GIOCondition condition, gpointer data)
837 Session *session = SESSION(data);
838 guint write_data_len;
841 cm_return_val_if_fail(condition == G_IO_OUT, FALSE);
842 cm_return_val_if_fail(session->write_data != NULL, FALSE);
843 cm_return_val_if_fail(session->write_data_p != NULL, FALSE);
844 cm_return_val_if_fail(session->write_data_len > 0, FALSE);
846 write_data_len = session->write_data_len;
848 ret = session_write_data(session);
851 session->state = SESSION_ERROR;
853 } else if (ret > 0) {
856 g_get_current_time(&tv_cur);
857 if (tv_cur.tv_sec - session->tv_prev.tv_sec > 0 ||
858 tv_cur.tv_usec - session->tv_prev.tv_usec >
859 UI_REFRESH_INTERVAL) {
860 session_set_timeout(session, session->timeout_interval);
861 session->send_data_progressive_notify
863 session->write_data_p - session->write_data,
865 session->send_data_progressive_notify_data);
866 g_get_current_time(&session->tv_prev);
871 if (session->io_tag > 0) {
872 g_source_remove(session->io_tag);
877 ret = session->send_data_finished(session, write_data_len);
878 session->send_data_notify(session, write_data_len,
879 session->send_data_notify_data);
884 void session_register_ping(Session *session, gboolean (*ping_cb)(gpointer data))
888 if (session->ping_tag > -1)
889 g_source_remove(session->ping_tag);
891 session->ping_tag = -1;
894 session->ping_tag = g_timeout_add_seconds(60, ping_cb, session);