2008-08-16 [colin] 3.5.0cvs61
[claws.git] / src / addrgather.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2002-2008 Match Grun and the Claws Mail team
4  *
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.
9  *
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.
14  *
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/>.
17  * 
18  */
19
20 /*
21 * Dialog for gathering EMail addresses from mail folder.
22 */
23
24 #ifdef HAVE_CONFIG_H
25 #  include "config.h"
26 #endif
27
28 #include "defs.h"
29
30 #include <glib.h>
31 #include <glib/gi18n.h>
32 #include <gdk/gdkkeysyms.h>
33 #include <gtk/gtkmain.h>
34 #include <gtk/gtkwidget.h>
35 #include <gtk/gtkwindow.h>
36 #include <gtk/gtkvbox.h>
37 #include <gtk/gtktable.h>
38 #include <gtk/gtklabel.h>
39 #include <gtk/gtkentry.h>
40 #include <gtk/gtkhbbox.h>
41 #include <gtk/gtkbutton.h>
42 #include <gtk/gtkfilesel.h>
43 #include <gtk/gtksignal.h>
44
45 #include "main.h"
46 #include "inc.h"
47 #include "mbox.h"
48 #include "filesel.h"
49 #include "foldersel.h"
50 #include "gtkutils.h"
51 #include "alertpanel.h"
52 #include "manage_window.h"
53 #include "folder.h"
54 #include "utils.h"
55
56 #include "addrharvest.h"
57 #include "addrindex.h"
58 #include "addrbook.h"
59
60 #define PAGE_FIELDS     0
61 #define PAGE_FINISH     1
62
63 #define NUM_FIELDS      6
64
65 #define FIELDS_N_COLS              2
66 #define FIELDS_COL_WIDTH_HEADER    100
67 #define FIELDS_COL_WIDTH_COUNT     140
68
69 #define MIN_FOLDER_SIZE 20
70 #define DFL_FOLDER_SIZE 50
71
72 typedef enum {
73         FIELD_COL_HEADER = 0,
74         FIELD_COL_COUNT  = 1
75 } AddrHarvest;
76
77 /*
78 * The dialog.
79 */
80 static struct _AddrHarvest {
81         GtkWidget *window;
82         GtkWidget *notebook;
83         GtkWidget *labelFolder;
84         GtkWidget *entryBook;
85         GtkWidget *checkHeader[ NUM_FIELDS ];
86         GtkWidget *spinbtnFolder;
87         GtkWidget *checkRecurse;
88         GtkWidget *btnOk;
89         GtkWidget *btnCancel;
90         GtkWidget *statusbar;
91         gint      status_cid;
92         gboolean  cancelled;
93         gboolean  done;
94         gchar     *folderPath;
95         GtkWidget *clistCount;
96 } addrgather_dlg;
97
98 static AddressIndex *_harv_addressIndex_;
99 static AddressBookFile *_harv_addressBook_;
100 static gchar *_harv_headerNames_[] = {
101         HEADER_FROM,
102         HEADER_REPLY_TO,
103         HEADER_SENDER,
104         HEADER_TO,
105         HEADER_CC,
106         HEADER_ERRORS_TO
107 };
108 static GList *_harv_messageList_;
109
110 static 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 );
114                 if( msg ) {
115                         gtk_statusbar_push(
116                                 GTK_STATUSBAR(addrgather_dlg.statusbar),
117                                 addrgather_dlg.status_cid, msg );
118                 }
119         }
120 }
121
122 static gint addrgather_dlg_delete_event(
123         GtkWidget *widget, GdkEventAny *event, gpointer data )
124 {
125         addrgather_dlg.cancelled = TRUE;
126         gtk_main_quit();
127         return TRUE;
128 }
129
130 static gboolean addrgather_dlg_key_pressed(
131         GtkWidget *widget, GdkEventKey *event, gpointer data )
132 {
133         if( event && event->keyval == GDK_Escape ) {
134                 addrgather_dlg.cancelled = TRUE;
135                 gtk_main_quit();
136         }
137         return FALSE;
138 }
139
140 #define FMT_BUFSIZE 32
141
142 static gboolean addrgather_dlg_harvest() {
143         GtkCMCList *clist;
144         gchar *text[ FIELDS_N_COLS ];
145         AddressHarvester *harvester;
146         AddressBookFile *abf;
147         gchar *name;
148         gchar *newFile;
149         gchar str[ FMT_BUFSIZE ];
150         gint cnt;
151         gint i;
152         gint sz;
153
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." ) );
158                 g_free( name );
159                 return FALSE;
160         }
161
162         /* Create harvest helper */
163         harvester = addrharvest_create();
164         addrharvest_set_path( harvester, addrgather_dlg.folderPath );
165
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]) ) );
170         }
171         addrharvest_set_recurse( harvester,
172                 gtk_toggle_button_get_active(
173                         GTK_TOGGLE_BUTTON( addrgather_dlg.checkRecurse ) ) );
174
175         if( addrharvest_check_header( harvester ) == FALSE ) {
176                 addrgather_dlg_status_show(
177                         _( "Please select the mail headers to search." ) );
178                 addrharvest_free( harvester );
179                 g_free( name );
180                 return FALSE;
181         }
182
183         /* Go fer it */
184         addrgather_dlg_status_show( _( "Collecting addresses..." ) );
185         GTK_EVENTS_FLUSH();
186         sz = gtk_spin_button_get_value_as_int(
187                 GTK_SPIN_BUTTON( addrgather_dlg.spinbtnFolder ) );
188         addrharvest_set_folder_size( harvester, sz );
189
190         /* Create address book */
191         abf = addrbook_create_book();
192         addrbook_set_path( abf, _harv_addressIndex_->filePath );
193         newFile = addrbook_guess_next_file( abf );
194         addrbook_set_file( abf, newFile );
195         addrbook_set_name( abf, name );
196         g_free( newFile );
197         g_free( name );
198
199         /* Harvest addresses */
200         addrharvest_harvest(
201                 harvester, abf->addressCache, _harv_messageList_ );
202         addrbook_save_data( abf );
203         _harv_addressBook_ = abf;
204
205         /* Update summary count */
206         clist = GTK_CMCLIST(addrgather_dlg.clistCount);
207         gtk_cmclist_clear( clist );
208         for( i = 0; i < NUM_FIELDS; i++ ) {
209                 cnt = addrharvest_get_count( harvester, _harv_headerNames_[i] );
210                 if( cnt < 1 ) {
211                         strcpy( str, "-" );
212                 }
213                 else {
214                         sprintf( str, "%d", cnt );
215                 }
216                 text[ FIELD_COL_HEADER ] = _harv_headerNames_[i];
217                 text[ FIELD_COL_COUNT  ] = str;
218                 gtk_cmclist_append( clist, text );
219         }
220
221         addrharvest_free( harvester );
222
223         addrgather_dlg_status_show(_("Addresses collected successfully."));
224
225         /* Display summary page */
226         gtk_notebook_set_current_page(
227                 GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FINISH );
228         addrgather_dlg.done = TRUE;
229         gtk_widget_set_sensitive( addrgather_dlg.btnCancel, FALSE );
230         gtk_widget_grab_default( addrgather_dlg.btnOk );
231
232         return TRUE;
233 }
234
235 static void addrgather_dlg_ok( GtkWidget *widget, gpointer data ) {
236         if(addrgather_dlg.done) {
237                 addrgather_dlg.done = FALSE;
238                 gtk_main_quit();
239                 return;
240         }
241         if( addrgather_dlg_harvest() ) {
242                 addrgather_dlg.cancelled = FALSE;
243         }
244 }
245
246 static void addrgather_dlg_cancel( GtkWidget *widget, gpointer data ) {
247         gtk_main_quit();
248 }
249
250 #define PACK_CHECK_BUTTON(box, checkbtn, label) \
251 { \
252         checkbtn = gtk_check_button_new_with_label(label); \
253         gtk_widget_show(checkbtn); \
254         gtk_box_pack_start(GTK_BOX(box), checkbtn, FALSE, TRUE, 0); \
255 }
256
257 /*
258  * Create notebook page for mail headers.
259  * Enter: pageNum Page number.
260  *        pageLbl Page label.
261  */
262 static void addrgather_page_fields(gint pageNum, gchar *pageLbl)
263 {
264         GtkWidget *vbox;
265         GtkWidget *vboxf;
266         GtkWidget *hboxs;
267         GtkWidget *table;
268         GtkWidget *label;
269         GtkWidget *labelFolder;
270         GtkWidget *entryBook;
271         GtkWidget *frameHeader;
272         GtkWidget *checkHeader[NUM_FIELDS];
273         GtkWidget *spinbtnFolder;
274         GtkObject *adjFolder;
275         GtkWidget *checkRecurse;
276         gint top;
277         gint i;
278         CLAWS_TIP_DECL();
279
280         /* Container */
281         vbox = gtk_vbox_new(FALSE, 6);
282         gtk_container_add(GTK_CONTAINER(addrgather_dlg.notebook), vbox);
283         gtk_container_set_border_width(GTK_CONTAINER(vbox), 4);
284
285         /* Notebook page */
286         label = gtk_label_new(pageLbl);
287         gtk_widget_show(label);
288         gtk_notebook_set_tab_label(GTK_NOTEBOOK(addrgather_dlg.notebook),
289                                    gtk_notebook_get_nth_page(GTK_NOTEBOOK(addrgather_dlg.notebook),
290                                                              pageNum), label);
291
292         /* Upper area - Field list */
293         table = gtk_table_new(4, 2, FALSE);
294         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
295         gtk_table_set_row_spacings(GTK_TABLE(table), 4);
296         gtk_table_set_col_spacings(GTK_TABLE(table), 4);
297
298         /* First row */
299         top = 0;
300         label = gtk_label_new(_("Current folder:"));
301         gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
302         gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
303
304         labelFolder = gtk_label_new("");
305         gtk_table_attach( GTK_TABLE(table), labelFolder, 1, 2, top, (top + 1),
306                 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
307         gtk_misc_set_alignment( GTK_MISC(labelFolder), 0, 0.5 );
308
309         /* Second row */
310         top = 1;
311         label = gtk_label_new(_("Address book name:"));
312         gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
313         gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
314
315         entryBook = gtk_entry_new();
316         gtk_table_attach( GTK_TABLE(table), entryBook, 1, 2, top, (top + 1),
317                 GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
318
319         /* Third row */
320         top = 2;
321         label = gtk_label_new(_("Address book folder size:"));
322         gtk_table_attach( GTK_TABLE(table), label, 0, 1, top, (top + 1), GTK_FILL, 0, 0, 0 );
323         gtk_misc_set_alignment( GTK_MISC(label), 1.0, 0.5 );
324         CLAWS_SET_TIP(label,
325                         _("Maximum amount of entries per folder within the newly created address book"));
326
327         hboxs = gtk_hbox_new(FALSE, 8);
328         adjFolder = gtk_adjustment_new(DFL_FOLDER_SIZE, MIN_FOLDER_SIZE, G_MAXINT, 1, 10, 100);
329         spinbtnFolder = gtk_spin_button_new(GTK_ADJUSTMENT(adjFolder), 1, 0);
330         gtk_box_pack_start(GTK_BOX(hboxs), spinbtnFolder, FALSE, FALSE, 0);
331         gtk_widget_set_size_request(spinbtnFolder, 100, -1);
332         gtk_spin_button_set_numeric(GTK_SPIN_BUTTON(spinbtnFolder), TRUE);
333         gtk_table_attach(GTK_TABLE(table), hboxs, 1, 2, top, (top + 1), GTK_FILL, 0, 0, 0);
334         CLAWS_SET_TIP(spinbtnFolder,
335                         _("Maximum amount of entries per folder within the newly created address book"));
336
337         /* Fourth row */
338         top = 3;
339         frameHeader = gtk_frame_new(_("Process these mail header fields"));
340         gtk_widget_show(frameHeader);
341         gtk_table_attach(GTK_TABLE(table), frameHeader, 0, 2, top, (top + 4), GTK_FILL, 0, 0, 0);
342         gtk_frame_set_label_align(GTK_FRAME(frameHeader), 0.01, 0.5);
343
344         /* Check boxes */
345         vboxf = gtk_vbox_new(FALSE, 0);
346         gtk_widget_show(vboxf);
347         gtk_container_add(GTK_CONTAINER(frameHeader), vboxf);
348         gtk_container_set_border_width(GTK_CONTAINER(vboxf), 8);
349
350         for (i = 0; i < NUM_FIELDS; i++) {
351                 PACK_CHECK_BUTTON(vboxf, checkHeader[i], _harv_headerNames_[i]);
352                 addrgather_dlg.checkHeader[i] = checkHeader[i];
353         }
354
355         /* Recurse folders */
356         top += 4;
357         checkRecurse = gtk_check_button_new_with_label( _("Include subfolders" ) );
358         gtk_table_attach( GTK_TABLE(table), checkRecurse, 0, 2, top, (top + 1),
359                         GTK_EXPAND|GTK_SHRINK|GTK_FILL, 0, 0, 0 );
360
361         addrgather_dlg.labelFolder   = labelFolder;
362         addrgather_dlg.entryBook     = entryBook;
363         addrgather_dlg.spinbtnFolder = spinbtnFolder;
364         addrgather_dlg.checkRecurse  = checkRecurse;
365 }
366
367 /*
368  * Create notebook page for summary counts.
369  * Enter: pageNum Page number.
370  *        pageLbl Page label.
371  */
372 static void addrgather_page_finish( gint pageNum, gchar *pageLbl ) {
373         GtkWidget *label;
374         GtkWidget *vbox;
375         GtkWidget *clistSWin;
376         GtkWidget *clistCount;
377         gchar *titles[ FIELDS_N_COLS ];
378         gint i;
379
380         titles[ FIELD_COL_HEADER ] = _("Header Name");
381         titles[ FIELD_COL_COUNT  ] = _("Address Count");
382
383         vbox = gtk_vbox_new(FALSE, 8);
384         gtk_container_add( GTK_CONTAINER( addrgather_dlg.notebook ), vbox );
385         gtk_container_set_border_width( GTK_CONTAINER (vbox), 8 );
386
387         label = gtk_label_new( pageLbl );
388         gtk_widget_show( label );
389         gtk_notebook_set_tab_label(
390                 GTK_NOTEBOOK( addrgather_dlg.notebook ),
391                 gtk_notebook_get_nth_page( GTK_NOTEBOOK( addrgather_dlg.notebook ), pageNum ),
392                 label );
393
394         /* Summary count */
395         clistSWin = gtk_scrolled_window_new( NULL, NULL );
396         gtk_container_add( GTK_CONTAINER(vbox), clistSWin );
397         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(clistSWin),
398                                        GTK_POLICY_AUTOMATIC,
399                                        GTK_POLICY_AUTOMATIC);
400
401         clistCount = gtk_cmclist_new_with_titles( FIELDS_N_COLS, titles );
402         gtk_container_add( GTK_CONTAINER(clistSWin), clistCount );
403         gtk_cmclist_set_selection_mode( GTK_CMCLIST(clistCount), GTK_SELECTION_BROWSE );
404         gtk_cmclist_set_column_width(
405                         GTK_CMCLIST(clistCount), FIELD_COL_HEADER, FIELDS_COL_WIDTH_HEADER );
406         gtk_cmclist_set_column_width(
407                         GTK_CMCLIST(clistCount), FIELD_COL_COUNT, FIELDS_COL_WIDTH_COUNT );
408
409         for( i = 0; i < FIELDS_N_COLS; i++ )
410                 GTK_WIDGET_UNSET_FLAGS(GTK_CMCLIST(clistCount)->column[i].button, GTK_CAN_FOCUS);
411
412         addrgather_dlg.clistCount = clistCount;
413 }
414
415 /*
416  * Create notebook page for warning message.
417  * Enter: pageNum Page number.
418  *        pageLbl Page label.
419  */
420 static void addrgather_dlg_create(void)
421 {
422         GtkWidget *window;
423         GtkWidget *notebook;
424         GtkWidget *btnOk;
425         GtkWidget *btnCancel;
426         GtkWidget *statusbar;
427         GtkWidget *vbox;
428         GtkWidget *hbbox;
429         GtkWidget *hsbox;
430
431         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "addrgather");
432         gtk_widget_set_size_request(window, 380, -1);
433         gtk_container_set_border_width(GTK_CONTAINER(window), 4);
434         gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER);
435         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
436         gtk_window_set_modal(GTK_WINDOW(window), TRUE);
437         
438         g_signal_connect(G_OBJECT(window), "delete_event",
439                          G_CALLBACK(addrgather_dlg_delete_event), NULL);
440         g_signal_connect(G_OBJECT(window), "key_press_event",
441                          G_CALLBACK(addrgather_dlg_key_pressed), NULL);
442
443         vbox = gtk_vbox_new(FALSE, 6);
444         gtk_container_add(GTK_CONTAINER(window), vbox);
445
446         /* Notebook */
447         notebook = gtk_notebook_new();
448         gtk_notebook_set_show_tabs(GTK_NOTEBOOK(notebook), FALSE);
449         gtk_widget_show(notebook);
450         gtk_box_pack_start(GTK_BOX(vbox), notebook, TRUE, TRUE, 0);
451         gtk_container_set_border_width(GTK_CONTAINER(notebook), 6);
452
453         /* Status line */
454         hsbox = gtk_hbox_new(FALSE, 0);
455         gtk_box_pack_end(GTK_BOX(vbox), hsbox, FALSE, FALSE, 0);
456         statusbar = gtk_statusbar_new();
457         gtk_box_pack_start(GTK_BOX(hsbox), statusbar, TRUE, TRUE, 0);
458
459         /* Button panel */
460         gtkut_stock_button_set_create(&hbbox, &btnCancel, GTK_STOCK_CANCEL,
461                                       &btnOk, GTK_STOCK_OK,
462                                       NULL, NULL);
463         gtk_box_pack_end(GTK_BOX(vbox), hbbox, FALSE, FALSE, 0);
464
465         /* Signal handlers */
466         g_signal_connect(G_OBJECT(btnOk), "clicked",
467                          G_CALLBACK(addrgather_dlg_ok), NULL);
468         g_signal_connect(G_OBJECT(btnCancel), "clicked",
469                          G_CALLBACK(addrgather_dlg_cancel), NULL);
470
471         gtk_widget_show_all(vbox);
472
473         addrgather_dlg.window     = window;
474         addrgather_dlg.notebook   = notebook;
475         addrgather_dlg.btnOk      = btnOk;
476         addrgather_dlg.btnCancel  = btnCancel;
477         addrgather_dlg.statusbar  = statusbar;
478         addrgather_dlg.status_cid = gtk_statusbar_get_context_id(GTK_STATUSBAR(statusbar),
479                                                                  "Collect Email Address Dialog");
480
481         /* Create notebook pages */
482         addrgather_page_fields(PAGE_FIELDS, _("Header Fields"));
483         addrgather_page_finish(PAGE_FINISH, _("Finish"));
484         gtk_widget_show_all(addrgather_dlg.window);
485 }
486
487 /*
488  * Harvest addresses main window.
489  * Enter: folderItem Source folder.
490  *        addrIndex  Address index.
491  *        sourceInd  Source indicator: FALSE - Folder, TRUE - Messages.
492  *        msgList    List of message numbers, or NULL to process folder.
493  * Return: Populated address book file, or NULL if none created.
494  */
495 AddressBookFile *addrgather_dlg_execute(FolderItem *folderItem, AddressIndex *addrIndex,
496                                         gboolean sourceInd, GList *msgList)
497 {
498         gint i;
499
500         _harv_addressIndex_ = addrIndex;
501         _harv_addressBook_ = NULL;
502         _harv_messageList_ = msgList;
503
504         /* Create dialog */
505         if (!addrgather_dlg.window)
506                 addrgather_dlg_create();
507         
508         addrgather_dlg.done = FALSE;
509
510         gtk_notebook_set_current_page(GTK_NOTEBOOK(addrgather_dlg.notebook), PAGE_FIELDS);
511         addrgather_dlg.folderPath = folder_item_get_path(folderItem);
512
513         /* Setup some default values */
514         gtk_label_set_text(GTK_LABEL(addrgather_dlg.labelFolder), folderItem->path);
515         gtk_entry_set_text(GTK_ENTRY(addrgather_dlg.entryBook), folderItem->path);
516
517         for (i = 0; i < NUM_FIELDS; i++) {
518                 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
519                                              FALSE);
520                 if (g_utf8_collate(_harv_headerNames_[i], HEADER_FROM) == 0)
521                         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkHeader[i]),
522                                                     TRUE);
523         }
524
525         gtk_widget_set_sensitive(addrgather_dlg.btnOk, TRUE);
526         gtk_widget_grab_default(addrgather_dlg.btnOk);
527
528         /* Apply window title */
529         if (sourceInd) {
530                 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
531                                      _("Collect email addresses from selected messages"));
532                 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, FALSE);
533         } else {
534                 gtk_window_set_title(GTK_WINDOW(addrgather_dlg.window),
535                                      _("Collect email addresses from folder"));
536                 gtk_widget_set_sensitive(addrgather_dlg.checkRecurse, TRUE);
537         }
538         gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(addrgather_dlg.checkRecurse), FALSE);
539
540         addrgather_dlg_status_show("");
541         gtk_widget_show(addrgather_dlg.window);
542
543         gtk_widget_grab_focus(addrgather_dlg.entryBook);
544         manage_window_set_transient(GTK_WINDOW(addrgather_dlg.window));
545         gtk_main();
546
547         g_free(addrgather_dlg.folderPath);
548         addrgather_dlg.folderPath = NULL;
549         gtk_widget_hide(addrgather_dlg.window);
550         _harv_addressIndex_ = NULL;
551
552         if (addrgather_dlg.cancelled == TRUE)
553                 return NULL;
554
555         return _harv_addressBook_;
556 }
557
558 /*
559 * End of Source.
560 */
561
562