2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002 Match Grun
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.
21 * Dialog for gathering EMail addresses from mail folder.
31 #include <gdk/gdkkeysyms.h>
32 #include <gtk/gtkmain.h>
33 #include <gtk/gtkwidget.h>
34 #include <gtk/gtkwindow.h>
35 #include <gtk/gtkvbox.h>
36 #include <gtk/gtktable.h>
37 #include <gtk/gtklabel.h>
38 #include <gtk/gtkentry.h>
39 #include <gtk/gtkhbbox.h>
40 #include <gtk/gtkbutton.h>
41 #include <gtk/gtkfilesel.h>
42 #include <gtk/gtksignal.h>
49 #include "foldersel.h"
51 #include "alertpanel.h"
52 #include "manage_window.h"
56 #include "addrharvest.h"
57 #include "addrindex.h"
60 #define PAGE_WARNING 0
66 #define FIELDS_N_COLS 2
67 #define FIELDS_COL_WIDTH_HEADER 100
68 #define FIELDS_COL_WIDTH_COUNT 140
70 #define MIN_FOLDER_SIZE 20
71 #define DFL_FOLDER_SIZE 50
81 static struct _AddrHarvest {
84 GtkWidget *labelFolder;
86 GtkWidget *checkHeader[ NUM_FIELDS ];
87 GtkWidget *spinbtnFolder;
88 GtkWidget *checkRecurse;
95 GtkWidget *clistCount;
98 static AddressIndex *_harv_addressIndex_;
99 static AddressBookFile *_harv_addressBook_;
100 static gchar *_harv_headerNames_[] = {
108 static GList *_harv_messageList_;
110 void addrgather_dlg_status_show( gchar *msg ) {
111 if( addrgather_dlg.statusbar != NULL ) {
112 gtk_statusbar_pop( GTK_STATUSBAR(addrgather_dlg.statusbar),
113 addrgather_dlg.status_cid );
116 GTK_STATUSBAR(addrgather_dlg.statusbar),
117 addrgather_dlg.status_cid, msg );
122 static gint addrgather_dlg_delete_event(
123 GtkWidget *widget, GdkEventAny *event, gpointer data )
125 addrgather_dlg.cancelled = TRUE;
130 static gboolean addrgather_dlg_key_pressed(
131 GtkWidget *widget, GdkEventKey *event, gpointer data )
133 if( event && event->keyval == GDK_Escape ) {
134 addrgather_dlg.cancelled = TRUE;
140 #define FMT_BUFSIZE 32
142 static gboolean addrgather_dlg_harvest() {
144 gchar *text[ FIELDS_N_COLS ];
145 AddressHarvester *harvester;
146 AddressBookFile *abf;
149 gchar str[ FMT_BUFSIZE ];
154 name = gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg.entryBook), 0, -1 );
155 if( name == NULL || strlen( name ) < 1 ) {
156 addrgather_dlg_status_show(
157 _( "Please specify name for address book." ) );
162 /* Create harvest helper */
163 harvester = addrharvest_create();
164 addrharvest_set_path( harvester, addrgather_dlg.folderPath );
166 for( i = 0; i < NUM_FIELDS; i++ ) {
167 addrharvest_set_header( harvester, _harv_headerNames_[i],
168 gtk_toggle_button_get_active(
169 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]) ) );
171 addrharvest_set_recurse( harvester,
172 gtk_toggle_button_get_active(
173 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ) ) );
175 if( addrharvest_check_header( harvester ) == FALSE ) {
176 addrgather_dlg_status_show(
177 _( "Please select the mail headers to search." ) );
178 addrharvest_free( harvester );
184 addrgather_dlg_status_show( _( "Busy harvesting addresses..." ) );
185 sz = gtk_spin_button_get_value_as_int(
186 GTK_SPIN_BUTTON( addrgather_dlg.spinbtnFolder ) );
187 addrharvest_set_folder_size( harvester, sz );
189 /* Create address book */
190 abf = addrbook_create_book();
191 addrbook_set_path( abf, _harv_addressIndex_->filePath );
192 newFile = addrbook_guess_next_file( abf );
193 addrbook_set_file( abf, newFile );
194 addrbook_set_name( abf, name );
198 /* Harvest addresses */
200 harvester, abf->addressCache, _harv_messageList_ );
201 addrbook_save_data( abf );
202 _harv_addressBook_ = abf;
204 /* Update summary count */
205 clist = GTK_CLIST(addrgather_dlg.clistCount);
206 gtk_clist_clear( clist );
207 for( i = 0; i < NUM_FIELDS; i++ ) {
208 cnt = addrharvest_get_count( harvester, _harv_headerNames_[i] );
213 sprintf( str, "%d", cnt );
215 text[ FIELD_COL_HEADER ] = _harv_headerNames_[i];
216 text[ FIELD_COL_COUNT ] = str;
217 gtk_clist_append( clist, text );
220 addrharvest_free( harvester );
222 addrgather_dlg_status_show( _("Addresses gathered successfully.") );
224 /* Display summary page */
225 gtk_notebook_set_page(
226 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FINISH );
227 gtk_widget_set_sensitive( addrgather_dlg.btnOk, FALSE );
228 gtk_widget_grab_default( addrgather_dlg.btnCancel );
233 static void addrgather_dlg_ok( GtkWidget *widget, gpointer data ) {
234 if( addrgather_dlg_harvest() ) {
235 addrgather_dlg.cancelled = FALSE;
239 static void addrgather_dlg_cancel( GtkWidget *widget, gpointer data ) {
243 #define PACK_CHECK_BUTTON(box, chkbtn, label) \
245 chkbtn = gtk_check_button_new_with_label(label); \
246 gtk_widget_show(chkbtn); \
247 gtk_box_pack_start(GTK_BOX(box), chkbtn, FALSE, TRUE, 0); \
251 * Create notebook page for warning message.
252 * Enter: pageNum Page number.
253 * pageLbl Page label.
255 static void addrgather_page_warning( gint pageNum, gchar *pageLbl ) {
261 vbox = gtk_vbox_new(FALSE, 8);
262 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
263 gtk_container_set_border_width( GTK_CONTAINER (vbox), BORDER_WIDTH );
265 label = gtk_label_new( pageLbl );
266 gtk_widget_show( label );
267 gtk_notebook_set_tab_label(
268 GTK_NOTEBOOK( addrgather_dlg.notebook ),
269 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
272 table = gtk_table_new(3, 2, FALSE);
273 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
274 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
275 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
276 gtk_table_set_col_spacings(GTK_TABLE(table), 8 );
280 label = gtk_label_new("");
281 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
282 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
286 label = gtk_label_new( _("No folder or message was selected." ) );
287 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
288 gtk_label_set_justify( GTK_LABEL(label), GTK_JUSTIFY_LEFT );
289 gtk_misc_set_alignment( GTK_MISC(label), 0, 0.5 );
293 label = gtk_label_new( _(
294 "Please select a folder to process from the folder\n"
295 "list. Alternatively, select one or messages from\n"
296 "the message list." ) );
298 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
299 gtk_label_set_justify( GTK_LABEL(label), GTK_JUSTIFY_LEFT );
300 gtk_misc_set_alignment( GTK_MISC(label), 0, 0.5 );
304 * Create notebook page for mail headers.
305 * Enter: pageNum Page number.
306 * pageLbl Page label.
308 static void addrgather_page_fields( gint pageNum, gchar *pageLbl ) {
314 GtkWidget *labelFolder;
315 GtkWidget *entryBook;
316 GtkWidget *frameHeader;
317 GtkWidget *checkHeader[ NUM_FIELDS ];
318 GtkWidget *spinbtnFolder;
319 GtkObject *adjFolder;
320 GtkWidget *checkRecurse;
325 vbox = gtk_vbox_new(FALSE, 8);
326 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
327 gtk_container_set_border_width( GTK_CONTAINER (vbox), 4 );
330 label = gtk_label_new( pageLbl );
331 gtk_widget_show( label );
332 gtk_notebook_set_tab_label(
333 GTK_NOTEBOOK( addrgather_dlg.notebook ),
334 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
337 /* Upper area - Field list */
338 table = gtk_table_new( 4, 2, FALSE);
339 gtk_box_pack_start( GTK_BOX(vbox), table, FALSE, FALSE, 0 );
340 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
341 gtk_table_set_row_spacings( GTK_TABLE(table), 8 );
342 gtk_table_set_col_spacings( GTK_TABLE(table), 8 );
346 label = gtk_label_new( _("Folder :") );
347 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
348 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
350 labelFolder = gtk_label_new( "" );
351 gtk_table_attach( GTK_TABLE(table), labelFolder, 1, 2, top, (top + 1),
352 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
353 gtk_misc_set_alignment( GTK_MISC(labelFolder), 0, 0.5 );
357 label = gtk_label_new( _("Address Book :") );
358 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
359 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
361 entryBook = gtk_entry_new();
362 gtk_table_attach( GTK_TABLE(table), entryBook, 1, 2, top, (top + 1),
363 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
367 label = gtk_label_new( _("Folder Size :") );
368 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
369 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
371 hboxs = gtk_hbox_new( FALSE, 8 );
373 gtk_adjustment_new( DFL_FOLDER_SIZE, MIN_FOLDER_SIZE, G_MAXINT, 1, 10, 100 );
374 spinbtnFolder = gtk_spin_button_new( GTK_ADJUSTMENT(adjFolder), 1, 0 );
375 gtk_box_pack_start( GTK_BOX(hboxs), spinbtnFolder, FALSE, FALSE, 0);
376 gtk_widget_set_usize( spinbtnFolder, 100, -1);
377 gtk_spin_button_set_numeric( GTK_SPIN_BUTTON(spinbtnFolder), TRUE );
378 gtk_table_attach( GTK_TABLE(table), hboxs, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0 );
382 frameHeader = gtk_frame_new( _("Process these mail header fields") );
383 gtk_widget_show( frameHeader );
384 gtk_table_attach( GTK_TABLE(table), frameHeader, 0, 2, top, (top + 4), GTK_FILL, 0, 0, 0 );
385 gtk_frame_set_label_align( GTK_FRAME(frameHeader), 0.01, 0.5 );
388 vboxf = gtk_vbox_new( FALSE, 0 );
389 gtk_widget_show( vboxf );
390 gtk_container_add( GTK_CONTAINER( frameHeader ), vboxf );
391 gtk_container_set_border_width (GTK_CONTAINER( vboxf ), 8);
393 for( i = 0; i < NUM_FIELDS; i++ ) {
394 PACK_CHECK_BUTTON( vboxf, checkHeader[i], _harv_headerNames_[i] );
395 addrgather_dlg.checkHeader[i] = checkHeader[i];
398 /* Recurse folders */
400 checkRecurse = gtk_check_button_new_with_label( _("Include sub-folders" ) );
401 gtk_table_attach( GTK_TABLE(table), checkRecurse, 0, 2, top, (top + 1),
402 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
404 addrgather_dlg.labelFolder = labelFolder;
405 addrgather_dlg.entryBook = entryBook;
406 addrgather_dlg.spinbtnFolder = spinbtnFolder;
407 addrgather_dlg.checkRecurse = checkRecurse;
411 * Create notebook page for summary counts.
412 * Enter: pageNum Page number.
413 * pageLbl Page label.
415 static void addrgather_page_finish( gint pageNum, gchar *pageLbl ) {
418 GtkWidget *clistSWin;
419 GtkWidget *clistCount;
420 gchar *titles[ FIELDS_N_COLS ];
423 titles[ FIELD_COL_HEADER ] = _("Header Name");
424 titles[ FIELD_COL_COUNT ] = _("Address Count");
426 vbox = gtk_vbox_new(FALSE, 8);
427 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
428 gtk_container_set_border_width( GTK_CONTAINER (vbox), 8 );
430 label = gtk_label_new( pageLbl );
431 gtk_widget_show( label );
432 gtk_notebook_set_tab_label(
433 GTK_NOTEBOOK( addrgather_dlg.notebook ),
434 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
438 clistSWin = gtk_scrolled_window_new( NULL, NULL );
439 gtk_container_add( GTK_CONTAINER(vbox), clistSWin );
440 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(clistSWin),
441 GTK_POLICY_AUTOMATIC,
442 GTK_POLICY_AUTOMATIC);
444 clistCount = gtk_clist_new_with_titles( FIELDS_N_COLS, titles );
445 gtk_container_add( GTK_CONTAINER(clistSWin), clistCount );
446 gtk_clist_set_selection_mode( GTK_CLIST(clistCount), GTK_SELECTION_BROWSE );
447 gtk_clist_set_column_width(
448 GTK_CLIST(clistCount), FIELD_COL_HEADER, FIELDS_COL_WIDTH_HEADER );
449 gtk_clist_set_column_width(
450 GTK_CLIST(clistCount), FIELD_COL_COUNT, FIELDS_COL_WIDTH_COUNT );
452 for( i = 0; i < FIELDS_N_COLS; i++ )
453 GTK_WIDGET_UNSET_FLAGS(GTK_CLIST(clistCount)->column[i].button, GTK_CAN_FOCUS);
455 addrgather_dlg.clistCount = clistCount;
459 * Create notebook page for warning message.
460 * Enter: pageNum Page number.
461 * pageLbl Page label.
463 static void addrgather_dlg_create( void ) {
467 GtkWidget *btnCancel;
468 GtkWidget *statusbar;
474 window = gtk_window_new( GTK_WINDOW_TOPLEVEL );
475 gtk_widget_set_usize( window, 380, -1 );
476 gtk_container_set_border_width(GTK_CONTAINER(window), 0);
477 gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_CENTER );
478 gtk_window_set_modal( GTK_WINDOW(window), TRUE );
479 g_signal_connect(G_OBJECT(window), "delete_event",
480 G_CALLBACK(addrgather_dlg_delete_event), NULL);
481 g_signal_connect(G_OBJECT(window), "key_press_event",
482 G_CALLBACK(addrgather_dlg_key_pressed), NULL);
484 vbox = gtk_vbox_new( FALSE, 8 );
485 gtk_container_add( GTK_CONTAINER(window), vbox );
486 gtk_container_set_border_width( GTK_CONTAINER(vbox), 0 );
488 vnbox = gtk_vbox_new(FALSE, 4);
489 gtk_container_set_border_width(GTK_CONTAINER(vnbox), 4);
490 gtk_widget_show(vnbox);
491 gtk_box_pack_start(GTK_BOX(vbox), vnbox, TRUE, TRUE, 0);
494 notebook = gtk_notebook_new();
495 gtk_notebook_set_show_tabs( GTK_NOTEBOOK(notebook), FALSE );
496 gtk_widget_show(notebook);
497 gtk_box_pack_start(GTK_BOX(vnbox), notebook, TRUE, TRUE, 0);
498 gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
501 hsbox = gtk_hbox_new( FALSE, 0 );
502 gtk_box_pack_end( GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH );
503 statusbar = gtk_statusbar_new();
504 gtk_box_pack_start( GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH );
507 gtkut_button_set_create( &hbbox, &btnOk, _("OK"),
508 &btnCancel, _("Cancel"), NULL, NULL );
509 gtk_box_pack_end( GTK_BOX(vbox), hbbox, FALSE, FALSE, 0 );
510 gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
512 /* Signal handlers */
513 g_signal_connect(G_OBJECT(btnOk), "clicked",
514 G_CALLBACK(addrgather_dlg_ok), NULL);
515 g_signal_connect(G_OBJECT(btnCancel), "clicked",
516 G_CALLBACK(addrgather_dlg_cancel), NULL);
518 gtk_widget_show_all( vbox );
519 addrgather_dlg.window = window;
520 addrgather_dlg.notebook = notebook;
521 addrgather_dlg.btnOk = btnOk;
522 addrgather_dlg.btnCancel = btnCancel;
523 addrgather_dlg.statusbar = statusbar;
524 addrgather_dlg.status_cid = gtk_statusbar_get_context_id(
525 GTK_STATUSBAR(statusbar), "Harvest E-Mail Address Dialog" );
527 /* Create notebook pages */
528 addrgather_page_warning( PAGE_WARNING, _( "Warning" ) );
529 addrgather_page_fields( PAGE_FIELDS, _( "Header Fields" ) );
530 addrgather_page_finish( PAGE_FINISH, _( "Finish" ) );
531 gtk_widget_show_all( addrgather_dlg.window );
535 * Harvest addresses main window.
536 * Enter: folderItem Source folder.
537 * addrIndex Address index.
538 * sourceInd Source indicator: FALSE - Folder, TRUE - Messages.
539 * msgList List of message numbers, or NULL to process folder.
540 * Return: Populated address book file, or NULL if none created.
542 AddressBookFile *addrgather_dlg_execute(
543 FolderItem *folderItem, AddressIndex *addrIndex, gboolean sourceInd,
549 _harv_addressIndex_ = addrIndex;
550 _harv_addressBook_ = NULL;
551 _harv_messageList_ = msgList;
554 if( ! addrgather_dlg.window ) {
555 addrgather_dlg_create();
559 if( folderItem && folderItem->path ) {
560 gtk_notebook_set_page(
561 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FIELDS );
562 addrgather_dlg.folderPath = folder_item_get_path( folderItem );
564 /* Setup some default values */
566 GTK_LABEL(addrgather_dlg.labelFolder), folderItem->path );
568 GTK_ENTRY(addrgather_dlg.entryBook), folderItem->path );
570 for( i = 0; i < NUM_FIELDS; i++ ) {
571 gtk_toggle_button_set_active(
572 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
574 if( g_utf8_collate( _harv_headerNames_[i], HEADER_FROM ) == 0 ) {
575 gtk_toggle_button_set_active(
576 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
581 gtk_widget_set_sensitive( addrgather_dlg.btnOk, TRUE );
582 gtk_widget_grab_default( addrgather_dlg.btnOk );
586 /* Apply window title */
588 gtk_window_set_title( GTK_WINDOW(addrgather_dlg.window),
589 _("Harvest E-Mail Addresses - from Selected Messages") );
590 gtk_widget_set_sensitive( addrgather_dlg.checkRecurse, FALSE );
591 if( msgList == NULL ) {
596 gtk_window_set_title( GTK_WINDOW(addrgather_dlg.window),
597 _("Harvest E-Mail Addresses - from Folder") );
598 gtk_widget_set_sensitive( addrgather_dlg.checkRecurse, TRUE );
600 gtk_toggle_button_set_active(
601 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ), FALSE );
603 addrgather_dlg_status_show( "" );
604 gtk_widget_show( addrgather_dlg.window );
607 gtk_notebook_set_page(
608 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_WARNING );
609 gtk_widget_set_sensitive( addrgather_dlg.btnOk, FALSE );
610 gtk_widget_grab_default( addrgather_dlg.btnCancel );
613 gtk_widget_grab_focus( addrgather_dlg.entryBook );
615 manage_window_set_transient( GTK_WINDOW(addrgather_dlg.window) );
619 g_free( addrgather_dlg.folderPath );
620 addrgather_dlg.folderPath = NULL;
622 gtk_widget_hide( addrgather_dlg.window );
623 _harv_addressIndex_ = NULL;
625 if( addrgather_dlg.cancelled == TRUE ) return NULL;
627 return _harv_addressBook_;