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;
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_;
110 ADDRGATHER_COL_HEADER,
111 ADDRGATHER_COL_COUNT,
115 static void addrgather_dlg_status_show( gchar *msg ) {
116 if( addrgather_dlg.statusbar != NULL ) {
117 gtk_statusbar_pop( GTK_STATUSBAR(addrgather_dlg.statusbar),
118 addrgather_dlg.status_cid );
121 GTK_STATUSBAR(addrgather_dlg.statusbar),
122 addrgather_dlg.status_cid, msg );
127 static gint addrgather_dlg_delete_event(
128 GtkWidget *widget, GdkEventAny *event, gpointer data )
130 addrgather_dlg.cancelled = TRUE;
135 static gboolean addrgather_dlg_key_pressed(
136 GtkWidget *widget, GdkEventKey *event, gpointer data )
138 if( event && event->keyval == GDK_KEY_Escape ) {
139 addrgather_dlg.cancelled = TRUE;
145 static void addrgather_size_allocate(
146 GtkWidget *widget, GtkAllocation *allocation )
148 cm_return_if_fail( allocation != NULL );
150 prefs_common.addrgather_width = allocation->width;
151 prefs_common.addrgather_height = allocation->height;
154 #define FMT_BUFSIZE 32
156 static gboolean addrgather_dlg_harvest() {
160 AddressHarvester *harvester;
162 #ifndef USE_ALT_ADDRBOOK
163 AddressBookFile *abf;
167 ContactData* contact;
168 GError* error = NULL;
170 gchar str[ FMT_BUFSIZE ];
173 #ifndef USE_ALT_ADDRBOOK
176 name = gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg.entryBook), 0, -1 );
177 if( name == NULL || strlen( name ) < 1 ) {
178 addrgather_dlg_status_show(
179 _( "Please specify name for address book." ) );
183 name = gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg.entryBook), 0, -1 );
184 if( name == NULL || strlen( name ) < 1 ) {
185 addrgather_dlg_status_show(
186 _("No available address book."));
192 /* Create harvest helper */
193 harvester = addrharvest_create();
194 addrharvest_set_path( harvester, addrgather_dlg.folderPath );
196 for( i = 0; i < NUM_FIELDS; i++ ) {
197 addrharvest_set_header( harvester, _harv_headerNames_[i],
198 gtk_toggle_button_get_active(
199 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]) ) );
201 addrharvest_set_recurse( harvester,
202 gtk_toggle_button_get_active(
203 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ) ) );
205 if( addrharvest_check_header( harvester ) == FALSE ) {
206 addrgather_dlg_status_show(
207 _( "Please select the mail headers to search." ) );
208 addrharvest_free( harvester );
214 addrgather_dlg_status_show( _( "Collecting addresses..." ) );
216 #ifndef USE_ALT_ADDRBOOK
217 sz = gtk_spin_button_get_value_as_int(
218 GTK_SPIN_BUTTON( addrgather_dlg.spinbtnFolder ) );
219 addrharvest_set_folder_size( harvester, sz );
222 #ifndef USE_ALT_ADDRBOOK
223 /* Create address book */
224 abf = addrbook_create_book();
225 addrbook_set_path( abf, _harv_addressIndex_->filePath );
226 newFile = addrbook_guess_next_file( abf );
227 addrbook_set_file( abf, newFile );
228 addrbook_set_name( abf, name );
233 /* Harvest addresses */
234 #ifndef USE_ALT_ADDRBOOK
236 harvester, abf->addressCache, _harv_messageList_ );
237 /* save address book */
238 addrbook_save_data( abf );
239 _harv_addressBook_ = abf;
242 harvester, NULL, _harv_messageList_ );
243 list = g_hash_table_get_values(harvester->dupTable);
244 for (; list; list = g_list_next(list)) {
245 contact = g_new0(ContactData, 1);
246 ContactEntry* person = (ContactEntry *) list->data;
247 if (person->first_name)
248 contact->name = g_strconcat(
249 person->first_name, " ", person->last_name, NULL);
251 contact->name = g_strdup(person->last_name);
252 if (! contact->name || strlen(contact->name) < 1)
253 contact->name = g_strdup(person->email);
254 contact->remarks = g_strdup(N_("address added by claws-mail"));
255 contact->email = g_strdup(person->email);
256 contact->book = g_strdup(name);
257 addressbook_dbus_add_contact(contact, &error);
258 contact_data_free(&contact);
264 /* Update summary count */
265 view = addrgather_dlg.viewCount;
266 model = gtk_tree_view_get_model(GTK_TREE_VIEW(view));
267 gtk_list_store_clear( GTK_LIST_STORE(model) );
268 for( i = 0; i < NUM_FIELDS; i++ ) {
269 cnt = addrharvest_get_count( harvester, _harv_headerNames_[i] );
274 snprintf( str, FMT_BUFSIZE, "%d", cnt );
276 gtk_list_store_append(GTK_LIST_STORE(model), &iter);
277 gtk_list_store_set(GTK_LIST_STORE(model), &iter,
278 ADDRGATHER_COL_HEADER, _harv_headerNames_[i],
279 ADDRGATHER_COL_COUNT, str,
283 addrharvest_free( harvester );
285 addrgather_dlg_status_show(_("Addresses collected successfully."));
287 /* Display summary page */
288 gtk_notebook_set_current_page(
289 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FINISH );
290 addrgather_dlg.done = TRUE;
291 gtk_widget_set_sensitive( addrgather_dlg.btnCancel, FALSE );
292 gtk_widget_grab_default( addrgather_dlg.btnOk );
297 static void addrgather_dlg_ok( GtkWidget *widget, gpointer data ) {
298 if(addrgather_dlg.done) {
299 addrgather_dlg.done = FALSE;
303 if( addrgather_dlg_harvest() ) {
304 addrgather_dlg.cancelled = FALSE;
308 static void addrgather_dlg_cancel( GtkWidget *widget, gpointer data ) {
313 * Create notebook page for mail headers.
314 * Enter: pageNum Page number.
315 * pageLbl Page label.
317 static void addrgather_page_fields(gint pageNum, gchar *pageLbl)
323 GtkWidget *labelFolder;
324 GtkWidget *entryBook;
325 GtkWidget *frameHeader;
326 GtkWidget *checkHeader[NUM_FIELDS];
327 #ifndef USE_ALT_ADDRBOOK
329 GtkWidget *spinbtnFolder;
330 GtkAdjustment *adjFolder;
332 GtkWidget *checkRecurse;
335 #ifdef USE_ALT_ADDRBOOK
336 GError* error = NULL;
341 vbox = gtk_vbox_new(FALSE, 6);
342 gtk_container_add(GTK_CONTAINER(addrgather_dlg.notebook), vbox);
343 gtk_container_set_border_width(GTK_CONTAINER(vbox), 4);
346 label = gtk_label_new(pageLbl);
347 gtk_widget_show(label);
348 gtk_notebook_set_tab_label(GTK_NOTEBOOK(addrgather_dlg.notebook),
349 gtk_notebook_get_nth_page(GTK_NOTEBOOK(addrgather_dlg.notebook),
352 /* Upper area - Field list */
353 table = gtk_table_new(4, 2, FALSE);
354 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
355 gtk_table_set_row_spacings(GTK_TABLE(table), 4);
356 gtk_table_set_col_spacings(GTK_TABLE(table), 4);
360 label = gtk_label_new(_("Current folder:"));
361 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
362 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
364 labelFolder = gtk_label_new("");
365 gtk_table_attach( GTK_TABLE(table), labelFolder, 1, 2, top, (top + 1),
366 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
367 gtk_misc_set_alignment( GTK_MISC(labelFolder), 0, 0.5 );
371 label = gtk_label_new(_("Address book name:"));
372 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
373 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
375 #ifndef USE_ALT_ADDRBOOK
376 entryBook = gtk_entry_new();
378 books = addressbook_dbus_get_books(&error);
379 entryBook = gtk_combo_box_text_new();
381 for (cur = books; cur; cur = g_slist_next(cur)) {
382 gchar* book = (gchar *) cur->data;
383 gtk_combo_box_text_prepend_text(GTK_COMBO_BOX_TEXT(entryBook), book);
389 gtk_combo_box_text_prepend_text(GTK_COMBO_BOX_TEXT(entryBook), "");
390 gtk_combo_box_set_active(GTK_COMBO_BOX(entryBook), 0);
392 gtk_table_attach( GTK_TABLE(table), entryBook, 1, 2, top, (top + 1),
393 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
395 #ifndef USE_ALT_ADDRBOOK
398 label = gtk_label_new(_("Address book folder size:"));
399 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
400 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
402 _("Maximum amount of entries per folder within the newly created address book"));
404 hboxs = gtk_hbox_new(FALSE, 8);
405 adjFolder = GTK_ADJUSTMENT(gtk_adjustment_new(DFL_FOLDER_SIZE, MIN_FOLDER_SIZE, G_MAXINT, 1, 10, 0));
406 spinbtnFolder = gtk_spin_button_new(GTK_ADJUSTMENT(adjFolder), 1, 0);
407 gtk_box_pack_start(GTK_BOX(hboxs), spinbtnFolder, FALSE, FALSE, 0);
408 gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(spinbtnFolder), TRUE);
409 gtk_table_attach(GTK_TABLE(table), hboxs, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
410 CLAWS_SET_TIP(spinbtnFolder,
411 _("Maximum amount of entries per folder within the newly created address book"));
415 frameHeader = gtk_frame_new(_("Process these mail header fields"));
416 gtk_widget_show(frameHeader);
417 gtk_table_attach(GTK_TABLE(table), frameHeader, 0, 2, top, (top + 4), GTK_FILL, 0, 0, 0);
418 gtk_frame_set_label_align(GTK_FRAME(frameHeader), 0.01, 0.5);
421 vboxf = gtk_vbox_new(FALSE, 0);
422 gtk_widget_show(vboxf);
423 gtk_container_add(GTK_CONTAINER(frameHeader), vboxf);
424 gtk_container_set_border_width(GTK_CONTAINER(vboxf), 8);
426 for (i = 0; i < NUM_FIELDS; i++) {
427 PACK_CHECK_BUTTON(vboxf, checkHeader[i],
428 prefs_common_translated_header_name(_harv_headerNames_[i]));
429 addrgather_dlg.checkHeader[i] = checkHeader[i];
432 /* Recurse folders */
434 checkRecurse = gtk_check_button_new_with_label( _("Include subfolders" ) );
435 gtk_table_attach( GTK_TABLE(table), checkRecurse, 0, 2, top, (top + 1),
436 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
438 addrgather_dlg.labelFolder = labelFolder;
439 addrgather_dlg.entryBook = entryBook;
440 #ifndef USE_ALT_ADDRBOOK
441 addrgather_dlg.spinbtnFolder = spinbtnFolder;
443 addrgather_dlg.checkRecurse = checkRecurse;
447 * Create notebook page for summary counts.
448 * Enter: pageNum Page number.
449 * pageLbl Page label.
451 static void addrgather_page_finish( gint pageNum, gchar *pageLbl ) {
454 GtkWidget *scrollwin;
455 GtkWidget *viewCount;
456 GtkTreeViewColumn *col;
457 GtkCellRenderer *rdr;
458 GtkTreeSelection *sel;
461 vbox = gtk_vbox_new(FALSE, 8);
462 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
463 gtk_container_set_border_width( GTK_CONTAINER (vbox), 8 );
465 label = gtk_label_new( pageLbl );
466 gtk_widget_show( label );
467 gtk_notebook_set_tab_label(
468 GTK_NOTEBOOK( addrgather_dlg.notebook ),
469 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
473 scrollwin = gtk_scrolled_window_new( NULL, NULL );
474 gtk_container_add( GTK_CONTAINER(vbox), scrollwin );
475 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrollwin),
476 GTK_POLICY_AUTOMATIC,
477 GTK_POLICY_AUTOMATIC);
480 model = GTK_TREE_MODEL(gtk_list_store_new(N_ADDRGATHER_COLS,
481 G_TYPE_STRING, G_TYPE_STRING, -1));
483 viewCount = gtk_tree_view_new_with_model(GTK_TREE_MODEL(model));
484 g_object_unref(model);
485 gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(viewCount), TRUE);
486 gtk_tree_view_set_reorderable(GTK_TREE_VIEW(viewCount), FALSE);
487 sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(viewCount));
488 gtk_tree_selection_set_mode(sel, GTK_SELECTION_NONE);
490 /* Columns for the treeview */
491 rdr = gtk_cell_renderer_text_new();
492 col = gtk_tree_view_column_new_with_attributes(_("Header Name"), rdr,
493 "markup", ADDRGATHER_COL_HEADER,
495 gtk_tree_view_column_set_min_width(col, FIELDS_COL_WIDTH_HEADER);
496 gtk_tree_view_append_column(GTK_TREE_VIEW(viewCount), col);
498 col = gtk_tree_view_column_new_with_attributes(_("Address Count"), rdr,
499 "text", ADDRGATHER_COL_COUNT,
501 gtk_tree_view_column_set_min_width(col, FIELDS_COL_WIDTH_COUNT);
502 gtk_tree_view_append_column(GTK_TREE_VIEW(viewCount), col);
504 gtk_container_add( GTK_CONTAINER(scrollwin), viewCount );
506 addrgather_dlg.viewCount = viewCount;
510 * Create notebook page for warning message.
511 * Enter: pageNum Page number.
512 * pageLbl Page label.
514 static void addrgather_dlg_create(void)
519 GtkWidget *btnCancel;
520 GtkWidget *statusbar;
524 static GdkGeometry geometry;
526 window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "addrgather");
527 gtk_container_set_border_width(GTK_CONTAINER(window), 4);
528 gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
529 gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
531 g_signal_connect(G_OBJECT(window), "delete_event",
532 G_CALLBACK(addrgather_dlg_delete_event), NULL);
533 g_signal_connect(G_OBJECT(window), "key_press_event",
534 G_CALLBACK(addrgather_dlg_key_pressed), NULL);
535 g_signal_connect(G_OBJECT(window), "size_allocate",
536 G_CALLBACK(addrgather_size_allocate), NULL);
538 vbox = gtk_vbox_new(FALSE, 6);
539 gtk_container_add(GTK_CONTAINER(window), vbox);
542 notebook = gtk_notebook_new();
543 gtk_notebook_set_show_tabs(GTK_NOTEBOOK(notebook), FALSE);
544 gtk_widget_show(notebook);
545 gtk_box_pack_start(GTK_BOX(vbox), notebook, TRUE, TRUE, 0);
546 gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
549 hsbox = gtk_hbox_new(FALSE, 0);
550 gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, 0);
551 statusbar = gtk_statusbar_new();
552 gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, 0);
555 gtkut_stock_button_set_create(&hbbox, &btnCancel, GTK_STOCK_CANCEL,
556 &btnOk, GTK_STOCK_OK,
558 gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
560 /* Signal handlers */
561 g_signal_connect(G_OBJECT(btnOk), "clicked",
562 G_CALLBACK(addrgather_dlg_ok), NULL);
563 g_signal_connect(G_OBJECT(btnCancel), "clicked",
564 G_CALLBACK(addrgather_dlg_cancel), NULL);
566 if (!geometry.min_width) {
567 geometry.min_width = 450;
568 geometry.min_height = -1;
571 gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
573 gtk_window_set_default_size(GTK_WINDOW(window), prefs_common.addrgather_width,
574 prefs_common.addrgather_height);
576 addrgather_dlg.window = window;
577 addrgather_dlg.notebook = notebook;
578 addrgather_dlg.btnOk = btnOk;
579 addrgather_dlg.btnCancel = btnCancel;
580 addrgather_dlg.statusbar = statusbar;
581 addrgather_dlg.status_cid = gtk_statusbar_get_context_id(GTK_STATUSBAR(statusbar),
582 "Collect Email Address Dialog");
584 /* Create notebook pages */
585 addrgather_page_fields(PAGE_FIELDS, _("Header Fields"));
586 addrgather_page_finish(PAGE_FINISH, _("Finish"));
587 gtk_widget_show_all(addrgather_dlg.window);
591 * Harvest addresses main window.
592 * Enter: folderItem Source folder.
593 * addrIndex Address index.
594 * sourceInd Source indicator: FALSE - Folder, TRUE - Messages.
595 * msgList List of message numbers, or NULL to process folder.
596 * Return: Populated address book file, or NULL if none created.
598 #ifndef USE_ALT_ADDRBOOK
599 AddressBookFile *addrgather_dlg_execute(FolderItem *folderItem, AddressIndex *addrIndex,
600 gboolean sourceInd, GList *msgList)
602 void addrgather_dlg_execute(FolderItem *folderItem, gboolean sourceInd, GList *msgList)
607 #ifndef USE_ALT_ADDRBOOK
608 _harv_addressIndex_ = addrIndex;
609 _harv_addressBook_ = NULL;
611 _harv_messageList_ = msgList;
614 if (!addrgather_dlg.window)
615 addrgather_dlg_create();
617 addrgather_dlg.done = FALSE;
619 gtk_notebook_set_current_page(GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FIELDS);
620 addrgather_dlg.folderPath = folder_item_get_path(folderItem);
622 /* Setup some default values */
624 gtk_label_set_text(GTK_LABEL(addrgather_dlg.labelFolder), folderItem->path);
625 #ifndef USE_ALT_ADDRBOOK
626 gtk_entry_set_text(GTK_ENTRY(addrgather_dlg.entryBook), folderItem->path);
629 for (i = 0; i < NUM_FIELDS; i++) {
630 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
632 if (g_utf8_collate(_harv_headerNames_[i], HEADER_FROM) == 0)
633 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
637 gtk_widget_set_sensitive(addrgather_dlg.btnOk, TRUE);
638 gtk_widget_set_sensitive(addrgather_dlg.btnCancel, TRUE);
639 gtk_widget_grab_default(addrgather_dlg.btnOk);
641 /* Apply window title */
643 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
644 _("Collect email addresses from selected messages"));
645 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, FALSE);
647 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
648 _("Collect email addresses from folder"));
649 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, TRUE);
651 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkRecurse), FALSE);
653 addrgather_dlg_status_show("");
654 gtk_widget_show(addrgather_dlg.window);
655 gtk_window_set_modal(GTK_WINDOW(addrgather_dlg.window), TRUE);
656 gtk_widget_grab_focus(addrgather_dlg.entryBook);
657 manage_window_set_transient(GTK_WINDOW(addrgather_dlg.window));
660 g_free(addrgather_dlg.folderPath);
661 addrgather_dlg.folderPath = NULL;
662 gtk_widget_hide(addrgather_dlg.window);
663 gtk_window_set_modal(GTK_WINDOW(addrgather_dlg.window), FALSE);
664 #ifndef USE_ALT_ADDRBOOK
665 _harv_addressIndex_ = NULL;
667 if (addrgather_dlg.cancelled == TRUE)
670 return _harv_addressBook_;