2009-10-03 [colin] 3.7.2cvs42
[claws.git] / src / gtk / logwindow.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2009 Hiroyuki Yamamoto 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 #ifdef HAVE_CONFIG_H
21 #  include "config.h"
22 #endif
23
24 #include <glib.h>
25 #include <glib/gi18n.h>
26 #include <gdk/gdkkeysyms.h>
27 #include <gtk/gtk.h>
28
29 #include "logwindow.h"
30 #include "utils.h"
31 #include "gtkutils.h"
32 #include "log.h"
33 #include "hooks.h"
34 #include "prefs_common.h"
35
36 static void hide_cb                             (GtkWidget      *widget,
37                                                  LogWindow      *logwin);
38 static gboolean key_pressed                     (GtkWidget      *widget,
39                                                  GdkEventKey    *event,
40                                                  LogWindow      *logwin);
41 static void size_allocate_cb    (GtkWidget *widget,
42                                          GtkAllocation *allocation,
43                                          gpointer data);
44 static gboolean log_window_append               (gpointer        source,
45                                                  gpointer        data);
46 static void log_window_clip                     (LogWindow      *logwin,
47                                                  guint           glip_length);
48 static void log_window_clear                    (GtkWidget      *widget,
49                                                  LogWindow      *logwin);
50 static void log_window_popup_menu_extend        (GtkTextView    *textview,
51                                                  GtkMenu        *menu,
52                                                  LogWindow      *logwin);
53                                          
54 /*!
55  *\brief        Save Gtk object size to prefs dataset
56  */
57 static void size_allocate_cb(GtkWidget *widget,
58                                          GtkAllocation *allocation,
59                                          gpointer data)
60 {
61         gint *prefs_logwin_width = NULL;
62         gint *prefs_logwin_height = NULL;
63         LogInstance instance = GPOINTER_TO_INT(data);
64
65         cm_return_if_fail(allocation != NULL);
66
67         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
68         cm_return_if_fail(prefs_logwin_width != NULL);
69         cm_return_if_fail(prefs_logwin_height != NULL);
70
71         *prefs_logwin_width = allocation->width;
72         *prefs_logwin_height = allocation->height;
73 }
74
75 LogWindow *log_window_create(LogInstance instance)
76 {
77         LogWindow *logwin;
78         GtkWidget *window;
79         GtkWidget *scrolledwin;
80         GtkWidget *text;
81         GtkTextBuffer *buffer;
82         GtkTextIter iter;
83         static GdkGeometry geometry;
84         gint *prefs_logwin_width = NULL;
85         gint *prefs_logwin_height = NULL;
86
87         debug_print("Creating log window...\n");
88
89         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
90         cm_return_val_if_fail(prefs_logwin_width != NULL, NULL);
91         cm_return_val_if_fail(prefs_logwin_height != NULL, NULL);
92
93         logwin = g_new0(LogWindow, 1);
94
95         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "logwindow");
96         gtk_window_set_title(GTK_WINDOW(window), get_log_title(instance));
97         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
98         g_signal_connect(G_OBJECT(window), "delete_event",
99                          G_CALLBACK(gtk_widget_hide_on_delete), NULL);
100         g_signal_connect(G_OBJECT(window), "key_press_event",
101                          G_CALLBACK(key_pressed), logwin);
102         g_signal_connect_after(G_OBJECT(window), "hide",
103                          G_CALLBACK(hide_cb), logwin);
104         gtk_widget_realize(window);
105
106         scrolledwin = gtk_scrolled_window_new(NULL, NULL);
107         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwin),
108                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
109         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwin),
110                                             GTK_SHADOW_IN);
111         gtk_container_add(GTK_CONTAINER(window), scrolledwin);
112         gtk_widget_show(scrolledwin);
113
114         text = gtk_text_view_new();
115         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
116         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(text), GTK_WRAP_WORD);
117         logwin->buffer = buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
118
119         g_object_ref(G_OBJECT(logwin->buffer));
120         gtk_text_view_set_buffer(GTK_TEXT_VIEW(text), NULL);
121         logwin->hidden = TRUE;
122         logwin->never_shown = TRUE;
123
124         gtk_text_buffer_get_start_iter(buffer, &iter);
125         logwin->end_mark = gtk_text_buffer_create_mark(buffer, "end", &iter, FALSE);
126
127         g_signal_connect(G_OBJECT(text), "populate-popup",
128                          G_CALLBACK(log_window_popup_menu_extend), logwin);
129         gtk_container_add(GTK_CONTAINER(scrolledwin), text);
130         gtk_widget_show(text);
131
132         g_signal_connect(G_OBJECT(window), "size_allocate",
133                          G_CALLBACK(size_allocate_cb), GINT_TO_POINTER(instance));
134
135         if (!geometry.min_height) {
136                 geometry.min_width = 520;
137                 geometry.min_height = 400;
138         }
139
140         gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
141                                       GDK_HINT_MIN_SIZE);
142         gtk_widget_set_size_request(window, *prefs_logwin_width,
143                                     *prefs_logwin_height);
144
145         logwin->window = window;
146         logwin->scrolledwin = scrolledwin;
147         logwin->text = text;
148         logwin->hook_id = hooks_register_hook(get_log_hook(instance), log_window_append, logwin);
149
150         return logwin;
151 }
152
153 #define LOG_COLORS 8
154
155 void log_window_init(LogWindow *logwin)
156 {
157         GtkTextBuffer *buffer;
158         GdkColormap *colormap;
159         GdkColor color[LOG_COLORS];
160         gboolean success[LOG_COLORS];
161         gint i;
162
163         gtkut_convert_int_to_gdk_color(prefs_common.log_msg_color, &color[0]);
164         gtkut_convert_int_to_gdk_color(prefs_common.log_warn_color, &color[1]);
165         gtkut_convert_int_to_gdk_color(prefs_common.log_error_color, &color[2]);
166         gtkut_convert_int_to_gdk_color(prefs_common.log_in_color, &color[3]);
167         gtkut_convert_int_to_gdk_color(prefs_common.log_out_color, &color[4]);
168         gtkut_convert_int_to_gdk_color(prefs_common.log_status_ok_color, &color[5]);
169         gtkut_convert_int_to_gdk_color(prefs_common.log_status_nok_color, &color[6]);
170         gtkut_convert_int_to_gdk_color(prefs_common.log_status_skip_color, &color[7]);
171
172         logwin->msg_color = color[0];
173         logwin->warn_color = color[1];
174         logwin->error_color = color[2];
175         logwin->in_color = color[3];
176         logwin->out_color = color[4];
177         logwin->status_ok_color = color[5];
178         logwin->status_nok_color = color[6];
179         logwin->status_skip_color = color[7];
180
181         colormap = gdk_drawable_get_colormap(logwin->window->window);
182         gdk_colormap_alloc_colors(colormap, color, LOG_COLORS, FALSE, TRUE, success);
183
184         for (i = 0; i < LOG_COLORS; i++) {
185                 if (success[i] == FALSE) {
186                         GtkStyle *style;
187
188                         g_warning("LogWindow: color allocation failed\n");
189                         style = gtk_widget_get_style(logwin->window);
190                         logwin->msg_color = logwin->warn_color =
191                                         logwin->error_color = logwin->in_color =
192                                         logwin->out_color = logwin->status_ok_color =
193                                         logwin->status_nok_color = logwin->status_skip_color =
194                                         style->black;
195                         break;
196                 }
197         }
198
199         buffer = logwin->buffer;
200         gtk_text_buffer_create_tag(buffer, "message",
201                                    "foreground-gdk", &logwin->msg_color,
202                                    NULL);
203         gtk_text_buffer_create_tag(buffer, "warn",
204                                    "foreground-gdk", &logwin->warn_color,
205                                    NULL);
206         logwin->error_tag = gtk_text_buffer_create_tag(buffer, "error",
207                                    "foreground-gdk", &logwin->error_color,
208                                    NULL);
209         gtk_text_buffer_create_tag(buffer, "input",
210                                    "foreground-gdk", &logwin->in_color,
211                                    NULL);
212         gtk_text_buffer_create_tag(buffer, "output",
213                                    "foreground-gdk", &logwin->out_color,
214                                    NULL);
215         gtk_text_buffer_create_tag(buffer, "status_ok",
216                                    "foreground-gdk", &logwin->status_ok_color,
217                                    NULL);
218         gtk_text_buffer_create_tag(buffer, "status_nok",
219                                    "foreground-gdk", &logwin->status_nok_color,
220                                    NULL);
221         gtk_text_buffer_create_tag(buffer, "status_skip",
222                                    "foreground-gdk", &logwin->status_skip_color,
223                                    NULL);
224 }
225
226 #undef LOG_COLORS
227
228 void log_window_show(LogWindow *logwin)
229 {
230         GtkTextView *text = GTK_TEXT_VIEW(logwin->text);
231         GtkTextBuffer *buffer = logwin->buffer;
232         GtkTextMark *mark;
233
234         logwin->hidden = FALSE;
235
236         if (logwin->never_shown)
237                 gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), logwin->buffer);
238
239         logwin->never_shown = FALSE;
240
241         mark = gtk_text_buffer_get_mark(buffer, "end");
242         gtk_text_view_scroll_mark_onscreen(text, mark);
243
244         gtk_window_deiconify(GTK_WINDOW(logwin->window));
245         gtk_widget_show(logwin->window);
246         gtk_window_present(GTK_WINDOW(logwin->window));
247 #ifdef MAEMO
248         maemo_window_full_screen_if_needed(GTK_WINDOW(logwin->window));
249         maemo_connect_key_press_to_mainwindow(GTK_WINDOW(logwin->window));
250 #endif
251 }
252
253 static void log_window_jump_to_error(LogWindow *logwin)
254 {
255         GtkTextIter iter;
256         gtk_text_buffer_get_end_iter(logwin->buffer, &iter);
257         if (!gtk_text_iter_backward_to_tag_toggle(&iter, logwin->error_tag))
258                 return;
259
260         gtk_text_iter_backward_line(&iter);
261         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(logwin->text), &iter, 0, TRUE, 0, 0);
262 }
263
264 void log_window_show_error(LogWindow *logwin)
265 {
266         log_window_show(logwin);
267         log_window_jump_to_error(logwin);
268 }
269
270 void log_window_set_clipping(LogWindow *logwin, gboolean clip, guint clip_length)
271 {
272         cm_return_if_fail(logwin != NULL);
273
274         logwin->clip = clip;
275         logwin->clip_length = clip_length;
276 }
277
278 static gboolean log_window_append(gpointer source, gpointer data)
279 {
280         LogText *logtext = (LogText *) source;
281         LogWindow *logwindow = (LogWindow *) data;
282         GtkTextView *text;
283         GtkTextBuffer *buffer;
284         GtkTextIter iter;
285         gchar *head = NULL;
286         const gchar *tag;
287
288         cm_return_val_if_fail(logtext != NULL, TRUE);
289         cm_return_val_if_fail(logtext->text != NULL, TRUE);
290         cm_return_val_if_fail(logwindow != NULL, FALSE);
291
292         if (logwindow->clip && !logwindow->clip_length)
293                 return FALSE;
294
295         text = GTK_TEXT_VIEW(logwindow->text);
296         buffer = logwindow->buffer;
297         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
298
299         switch (logtext->type) {
300         case LOG_MSG:
301                 tag = "message";
302                 head = "* ";
303                 break;
304         case LOG_WARN:
305                 tag = "warn";
306                 head = "** ";
307                 break;
308         case LOG_ERROR:
309                 tag = "error";
310                 head = "*** ";
311                 logwindow->has_error = TRUE;
312                 break;
313         case LOG_STATUS_OK:
314                 tag = "status_ok";
315                 head = "> ";
316                 break;
317         case LOG_STATUS_NOK:
318                 tag = "status_nok";
319                 head = "> ";
320                 break;
321         case LOG_STATUS_SKIP:
322                 tag = "status_skip";
323                 head = "> skipped: ";
324                 break;
325         default:
326                 tag = NULL;
327                 break;
328         }
329
330         if (logtext->instance == LOG_PROTOCOL) {
331                 if (tag == NULL) {
332                         if (strstr(logtext->text, "] POP3>")
333                         ||  strstr(logtext->text, "] IMAP4>")
334                         ||  strstr(logtext->text, "] SMTP>")
335                         ||  strstr(logtext->text, "] ESMTP>")
336                         ||  strstr(logtext->text, "] NNTP>"))
337                                 tag = "output";
338                         if (strstr(logtext->text, "] POP3<")
339                         ||  strstr(logtext->text, "] IMAP4<")
340                         ||  strstr(logtext->text, "] SMTP<")
341                         ||  strstr(logtext->text, "] ESMTP<")
342                         ||  strstr(logtext->text, "] NNTP<"))
343                                 tag = "input";
344                 }
345         }
346
347         if (head)
348                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, head, -1,
349                                                          tag, NULL);
350
351         if (!g_utf8_validate(logtext->text, -1, NULL)) {
352                 gchar * mybuf = g_malloc(strlen(logtext->text)*2 +1);
353                 conv_localetodisp(mybuf, strlen(logtext->text)*2 +1, logtext->text);
354                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, mybuf, -1,
355                                                          tag, NULL);
356                 g_free(mybuf);
357         } else {
358                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, logtext->text, -1,
359                                                          tag, NULL);
360         }
361         gtk_text_buffer_get_start_iter(buffer, &iter);
362
363         if (logwindow->clip)
364                log_window_clip (logwindow, logwindow->clip_length);
365
366         if (!logwindow->hidden) {
367                 GtkAdjustment *vadj = text->vadjustment;
368                 gfloat upper = vadj->upper - vadj->page_size;
369                 if (vadj->value == upper || 
370                     (upper - vadj->value < 16 && vadj->value < 8))
371                         gtk_text_view_scroll_mark_onscreen(text, logwindow->end_mark);
372         }
373
374         return FALSE;
375 }
376
377 static void hide_cb(GtkWidget *widget, LogWindow *logwin)
378 {
379         logwin->hidden = TRUE;
380 }
381
382 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
383                         LogWindow *logwin)
384 {
385         if (event && event->keyval == GDK_Escape)
386                 gtk_widget_hide(logwin->window);
387         else if (event && event->keyval == GDK_Delete) 
388                 log_window_clear(NULL, logwin);
389
390         return FALSE;
391 }
392
393 static void log_window_clip(LogWindow *logwin, guint clip_length)
394 {
395         guint length;
396         guint point;
397         GtkTextBuffer *textbuf = logwin->buffer;
398         GtkTextIter start_iter, end_iter;
399         
400         length = gtk_text_buffer_get_line_count(textbuf);
401         /* debug_print("Log window length: %u\n", length); */
402         
403         if (length > clip_length) {
404                 /* find the end of the first line after the cut off
405                  * point */
406                 point = length - clip_length;
407                 gtk_text_buffer_get_iter_at_line(textbuf, &end_iter, point);
408                 if (!gtk_text_iter_forward_to_line_end(&end_iter))
409                         return;
410                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
411                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
412                 if (logwin->has_error) {
413                         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
414                         if (mainwindow_get_mainwindow() && !gtk_text_iter_forward_to_tag_toggle(&start_iter, logwin->error_tag)) {
415                                 mainwindow_clear_error(mainwindow_get_mainwindow());
416                                 logwin->has_error = FALSE;
417                         }
418                 }
419         }
420 }
421
422 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
423 {
424         GtkTextBuffer *textbuf = logwin->buffer;
425         GtkTextIter start_iter, end_iter;
426         
427         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
428         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
429         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
430 }
431
432 static void log_window_popup_menu_extend(GtkTextView *textview,
433                         GtkMenu *menu, LogWindow *logwin)
434 {
435         GtkWidget *menuitem;
436         
437         cm_return_if_fail(menu != NULL);
438         cm_return_if_fail(GTK_IS_MENU_SHELL(menu));
439
440         menuitem = gtk_separator_menu_item_new();
441         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
442         gtk_widget_show(menuitem);
443         
444         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
445         g_signal_connect(G_OBJECT(menuitem), "activate",
446                          G_CALLBACK(log_window_clear), logwin);
447         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
448         gtk_widget_show(menuitem);
449 }
450