2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2005-2016 DINH Viet Hoa 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/>.
21 #include "claws-features.h"
27 #include <glib/gi18n.h>
28 #include "nntp-thread.h"
30 #include <sys/types.h>
32 #if (defined(__DragonFly__) || defined (__NetBSD__) || defined (__FreeBSD__) || defined (__OpenBSD__) || defined (__CYGWIN__))
33 #include <sys/socket.h>
42 #include "etpan-thread-manager.h"
43 #include "etpan-ssl.h"
45 #include "mainwindow.h"
46 #include "ssl_certificate.h"
48 #include "remotefolder.h"
51 #include "statusbar.h"
53 #define DISABLE_LOG_DURING_LOGIN
55 #define NNTP_BATCH_SIZE 5000
57 static struct etpan_thread_manager * thread_manager = NULL;
58 static chash * nntp_hash = NULL;
59 static chash * session_hash = NULL;
60 static guint thread_manager_signal = 0;
61 static GIOChannel * io_channel = NULL;
63 static int do_newsnntp_socket_connect(newsnntp * imap, const char * server,
64 gushort port, ProxyInfo * proxy_info)
70 return newsnntp_socket_connect(imap, server, port);
75 sock = sock_connect(proxy_info->proxy_host, proxy_info->proxy_port);
78 return NEWSNNTP_ERROR_CONNECTION_REFUSED;
80 if (proxy_connect(sock, server, port, proxy_info) < 0) {
82 return NEWSNNTP_ERROR_CONNECTION_REFUSED;
85 stream = mailstream_socket_open_timeout(sock->sock,
89 return NEWSNNTP_ERROR_MEMORY;
92 return newsnntp_connect(imap, stream);
95 static int do_newsnntp_ssl_connect_with_callback(newsnntp * imap, const char * server,
97 void (* callback)(struct mailstream_ssl_context * ssl_context, void * data),
99 ProxyInfo *proxy_info)
105 return newsnntp_ssl_connect_with_callback(imap, server,
106 port, callback, data);
111 sock = sock_connect(proxy_info->proxy_host, proxy_info->proxy_port);
114 return NEWSNNTP_ERROR_CONNECTION_REFUSED;
116 if (proxy_connect(sock, server, port, proxy_info) < 0) {
118 return NEWSNNTP_ERROR_CONNECTION_REFUSED;
121 stream = mailstream_ssl_open_with_callback_timeout(sock->sock,
122 imap->nntp_timeout, callback, data);
123 if (stream == NULL) {
125 return NEWSNNTP_ERROR_SSL;
128 return newsnntp_connect(imap, stream);
132 static void nntp_logger(int direction, const char * str, size_t size)
139 log_print(LOG_PROTOCOL, "NNTP%c [data - %"G_GSIZE_FORMAT" bytes]\n", direction?'>':'<', size);
142 buf = malloc(size+1);
143 memset(buf, 0, size+1);
144 strncpy(buf, str, size);
147 if (!strncmp(buf, "<<<<<<<", 7)
148 || !strncmp(buf, ">>>>>>>", 7)) {
152 while (strstr(buf, "\r"))
153 *strstr(buf, "\r") = ' ';
154 while (strlen(buf) > 0 && buf[strlen(buf)-1] == '\n')
155 buf[strlen(buf)-1] = '\0';
157 lines = g_strsplit(buf, "\n", -1);
159 while (lines[i] && *lines[i]) {
160 log_print(LOG_PROTOCOL, "NNTP%c %s\n", direction?'>':'<', lines[i]);
167 static void delete_nntp(Folder *folder, newsnntp *nntp)
172 key.len = sizeof(folder);
173 chash_delete(session_hash, &key, NULL);
176 key.len = sizeof(nntp);
177 if (nntp && nntp->nntp_stream) {
178 /* we don't want libetpan to logout */
179 mailstream_close(nntp->nntp_stream);
180 nntp->nntp_stream = NULL;
182 debug_print("removing newsnntp %p\n", nntp);
186 static gboolean thread_manager_event(GIOChannel * source,
187 GIOCondition condition,
194 if (condition & G_IO_IN)
195 g_io_channel_read_chars(source, &ch, 1, &bytes_read, NULL);
197 etpan_thread_manager_loop(thread_manager);
202 #define ETPAN_DEFAULT_NETWORK_TIMEOUT 60
203 extern gboolean etpan_skip_ssl_cert_check;
205 void nntp_main_init(gboolean skip_ssl_cert_check)
207 int fd_thread_manager;
209 etpan_skip_ssl_cert_check = skip_ssl_cert_check;
211 nntp_hash = chash_new(CHASH_COPYKEY, CHASH_DEFAULTSIZE);
212 session_hash = chash_new(CHASH_COPYKEY, CHASH_DEFAULTSIZE);
214 thread_manager = etpan_thread_manager_new();
216 fd_thread_manager = etpan_thread_manager_get_fd(thread_manager);
219 io_channel = g_io_channel_unix_new(fd_thread_manager);
221 io_channel = g_io_channel_win32_new_fd(fd_thread_manager);
224 thread_manager_signal = g_io_add_watch_full(io_channel, 0, G_IO_IN,
225 thread_manager_event,
230 void nntp_main_done(gboolean have_connectivity)
232 nntp_disconnect_all(have_connectivity);
233 etpan_thread_manager_stop(thread_manager);
234 #if defined(__NetBSD__) || defined(__OpenBSD__) || defined(__FreeBSD__)
237 etpan_thread_manager_join(thread_manager);
239 g_source_remove(thread_manager_signal);
240 g_io_channel_unref(io_channel);
242 etpan_thread_manager_free(thread_manager);
244 chash_free(session_hash);
245 chash_free(nntp_hash);
248 void nntp_init(Folder * folder)
250 struct etpan_thread * thread;
254 thread = etpan_thread_manager_get_thread(thread_manager);
257 key.len = sizeof(folder);
261 chash_set(nntp_hash, &key, &value, NULL);
264 void nntp_done(Folder * folder)
266 struct etpan_thread * thread;
272 key.len = sizeof(folder);
274 r = chash_get(nntp_hash, &key, &value);
280 etpan_thread_unbind(thread);
282 chash_delete(nntp_hash, &key, NULL);
284 debug_print("remove thread\n");
287 static struct etpan_thread * get_thread(Folder * folder)
289 struct etpan_thread * thread;
295 key.len = sizeof(folder);
297 r = chash_get(nntp_hash, &key, &value);
306 static newsnntp * get_nntp(Folder * folder)
314 key.len = sizeof(folder);
316 r = chash_get(session_hash, &key, &value);
321 debug_print("found nntp %p\n", nntp);
326 static void generic_cb(int cancelled, void * result, void * callback_data)
328 struct etpan_thread_op * op;
330 op = (struct etpan_thread_op *) callback_data;
332 debug_print("generic_cb\n");
336 static void threaded_run(Folder * folder, void * param, void * result,
337 void (* func)(struct etpan_thread_op * ))
339 struct etpan_thread_op * op;
340 struct etpan_thread * thread;
341 void (*previous_stream_logger)(int direction,
342 const char * str, size_t size);
344 nntp_folder_ref(folder);
346 op = etpan_thread_op_new();
348 op->nntp = get_nntp(folder);
353 op->callback = generic_cb;
354 op->callback_data = op;
356 previous_stream_logger = mailstream_logger;
357 mailstream_logger = nntp_logger;
359 thread = get_thread(folder);
360 etpan_thread_op_schedule(thread, op);
362 while (!op->finished) {
363 gtk_main_iteration();
366 mailstream_logger = previous_stream_logger;
368 etpan_thread_op_free(op);
370 nntp_folder_unref(folder);
376 struct connect_param {
378 PrefsAccount *account;
381 ProxyInfo * proxy_info;
384 struct connect_result {
388 #define CHECK_NNTP() { \
389 if (!param->nntp) { \
390 result->error = NEWSNNTP_ERROR_BAD_STATE; \
395 static void connect_run(struct etpan_thread_op * op)
398 struct connect_param * param;
399 struct connect_result * result;
406 r = do_newsnntp_socket_connect(param->nntp,
407 param->server, param->port,
414 int nntp_threaded_connect(Folder * folder, const char * server, int port, ProxyInfo *proxy_info)
416 struct connect_param param;
417 struct connect_result result;
420 newsnntp * nntp, * oldnntp;
422 oldnntp = get_nntp(folder);
424 nntp = newsnntp_new(0, NULL);
427 debug_print("deleting old nntp %p\n", oldnntp);
428 delete_nntp(folder, oldnntp);
432 key.len = sizeof(folder);
435 chash_set(session_hash, &key, &value, NULL);
438 param.server = server;
440 param.proxy_info = proxy_info;
443 threaded_run(folder, ¶m, &result, connect_run);
445 debug_print("connect ok %i with nntp %p\n", result.error, nntp);
450 static void connect_ssl_run(struct etpan_thread_op * op)
453 struct connect_param * param;
454 struct connect_result * result;
461 r = do_newsnntp_ssl_connect_with_callback(param->nntp,
462 param->server, param->port,
463 etpan_connect_ssl_context_cb, param->account,
468 int nntp_threaded_connect_ssl(Folder * folder, const char * server, int port, ProxyInfo *proxy_info)
470 struct connect_param param;
471 struct connect_result result;
474 newsnntp * nntp, * oldnntp;
475 gboolean accept_if_valid = FALSE;
477 oldnntp = get_nntp(folder);
479 nntp = newsnntp_new(0, NULL);
482 debug_print("deleting old nntp %p\n", oldnntp);
483 delete_nntp(folder, oldnntp);
487 key.len = sizeof(folder);
490 chash_set(session_hash, &key, &value, NULL);
493 param.server = server;
495 param.account = folder->account;
496 param.proxy_info = proxy_info;
499 accept_if_valid = folder->account->ssl_certs_auto_accept;
502 threaded_run(folder, ¶m, &result, connect_ssl_run);
504 if (result.error == NEWSNNTP_NO_ERROR && !etpan_skip_ssl_cert_check) {
505 if (etpan_certificate_check(nntp->nntp_stream, server, port,
506 accept_if_valid) != TRUE)
509 debug_print("connect %d with nntp %p\n", result.error, nntp);
515 void nntp_threaded_disconnect(Folder * folder)
519 nntp = get_nntp(folder);
521 debug_print("was disconnected\n");
525 debug_print("deleting old nntp %p\n", nntp);
526 delete_nntp(folder, nntp);
528 debug_print("disconnect ok\n");
531 void nntp_threaded_cancel(Folder * folder)
535 nntp = get_nntp(folder);
536 if (nntp->nntp_stream != NULL)
537 mailstream_cancel(nntp->nntp_stream);
544 const char * password;
547 struct login_result {
551 static void login_run(struct etpan_thread_op * op)
553 struct login_param * param;
554 struct login_result * result;
556 #ifdef DISABLE_LOG_DURING_LOGIN
565 #ifdef DISABLE_LOG_DURING_LOGIN
566 old_debug = mailstream_debug;
567 mailstream_debug = 0;
570 r = newsnntp_authinfo_username(param->nntp, param->login);
571 /* libetpan returning NO_ERROR means it received resp.code 281:
572 in this case auth. is already successful, no password is needed. */
573 if (r == NEWSNNTP_WARNING_REQUEST_AUTHORIZATION_PASSWORD) {
574 r = newsnntp_authinfo_password(param->nntp, param->password);
579 #ifdef DISABLE_LOG_DURING_LOGIN
580 mailstream_debug = old_debug;
584 if (param->nntp->nntp_response)
585 nntp_logger(0, param->nntp->nntp_response, strlen(param->nntp->nntp_response));
587 debug_print("nntp login run - end %i\n", r);
590 int nntp_threaded_login(Folder * folder, const char * login, const char * password)
592 struct login_param param;
593 struct login_result result;
595 debug_print("nntp login - begin\n");
597 param.nntp = get_nntp(folder);
599 param.password = password;
601 threaded_run(folder, ¶m, &result, login_run);
603 debug_print("nntp login - end\n");
617 static void date_run(struct etpan_thread_op * op)
619 struct date_param * param;
620 struct date_result * result;
628 r = newsnntp_date(param->nntp, param->lt);
631 debug_print("nntp date run - end %i\n", r);
634 int nntp_threaded_date(Folder * folder, struct tm *lt)
636 struct date_param param;
637 struct date_result result;
639 debug_print("nntp date - begin\n");
641 param.nntp = get_nntp(folder);
644 threaded_run(folder, ¶m, &result, date_run);
646 debug_print("nntp date - end\n");
660 static void list_run(struct etpan_thread_op * op)
662 struct list_param * param;
663 struct list_result * result;
671 r = newsnntp_list(param->nntp, param->grouplist);
674 debug_print("nntp list run - end %i\n", r);
677 int nntp_threaded_list(Folder * folder, clist **grouplist)
679 struct list_param param;
680 struct list_result result;
682 debug_print("nntp list - begin\n");
684 param.nntp = get_nntp(folder);
685 param.grouplist = grouplist;
687 threaded_run(folder, ¶m, &result, list_run);
689 debug_print("nntp list - end\n");
704 static void post_run(struct etpan_thread_op * op)
706 struct post_param * param;
707 struct post_result * result;
715 r = newsnntp_post(param->nntp, param->contents, param->len);
718 debug_print("nntp post run - end %i\n", r);
721 int nntp_threaded_post(Folder * folder, char *contents, size_t len)
723 struct post_param param;
724 struct post_result result;
726 debug_print("nntp post - begin\n");
728 param.nntp = get_nntp(folder);
729 param.contents = contents;
732 threaded_run(folder, ¶m, &result, post_run);
734 debug_print("nntp post - end\n");
739 struct article_param {
746 struct article_result {
750 static void article_run(struct etpan_thread_op * op)
752 struct article_param * param;
753 struct article_result * result;
761 r = newsnntp_article(param->nntp, param->num, param->contents, param->len);
764 debug_print("nntp article run - end %i\n", r);
767 int nntp_threaded_article(Folder * folder, guint32 num, char **contents, size_t *len)
769 struct article_param param;
770 struct article_result result;
772 debug_print("nntp article - begin\n");
774 param.nntp = get_nntp(folder);
776 param.contents = contents;
779 threaded_run(folder, ¶m, &result, article_run);
781 debug_print("nntp article - end\n");
789 struct newsnntp_group_info **info;
792 struct group_result {
796 static void group_run(struct etpan_thread_op * op)
798 struct group_param * param;
799 struct group_result * result;
807 r = newsnntp_group(param->nntp, param->group, param->info);
810 debug_print("nntp group run - end %i\n", r);
813 int nntp_threaded_group(Folder * folder, const char *group, struct newsnntp_group_info **info)
815 struct group_param param;
816 struct group_result result;
818 debug_print("nntp group - begin\n");
820 param.nntp = get_nntp(folder);
824 threaded_run(folder, ¶m, &result, group_run);
826 debug_print("nntp group - end\n");
831 struct mode_reader_param {
835 struct mode_reader_result {
839 static void mode_reader_run(struct etpan_thread_op * op)
841 struct mode_reader_param * param;
842 struct mode_reader_result * result;
850 r = newsnntp_mode_reader(param->nntp);
853 debug_print("nntp mode_reader run - end %i\n", r);
856 int nntp_threaded_mode_reader(Folder * folder)
858 struct mode_reader_param param;
859 struct mode_reader_result result;
861 debug_print("nntp mode_reader - begin\n");
863 param.nntp = get_nntp(folder);
865 threaded_run(folder, ¶m, &result, mode_reader_run);
867 debug_print("nntp mode_reader - end\n");
876 struct newsnntp_xover_resp_item **result;
880 struct xover_result {
884 static void xover_run(struct etpan_thread_op * op)
886 struct xover_param * param;
887 struct xover_result * result;
896 r = newsnntp_xover_single(param->nntp, param->beg, param->result);
898 r = newsnntp_xover_range(param->nntp, param->beg, param->end, param->msglist);
902 debug_print("nntp xover run %d-%d - end %i\n",
903 param->beg, param->end, r);
906 int nntp_threaded_xover(Folder * folder, guint32 beg, guint32 end, struct newsnntp_xover_resp_item **single_result, clist **multiple_result)
908 struct xover_param param;
909 struct xover_result result;
910 clist *l = NULL, *h = NULL;
911 guint32 cbeg = 0, cend = 0;
913 debug_print("nntp xover - begin (%d-%d)\n", beg, end);
917 /* Request the overview in batches of NNTP_BATCH_SIZE, to prevent
918 * long stalls or libetpan choking on too large server response,
919 * and to allow updating any progress indicators while we work. */
921 while (cbeg <= end && cend <= end) {
922 cend = cbeg + (NNTP_BATCH_SIZE - 1);
926 statusbar_progress_all(cbeg - beg, end - beg, 1);
929 param.nntp = get_nntp(folder);
932 param.result = single_result;
935 threaded_run(folder, ¶m, &result, xover_run);
938 if (result.error != NEWSNNTP_NO_ERROR) {
939 log_warning(LOG_PROTOCOL, _("couldn't get xover range\n"));
940 debug_print("couldn't get xover for %d-%d\n", cbeg, cend);
942 newsnntp_xover_resp_list_free(l);
943 newsnntp_xover_resp_list_free(h);
944 statusbar_progress_all(0, 0, 0);
948 /* Append the new data (l) to list of results (h). */
950 debug_print("total items so far %d, items this batch %d\n",
951 clist_count(h), clist_count(l));
957 cbeg += NNTP_BATCH_SIZE;
960 statusbar_progress_all(0, 0, 0);
962 debug_print("nntp xover - end\n");
964 *multiple_result = h;
981 static void xhdr_run(struct etpan_thread_op * op)
983 struct xhdr_param * param;
984 struct xhdr_result * result;
992 if (param->beg == param->end) {
993 r = newsnntp_xhdr_single(param->nntp, param->header, param->beg, param->hdrlist);
995 r = newsnntp_xhdr_range(param->nntp, param->header, param->beg, param->end, param->hdrlist);
999 debug_print("nntp xhdr '%s %d-%d' run - end %i\n",
1000 param->header, param->beg, param->end, r);
1003 int nntp_threaded_xhdr(Folder * folder, const char *header, guint32 beg, guint32 end, clist **hdrlist)
1005 struct xhdr_param param;
1006 struct xhdr_result result;
1008 clist *h = *hdrlist;
1009 guint32 cbeg = 0, cend = 0;
1011 debug_print("nntp xhdr %s - begin (%d-%d)\n", header, beg, end);
1016 /* Request the headers in batches of NNTP_BATCH_SIZE, to prevent
1017 * long stalls or libetpan choking on too large server response,
1018 * and to allow updating any progress indicators while we work. */
1020 while (cbeg <= end && cend <= end) {
1021 cend = cbeg + NNTP_BATCH_SIZE - 1;
1025 statusbar_progress_all(cbeg - beg, end - beg, 1);
1028 param.nntp = get_nntp(folder);
1029 param.header = header;
1034 threaded_run(folder, ¶m, &result, xhdr_run);
1037 if (result.error != NEWSNNTP_NO_ERROR) {
1038 log_warning(LOG_PROTOCOL, _("couldn't get xhdr range\n"));
1039 debug_print("couldn't get xhdr %s %d-%d\n", header, cbeg, cend);
1041 newsnntp_xhdr_free(l);
1042 newsnntp_xhdr_free(h);
1043 statusbar_progress_all(0, 0, 0);
1044 return result.error;
1047 /* Append the new data (l) to list of results (h). */
1049 debug_print("total items so far %d, items this batch %d\n",
1050 clist_count(h), clist_count(l));
1056 cbeg += NNTP_BATCH_SIZE;
1059 statusbar_progress_all(0, 0, 0);
1061 debug_print("nntp xhdr %s - end (%d-%d)\n", header, beg, end);
1065 return result.error;
1068 void nntp_main_set_timeout(int sec)
1070 mailstream_network_delay.tv_sec = sec;
1071 mailstream_network_delay.tv_usec = 0;
1076 void nntp_main_init(void)
1079 void nntp_main_done(gboolean have_connectivity)
1082 void nntp_main_set_timeout(int sec)
1086 void nntp_threaded_cancel(Folder * folder);