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