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)
331 case SESSION_MSG_NORMAL:
332 prefix = "MESSAGE"; break;
333 case SESSION_MSG_SEND_DATA:
334 prefix = "SENDDATA"; break;
335 case SESSION_MSG_RECV_DATA:
336 prefix = "RECVDATA"; break;
337 case SESSION_MSG_CONTROL:
338 prefix = "CONTROL"; break;
339 case SESSION_MSG_ERROR:
340 prefix = "ERROR"; break;
345 cur = str = g_strdup_printf("%s %s\n", prefix, msg);
349 if (g_io_channel_write(session->write_ch, cur, size,
351 != G_IO_ERROR_NONE || bytes_written == 0) {
352 g_warning("%s: sending message failed.\n",
353 session->child_pid == 0 ? "child" : "parent");
357 size -= bytes_written;
358 cur += bytes_written;
367 *\brief child and parent receive function
369 *\param session Contains session information
371 *\return Message read by current session
373 static gchar *session_recv_msg(Session *session)
381 if (g_io_channel_read(session->read_ch, buf, sizeof(buf) - 1,
383 != G_IO_ERROR_NONE || bytes_read == 0) {
384 g_warning("%s: receiving message failed.\n",
385 session->child_pid == 0 ? "child" : "parent");
392 buf[bytes_read] = '\0';
397 str = g_realloc(str, size);
400 if (str[size - 2] == '\n') {
401 str[size - 2] = '\0';
403 debug_print("session: %s: received message: %s\n",
404 session->child_pid == 0 ?
405 "child" : "parent", str);
415 gint session_start_tls(Session *session)
419 session_send_msg(session, SESSION_MSG_CONTROL, "STARTTLS");
420 ctl_msg = session_recv_msg(session);
421 if (!ctl_msg || strcmp(ctl_msg, "CONTROL STARTTLSOK") != 0) {
432 *\brief parent (child?): send data to other process
434 *\param session Contains session information
441 gint session_send_data(Session *session, const guchar *data, guint size)
444 const guchar *cur = data;
448 session_send_msg(session, SESSION_MSG_SEND_DATA, itos(size));
449 if ((msg = session_recv_msg(session)) == NULL)
454 if ((err = g_io_channel_write(session->write_ch, (guchar *)cur,
455 size, &bytes_written))
456 != G_IO_ERROR_NONE || bytes_written == 0) {
457 g_warning("%s: sending data failed: %d\n",
458 session->child_pid == 0 ? "child" : "parent",
462 size -= bytes_written;
463 cur += bytes_written;
464 debug_print("session: %s: sent %d bytes of data\n",
465 session->child_pid == 0 ? "child" : "parent",
472 gint session_recv_data(Session *session, guint size, gboolean unescape_dot)
477 g_snprintf(buf, sizeof(buf), "%d UNESCAPE", size);
478 session_send_msg(session, SESSION_MSG_RECV_DATA, buf);
480 session_send_msg(session, SESSION_MSG_RECV_DATA, itos(size));
485 *\brief child (parent?): read data from other process
487 *\param session Contains session information
490 *\return data read from session
492 static guchar *session_read_data(Session *session, guint size)
499 cur = data = g_malloc(size);
502 if ((err = g_io_channel_read(session->read_ch, cur, size,
504 != G_IO_ERROR_NONE || bytes_read == 0) {
505 g_warning("%s: reading data failed: %d\n",
506 session->child_pid == 0 ? "child" : "parent",
513 debug_print("session: %s: received %d bytes of data\n",
514 session->child_pid == 0 ? "child" : "parent",
521 #define MAX_CHUNK_SIZE 4096
524 *\brief child: Send session data to server
526 *\param session Contains session information
527 * data Data to send to server
533 static gint session_send_data_to_sock(Session *session, const guchar *data,
536 const guchar *cur = data;
538 gint total_write_len = 0;
542 struct timeval tv_prev, tv_cur;
544 gettimeofday(&tv_prev, NULL);
547 bytes_written = sock_write(session->sock, cur,
548 MIN(left, MAX_CHUNK_SIZE));
549 if (bytes_written <= 0)
551 left -= bytes_written;
552 cur += bytes_written;
553 total_write_len += bytes_written;
557 gettimeofday(&tv_cur, NULL);
558 if (tv_cur.tv_sec - tv_prev.tv_sec > 0 ||
559 tv_cur.tv_usec - tv_prev.tv_usec > UI_REFRESH_INTERVAL) {
560 g_snprintf(buf, sizeof(buf), "DATASENDINPROG %d %d",
561 total_write_len, size);
562 session_send_msg(session, SESSION_MSG_CONTROL, buf);
563 if ((msg = session_recv_msg(session)) == NULL)
566 gettimeofday(&tv_prev, NULL);
574 *\brief child: Read answer/data from server
576 *\param session Contains session information
577 * size Max bytes to receive
579 *\return Server answer
581 static guchar *session_recv_data_from_sock(Session *session, guint size)
586 gint total_read_len = 0;
590 struct timeval tv_prev, tv_cur;
592 gettimeofday(&tv_prev, NULL);
594 cur = data = g_malloc(size);
597 bytes_read = sock_read(session->sock, cur, left);
598 if (bytes_read <= 0) {
602 debug_print("session: child: "
603 "received %d bytes of data from sock\n",
607 total_read_len += bytes_read;
611 gettimeofday(&tv_cur, NULL);
612 if (tv_cur.tv_sec - tv_prev.tv_sec > 0 ||
613 tv_cur.tv_usec - tv_prev.tv_usec > UI_REFRESH_INTERVAL) {
614 g_snprintf(buf, sizeof(buf), "DATARECVINPROG %d %d",
615 total_read_len, size);
616 session_send_msg(session, SESSION_MSG_CONTROL, buf);
617 if ((msg = session_recv_msg(session)) == NULL) {
622 gettimeofday(&tv_prev, NULL);
629 static guchar *session_recv_data_from_sock_unescape(Session *session,
638 struct timeval tv_prev, tv_cur;
640 gettimeofday(&tv_prev, NULL);
642 data = g_string_sized_new(size + 1);
646 bytes_read = sock_gets(session->sock, buf, sizeof(buf));
647 if (bytes_read <= 0) {
648 g_string_free(data, TRUE);
652 if (buf[0] == '.' && buf[1] == '\r' && buf[2] == '\n')
654 if (buf[0] == '.' && buf[1] == '.')
655 g_string_append(data, buf + 1);
657 g_string_append(data, buf);
659 gettimeofday(&tv_cur, NULL);
660 if (tv_cur.tv_sec - tv_prev.tv_sec > 0 ||
661 tv_cur.tv_usec - tv_prev.tv_usec > UI_REFRESH_INTERVAL) {
662 g_snprintf(buf, sizeof(buf), "DATARECVINPROG %d %d",
663 data->len, MAX(data->len, size));
664 session_send_msg(session, SESSION_MSG_CONTROL, buf);
665 if ((msg = session_recv_msg(session)) == NULL) {
666 g_string_free(data, TRUE);
670 gettimeofday(&tv_prev, NULL);
674 ret_data = data->str;
675 *actual_size = data->len;
676 g_string_free(data, FALSE);
682 *\brief Return if message is an internal command or server data
684 *\param str Message to analyze
686 *\return Type of message
688 static SessionMsgType session_get_msg_type(const gchar *str)
690 if (!strncmp(str, "MESSAGE ", 8))
691 return SESSION_MSG_NORMAL;
692 else if (!strncmp(str, "SENDDATA ", 9))
693 return SESSION_MSG_SEND_DATA;
694 else if (!strncmp(str, "RECVDATA ", 9))
695 return SESSION_MSG_RECV_DATA;
696 else if (!strncmp(str, "CONTROL ", 8))
697 return SESSION_MSG_CONTROL;
698 else if (!strncmp(str, "ERROR ", 6))
699 return SESSION_MSG_ERROR;
701 return SESSION_MSG_UNKNOWN;
705 *\brief parent: Received data from child
707 *\param source Channel watching child pipe
708 * condition Unused (IN, HUP, OUT)
709 * data Contains session information
711 *\return FALSE to remove watching channel
713 gboolean session_parent_input_cb(GIOChannel *source, GIOCondition condition,
716 Session *session = SESSION(data);
725 if ((msg = session_recv_msg(session)) == NULL) {
726 session->state = SESSION_ERROR;
730 switch (session_get_msg_type(msg)) {
731 case SESSION_MSG_NORMAL:
732 msg_data = msg + strlen("MESSAGE ");
733 ret = session->recv_msg(session, msg_data);
734 g_print("$$$ > session_parent_input_cb(data: %lx)\n",
735 session->recv_msg_notify_data);
736 session->recv_msg_notify(session, msg_data,
737 session->recv_msg_notify_data);
738 g_print("$$$ < session_parent_input_cb(data: %lx)\n",
739 session->recv_msg_notify_data);
741 session_send_msg(session, SESSION_MSG_CONTROL,
744 session->state = SESSION_ERROR;
749 case SESSION_MSG_SEND_DATA:
750 msg_data = msg + strlen("SENDDATA ");
751 size = atoi(msg_data);
752 session_send_msg(session, SESSION_MSG_CONTROL, "ACCEPTDATA");
753 recv_data = session_read_data(session, size);
755 session->state = SESSION_ERROR;
759 ret = session->recv_data_finished(session, recv_data, size);
761 session->recv_data_notify(session, size,
762 session->recv_data_notify_data);
764 session_send_msg(session, SESSION_MSG_CONTROL,
767 session->state = SESSION_ERROR;
772 case SESSION_MSG_RECV_DATA:
774 case SESSION_MSG_CONTROL:
775 msg_data = msg + strlen("CONTROL ");
776 if (!strncmp(msg_data, "DATARECVINPROG ", 15)) {
777 ret = sscanf(msg_data,
778 "DATARECVINPROG %d %d", &len, &total);
780 g_warning("wrong control message: %s\n", msg);
781 session->state = SESSION_ERROR;
785 session_send_msg(session, SESSION_MSG_CONTROL,
787 session->recv_data_progressive_notify
788 (session, len, total,
789 session->recv_data_progressive_notify_data);
790 } else if (!strncmp(msg_data, "DATASENDINPROG ", 15)) {
791 ret = sscanf(msg_data,
792 "DATASENDINPROG %d %d", &len, &total);
794 g_warning("wrong control message: %s\n", msg);
795 session->state = SESSION_ERROR;
799 session_send_msg(session, SESSION_MSG_CONTROL,
801 session->send_data_progressive_notify
802 (session, len, total,
803 session->send_data_progressive_notify_data);
804 } else if (!strncmp(msg_data, "DATASENT ", 9)) {
805 len = atoi(msg_data + 9);
806 ret = session->send_data_finished(session, len);
807 session->send_data_notify
808 (session, len, session->send_data_notify_data);
809 } else if (!strcmp(msg_data, "DISCONNECTED")) {
810 session->state = SESSION_DISCONNECTED;
814 g_warning("wrong control message: %s\n", msg);
815 session->state = SESSION_ERROR;
820 case SESSION_MSG_ERROR:
822 g_warning("error from child: %s\n", msg + strlen("ERROR "));
823 session->state = SESSION_ERROR;
833 *\brief child: Receive control message from parent,
834 * transfer data from/to server
836 *\param session Contains session information
838 *\return TRUE if more data is available
840 gboolean session_child_input(Session *session)
851 if ((msg = session_recv_msg(session)) == NULL) {
852 session_send_msg(session, SESSION_MSG_ERROR,
853 "receiving message failed.");
854 session->state = SESSION_ERROR;
858 switch (session_get_msg_type(msg)) {
859 case SESSION_MSG_NORMAL:
860 msg_data = msg + strlen("MESSAGE ");
861 session->state = SESSION_SEND;
862 sock_puts(session->sock, msg_data);
863 session->state = SESSION_RECV;
864 str = sock_getline(session->sock);
866 session_send_msg(session, SESSION_MSG_ERROR,
867 "receiving message failed.");
868 session->state = SESSION_ERROR;
873 session_send_msg(session, SESSION_MSG_NORMAL, str);
876 case SESSION_MSG_SEND_DATA:
877 msg_data = msg + strlen("SENDDATA ");
878 size = atoi(msg_data);
879 session_send_msg(session, SESSION_MSG_CONTROL, "ACCEPTDATA");
880 send_data = session_read_data(session, size);
882 session_send_msg(session, SESSION_MSG_ERROR,
883 "sending data failed.");
884 session->state = SESSION_ERROR;
888 session->state = SESSION_SEND;
889 if (session_send_data_to_sock(session, send_data, size) < 0) {
890 session_send_msg(session, SESSION_MSG_ERROR,
891 "sending data failed.");
892 session->state = SESSION_ERROR;
898 g_snprintf(buf, sizeof(buf), "DATASENT %d", size);
899 session_send_msg(session, SESSION_MSG_CONTROL, buf);
901 case SESSION_MSG_RECV_DATA:
902 msg_data = msg + strlen("RECVDATA ");
903 size = atoi(msg_data);
904 session->state = SESSION_RECV;
905 if (strstr(msg_data, "UNESCAPE") != NULL) {
906 recv_data = session_recv_data_from_sock_unescape
907 (session, size, &actual_size);
910 recv_data = session_recv_data_from_sock(session, size);
912 session_send_msg(session, SESSION_MSG_ERROR,
913 "receiving data failed.");
914 session->state = SESSION_ERROR;
918 if (session_send_data(session, recv_data, size) < 0) {
919 session->state = SESSION_ERROR;
926 case SESSION_MSG_CONTROL:
927 msg_data = msg + strlen("CONTROL ");
928 if (!strcmp(msg_data, "CONTINUE")) {
929 session->state = SESSION_RECV;
930 str = sock_getline(session->sock);
932 session_send_msg(session, SESSION_MSG_ERROR,
933 "receiving message failed.");
934 session->state = SESSION_ERROR;
939 session_send_msg(session, SESSION_MSG_NORMAL, str);
943 } else if (!strcmp(msg_data, "STARTTLS")) {
944 if (!ssl_init_socket_with_method(session->sock,
946 session_send_msg(session, SESSION_MSG_ERROR,
947 "can't start TLS session.");
948 session->state = SESSION_ERROR;
952 session_send_msg(session, SESSION_MSG_CONTROL,
956 } else if (!strcmp(msg_data, "DISCONNECT")) {
957 sock_close(session->sock);
958 session->sock = NULL;
959 session->state = SESSION_DISCONNECTED;
960 session_send_msg(session, SESSION_MSG_CONTROL,
965 session_send_msg(session, SESSION_MSG_ERROR,
966 "wrong control message.");
967 session->state = SESSION_ERROR;
972 case SESSION_MSG_ERROR:
974 session_send_msg(session, SESSION_MSG_ERROR,
975 "error received from parent.");
976 session->state = SESSION_ERROR;