2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2003 Hiroyuki Yamamoto
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 2 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
31 #include <sys/types.h>
33 #include <sys/signal.h>
40 static gint session_close (Session *session);
42 static gchar *session_recv_msg (Session *session);
44 static guchar *session_read_data (Session *session,
47 static gint session_send_data_to_sock (Session *session,
50 static guchar *session_recv_data_from_sock (Session *session,
53 static guchar *session_recv_data_from_sock_unescape (Session *session,
57 gboolean session_parent_input_cb (GIOChannel *source,
58 GIOCondition condition,
61 gboolean session_child_input (Session *session);
65 *\brief init session members to zero
67 *\param session to be initialized
69 void session_init(Session *session)
74 session->server = NULL;
76 session->state = SESSION_READY;
77 session->last_access_time = time(NULL);
80 session->read_ch = NULL;
81 session->write_ch = NULL;
85 *\brief Set up parent and child process
86 * Childloop: Read commands from parent,
87 * send to server, get answer, pass to parent
89 *\param session Contains session information
90 * server to connect to
94 * -1 : pipe / fork errors (parent)
95 * 1 : connection error (child)
97 gint session_connect(Session *session, const gchar *server, gushort port)
100 gint pipe_fds1[2], pipe_fds2[2];
104 session->server = g_strdup(server);
105 session->port = port;
107 if (pipe(pipe_fds1) < 0) {
111 if (pipe(pipe_fds2) < 0) {
118 if ((pid = fork()) < 0) {
124 session->child_pid = pid;
125 session->read_ch = g_io_channel_unix_new(pipe_fds2[0]);
126 session->write_ch = g_io_channel_unix_new(pipe_fds1[1]);
129 session->read_tag = g_io_add_watch(session->read_ch, G_IO_IN,
130 session_parent_input_cb,
137 session->read_ch = g_io_channel_unix_new(pipe_fds1[0]);
138 session->write_ch = g_io_channel_unix_new(pipe_fds2[1]);
142 debug_print("session: child: connecting to %s:%d ...\n", server, port);
144 if ((sock = sock_connect(server, port)) == NULL) {
145 session_send_msg(session, SESSION_MSG_ERROR,
146 "can't connect to server.");
147 session_close(session);
152 if (session->ssl_type == SSL_TUNNEL && !ssl_init_socket(sock)) {
153 session_send_msg(session, SESSION_MSG_ERROR,
154 "can't initialize SSL.");
155 session_close(session);
160 debug_print("session: child: connected\n");
162 session->sock = sock;
163 session->state = SESSION_RECV;
165 if ((str = sock_getline(sock)) == NULL) {
166 session_send_msg(session, SESSION_MSG_ERROR,
167 "can't get server response.");
168 session_close(session);
172 session_send_msg(session, SESSION_MSG_NORMAL, str);
175 while (session_child_input(session) == TRUE)
178 session_close(session);
180 debug_print("session: child: disconnected\n");
186 *\brief child and parent: send DISCONNECT message to other process
188 *\param session Contains session information
192 gint session_disconnect(Session *session)
194 debug_print("session: %s: session_disconnect()\n",
195 session->child_pid == 0 ? "child" : "parent");
196 session_send_msg(session, SESSION_MSG_CONTROL, "DISCONNECT");
203 *\param session Contains session information
205 void session_destroy(Session *session)
207 g_return_if_fail(session != NULL);
208 g_return_if_fail(session->destroy != NULL);
210 debug_print("session: session_destroy()\n");
211 session_close(session);
212 g_print("$$$ session_destroy() session->destroy called\n");
213 session->destroy(session);
214 g_print("$$$ session_destroy() freeing session server\n");
215 g_free(session->server);
216 g_print("$$$ session_destroy() freeing session\n");
218 g_print("$$$ session_destroy() done\n");
221 void session_set_recv_message_notify(Session *session,
222 RecvMsgNotify notify_func, gpointer data)
224 session->recv_msg_notify = notify_func;
225 session->recv_msg_notify_data = data;
228 void session_set_recv_data_progressive_notify
230 RecvDataProgressiveNotify notify_func,
233 session->recv_data_progressive_notify = notify_func,
234 session->recv_data_progressive_notify_data = data;
237 void session_set_recv_data_notify(Session *session, RecvDataNotify notify_func,
240 session->recv_data_notify = notify_func;
241 session->recv_data_notify_data = data;
244 void session_set_send_data_progressive_notify
246 SendDataProgressiveNotify notify_func,
249 session->send_data_progressive_notify = notify_func;
250 session->send_data_progressive_notify_data = data;
253 void session_set_send_data_notify(Session *session, SendDataNotify notify_func,
256 session->send_data_notify = notify_func;
257 session->send_data_notify_data = data;
261 *\brief child and parent cleanup (child closes first)
263 *\param session Contains session information
267 static gint session_close(Session *session)
269 g_return_val_if_fail(session != NULL, -1);
271 debug_print("session: %s: session_close()\n",
272 session->child_pid == 0 ? "child" : "parent");
274 if (session->read_tag > 0) {
275 g_source_remove(session->read_tag);
276 session->read_tag = 0;
279 g_print("$$$ %s: closing read channel\n", session->child_pid == 0 ? "child" : "parent");
280 if (session->read_ch) {
281 g_io_channel_close(session->read_ch);
282 g_io_channel_unref(session->read_ch);
283 session->read_ch = NULL;
286 g_print("$$$ %s: closing write channel\n", session->child_pid == 0 ? "child" : "parent");
287 if (session->write_ch) {
288 g_io_channel_close(session->write_ch);
289 g_io_channel_unref(session->write_ch);
290 session->write_ch = NULL;
293 g_print("$$$ %s: closing socket\n", session->child_pid == 0 ? "child" : "parent");
295 sock_close(session->sock);
296 session->sock = NULL;
297 session->state = SESSION_DISCONNECTED;
300 if (session->child_pid) {
301 g_print("$$$ %s: closing child\n", session->child_pid == 0 ? "child" : "parent");
302 if (session->state != SESSION_DISCONNECTED)
303 kill(session->child_pid, SIGTERM);
304 waitpid(session->child_pid, NULL, 0);
305 session->child_pid = 0;
308 g_print("$$$ %s: exiting session_close\n", session->child_pid == 0 ? "child" : "parent");
313 *\brief child and parent: send control message to other process
315 *\param session Contains session information
316 * type Kind of data (commands or message data)
322 gint session_send_msg(Session *session, SessionMsgType type, const gchar *msg)
330 case SESSION_MSG_NORMAL:
331 prefix = "MESSAGE"; break;
332 case SESSION_MSG_SEND_DATA:
333 prefix = "SENDDATA"; break;
334 case SESSION_MSG_RECV_DATA:
335 prefix = "RECVDATA"; break;
336 case SESSION_MSG_CONTROL:
337 prefix = "CONTROL"; break;
338 case SESSION_MSG_ERROR:
339 prefix = "ERROR"; break;
344 str = g_strdup_printf("%s %s\n", prefix, msg);
348 if (g_io_channel_write(session->write_ch, str, size,
350 != G_IO_ERROR_NONE || bytes_written == 0) {
351 g_warning("%s: sending message failed.\n",
352 session->child_pid == 0 ? "child" : "parent");
355 size -= bytes_written;
364 *\brief child and parent receive function
366 *\param session Contains session information
368 *\return Message read by current session
370 static gchar *session_recv_msg(Session *session)
378 if (g_io_channel_read(session->read_ch, buf, sizeof(buf) - 1,
380 != G_IO_ERROR_NONE || bytes_read == 0) {
381 g_warning("%s: receiving message failed.\n",
382 session->child_pid == 0 ? "child" : "parent");
389 buf[bytes_read] = '\0';
394 str = g_realloc(str, size);
397 if (str[size - 2] == '\n') {
398 str[size - 2] = '\0';
400 debug_print("session: %s: received message: %s\n",
401 session->child_pid == 0 ?
402 "child" : "parent", str);
412 gint session_start_tls(Session *session)
416 session_send_msg(session, SESSION_MSG_CONTROL, "STARTTLS");
417 ctl_msg = session_recv_msg(session);
418 if (!ctl_msg || strcmp(ctl_msg, "CONTROL STARTTLSOK") != 0) {
429 *\brief parent (child?): send data to other process
431 *\param session Contains session information
438 gint session_send_data(Session *session, const guchar *data, guint size)
444 session_send_msg(session, SESSION_MSG_SEND_DATA, itos(size));
445 if ((msg = session_recv_msg(session)) == NULL)
450 if ((err = g_io_channel_write(session->write_ch, (guchar *)data,
451 size, &bytes_written))
452 != G_IO_ERROR_NONE || bytes_written == 0) {
453 g_warning("%s: sending data failed: %d\n",
454 session->child_pid == 0 ? "child" : "parent",
458 size -= bytes_written;
459 debug_print("session: %s: sent %d bytes of data\n",
460 session->child_pid == 0 ? "child" : "parent",
467 gint session_recv_data(Session *session, guint size, gboolean unescape_dot)
472 g_snprintf(buf, sizeof(buf), "%d UNESCAPE", size);
473 session_send_msg(session, SESSION_MSG_RECV_DATA, buf);
475 session_send_msg(session, SESSION_MSG_RECV_DATA, itos(size));
480 *\brief child (parent?): read data from other process
482 *\param session Contains session information
485 *\return data read from session
487 static guchar *session_read_data(Session *session, guint size)
494 cur = data = g_malloc(size);
497 if ((err = g_io_channel_read(session->read_ch, cur, size,
499 != G_IO_ERROR_NONE || bytes_read == 0) {
500 g_warning("%s: reading data failed: %d\n",
501 session->child_pid == 0 ? "child" : "parent",
508 debug_print("session: %s: received %d bytes of data\n",
509 session->child_pid == 0 ? "child" : "parent",
516 #define MAX_CHUNK_SIZE 4096
519 *\brief child: Send session data to server
521 *\param session Contains session information
522 * data Data to send to server
528 static gint session_send_data_to_sock(Session *session, const guchar *data,
531 const guchar *cur = data;
533 gint total_write_len = 0;
537 struct timeval tv_prev, tv_cur;
539 gettimeofday(&tv_prev, NULL);
542 bytes_written = sock_write(session->sock, cur,
543 MIN(left, MAX_CHUNK_SIZE));
544 if (bytes_written <= 0)
546 left -= bytes_written;
547 cur += bytes_written;
548 total_write_len += bytes_written;
552 gettimeofday(&tv_cur, NULL);
553 if (tv_cur.tv_sec - tv_prev.tv_sec > 0 ||
554 tv_cur.tv_usec - tv_prev.tv_usec > UI_REFRESH_INTERVAL) {
555 g_snprintf(buf, sizeof(buf), "DATASENDINPROG %d %d",
556 total_write_len, size);
557 session_send_msg(session, SESSION_MSG_CONTROL, buf);
558 if ((msg = session_recv_msg(session)) == NULL)
561 gettimeofday(&tv_prev, NULL);
569 *\brief child: Read answer/data from server
571 *\param session Contains session information
572 * size Max bytes to receive
574 *\return Server answer
576 static guchar *session_recv_data_from_sock(Session *session, guint size)
581 gint total_read_len = 0;
585 struct timeval tv_prev, tv_cur;
587 gettimeofday(&tv_prev, NULL);
589 cur = data = g_malloc(size);
592 bytes_read = sock_read(session->sock, cur, left);
593 if (bytes_read <= 0) {
597 debug_print("session: child: "
598 "received %d bytes of data from sock\n",
602 total_read_len += bytes_read;
606 gettimeofday(&tv_cur, NULL);
607 if (tv_cur.tv_sec - tv_prev.tv_sec > 0 ||
608 tv_cur.tv_usec - tv_prev.tv_usec > UI_REFRESH_INTERVAL) {
609 g_snprintf(buf, sizeof(buf), "DATARECVINPROG %d %d",
610 total_read_len, size);
611 session_send_msg(session, SESSION_MSG_CONTROL, buf);
612 if ((msg = session_recv_msg(session)) == NULL) {
617 gettimeofday(&tv_prev, NULL);
624 static guchar *session_recv_data_from_sock_unescape(Session *session,
633 struct timeval tv_prev, tv_cur;
635 gettimeofday(&tv_prev, NULL);
637 data = g_string_sized_new(size + 1);
641 bytes_read = sock_gets(session->sock, buf, sizeof(buf));
642 if (bytes_read <= 0) {
643 g_string_free(data, TRUE);
647 if (buf[0] == '.' && buf[1] == '\r' && buf[2] == '\n')
649 if (buf[0] == '.' && buf[1] == '.')
650 g_string_append(data, buf + 1);
652 g_string_append(data, buf);
654 gettimeofday(&tv_cur, NULL);
655 if (tv_cur.tv_sec - tv_prev.tv_sec > 0 ||
656 tv_cur.tv_usec - tv_prev.tv_usec > UI_REFRESH_INTERVAL) {
657 g_snprintf(buf, sizeof(buf), "DATARECVINPROG %d %d",
658 data->len, MAX(data->len, size));
659 session_send_msg(session, SESSION_MSG_CONTROL, buf);
660 if ((msg = session_recv_msg(session)) == NULL) {
661 g_string_free(data, TRUE);
665 gettimeofday(&tv_prev, NULL);
669 ret_data = data->str;
670 *actual_size = data->len;
671 g_string_free(data, FALSE);
677 *\brief Return if message is an internal command or server data
679 *\param str Message to analyze
681 *\return Type of message
683 static SessionMsgType session_get_msg_type(const gchar *str)
685 if (!strncmp(str, "MESSAGE ", 8))
686 return SESSION_MSG_NORMAL;
687 else if (!strncmp(str, "SENDDATA ", 9))
688 return SESSION_MSG_SEND_DATA;
689 else if (!strncmp(str, "RECVDATA ", 9))
690 return SESSION_MSG_RECV_DATA;
691 else if (!strncmp(str, "CONTROL ", 8))
692 return SESSION_MSG_CONTROL;
693 else if (!strncmp(str, "ERROR ", 6))
694 return SESSION_MSG_ERROR;
696 return SESSION_MSG_UNKNOWN;
700 *\brief parent: Received data from child
702 *\param source Channel watching child pipe
703 * condition Unused (IN, HUP, OUT)
704 * data Contains session information
706 *\return FALSE to remove watching channel
708 gboolean session_parent_input_cb(GIOChannel *source, GIOCondition condition,
711 Session *session = SESSION(data);
720 if ((msg = session_recv_msg(session)) == NULL) {
721 session->state = SESSION_ERROR;
725 switch (session_get_msg_type(msg)) {
726 case SESSION_MSG_NORMAL:
727 msg_data = msg + strlen("MESSAGE ");
728 ret = session->recv_msg(session, msg_data);
729 g_print("$$$ > session_parent_input_cb(data: %lx)\n",
730 session->recv_msg_notify_data);
731 session->recv_msg_notify(session, msg_data,
732 session->recv_msg_notify_data);
733 g_print("$$$ < session_parent_input_cb(data: %lx)\n",
734 session->recv_msg_notify_data);
736 session_send_msg(session, SESSION_MSG_CONTROL,
739 session->state = SESSION_ERROR;
744 case SESSION_MSG_SEND_DATA:
745 msg_data = msg + strlen("SENDDATA ");
746 size = atoi(msg_data);
747 session_send_msg(session, SESSION_MSG_CONTROL, "ACCEPTDATA");
748 recv_data = session_read_data(session, size);
750 session->state = SESSION_ERROR;
754 ret = session->recv_data_finished(session, recv_data, size);
756 session->recv_data_notify(session, size,
757 session->recv_data_notify_data);
759 session_send_msg(session, SESSION_MSG_CONTROL,
762 session->state = SESSION_ERROR;
767 case SESSION_MSG_RECV_DATA:
769 case SESSION_MSG_CONTROL:
770 msg_data = msg + strlen("CONTROL ");
771 if (!strncmp(msg_data, "DATARECVINPROG ", 15)) {
772 ret = sscanf(msg_data,
773 "DATARECVINPROG %d %d", &len, &total);
775 g_warning("wrong control message: %s\n", msg);
776 session->state = SESSION_ERROR;
780 session_send_msg(session, SESSION_MSG_CONTROL,
782 session->recv_data_progressive_notify
783 (session, len, total,
784 session->recv_data_progressive_notify_data);
785 } else if (!strncmp(msg_data, "DATASENDINPROG ", 15)) {
786 ret = sscanf(msg_data,
787 "DATASENDINPROG %d %d", &len, &total);
789 g_warning("wrong control message: %s\n", msg);
790 session->state = SESSION_ERROR;
794 session_send_msg(session, SESSION_MSG_CONTROL,
796 session->send_data_progressive_notify
797 (session, len, total,
798 session->send_data_progressive_notify_data);
799 } else if (!strncmp(msg_data, "DATASENT ", 9)) {
800 len = atoi(msg_data + 9);
801 ret = session->send_data_finished(session, len);
802 session->send_data_notify
803 (session, len, session->send_data_notify_data);
804 } else if (!strcmp(msg_data, "DISCONNECTED")) {
805 session->state = SESSION_DISCONNECTED;
809 g_warning("wrong control message: %s\n", msg);
810 session->state = SESSION_ERROR;
815 case SESSION_MSG_ERROR:
817 g_warning("error from child: %s\n", msg + strlen("ERROR "));
818 session->state = SESSION_ERROR;
828 *\brief child: Receive control message from parent,
829 * transfer data from/to server
831 *\param session Contains session information
833 *\return TRUE if more data is available
835 gboolean session_child_input(Session *session)
846 if ((msg = session_recv_msg(session)) == NULL) {
847 session_send_msg(session, SESSION_MSG_ERROR,
848 "receiving message failed.");
849 session->state = SESSION_ERROR;
853 switch (session_get_msg_type(msg)) {
854 case SESSION_MSG_NORMAL:
855 msg_data = msg + strlen("MESSAGE ");
856 session->state = SESSION_SEND;
857 sock_puts(session->sock, msg_data);
858 session->state = SESSION_RECV;
859 str = sock_getline(session->sock);
861 session_send_msg(session, SESSION_MSG_ERROR,
862 "receiving message failed.");
863 session->state = SESSION_ERROR;
868 session_send_msg(session, SESSION_MSG_NORMAL, str);
871 case SESSION_MSG_SEND_DATA:
872 msg_data = msg + strlen("SENDDATA ");
873 size = atoi(msg_data);
874 session_send_msg(session, SESSION_MSG_CONTROL, "ACCEPTDATA");
875 send_data = session_read_data(session, size);
877 session_send_msg(session, SESSION_MSG_ERROR,
878 "sending data failed.");
879 session->state = SESSION_ERROR;
883 session->state = SESSION_SEND;
884 if (session_send_data_to_sock(session, send_data, size) < 0) {
885 session_send_msg(session, SESSION_MSG_ERROR,
886 "sending data failed.");
887 session->state = SESSION_ERROR;
893 g_snprintf(buf, sizeof(buf), "DATASENT %d", size);
894 session_send_msg(session, SESSION_MSG_CONTROL, buf);
896 case SESSION_MSG_RECV_DATA:
897 msg_data = msg + strlen("RECVDATA ");
898 size = atoi(msg_data);
899 session->state = SESSION_RECV;
900 if (strstr(msg_data, "UNESCAPE") != NULL) {
901 recv_data = session_recv_data_from_sock_unescape
902 (session, size, &actual_size);
905 recv_data = session_recv_data_from_sock(session, size);
907 session_send_msg(session, SESSION_MSG_ERROR,
908 "receiving data failed.");
909 session->state = SESSION_ERROR;
913 if (session_send_data(session, recv_data, size) < 0) {
914 session->state = SESSION_ERROR;
921 case SESSION_MSG_CONTROL:
922 msg_data = msg + strlen("CONTROL ");
923 if (!strcmp(msg_data, "CONTINUE")) {
924 session->state = SESSION_RECV;
925 str = sock_getline(session->sock);
927 session_send_msg(session, SESSION_MSG_ERROR,
928 "receiving message failed.");
929 session->state = SESSION_ERROR;
934 session_send_msg(session, SESSION_MSG_NORMAL, str);
938 } else if (!strcmp(msg_data, "STARTTLS")) {
939 if (!ssl_init_socket_with_method(session->sock,
941 session_send_msg(session, SESSION_MSG_ERROR,
942 "can't start TLS session.");
943 session->state = SESSION_ERROR;
947 session_send_msg(session, SESSION_MSG_CONTROL,
951 } else if (!strcmp(msg_data, "DISCONNECT")) {
952 sock_close(session->sock);
953 session->sock = NULL;
954 session->state = SESSION_DISCONNECTED;
955 session_send_msg(session, SESSION_MSG_CONTROL,
960 session_send_msg(session, SESSION_MSG_ERROR,
961 "wrong control message.");
962 session->state = SESSION_ERROR;
967 case SESSION_MSG_ERROR:
969 session_send_msg(session, SESSION_MSG_ERROR,
970 "error received from parent.");
971 session->state = SESSION_ERROR;