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 void addrgather_dlg_key_pressed(
131 GtkWidget *widget, GdkEventKey *event, gpointer data )
133 if( event && event->keyval == GDK_Escape ) {
134 addrgather_dlg.cancelled = TRUE;
139 #define FMT_BUFSIZE 32
141 static gboolean addrgather_dlg_harvest() {
143 gchar *text[ FIELDS_N_COLS ];
144 AddressHarvester *harvester;
145 AddressBookFile *abf;
148 gchar str[ FMT_BUFSIZE ];
153 name = gtk_editable_get_chars( GTK_EDITABLE(addrgather_dlg.entryBook), 0, -1 );
154 if( name == NULL || strlen( name ) < 1 ) {
155 addrgather_dlg_status_show(
156 _( "Please specify name for address book." ) );
161 /* Create harvest helper */
162 harvester = addrharvest_create();
163 addrharvest_set_path( harvester, addrgather_dlg.folderPath );
165 for( i = 0; i < NUM_FIELDS; i++ ) {
166 addrharvest_set_header( harvester, _harv_headerNames_[i],
167 gtk_toggle_button_get_active(
168 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]) ) );
170 addrharvest_set_recurse( harvester,
171 gtk_toggle_button_get_active(
172 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ) ) );
174 if( addrharvest_check_header( harvester ) == FALSE ) {
175 addrgather_dlg_status_show(
176 _( "Please select the mail headers to search." ) );
177 addrharvest_free( harvester );
183 addrgather_dlg_status_show( _( "Busy harvesting addresses..." ) );
184 sz = gtk_spin_button_get_value_as_int(
185 GTK_SPIN_BUTTON( addrgather_dlg.spinbtnFolder ) );
186 addrharvest_set_folder_size( harvester, sz );
188 /* Create address book */
189 abf = addrbook_create_book();
190 addrbook_set_path( abf, _harv_addressIndex_->filePath );
191 newFile = addrbook_guess_next_file( abf );
192 addrbook_set_file( abf, newFile );
193 addrbook_set_name( abf, name );
197 /* Harvest addresses */
199 harvester, abf->addressCache, _harv_messageList_ );
200 addrbook_save_data( abf );
201 _harv_addressBook_ = abf;
203 /* Update summary count */
204 clist = GTK_CLIST(addrgather_dlg.clistCount);
205 gtk_clist_clear( clist );
206 for( i = 0; i < NUM_FIELDS; i++ ) {
207 cnt = addrharvest_get_count( harvester, _harv_headerNames_[i] );
212 sprintf( str, "%d", cnt );
214 text[ FIELD_COL_HEADER ] = _harv_headerNames_[i];
215 text[ FIELD_COL_COUNT ] = str;
216 gtk_clist_append( clist, text );
219 addrharvest_free( harvester );
221 addrgather_dlg_status_show( _("Addresses gathered successfully.") );
223 /* Display summary page */
224 gtk_notebook_set_page(
225 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FINISH );
226 gtk_widget_set_sensitive( addrgather_dlg.btnOk, FALSE );
227 gtk_widget_grab_default( addrgather_dlg.btnCancel );
232 static void addrgather_dlg_ok( GtkWidget *widget, gpointer data ) {
233 if( addrgather_dlg_harvest() ) {
234 addrgather_dlg.cancelled = FALSE;
238 static void addrgather_dlg_cancel( GtkWidget *widget, gpointer data ) {
242 #define PACK_CHECK_BUTTON(box, chkbtn, label) \
244 chkbtn = gtk_check_button_new_with_label(label); \
245 gtk_widget_show(chkbtn); \
246 gtk_box_pack_start(GTK_BOX(box), chkbtn, FALSE, TRUE, 0); \
250 * Create notebook page for warning message.
251 * Enter: pageNum Page number.
252 * pageLbl Page label.
254 static void addrgather_page_warning( gint pageNum, gchar *pageLbl ) {
260 vbox = gtk_vbox_new(FALSE, 8);
261 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
262 gtk_container_set_border_width( GTK_CONTAINER (vbox), BORDER_WIDTH );
264 label = gtk_label_new( pageLbl );
265 gtk_widget_show( label );
266 gtk_notebook_set_tab_label(
267 GTK_NOTEBOOK( addrgather_dlg.notebook ),
268 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
271 table = gtk_table_new(3, 2, FALSE);
272 gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
273 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
274 gtk_table_set_row_spacings(GTK_TABLE(table), 8);
275 gtk_table_set_col_spacings(GTK_TABLE(table), 8 );
279 label = gtk_label_new("");
280 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
281 gtk_misc_set_alignment(GTK_MISC(label), 0, 0.5);
285 label = gtk_label_new( _("No folder or message was selected." ) );
286 gtk_table_attach(GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
287 gtk_label_set_justify( GTK_LABEL(label), GTK_JUSTIFY_LEFT );
288 gtk_misc_set_alignment( GTK_MISC(label), 0, 0.5 );
292 label = gtk_label_new( _(
293 "Please select a folder to process from the folder\n"
294 "list. Alternatively, select one or messages from\n"
295 "the message list." ) );
297 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0);
298 gtk_label_set_justify( GTK_LABEL(label), GTK_JUSTIFY_LEFT );
299 gtk_misc_set_alignment( GTK_MISC(label), 0, 0.5 );
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 GtkWidget *spinbtnFolder;
318 GtkObject *adjFolder;
319 GtkWidget *checkRecurse;
324 vbox = gtk_vbox_new(FALSE, 8);
325 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
326 gtk_container_set_border_width( GTK_CONTAINER (vbox), 4 );
329 label = gtk_label_new( pageLbl );
330 gtk_widget_show( label );
331 gtk_notebook_set_tab_label(
332 GTK_NOTEBOOK( addrgather_dlg.notebook ),
333 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
336 /* Upper area - Field list */
337 table = gtk_table_new( 4, 2, FALSE);
338 gtk_box_pack_start( GTK_BOX(vbox), table, FALSE, FALSE, 0 );
339 gtk_container_set_border_width( GTK_CONTAINER(table), 8 );
340 gtk_table_set_row_spacings( GTK_TABLE(table), 8 );
341 gtk_table_set_col_spacings( GTK_TABLE(table), 8 );
345 label = gtk_label_new( _("Folder :") );
346 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
347 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
349 labelFolder = gtk_label_new( "" );
350 gtk_table_attach( GTK_TABLE(table), labelFolder, 1, 2, top, (top + 1),
351 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
352 gtk_misc_set_alignment( GTK_MISC(labelFolder), 0, 0.5 );
356 label = gtk_label_new( _("Address Book :") );
357 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
358 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
360 entryBook = gtk_entry_new();
361 gtk_table_attach( GTK_TABLE(table), entryBook, 1, 2, top, (top + 1),
362 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
366 label = gtk_label_new( _("Folder Size :") );
367 gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
368 gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
370 hboxs = gtk_hbox_new( FALSE, 8 );
372 gtk_adjustment_new( DFL_FOLDER_SIZE, MIN_FOLDER_SIZE, G_MAXINT, 1, 10, 100 );
373 spinbtnFolder = gtk_spin_button_new( GTK_ADJUSTMENT(adjFolder), 1, 0 );
374 gtk_box_pack_start( GTK_BOX(hboxs), spinbtnFolder, FALSE, FALSE, 0);
375 gtk_widget_set_usize( spinbtnFolder, 100, -1);
376 gtk_spin_button_set_numeric( GTK_SPIN_BUTTON(spinbtnFolder), TRUE );
377 gtk_table_attach( GTK_TABLE(table), hboxs, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0 );
381 frameHeader = gtk_frame_new( _("Process these mail header fields") );
382 gtk_widget_show( frameHeader );
383 gtk_table_attach( GTK_TABLE(table), frameHeader, 0, 2, top, (top + 4), GTK_FILL, 0, 0, 0 );
384 gtk_frame_set_label_align( GTK_FRAME(frameHeader), 0.01, 0.5 );
387 vboxf = gtk_vbox_new( FALSE, 0 );
388 gtk_widget_show( vboxf );
389 gtk_container_add( GTK_CONTAINER( frameHeader ), vboxf );
390 gtk_container_set_border_width (GTK_CONTAINER( vboxf ), 8);
392 for( i = 0; i < NUM_FIELDS; i++ ) {
393 PACK_CHECK_BUTTON( vboxf, checkHeader[i], _harv_headerNames_[i] );
394 addrgather_dlg.checkHeader[i] = checkHeader[i];
397 /* Recurse folders */
399 checkRecurse = gtk_check_button_new_with_label( _("Include sub-folders" ) );
400 gtk_table_attach( GTK_TABLE(table), checkRecurse, 0, 2, top, (top + 1),
401 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
403 addrgather_dlg.labelFolder = labelFolder;
404 addrgather_dlg.entryBook = entryBook;
405 addrgather_dlg.spinbtnFolder = spinbtnFolder;
406 addrgather_dlg.checkRecurse = checkRecurse;
410 * Create notebook page for summary counts.
411 * Enter: pageNum Page number.
412 * pageLbl Page label.
414 static void addrgather_page_finish( gint pageNum, gchar *pageLbl ) {
417 GtkWidget *clistSWin;
418 GtkWidget *clistCount;
419 gchar *titles[ FIELDS_N_COLS ];
422 titles[ FIELD_COL_HEADER ] = _("Header Name");
423 titles[ FIELD_COL_COUNT ] = _("Address Count");
425 vbox = gtk_vbox_new(FALSE, 8);
426 gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
427 gtk_container_set_border_width( GTK_CONTAINER (vbox), 8 );
429 label = gtk_label_new( pageLbl );
430 gtk_widget_show( label );
431 gtk_notebook_set_tab_label(
432 GTK_NOTEBOOK( addrgather_dlg.notebook ),
433 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
437 clistSWin = gtk_scrolled_window_new( NULL, NULL );
438 gtk_container_add( GTK_CONTAINER(vbox), clistSWin );
439 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(clistSWin),
440 GTK_POLICY_AUTOMATIC,
443 clistCount = gtk_clist_new_with_titles( FIELDS_N_COLS, titles );
444 gtk_container_add( GTK_CONTAINER(clistSWin), clistCount );
445 gtk_clist_set_selection_mode( GTK_CLIST(clistCount), GTK_SELECTION_BROWSE );
446 gtk_clist_set_column_width(
447 GTK_CLIST(clistCount), FIELD_COL_HEADER, FIELDS_COL_WIDTH_HEADER );
448 gtk_clist_set_column_width(
449 GTK_CLIST(clistCount), FIELD_COL_COUNT, FIELDS_COL_WIDTH_COUNT );
451 for( i = 0; i < FIELDS_N_COLS; i++ )
452 GTK_WIDGET_UNSET_FLAGS(GTK_CLIST(clistCount)->column[i].button, GTK_CAN_FOCUS);
454 addrgather_dlg.clistCount = clistCount;
458 * Create notebook page for warning message.
459 * Enter: pageNum Page number.
460 * pageLbl Page label.
462 static void addrgather_dlg_create( void ) {
466 GtkWidget *btnCancel;
467 GtkWidget *statusbar;
473 window = gtk_window_new( GTK_WINDOW_DIALOG );
474 gtk_widget_set_usize( window, 380, -1 );
475 gtk_container_set_border_width(GTK_CONTAINER(window), 0);
476 gtk_window_set_position( GTK_WINDOW(window), GTK_WIN_POS_CENTER );
477 gtk_window_set_modal( GTK_WINDOW(window), TRUE );
478 gtk_signal_connect( GTK_OBJECT(window), "delete_event",
479 GTK_SIGNAL_FUNC( addrgather_dlg_delete_event ), NULL );
480 gtk_signal_connect( GTK_OBJECT(window), "key_press_event",
481 GTK_SIGNAL_FUNC( addrgather_dlg_key_pressed ), NULL );
483 vbox = gtk_vbox_new( FALSE, 8 );
484 gtk_container_add( GTK_CONTAINER(window), vbox );
485 gtk_container_set_border_width( GTK_CONTAINER(vbox), 0 );
487 vnbox = gtk_vbox_new(FALSE, 4);
488 gtk_container_set_border_width(GTK_CONTAINER(vnbox), 4);
489 gtk_widget_show(vnbox);
490 gtk_box_pack_start(GTK_BOX(vbox), vnbox, TRUE, TRUE, 0);
493 notebook = gtk_notebook_new();
494 gtk_notebook_set_show_tabs( GTK_NOTEBOOK(notebook), FALSE );
495 gtk_widget_show(notebook);
496 gtk_box_pack_start(GTK_BOX(vnbox), notebook, TRUE, TRUE, 0);
497 gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
500 hsbox = gtk_hbox_new( FALSE, 0 );
501 gtk_box_pack_end( GTK_BOX(vbox), hsbox, FALSE, FALSE, BORDER_WIDTH );
502 statusbar = gtk_statusbar_new();
503 gtk_box_pack_start( GTK_BOX(hsbox), statusbar, TRUE, TRUE, BORDER_WIDTH );
506 gtkut_button_set_create( &hbbox, &btnOk, _("OK"),
507 &btnCancel, _("Cancel"), NULL, NULL );
508 gtk_box_pack_end( GTK_BOX(vbox), hbbox, FALSE, FALSE, 0 );
509 gtk_container_set_border_width( GTK_CONTAINER(hbbox), 0 );
511 /* Signal handlers */
512 gtk_signal_connect( GTK_OBJECT(btnOk), "clicked",
513 GTK_SIGNAL_FUNC(addrgather_dlg_ok), NULL );
514 gtk_signal_connect( GTK_OBJECT(btnCancel), "clicked",
515 GTK_SIGNAL_FUNC(addrgather_dlg_cancel), NULL );
517 gtk_widget_show_all( vbox );
518 addrgather_dlg.window = window;
519 addrgather_dlg.notebook = notebook;
520 addrgather_dlg.btnOk = btnOk;
521 addrgather_dlg.btnCancel = btnCancel;
522 addrgather_dlg.statusbar = statusbar;
523 addrgather_dlg.status_cid = gtk_statusbar_get_context_id(
524 GTK_STATUSBAR(statusbar), "Harvest E-Mail Address Dialog" );
526 /* Create notebook pages */
527 addrgather_page_warning( PAGE_WARNING, _( "Warning" ) );
528 addrgather_page_fields( PAGE_FIELDS, _( "Header Fields" ) );
529 addrgather_page_finish( PAGE_FINISH, _( "Finish" ) );
530 gtk_widget_show_all( addrgather_dlg.window );
534 * Harvest addresses main window.
535 * Enter: folderItem Source folder.
536 * addrIndex Address index.
537 * sourceInd Source indicator: FALSE - Folder, TRUE - Messages.
538 * msgList List of message numbers, or NULL to process folder.
539 * Return: Populated address book file, or NULL if none created.
541 AddressBookFile *addrgather_dlg_execute(
542 FolderItem *folderItem, AddressIndex *addrIndex, gboolean sourceInd,
548 _harv_addressIndex_ = addrIndex;
549 _harv_addressBook_ = NULL;
550 _harv_messageList_ = msgList;
553 if( ! addrgather_dlg.window ) {
554 addrgather_dlg_create();
558 if( folderItem && folderItem->path ) {
559 gtk_notebook_set_page(
560 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FIELDS );
561 addrgather_dlg.folderPath = folder_item_get_path( folderItem );
563 /* Setup some default values */
565 GTK_LABEL(addrgather_dlg.labelFolder), folderItem->path );
567 GTK_ENTRY(addrgather_dlg.entryBook), folderItem->path );
569 for( i = 0; i < NUM_FIELDS; i++ ) {
570 gtk_toggle_button_set_active(
571 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
573 if( g_strcasecmp( _harv_headerNames_[i], HEADER_FROM ) == 0 ) {
574 gtk_toggle_button_set_active(
575 GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
580 gtk_widget_set_sensitive( addrgather_dlg.btnOk, TRUE );
581 gtk_widget_grab_default( addrgather_dlg.btnOk );
585 /* Apply window title */
587 gtk_window_set_title( GTK_WINDOW(addrgather_dlg.window),
588 _("Harvest E-Mail Addresses - from Selected Messages") );
589 gtk_widget_set_sensitive( addrgather_dlg.checkRecurse, FALSE );
590 if( msgList == NULL ) {
595 gtk_window_set_title( GTK_WINDOW(addrgather_dlg.window),
596 _("Harvest E-Mail Addresses - from Folder") );
597 gtk_widget_set_sensitive( addrgather_dlg.checkRecurse, TRUE );
599 gtk_toggle_button_set_active(
600 GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ), FALSE );
602 addrgather_dlg_status_show( "" );
603 gtk_widget_show( addrgather_dlg.window );
606 gtk_notebook_set_page(
607 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_WARNING );
608 gtk_widget_set_sensitive( addrgather_dlg.btnOk, FALSE );
609 gtk_widget_grab_default( addrgather_dlg.btnCancel );
612 gtk_widget_grab_focus( addrgather_dlg.entryBook );
614 manage_window_set_transient( GTK_WINDOW(addrgather_dlg.window) );
618 g_free( addrgather_dlg.folderPath );
619 addrgather_dlg.folderPath = NULL;
621 gtk_widget_hide( addrgather_dlg.window );
622 _harv_addressIndex_ = NULL;
624 if( addrgather_dlg.cancelled == TRUE ) return NULL;
626 return _harv_addressBook_;