src/gtk/logwindow.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2013 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 #include "claws-features.h"
  23 #endif
  24
  25 #include <glib.h>
  26 #include <glib/gi18n.h>
  27 #include <gdk/gdkkeysyms.h>
  28 #include <gtk/gtk.h>
  29
  30 #include "logwindow.h"
  31 #include "utils.h"
  32 #include "gtkutils.h"
  33 #include "log.h"
  34 #include "hooks.h"
  35 #include "prefs_common.h"
  36
  37 static void hide_cb                             (GtkWidget      *widget,
  38                                                  LogWindow      *logwin);
  39 static gboolean key_pressed                     (GtkWidget      *widget,
  40                                                  GdkEventKey    *event,
  41                                                  LogWindow      *logwin);
  42 static void size_allocate_cb    (GtkWidget *widget,
  43                                          GtkAllocation *allocation,
  44                                          gpointer data);
  45 static gboolean log_window_append               (gpointer        source,
  46                                                  gpointer        data);
  47 static void log_window_clip                     (LogWindow      *logwin,
  48                                                  guint           glip_length);
  49 static void log_window_clear                    (GtkWidget      *widget,
  50                                                  LogWindow      *logwin);
  51 static void log_window_popup_menu_extend        (GtkTextView    *textview,
  52                                                  GtkMenu        *menu,
  53                                                  LogWindow      *logwin);
  54
  55 /*!
  56  *\brief        Save Gtk object size to prefs dataset
  57  */
  58 static void size_allocate_cb(GtkWidget *widget,
  59                                          GtkAllocation *allocation,
  60                                          gpointer data)
  61 {
  62         gint *prefs_logwin_width = NULL;
  63         gint *prefs_logwin_height = NULL;
  64         LogInstance instance = GPOINTER_TO_INT(data);
  65
  66         cm_return_if_fail(allocation != NULL);
  67
  68         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
  69         cm_return_if_fail(prefs_logwin_width != NULL);
  70         cm_return_if_fail(prefs_logwin_height != NULL);
  71
  72         *prefs_logwin_width = allocation->width;
  73         *prefs_logwin_height = allocation->height;
  74 }
  75
  76 LogWindow *log_window_create(LogInstance instance)
  77 {
  78         LogWindow *logwin;
  79         GtkWidget *window;
  80         GtkWidget *scrolledwin;
  81         GtkWidget *text;
  82         GtkTextBuffer *buffer;
  83         GtkTextIter iter;
  84         static GdkGeometry geometry;
  85         gint *prefs_logwin_width = NULL;
  86         gint *prefs_logwin_height = NULL;
  87
  88         debug_print("Creating log window...\n");
  89
  90         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
  91         cm_return_val_if_fail(prefs_logwin_width != NULL, NULL);
  92         cm_return_val_if_fail(prefs_logwin_height != NULL, NULL);
  93
  94         logwin = g_new0(LogWindow, 1);
  95
  96         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "logwindow");
  97         gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER_ALWAYS);
  98         gtk_window_set_title(GTK_WINDOW(window), get_log_title(instance));
  99         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
 100         g_signal_connect(G_OBJECT(window), "delete_event",
 101                          G_CALLBACK(gtk_widget_hide_on_delete), NULL);
 102         g_signal_connect(G_OBJECT(window), "key_press_event",
 103                          G_CALLBACK(key_pressed), logwin);
 104         g_signal_connect_after(G_OBJECT(window), "hide",
 105                          G_CALLBACK(hide_cb), logwin);
 106         gtk_widget_realize(window);
 107
 108         scrolledwin = gtk_scrolled_window_new(NULL, NULL);
 109         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwin),
 110                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 111         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwin),
 112                                             GTK_SHADOW_IN);
 113         gtk_container_add(GTK_CONTAINER(window), scrolledwin);
 114         gtk_widget_show(scrolledwin);
 115
 116         text = gtk_text_view_new();
 117         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
 118         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(text), GTK_WRAP_WORD);
 119         logwin->buffer = buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 120
 121         g_object_ref(G_OBJECT(logwin->buffer));
 122         gtk_text_view_set_buffer(GTK_TEXT_VIEW(text), NULL);
 123         logwin->hidden = TRUE;
 124         logwin->never_shown = TRUE;
 125
 126         gtk_text_buffer_get_start_iter(buffer, &iter);
 127         logwin->end_mark = gtk_text_buffer_create_mark(buffer, "end", &iter, FALSE);
 128
 129         g_signal_connect(G_OBJECT(text), "populate-popup",
 130                          G_CALLBACK(log_window_popup_menu_extend), logwin);
 131         gtk_container_add(GTK_CONTAINER(scrolledwin), text);
 132         gtk_widget_show(text);
 133
 134         g_signal_connect(G_OBJECT(window), "size_allocate",
 135                          G_CALLBACK(size_allocate_cb), GINT_TO_POINTER(instance));
 136
 137         if (!geometry.min_height) {
 138                 geometry.min_width = 520;
 139                 geometry.min_height = 400;
 140         }
 141
 142         gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
 143                                       GDK_HINT_MIN_SIZE);
 144         gtk_widget_set_size_request(window, *prefs_logwin_width,
 145                                     *prefs_logwin_height);
 146
 147         logwin->window = window;
 148         logwin->scrolledwin = scrolledwin;
 149         logwin->text = text;
 150         logwin->hook_id = hooks_register_hook(get_log_hook(instance), log_window_append, logwin);
 151
 152         return logwin;
 153 }
 154
 155 #define LOG_COLORS 8
 156
 157 void log_window_init(LogWindow *logwin)
 158 {
 159         GtkTextBuffer *buffer;
 160 #if !GTK_CHECK_VERSION(3, 0, 0)
 161         GdkColormap *colormap;
 162         gboolean success[LOG_COLORS];
 163 #endif
 164         GdkColor color[LOG_COLORS];
 165         gint i;
 166
 167         gtkut_convert_int_to_gdk_color(prefs_common.log_msg_color, &color[0]);
 168         gtkut_convert_int_to_gdk_color(prefs_common.log_warn_color, &color[1]);
 169         gtkut_convert_int_to_gdk_color(prefs_common.log_error_color, &color[2]);
 170         gtkut_convert_int_to_gdk_color(prefs_common.log_in_color, &color[3]);
 171         gtkut_convert_int_to_gdk_color(prefs_common.log_out_color, &color[4]);
 172         gtkut_convert_int_to_gdk_color(prefs_common.log_status_ok_color, &color[5]);
 173         gtkut_convert_int_to_gdk_color(prefs_common.log_status_nok_color, &color[6]);
 174         gtkut_convert_int_to_gdk_color(prefs_common.log_status_skip_color, &color[7]);
 175
 176         logwin->msg_color = color[0];
 177         logwin->warn_color = color[1];
 178         logwin->error_color = color[2];
 179         logwin->in_color = color[3];
 180         logwin->out_color = color[4];
 181         logwin->status_ok_color = color[5];
 182         logwin->status_nok_color = color[6];
 183         logwin->status_skip_color = color[7];
 184
 185 #if !GTK_CHECK_VERSION(3, 0, 0)
 186         colormap = gdk_drawable_get_colormap(gtk_widget_get_window(logwin->window));
 187         gdk_colormap_alloc_colors(colormap, color, LOG_COLORS, FALSE, TRUE, success);
 188
 189         for (i = 0; i < LOG_COLORS; i++) {
 190                 if (success[i] == FALSE) {
 191                         GtkStyle *style;
 192
 193                         g_warning("LogWindow: color allocation failed");
 194                         style = gtk_widget_get_style(logwin->window);
 195                         logwin->msg_color = logwin->warn_color =
 196                                         logwin->error_color = logwin->in_color =
 197                                         logwin->out_color = logwin->status_ok_color =
 198                                         logwin->status_nok_color = logwin->status_skip_color =
 199                                         style->black;
 200                         break;
 201                 }
 202         }
 203 #endif
 204
 205         buffer = logwin->buffer;
 206         gtk_text_buffer_create_tag(buffer, "message",
 207                                    "foreground-gdk", &logwin->msg_color,
 208                                    NULL);
 209         gtk_text_buffer_create_tag(buffer, "warn",
 210                                    "foreground-gdk", &logwin->warn_color,
 211                                    NULL);
 212         logwin->error_tag = gtk_text_buffer_create_tag(buffer, "error",
 213                                    "foreground-gdk", &logwin->error_color,
 214                                    NULL);
 215         gtk_text_buffer_create_tag(buffer, "input",
 216                                    "foreground-gdk", &logwin->in_color,
 217                                    NULL);
 218         gtk_text_buffer_create_tag(buffer, "output",
 219                                    "foreground-gdk", &logwin->out_color,
 220                                    NULL);
 221         gtk_text_buffer_create_tag(buffer, "status_ok",
 222                                    "foreground-gdk", &logwin->status_ok_color,
 223                                    NULL);
 224         gtk_text_buffer_create_tag(buffer, "status_nok",
 225                                    "foreground-gdk", &logwin->status_nok_color,
 226                                    NULL);
 227         gtk_text_buffer_create_tag(buffer, "status_skip",
 228                                    "foreground-gdk", &logwin->status_skip_color,
 229                                    NULL);
 230 }
 231
 232 #undef LOG_COLORS
 233
 234 void log_window_show(LogWindow *logwin)
 235 {
 236         GtkTextView *text = GTK_TEXT_VIEW(logwin->text);
 237         GtkTextBuffer *buffer = logwin->buffer;
 238         GtkTextMark *mark;
 239
 240         logwin->hidden = FALSE;
 241
 242         if (logwin->never_shown)
 243                 gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), logwin->buffer);
 244
 245         logwin->never_shown = FALSE;
 246
 247         mark = gtk_text_buffer_get_mark(buffer, "end");
 248         gtk_text_view_scroll_mark_onscreen(text, mark);
 249
 250         gtk_window_deiconify(GTK_WINDOW(logwin->window));
 251         gtk_widget_show(logwin->window);
 252         gtk_window_present(GTK_WINDOW(logwin->window));
 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 = gtk_text_view_get_vadjustment(text);
 370                 gfloat upper = gtk_adjustment_get_upper(vadj) -
 371                     gtk_adjustment_get_page_size(vadj);
 372                 gfloat value = gtk_adjustment_get_value(vadj);
 373                 if (value == upper ||
 374                     (upper - value < 16 && value < 8))
 375                         gtk_text_view_scroll_mark_onscreen(text, logwindow->end_mark);
 376         }
 377
 378         return FALSE;
 379 }
 380
 381 static void hide_cb(GtkWidget *widget, LogWindow *logwin)
 382 {
 383         logwin->hidden = TRUE;
 384 }
 385
 386 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
 387                         LogWindow *logwin)
 388 {
 389         if (event && event->keyval == GDK_KEY_Escape)
 390                 gtk_widget_hide(logwin->window);
 391         else if (event && event->keyval == GDK_KEY_Delete)
 392                 log_window_clear(NULL, logwin);
 393
 394         return FALSE;
 395 }
 396
 397 static void log_window_clip(LogWindow *logwin, guint clip_length)
 398 {
 399         guint length;
 400         guint point;
 401         GtkTextBuffer *textbuf = logwin->buffer;
 402         GtkTextIter start_iter, end_iter;
 403
 404         length = gtk_text_buffer_get_line_count(textbuf);
 405         /* debug_print("Log window length: %u\n", length); */
 406
 407         if (length > clip_length) {
 408                 /* find the end of the first line after the cut off
 409                  * point */
 410                 point = length - clip_length;
 411                 gtk_text_buffer_get_iter_at_line(textbuf, &end_iter, point);
 412                 if (!gtk_text_iter_forward_to_line_end(&end_iter))
 413                         return;
 414                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 415                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 416                 if (logwin->has_error) {
 417                         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 418                         if (mainwindow_get_mainwindow() && !gtk_text_iter_forward_to_tag_toggle(&start_iter, logwin->error_tag)) {
 419                                 mainwindow_clear_error(mainwindow_get_mainwindow());
 420                                 logwin->has_error = FALSE;
 421                         }
 422                 }
 423         }
 424 }
 425
 426 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
 427 {
 428         GtkTextBuffer *textbuf = logwin->buffer;
 429         GtkTextIter start_iter, end_iter;
 430
 431         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 432         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
 433         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 434 }
 435
 436 static void log_window_popup_menu_extend(GtkTextView *textview,
 437                         GtkMenu *menu, LogWindow *logwin)
 438 {
 439         GtkWidget *menuitem;
 440
 441         cm_return_if_fail(menu != NULL);
 442         cm_return_if_fail(GTK_IS_MENU_SHELL(menu));
 443
 444         menuitem = gtk_separator_menu_item_new();
 445         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 446         gtk_widget_show(menuitem);
 447
 448         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
 449         g_signal_connect(G_OBJECT(menuitem), "activate",
 450                          G_CALLBACK(log_window_clear), logwin);
 451         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 452         gtk_widget_show(menuitem);
 453 }
 454