src/gtk/logwindow.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2012 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_title(GTK_WINDOW(window), get_log_title(instance));
  98         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
  99         g_signal_connect(G_OBJECT(window), "delete_event",
 100                          G_CALLBACK(gtk_widget_hide_on_delete), NULL);
 101         g_signal_connect(G_OBJECT(window), "key_press_event",
 102                          G_CALLBACK(key_pressed), logwin);
 103         g_signal_connect_after(G_OBJECT(window), "hide",
 104                          G_CALLBACK(hide_cb), logwin);
 105         gtk_widget_realize(window);
 106
 107         scrolledwin = gtk_scrolled_window_new(NULL, NULL);
 108         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwin),
 109                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 110         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwin),
 111                                             GTK_SHADOW_IN);
 112         gtk_container_add(GTK_CONTAINER(window), scrolledwin);
 113         gtk_widget_show(scrolledwin);
 114
 115         text = gtk_text_view_new();
 116         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
 117         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(text), GTK_WRAP_WORD);
 118         logwin->buffer = buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 119
 120         g_object_ref(G_OBJECT(logwin->buffer));
 121         gtk_text_view_set_buffer(GTK_TEXT_VIEW(text), NULL);
 122         logwin->hidden = TRUE;
 123         logwin->never_shown = TRUE;
 124
 125         gtk_text_buffer_get_start_iter(buffer, &iter);
 126         logwin->end_mark = gtk_text_buffer_create_mark(buffer, "end", &iter, FALSE);
 127
 128         g_signal_connect(G_OBJECT(text), "populate-popup",
 129                          G_CALLBACK(log_window_popup_menu_extend), logwin);
 130         gtk_container_add(GTK_CONTAINER(scrolledwin), text);
 131         gtk_widget_show(text);
 132
 133         g_signal_connect(G_OBJECT(window), "size_allocate",
 134                          G_CALLBACK(size_allocate_cb), GINT_TO_POINTER(instance));
 135
 136         if (!geometry.min_height) {
 137                 geometry.min_width = 520;
 138                 geometry.min_height = 400;
 139         }
 140
 141         gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
 142                                       GDK_HINT_MIN_SIZE);
 143         gtk_widget_set_size_request(window, *prefs_logwin_width,
 144                                     *prefs_logwin_height);
 145
 146         logwin->window = window;
 147         logwin->scrolledwin = scrolledwin;
 148         logwin->text = text;
 149         logwin->hook_id = hooks_register_hook(get_log_hook(instance), log_window_append, logwin);
 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.log_msg_color, &color[0]);
 167         gtkut_convert_int_to_gdk_color(prefs_common.log_warn_color, &color[1]);
 168         gtkut_convert_int_to_gdk_color(prefs_common.log_error_color, &color[2]);
 169         gtkut_convert_int_to_gdk_color(prefs_common.log_in_color, &color[3]);
 170         gtkut_convert_int_to_gdk_color(prefs_common.log_out_color, &color[4]);
 171         gtkut_convert_int_to_gdk_color(prefs_common.log_status_ok_color, &color[5]);
 172         gtkut_convert_int_to_gdk_color(prefs_common.log_status_nok_color, &color[6]);
 173         gtkut_convert_int_to_gdk_color(prefs_common.log_status_skip_color, &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\n");
 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 #ifdef MAEMO
 253         maemo_window_full_screen_if_needed(GTK_WINDOW(logwin->window));
 254         maemo_connect_key_press_to_mainwindow(GTK_WINDOW(logwin->window));
 255 #endif
 256 }
 257
 258 static void log_window_jump_to_error(LogWindow *logwin)
 259 {
 260         GtkTextIter iter;
 261         gtk_text_buffer_get_end_iter(logwin->buffer, &iter);
 262         if (!gtk_text_iter_backward_to_tag_toggle(&iter, logwin->error_tag))
 263                 return;
 264
 265         gtk_text_iter_backward_line(&iter);
 266         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(logwin->text), &iter, 0, TRUE, 0, 0);
 267 }
 268
 269 void log_window_show_error(LogWindow *logwin)
 270 {
 271         log_window_show(logwin);
 272         log_window_jump_to_error(logwin);
 273 }
 274
 275 void log_window_set_clipping(LogWindow *logwin, gboolean clip, guint clip_length)
 276 {
 277         cm_return_if_fail(logwin != NULL);
 278
 279         logwin->clip = clip;
 280         logwin->clip_length = clip_length;
 281 }
 282
 283 static gboolean log_window_append(gpointer source, gpointer data)
 284 {
 285         LogText *logtext = (LogText *) source;
 286         LogWindow *logwindow = (LogWindow *) data;
 287         GtkTextView *text;
 288         GtkTextBuffer *buffer;
 289         GtkTextIter iter;
 290         gchar *head = NULL;
 291         const gchar *tag;
 292
 293         cm_return_val_if_fail(logtext != NULL, TRUE);
 294         cm_return_val_if_fail(logtext->text != NULL, TRUE);
 295         cm_return_val_if_fail(logwindow != NULL, FALSE);
 296
 297         if (logwindow->clip && !logwindow->clip_length)
 298                 return FALSE;
 299
 300         text = GTK_TEXT_VIEW(logwindow->text);
 301         buffer = logwindow->buffer;
 302         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
 303
 304         switch (logtext->type) {
 305         case LOG_MSG:
 306                 tag = "message";
 307                 head = "* ";
 308                 break;
 309         case LOG_WARN:
 310                 tag = "warn";
 311                 head = "** ";
 312                 break;
 313         case LOG_ERROR:
 314                 tag = "error";
 315                 head = "*** ";
 316                 logwindow->has_error = TRUE;
 317                 break;
 318         case LOG_STATUS_OK:
 319                 tag = "status_ok";
 320                 head = "> ";
 321                 break;
 322         case LOG_STATUS_NOK:
 323                 tag = "status_nok";
 324                 head = "> ";
 325                 break;
 326         case LOG_STATUS_SKIP:
 327                 tag = "status_skip";
 328                 head = "> skipped: ";
 329                 break;
 330         default:
 331                 tag = NULL;
 332                 break;
 333         }
 334
 335         if (logtext->instance == LOG_PROTOCOL) {
 336                 if (tag == NULL) {
 337                         if (strstr(logtext->text, "] POP3>")
 338                         ||  strstr(logtext->text, "] IMAP4>")
 339                         ||  strstr(logtext->text, "] SMTP>")
 340                         ||  strstr(logtext->text, "] ESMTP>")
 341                         ||  strstr(logtext->text, "] NNTP>"))
 342                                 tag = "output";
 343                         if (strstr(logtext->text, "] POP3<")
 344                         ||  strstr(logtext->text, "] IMAP4<")
 345                         ||  strstr(logtext->text, "] SMTP<")
 346                         ||  strstr(logtext->text, "] ESMTP<")
 347                         ||  strstr(logtext->text, "] NNTP<"))
 348                                 tag = "input";
 349                 }
 350         }
 351
 352         if (head)
 353                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, head, -1,
 354                                                          tag, NULL);
 355
 356         if (!g_utf8_validate(logtext->text, -1, NULL)) {
 357                 gchar * mybuf = g_malloc(strlen(logtext->text)*2 +1);
 358                 conv_localetodisp(mybuf, strlen(logtext->text)*2 +1, logtext->text);
 359                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, mybuf, -1,
 360                                                          tag, NULL);
 361                 g_free(mybuf);
 362         } else {
 363                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, logtext->text, -1,
 364                                                          tag, NULL);
 365         }
 366         gtk_text_buffer_get_start_iter(buffer, &iter);
 367
 368         if (logwindow->clip)
 369                log_window_clip (logwindow, logwindow->clip_length);
 370
 371         if (!logwindow->hidden) {
 372                 GtkAdjustment *vadj = gtk_text_view_get_vadjustment(text);
 373                 gfloat upper = gtk_adjustment_get_upper(vadj) -
 374                     gtk_adjustment_get_page_size(vadj);
 375                 gfloat value = gtk_adjustment_get_value(vadj);
 376                 if (value == upper ||
 377                     (upper - value < 16 && value < 8))
 378                         gtk_text_view_scroll_mark_onscreen(text, logwindow->end_mark);
 379         }
 380
 381         return FALSE;
 382 }
 383
 384 static void hide_cb(GtkWidget *widget, LogWindow *logwin)
 385 {
 386         logwin->hidden = TRUE;
 387 }
 388
 389 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
 390                         LogWindow *logwin)
 391 {
 392         if (event && event->keyval == GDK_KEY_Escape)
 393                 gtk_widget_hide(logwin->window);
 394         else if (event && event->keyval == GDK_KEY_Delete)
 395                 log_window_clear(NULL, logwin);
 396
 397         return FALSE;
 398 }
 399
 400 static void log_window_clip(LogWindow *logwin, guint clip_length)
 401 {
 402         guint length;
 403         guint point;
 404         GtkTextBuffer *textbuf = logwin->buffer;
 405         GtkTextIter start_iter, end_iter;
 406
 407         length = gtk_text_buffer_get_line_count(textbuf);
 408         /* debug_print("Log window length: %u\n", length); */
 409
 410         if (length > clip_length) {
 411                 /* find the end of the first line after the cut off
 412                  * point */
 413                 point = length - clip_length;
 414                 gtk_text_buffer_get_iter_at_line(textbuf, &end_iter, point);
 415                 if (!gtk_text_iter_forward_to_line_end(&end_iter))
 416                         return;
 417                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 418                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 419                 if (logwin->has_error) {
 420                         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 421                         if (mainwindow_get_mainwindow() && !gtk_text_iter_forward_to_tag_toggle(&start_iter, logwin->error_tag)) {
 422                                 mainwindow_clear_error(mainwindow_get_mainwindow());
 423                                 logwin->has_error = FALSE;
 424                         }
 425                 }
 426         }
 427 }
 428
 429 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
 430 {
 431         GtkTextBuffer *textbuf = logwin->buffer;
 432         GtkTextIter start_iter, end_iter;
 433
 434         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 435         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
 436         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 437 }
 438
 439 static void log_window_popup_menu_extend(GtkTextView *textview,
 440                         GtkMenu *menu, LogWindow *logwin)
 441 {
 442         GtkWidget *menuitem;
 443
 444         cm_return_if_fail(menu != NULL);
 445         cm_return_if_fail(GTK_IS_MENU_SHELL(menu));
 446
 447         menuitem = gtk_separator_menu_item_new();
 448         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 449         gtk_widget_show(menuitem);
 450
 451         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
 452         g_signal_connect(G_OBJECT(menuitem), "activate",
 453                          G_CALLBACK(log_window_clear), logwin);
 454         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 455         gtk_widget_show(menuitem);
 456 }
 457