2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002-2018 Match Grun 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/>.
20 * Dialog for gathering EMail addresses from mail folder.
25 #include "claws-features.h"
31 #include <glib/gi18n.h>
32 #include <gdk/gdkkeysyms.h>
39 #include "foldersel.h"
41 #include "alertpanel.h"
42 #include "manage_window.h"
45 #include "prefs_common.h"
46 #include "prefs_gtk.h"
48 #include "addrharvest.h"
49 #ifndef USE_ALT_ADDRBOOK
50 #include "addrindex.h"
53 #include "addressbook-dbus.h"
60 #define FIELDS_N_COLS 2
61 #define FIELDS_COL_WIDTH_HEADER 100
62 #define FIELDS_COL_WIDTH_COUNT 140
64 #define MIN_FOLDER_SIZE 20
65 #define DFL_FOLDER_SIZE 50
75 static struct _AddrHarvest {
78 GtkWidget *labelFolder;
80 GtkWidget *checkHeader[ NUM_FIELDS ];
81 #ifndef USE_ALT_ADDRBOOK
82 GtkWidget *spinbtnFolder;
84 GtkWidget *checkRecurse;
92 GtkWidget *clistCount;
95 #ifndef USE_ALT_ADDRBOOK
96 static AddressIndex *_harv_addressIndex_;
97 static AddressBookFile *_harv_addressBook_;
99 static gchar *_harv_headerNames_[] = {
107 static GList *_harv_messageList_;
109 static void addrgather_dlg_status_show( gchar *msg ) {
110 if( addrgather_dlg.statusbar != NULL ) {
111 gtk_statusbar_pop( GTK_STATUSBAR(addrgather_dlg.statusbar),
112 addrgather_dlg.status_cid );
115 GTK_STATUSBAR(addrgather_dlg.statusbar),
116 addrgather_dlg.status_cid, msg );
121 static gint addrgather_dlg_delete_event(
122 GtkWidget *widget, GdkEventAny *event, gpointer data )
124 addrgather_dlg.cancelled = TRUE;
129 static gboolean addrgather_dlg_key_pressed(
130 GtkWidget *widget, GdkEventKey *event, gpointer data )
132 if( event && event->keyval == GDK_KEY_Escape ) {
133 addrgather_dlg.cancelled = TRUE;
139 static void addrgather_size_allocate(
140 GtkWidget *widget, GtkAllocation *allocation )
142 cm_return_if_fail( allocation != NULL );
144 prefs_common.addrgather_width = allocation->width;
145 prefs_common.addrgather_height = allocation->height;
148 #define FMT_BUFSIZE 32
150 static gboolean addrgather_dlg_harvest() {
152 gchar *text[ FIELDS_N_COLS ];
153 AddressHarvester *harvester;
155 #ifndef USE_ALT_ADDRBOOK
156 AddressBookFile *abf;
160 ContactData* contact;
161 GError* error = NULL;
163 gchar str[ FMT_BUFSIZE ];
166 #ifndef USE_ALT_ADDRBOOK
169 name = gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg.entryBook), 0, -1 );
170 if( name == NULL || strlen( name ) < 1 ) {
171 addrgather_dlg_status_show(
172 _( "Please specify name for address book." ) );
176 name = gtk_combo_box_get_active_text(GTK_COMBO_BOX(addrgather_dlg.entryBook));
177 if( name == NULL || strlen( name ) < 1 ) {
178 addrgather_dlg_status_show(
179 _("No available address book."));
185 /* Create harvest helper */
186 harvester = addrharvest_create();
187 addrharvest_set_path( harvester, addrgather_dlg.folderPath );
189 for( i = 0; i < NUM_FIELDS; i++ ) {
190 addrharvest_set_header( harvester, _harv_headerNames_[i],
191 gtk_toggle_button_get_active(
192 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]) ) );
194 addrharvest_set_recurse( harvester,
195 gtk_toggle_button_get_active(
196 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ) ) );
198 if( addrharvest_check_header( harvester ) == FALSE ) {
199 addrgather_dlg_status_show(
200 _( "Please select the mail headers to search." ) );
201 addrharvest_free( harvester );
207 addrgather_dlg_status_show( _( "Collecting addresses..." ) );
209 #ifndef USE_ALT_ADDRBOOK
210 sz = gtk_spin_button_get_value_as_int(
211 GTK_SPIN_BUTTON( addrgather_dlg.spinbtnFolder ) );
212 addrharvest_set_folder_size( harvester, sz );
215 #ifndef USE_ALT_ADDRBOOK
216 /* Create address book */
217 abf = addrbook_create_book();
218 addrbook_set_path( abf, _harv_addressIndex_->filePath );
219 newFile = addrbook_guess_next_file( abf );
220 addrbook_set_file( abf, newFile );
221 addrbook_set_name( abf, name );
226 /* Harvest addresses */
227 #ifndef USE_ALT_ADDRBOOK
229 harvester, abf->addressCache, _harv_messageList_ );
230 /* save address book */
231 addrbook_save_data( abf );
232 _harv_addressBook_ = abf;
235 harvester, NULL, _harv_messageList_ );
236 list = g_hash_table_get_values(harvester->dupTable);
237 for (; list; list = g_list_next(list)) {
238 contact = g_new0(ContactData, 1);
239 ContactEntry* person = (ContactEntry *) list->data;
240 if (person->first_name)
241 contact->name = g_strconcat(
242 person->first_name, " ", person->last_name, NULL);
244 contact->name = g_strdup(person->last_name);
245 if (! contact->name || strlen(contact->name) < 1)
246 contact->name = g_strdup(person->email);
247 contact->remarks = g_strdup(N_("address added by claws-mail"));
248 contact->email = g_strdup(person->email);
249 contact->book = g_strdup(name);
250 addressbook_dbus_add_contact(contact, &error);
251 contact_data_free(&contact);
257 /* Update summary count */
258 clist = GTK_CMCLIST(addrgather_dlg.clistCount);
259 gtk_cmclist_clear( clist );
260 for( i = 0; i < NUM_FIELDS; i++ ) {
261 cnt = addrharvest_get_count( harvester, _harv_headerNames_[i] );
266 sprintf( str, "%d", cnt );
268 text[ FIELD_COL_HEADER ] = _harv_headerNames_[i];
269 text[ FIELD_COL_COUNT ] = str;
270 gtk_cmclist_append( clist, text );
273 addrharvest_free( harvester );
275 addrgather_dlg_status_show(_("Addresses collected successfully."));
277 /* Display summary page */
278 gtk_notebook_set_current_page(
279 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FINISH );
280 addrgather_dlg.done = TRUE;
281 gtk_widget_set_sensitive( addrgather_dlg.btnCancel, FALSE );
282 gtk_widget_grab_default( addrgather_dlg.btnOk );
287 static void addrgather_dlg_ok( GtkWidget *widget, gpointer data ) {
288 if(addrgather_dlg.done) {
289 addrgather_dlg.done = FALSE;
293 if( addrgather_dlg_harvest() ) {
294 addrgather_dlg.cancelled = FALSE;
298 static void addrgather_dlg_cancel( GtkWidget *widget, gpointer data ) {
303 * Create notebook page for mail headers.
304 * Enter: pageNum Page number.
305 * pageLbl Page label.
307 static void addrgather_page_fields(gint pageNum, gchar *pageLbl)
313 GtkWidget *labelFolder;
314 GtkWidget *entryBook;
315 GtkWidget *frameHeader;
316 GtkWidget *checkHeader[NUM_FIELDS];
317 #ifndef USE_ALT_ADDRBOOK
319 GtkWidget *spinbtnFolder;
320 GtkAdjustment *adjFolder;
322 GtkWidget *checkRecurse;
325 #ifdef USE_ALT_ADDRBOOK
326 GError* error = NULL;
331 vbox = gtk_vbox_new(FALSE, 6);
332 gtk_container_add(GTK_CONTAINER(addrgather_dlg.notebook), vbox);
333 gtk_container_set_border_width(GTK_CONTAINER(vbox), 4);
336 label = gtk_label_new(pageLbl);
337 gtk_widget_show(label);
338 gtk_notebook_set_tab_label(GTK_NOTEBOOK(addrgather_dlg.notebook),
339 gtk_notebook_get_nth_page(GTK_NOTEBOOK(addrgather_dlg.notebook),
342 /* Upper area - Field list */
343 table = gtk_table_new(4, 2, FALSE);
344 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
345 gtk_table_set_row_spacings(GTK_TABLE(table), 4);
346 gtk_table_set_col_spacings(GTK_TABLE(table), 4);
350 label = gtk_label_new(_("Current folder:"));
351 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
352 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
354 labelFolder = gtk_label_new("");
355 gtk_table_attach( GTK_TABLE(table), labelFolder, 1, 2, top, (top + 1),
356 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
357 gtk_misc_set_alignment( GTK_MISC(labelFolder), 0, 0.5 );
361 label = gtk_label_new(_("Address book name:"));
362 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
363 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
365 #ifndef USE_ALT_ADDRBOOK
366 entryBook = gtk_entry_new();
368 books = addressbook_dbus_get_books(&error);
369 entryBook = gtk_combo_box_text_new();
371 for (cur = books; cur; cur = g_slist_next(cur)) {
372 gchar* book = (gchar *) cur->data;
373 gtk_combo_box_text_prepend_text(GTK_COMBO_BOX_TEXT(entryBook), book);
379 gtk_combo_box_text_prepend_text(GTK_COMBO_BOX_TEXT(entryBook), "");
380 gtk_combo_box_set_active(GTK_COMBO_BOX(entryBook), 0);
382 gtk_table_attach( GTK_TABLE(table), entryBook, 1, 2, top, (top + 1),
383 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
385 #ifndef USE_ALT_ADDRBOOK
388 label = gtk_label_new(_("Address book folder size:"));
389 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
390 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
392 _("Maximum amount of entries per folder within the newly created address book"));
394 hboxs = gtk_hbox_new(FALSE, 8);
395 adjFolder = GTK_ADJUSTMENT(gtk_adjustment_new(DFL_FOLDER_SIZE, MIN_FOLDER_SIZE, G_MAXINT, 1, 10, 0));
396 spinbtnFolder = gtk_spin_button_new(GTK_ADJUSTMENT(adjFolder), 1, 0);
397 gtk_box_pack_start(GTK_BOX(hboxs), spinbtnFolder, FALSE, FALSE, 0);
398 gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(spinbtnFolder), TRUE);
399 gtk_table_attach(GTK_TABLE(table), hboxs, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
400 CLAWS_SET_TIP(spinbtnFolder,
401 _("Maximum amount of entries per folder within the newly created address book"));
405 frameHeader = gtk_frame_new(_("Process these mail header fields"));
406 gtk_widget_show(frameHeader);
407 gtk_table_attach(GTK_TABLE(table), frameHeader, 0, 2, top, (top + 4), GTK_FILL, 0, 0, 0);
408 gtk_frame_set_label_align(GTK_FRAME(frameHeader), 0.01, 0.5);
411 vboxf = gtk_vbox_new(FALSE, 0);
412 gtk_widget_show(vboxf);
413 gtk_container_add(GTK_CONTAINER(frameHeader), vboxf);
414 gtk_container_set_border_width(GTK_CONTAINER(vboxf), 8);
416 for (i = 0; i < NUM_FIELDS; i++) {
417 PACK_CHECK_BUTTON(vboxf, checkHeader[i],
418 prefs_common_translated_header_name(_harv_headerNames_[i]));
419 addrgather_dlg.checkHeader[i] = checkHeader[i];
422 /* Recurse folders */
424 checkRecurse = gtk_check_button_new_with_label( _("Include subfolders" ) );
425 gtk_table_attach( GTK_TABLE(table), checkRecurse, 0, 2, top, (top + 1),
426 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
428 addrgather_dlg.labelFolder = labelFolder;
429 addrgather_dlg.entryBook = entryBook;
430 #ifndef USE_ALT_ADDRBOOK
431 addrgather_dlg.spinbtnFolder = spinbtnFolder;
433 addrgather_dlg.checkRecurse = checkRecurse;
437 * Create notebook page for summary counts.
438 * Enter: pageNum Page number.
439 * pageLbl Page label.
441 static void addrgather_page_finish( gint pageNum, gchar *pageLbl ) {
444 GtkWidget *clistSWin;
445 GtkWidget *clistCount;
446 gchar *titles[ FIELDS_N_COLS ];
448 titles[ FIELD_COL_HEADER ] = _("Header Name");
449 titles[ FIELD_COL_COUNT ] = _("Address Count");
451 vbox = gtk_vbox_new(FALSE, 8);
452 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
453 gtk_container_set_border_width( GTK_CONTAINER (vbox), 8 );
455 label = gtk_label_new( pageLbl );
456 gtk_widget_show( label );
457 gtk_notebook_set_tab_label(
458 GTK_NOTEBOOK( addrgather_dlg.notebook ),
459 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
463 clistSWin = gtk_scrolled_window_new( NULL, NULL );
464 gtk_container_add( GTK_CONTAINER(vbox), clistSWin );
465 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(clistSWin),
466 GTK_POLICY_AUTOMATIC,
467 GTK_POLICY_AUTOMATIC);
469 clistCount = gtk_cmclist_new_with_titles( FIELDS_N_COLS, titles );
470 gtk_container_add( GTK_CONTAINER(clistSWin), clistCount );
471 gtk_cmclist_set_selection_mode( GTK_CMCLIST(clistCount), GTK_SELECTION_BROWSE );
472 gtk_cmclist_set_column_width(
473 GTK_CMCLIST(clistCount), FIELD_COL_HEADER, FIELDS_COL_WIDTH_HEADER );
474 gtk_cmclist_set_column_width(
475 GTK_CMCLIST(clistCount), FIELD_COL_COUNT, FIELDS_COL_WIDTH_COUNT );
477 for( i = 0; i < FIELDS_N_COLS; i++ )
478 gtk_widget_set_can_focus(GTK_CMCLIST(clistCount)->column[i].button, FALSE);
480 addrgather_dlg.clistCount = clistCount;
484 * Create notebook page for warning message.
485 * Enter: pageNum Page number.
486 * pageLbl Page label.
488 static void addrgather_dlg_create(void)
493 GtkWidget *btnCancel;
494 GtkWidget *statusbar;
498 static GdkGeometry geometry;
500 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "addrgather");
501 gtk_container_set_border_width(GTK_CONTAINER(window), 4);
502 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
503 gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
505 g_signal_connect(G_OBJECT(window), "delete_event",
506 G_CALLBACK(addrgather_dlg_delete_event), NULL);
507 g_signal_connect(G_OBJECT(window), "key_press_event",
508 G_CALLBACK(addrgather_dlg_key_pressed), NULL);
509 g_signal_connect(G_OBJECT(window), "size_allocate",
510 G_CALLBACK(addrgather_size_allocate), NULL);
512 vbox = gtk_vbox_new(FALSE, 6);
513 gtk_container_add(GTK_CONTAINER(window), vbox);
516 notebook = gtk_notebook_new();
517 gtk_notebook_set_show_tabs(GTK_NOTEBOOK(notebook), FALSE);
518 gtk_widget_show(notebook);
519 gtk_box_pack_start(GTK_BOX(vbox), notebook, TRUE, TRUE, 0);
520 gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
523 hsbox = gtk_hbox_new(FALSE, 0);
524 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, 0);
525 statusbar = gtk_statusbar_new();
526 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, 0);
529 gtkut_stock_button_set_create(&hbbox, &btnCancel, GTK_STOCK_CANCEL,
530 &btnOk, GTK_STOCK_OK,
532 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
534 /* Signal handlers */
535 g_signal_connect(G_OBJECT(btnOk), "clicked",
536 G_CALLBACK(addrgather_dlg_ok), NULL);
537 g_signal_connect(G_OBJECT(btnCancel), "clicked",
538 G_CALLBACK(addrgather_dlg_cancel), NULL);
540 if (!geometry.min_width) {
541 geometry.min_width = 450;
542 geometry.min_height = -1;
545 gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
547 gtk_window_set_default_size(GTK_WINDOW(window), prefs_common.addrgather_width,
548 prefs_common.addrgather_height);
550 addrgather_dlg.window = window;
551 addrgather_dlg.notebook = notebook;
552 addrgather_dlg.btnOk = btnOk;
553 addrgather_dlg.btnCancel = btnCancel;
554 addrgather_dlg.statusbar = statusbar;
555 addrgather_dlg.status_cid = gtk_statusbar_get_context_id(GTK_STATUSBAR(statusbar),
556 "Collect Email Address Dialog");
558 /* Create notebook pages */
559 addrgather_page_fields(PAGE_FIELDS, _("Header Fields"));
560 addrgather_page_finish(PAGE_FINISH, _("Finish"));
561 gtk_widget_show_all(addrgather_dlg.window);
565 * Harvest addresses main window.
566 * Enter: folderItem Source folder.
567 * addrIndex Address index.
568 * sourceInd Source indicator: FALSE - Folder, TRUE - Messages.
569 * msgList List of message numbers, or NULL to process folder.
570 * Return: Populated address book file, or NULL if none created.
572 #ifndef USE_ALT_ADDRBOOK
573 AddressBookFile *addrgather_dlg_execute(FolderItem *folderItem, AddressIndex *addrIndex,
574 gboolean sourceInd, GList *msgList)
576 void addrgather_dlg_execute(FolderItem *folderItem, gboolean sourceInd, GList *msgList)
581 #ifndef USE_ALT_ADDRBOOK
582 _harv_addressIndex_ = addrIndex;
583 _harv_addressBook_ = NULL;
585 _harv_messageList_ = msgList;
588 if (!addrgather_dlg.window)
589 addrgather_dlg_create();
591 addrgather_dlg.done = FALSE;
593 gtk_notebook_set_current_page(GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FIELDS);
594 addrgather_dlg.folderPath = folder_item_get_path(folderItem);
596 /* Setup some default values */
598 gtk_label_set_text(GTK_LABEL(addrgather_dlg.labelFolder), folderItem->path);
599 #ifndef USE_ALT_ADDRBOOK
600 gtk_entry_set_text(GTK_ENTRY(addrgather_dlg.entryBook), folderItem->path);
603 for (i = 0; i < NUM_FIELDS; i++) {
604 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
606 if (g_utf8_collate(_harv_headerNames_[i], HEADER_FROM) == 0)
607 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
611 gtk_widget_set_sensitive(addrgather_dlg.btnOk, TRUE);
612 gtk_widget_set_sensitive(addrgather_dlg.btnCancel, TRUE);
613 gtk_widget_grab_default(addrgather_dlg.btnOk);
615 /* Apply window title */
617 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
618 _("Collect email addresses from selected messages"));
619 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, FALSE);
621 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
622 _("Collect email addresses from folder"));
623 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, TRUE);
625 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkRecurse), FALSE);
627 addrgather_dlg_status_show("");
628 gtk_widget_show(addrgather_dlg.window);
629 gtk_window_set_modal(GTK_WINDOW(addrgather_dlg.window), TRUE);
630 gtk_widget_grab_focus(addrgather_dlg.entryBook);
631 manage_window_set_transient(GTK_WINDOW(addrgather_dlg.window));
634 g_free(addrgather_dlg.folderPath);
635 addrgather_dlg.folderPath = NULL;
636 gtk_widget_hide(addrgather_dlg.window);
637 gtk_window_set_modal(GTK_WINDOW(addrgather_dlg.window), FALSE);
638 #ifndef USE_ALT_ADDRBOOK
639 _harv_addressIndex_ = NULL;
641 if (addrgather_dlg.cancelled == TRUE)
644 return _harv_addressBook_;