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