ab254724e644d35c0d1d34e1fae2de523d613361
[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         gtk_text_view_scroll_mark_onscreen(GTK_TEXT_VIEW(text), logwin->end_mark);
151
152         return logwin;
153 }
154
155 #define LOG_COLORS 8
156
157 void log_window_init(LogWindow *logwin)
158 {
159         GtkTextBuffer *buffer;
160         GdkColormap *colormap;
161         GdkColor color[LOG_COLORS];
162         gboolean success[LOG_COLORS];
163         gint i;
164
165         gtkut_convert_int_to_gdk_color(prefs_common.log_msg_color, &color[0]);
166         gtkut_convert_int_to_gdk_color(prefs_common.log_warn_color, &color[1]);
167         gtkut_convert_int_to_gdk_color(prefs_common.log_error_color, &color[2]);
168         gtkut_convert_int_to_gdk_color(prefs_common.log_in_color, &color[3]);
169         gtkut_convert_int_to_gdk_color(prefs_common.log_out_color, &color[4]);
170         gtkut_convert_int_to_gdk_color(prefs_common.log_status_ok_color, &color[5]);
171         gtkut_convert_int_to_gdk_color(prefs_common.log_status_nok_color, &color[6]);
172         gtkut_convert_int_to_gdk_color(prefs_common.log_status_skip_color, &color[7]);
173
174         logwin->msg_color = color[0];
175         logwin->warn_color = color[1];
176         logwin->error_color = color[2];
177         logwin->in_color = color[3];
178         logwin->out_color = color[4];
179         logwin->status_ok_color = color[5];
180         logwin->status_nok_color = color[6];
181         logwin->status_skip_color = color[7];
182
183         colormap = gdk_drawable_get_colormap(logwin->window->window);
184         gdk_colormap_alloc_colors(colormap, color, LOG_COLORS, FALSE, TRUE, success);
185
186         for (i = 0; i < LOG_COLORS; i++) {
187                 if (success[i] == FALSE) {
188                         GtkStyle *style;
189
190                         g_warning("LogWindow: color allocation failed\n");
191                         style = gtk_widget_get_style(logwin->window);
192                         logwin->msg_color = logwin->warn_color =
193                                         logwin->error_color = logwin->in_color =
194                                         logwin->out_color = logwin->status_ok_color =
195                                         logwin->status_nok_color = logwin->status_skip_color =
196                                         style->black;
197                         break;
198                 }
199         }
200
201         buffer = logwin->buffer;
202         gtk_text_buffer_create_tag(buffer, "message",
203                                    "foreground-gdk", &logwin->msg_color,
204                                    NULL);
205         gtk_text_buffer_create_tag(buffer, "warn",
206                                    "foreground-gdk", &logwin->warn_color,
207                                    NULL);
208         logwin->error_tag = gtk_text_buffer_create_tag(buffer, "error",
209                                    "foreground-gdk", &logwin->error_color,
210                                    NULL);
211         gtk_text_buffer_create_tag(buffer, "input",
212                                    "foreground-gdk", &logwin->in_color,
213                                    NULL);
214         gtk_text_buffer_create_tag(buffer, "output",
215                                    "foreground-gdk", &logwin->out_color,
216                                    NULL);
217         gtk_text_buffer_create_tag(buffer, "status_ok",
218                                    "foreground-gdk", &logwin->status_ok_color,
219                                    NULL);
220         gtk_text_buffer_create_tag(buffer, "status_nok",
221                                    "foreground-gdk", &logwin->status_nok_color,
222                                    NULL);
223         gtk_text_buffer_create_tag(buffer, "status_skip",
224                                    "foreground-gdk", &logwin->status_skip_color,
225                                    NULL);
226 }
227
228 #undef LOG_COLORS
229
230 void log_window_show(LogWindow *logwin)
231 {
232         GtkTextView *text = GTK_TEXT_VIEW(logwin->text);
233         GtkTextBuffer *buffer = logwin->buffer;
234         GtkTextMark *mark;
235
236         logwin->hidden = FALSE;
237
238         if (logwin->never_shown)
239                 gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), logwin->buffer);
240
241         logwin->never_shown = FALSE;
242
243         mark = gtk_text_buffer_get_mark(buffer, "end");
244         gtk_text_view_scroll_mark_onscreen(text, mark);
245
246         gtk_window_deiconify(GTK_WINDOW(logwin->window));
247         gtk_widget_show(logwin->window);
248         gtk_window_present(GTK_WINDOW(logwin->window));
249 #ifdef MAEMO
250         maemo_window_full_screen_if_needed(GTK_WINDOW(logwin->window));
251         maemo_connect_key_press_to_mainwindow(GTK_WINDOW(logwin->window));
252 #endif
253 }
254
255 static void log_window_jump_to_error(LogWindow *logwin)
256 {
257         GtkTextIter iter;
258         gtk_text_buffer_get_end_iter(logwin->buffer, &iter);
259         if (!gtk_text_iter_backward_to_tag_toggle(&iter, logwin->error_tag))
260                 return;
261
262         gtk_text_iter_backward_line(&iter);
263         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(logwin->text), &iter, 0, TRUE, 0, 0);
264 }
265
266 void log_window_show_error(LogWindow *logwin)
267 {
268         log_window_show(logwin);
269         log_window_jump_to_error(logwin);
270 }
271
272 void log_window_set_clipping(LogWindow *logwin, gboolean clip, guint clip_length)
273 {
274         cm_return_if_fail(logwin != NULL);
275
276         logwin->clip = clip;
277         logwin->clip_length = clip_length;
278 }
279
280 static gboolean log_window_append(gpointer source, gpointer data)
281 {
282         LogText *logtext = (LogText *) source;
283         LogWindow *logwindow = (LogWindow *) data;
284         GtkTextView *text;
285         GtkTextBuffer *buffer;
286         GtkTextIter iter;
287         gchar *head = NULL;
288         const gchar *tag;
289
290         cm_return_val_if_fail(logtext != NULL, TRUE);
291         cm_return_val_if_fail(logtext->text != NULL, TRUE);
292         cm_return_val_if_fail(logwindow != NULL, FALSE);
293
294         if (logwindow->clip && !logwindow->clip_length)
295                 return FALSE;
296
297         text = GTK_TEXT_VIEW(logwindow->text);
298         buffer = logwindow->buffer;
299         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
300
301         switch (logtext->type) {
302         case LOG_MSG:
303                 tag = "message";
304                 head = "* ";
305                 break;
306         case LOG_WARN:
307                 tag = "warn";
308                 head = "** ";
309                 break;
310         case LOG_ERROR:
311                 tag = "error";
312                 head = "*** ";
313                 logwindow->has_error = TRUE;
314                 break;
315         case LOG_STATUS_OK:
316                 tag = "status_ok";
317                 head = "> ";
318                 break;
319         case LOG_STATUS_NOK:
320                 tag = "status_nok";
321                 head = "> ";
322                 break;
323         case LOG_STATUS_SKIP:
324                 tag = "status_skip";
325                 head = "> skipped: ";
326                 break;
327         default:
328                 tag = NULL;
329                 break;
330         }
331
332         if (logtext->instance == LOG_PROTOCOL) {
333                 if (tag == NULL) {
334                         if (strstr(logtext->text, "] POP3>")
335                         ||  strstr(logtext->text, "] IMAP4>")
336                         ||  strstr(logtext->text, "] SMTP>")
337                         ||  strstr(logtext->text, "] ESMTP>")
338                         ||  strstr(logtext->text, "] NNTP>"))
339                                 tag = "output";
340                         if (strstr(logtext->text, "] POP3<")
341                         ||  strstr(logtext->text, "] IMAP4<")
342                         ||  strstr(logtext->text, "] SMTP<")
343                         ||  strstr(logtext->text, "] ESMTP<")
344                         ||  strstr(logtext->text, "] NNTP<"))
345                                 tag = "input";
346                 }
347         }
348
349         if (head)
350                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, head, -1,
351                                                          tag, NULL);
352
353         if (!g_utf8_validate(logtext->text, -1, NULL)) {
354                 gchar * mybuf = g_malloc(strlen(logtext->text)*2 +1);
355                 conv_localetodisp(mybuf, strlen(logtext->text)*2 +1, logtext->text);
356                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, mybuf, -1,
357                                                          tag, NULL);
358                 g_free(mybuf);
359         } else {
360                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, logtext->text, -1,
361                                                          tag, NULL);
362         }
363         gtk_text_buffer_get_start_iter(buffer, &iter);
364
365         if (logwindow->clip)
366                log_window_clip (logwindow, logwindow->clip_length);
367
368         if (!logwindow->hidden) {
369                 GtkAdjustment *vadj = text->vadjustment;
370                 gfloat upper = vadj->upper - vadj->page_size;
371                 if (vadj->value == upper || 
372                     (upper - vadj->value < 16 && vadj->value < 8))
373                         gtk_text_view_scroll_mark_onscreen(text, logwindow->end_mark);
374         }
375
376         return FALSE;
377 }
378
379 static void hide_cb(GtkWidget *widget, LogWindow *logwin)
380 {
381         logwin->hidden = TRUE;
382 }
383
384 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
385                         LogWindow *logwin)
386 {
387         if (event && event->keyval == GDK_Escape)
388                 gtk_widget_hide(logwin->window);
389         else if (event && event->keyval == GDK_Delete) 
390                 log_window_clear(NULL, logwin);
391
392         return FALSE;
393 }
394
395 static void log_window_clip(LogWindow *logwin, guint clip_length)
396 {
397         guint length;
398         guint point;
399         GtkTextBuffer *textbuf = logwin->buffer;
400         GtkTextIter start_iter, end_iter;
401         
402         length = gtk_text_buffer_get_line_count(textbuf);
403         /* debug_print("Log window length: %u\n", length); */
404         
405         if (length > clip_length) {
406                 /* find the end of the first line after the cut off
407                  * point */
408                 point = length - clip_length;
409                 gtk_text_buffer_get_iter_at_line(textbuf, &end_iter, point);
410                 if (!gtk_text_iter_forward_to_line_end(&end_iter))
411                         return;
412                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
413                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
414                 if (logwin->has_error) {
415                         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
416                         if (mainwindow_get_mainwindow() && !gtk_text_iter_forward_to_tag_toggle(&start_iter, logwin->error_tag)) {
417                                 mainwindow_clear_error(mainwindow_get_mainwindow());
418                                 logwin->has_error = FALSE;
419                         }
420                 }
421         }
422 }
423
424 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
425 {
426         GtkTextBuffer *textbuf = logwin->buffer;
427         GtkTextIter start_iter, end_iter;
428         
429         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
430         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
431         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
432 }
433
434 static void log_window_popup_menu_extend(GtkTextView *textview,
435                         GtkMenu *menu, LogWindow *logwin)
436 {
437         GtkWidget *menuitem;
438         
439         cm_return_if_fail(menu != NULL);
440         cm_return_if_fail(GTK_IS_MENU_SHELL(menu));
441
442         menuitem = gtk_separator_menu_item_new();
443         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
444         gtk_widget_show(menuitem);
445         
446         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
447         g_signal_connect(G_OBJECT(menuitem), "activate",
448                          G_CALLBACK(log_window_clear), logwin);
449         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
450         gtk_widget_show(menuitem);
451 }
452