src/gtk/logwindow.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2007 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 2 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, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  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/gtkwidget.h>
  28 #include <gtk/gtkwindow.h>
  29 #include <gtk/gtksignal.h>
  30 #include <gtk/gtkscrolledwindow.h>
  31 #include <gtk/gtktextview.h>
  32 #include <gtk/gtkstyle.h>
  33 #include <gtk/gtkmenuitem.h>
  34 #include <gtk/gtkseparatormenuitem.h>
  35
  36 #include "logwindow.h"
  37 #include "utils.h"
  38 #include "gtkutils.h"
  39 #include "log.h"
  40 #include "hooks.h"
  41 #include "prefs_common.h"
  42
  43 static void hide_cb                             (GtkWidget      *widget,
  44                                                  LogWindow      *logwin);
  45 static gboolean key_pressed                     (GtkWidget      *widget,
  46                                                  GdkEventKey    *event,
  47                                                  LogWindow      *logwin);
  48 static void size_allocate_cb    (GtkWidget *widget,
  49                                          GtkAllocation *allocation,
  50                                          gpointer data);
  51 static gboolean log_window_append               (gpointer        source,
  52                                                  gpointer        data);
  53 static void log_window_clip                     (LogWindow      *logwin,
  54                                                  guint           glip_length);
  55 static void log_window_clear                    (GtkWidget      *widget,
  56                                                  LogWindow      *logwin);
  57 static void log_window_popup_menu_extend        (GtkTextView    *textview,
  58                                                  GtkMenu        *menu,
  59                                                  LogWindow      *logwin);
  60
  61 /*!
  62  *\brief        Save Gtk object size to prefs dataset
  63  */
  64 static void size_allocate_cb(GtkWidget *widget,
  65                                          GtkAllocation *allocation,
  66                                          gpointer data)
  67 {
  68         gint *prefs_logwin_width = NULL;
  69         gint *prefs_logwin_height = NULL;
  70         LogInstance instance = GPOINTER_TO_INT(data);
  71
  72         g_return_if_fail(allocation != NULL);
  73
  74         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
  75         g_return_if_fail(prefs_logwin_width != NULL);
  76         g_return_if_fail(prefs_logwin_height != NULL);
  77
  78         *prefs_logwin_width = allocation->width;
  79         *prefs_logwin_height = allocation->height;
  80 }
  81
  82 LogWindow *log_window_create(LogInstance instance)
  83 {
  84         LogWindow *logwin;
  85         GtkWidget *window;
  86         GtkWidget *scrolledwin;
  87         GtkWidget *text;
  88         GtkTextBuffer *buffer;
  89         GtkTextIter iter;
  90         static GdkGeometry geometry;
  91         gint *prefs_logwin_width = NULL;
  92         gint *prefs_logwin_height = NULL;
  93
  94         debug_print("Creating log window...\n");
  95
  96         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
  97         g_return_val_if_fail(prefs_logwin_width != NULL, NULL);
  98         g_return_val_if_fail(prefs_logwin_height != NULL, NULL);
  99
 100         logwin = g_new0(LogWindow, 1);
 101
 102         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "logwindow");
 103         gtk_window_set_title(GTK_WINDOW(window), get_log_title(instance));
 104         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
 105         g_signal_connect(G_OBJECT(window), "delete_event",
 106                          G_CALLBACK(gtk_widget_hide_on_delete), NULL);
 107         g_signal_connect(G_OBJECT(window), "key_press_event",
 108                          G_CALLBACK(key_pressed), logwin);
 109         g_signal_connect_after(G_OBJECT(window), "hide",
 110                          G_CALLBACK(hide_cb), logwin);
 111         gtk_widget_realize(window);
 112
 113         scrolledwin = gtk_scrolled_window_new(NULL, NULL);
 114         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwin),
 115                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 116         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwin),
 117                                             GTK_SHADOW_IN);
 118         gtk_container_add(GTK_CONTAINER(window), scrolledwin);
 119         gtk_widget_show(scrolledwin);
 120
 121         text = gtk_text_view_new();
 122         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
 123         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(text), GTK_WRAP_WORD);
 124         logwin->buffer = buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 125
 126         g_object_ref(G_OBJECT(logwin->buffer));
 127         gtk_text_view_set_buffer(GTK_TEXT_VIEW(text), NULL);
 128         logwin->hidden = TRUE;
 129         logwin->never_shown = TRUE;
 130
 131         gtk_text_buffer_get_start_iter(buffer, &iter);
 132         logwin->end_mark = gtk_text_buffer_create_mark(buffer, "end", &iter, FALSE);
 133
 134         g_signal_connect(G_OBJECT(text), "populate-popup",
 135                          G_CALLBACK(log_window_popup_menu_extend), logwin);
 136         gtk_container_add(GTK_CONTAINER(scrolledwin), text);
 137         gtk_widget_show(text);
 138
 139         g_signal_connect(G_OBJECT(window), "size_allocate",
 140                          G_CALLBACK(size_allocate_cb), GINT_TO_POINTER(instance));
 141
 142         if (!geometry.min_height) {
 143                 geometry.min_width = 520;
 144                 geometry.min_height = 400;
 145         }
 146
 147         gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
 148                                       GDK_HINT_MIN_SIZE);
 149         gtk_widget_set_size_request(window, *prefs_logwin_width,
 150                                     *prefs_logwin_height);
 151
 152         logwin->window = window;
 153         logwin->scrolledwin = scrolledwin;
 154         logwin->text = text;
 155         logwin->hook_id = hooks_register_hook(get_log_hook(instance), log_window_append, logwin);
 156
 157         gtk_text_view_scroll_mark_onscreen(GTK_TEXT_VIEW(text), logwin->end_mark);
 158
 159         return logwin;
 160 }
 161
 162 #define LOG_COLORS 8
 163
 164 void log_window_init(LogWindow *logwin)
 165 {
 166         GtkTextBuffer *buffer;
 167         GdkColormap *colormap;
 168         GdkColor color[LOG_COLORS];
 169         gboolean success[LOG_COLORS];
 170         gint i;
 171
 172         gtkut_convert_int_to_gdk_color(prefs_common.log_msg_color, &color[0]);
 173         gtkut_convert_int_to_gdk_color(prefs_common.log_warn_color, &color[1]);
 174         gtkut_convert_int_to_gdk_color(prefs_common.log_error_color, &color[2]);
 175         gtkut_convert_int_to_gdk_color(prefs_common.log_in_color, &color[3]);
 176         gtkut_convert_int_to_gdk_color(prefs_common.log_out_color, &color[4]);
 177         gtkut_convert_int_to_gdk_color(prefs_common.log_status_ok_color, &color[5]);
 178         gtkut_convert_int_to_gdk_color(prefs_common.log_status_nok_color, &color[6]);
 179         gtkut_convert_int_to_gdk_color(prefs_common.log_status_skip_color, &color[7]);
 180
 181         logwin->msg_color = color[0];
 182         logwin->warn_color = color[1];
 183         logwin->error_color = color[2];
 184         logwin->in_color = color[3];
 185         logwin->out_color = color[4];
 186         logwin->status_ok_color = color[5];
 187         logwin->status_nok_color = color[6];
 188         logwin->status_skip_color = color[7];
 189
 190         colormap = gdk_drawable_get_colormap(logwin->window->window);
 191         gdk_colormap_alloc_colors(colormap, color, LOG_COLORS, FALSE, TRUE, success);
 192
 193         for (i = 0; i < LOG_COLORS; i++) {
 194                 if (success[i] == FALSE) {
 195                         GtkStyle *style;
 196
 197                         g_warning("LogWindow: color allocation failed\n");
 198                         style = gtk_widget_get_style(logwin->window);
 199                         logwin->msg_color = logwin->warn_color =
 200                                         logwin->error_color = logwin->in_color =
 201                                         logwin->out_color = logwin->status_ok_color =
 202                                         logwin->status_nok_color = logwin->status_skip_color =
 203                                         style->black;
 204                         break;
 205                 }
 206         }
 207
 208         buffer = logwin->buffer;
 209         gtk_text_buffer_create_tag(buffer, "message",
 210                                    "foreground-gdk", &logwin->msg_color,
 211                                    NULL);
 212         gtk_text_buffer_create_tag(buffer, "warn",
 213                                    "foreground-gdk", &logwin->warn_color,
 214                                    NULL);
 215         logwin->error_tag = gtk_text_buffer_create_tag(buffer, "error",
 216                                    "foreground-gdk", &logwin->error_color,
 217                                    NULL);
 218         gtk_text_buffer_create_tag(buffer, "input",
 219                                    "foreground-gdk", &logwin->in_color,
 220                                    NULL);
 221         gtk_text_buffer_create_tag(buffer, "output",
 222                                    "foreground-gdk", &logwin->out_color,
 223                                    NULL);
 224         gtk_text_buffer_create_tag(buffer, "status_ok",
 225                                    "foreground-gdk", &logwin->status_ok_color,
 226                                    NULL);
 227         gtk_text_buffer_create_tag(buffer, "status_nok",
 228                                    "foreground-gdk", &logwin->status_nok_color,
 229                                    NULL);
 230         gtk_text_buffer_create_tag(buffer, "status_skip",
 231                                    "foreground-gdk", &logwin->status_skip_color,
 232                                    NULL);
 233 }
 234
 235 #undef LOG_COLORS
 236
 237 void log_window_show(LogWindow *logwin)
 238 {
 239         GtkTextView *text = GTK_TEXT_VIEW(logwin->text);
 240         GtkTextBuffer *buffer = logwin->buffer;
 241         GtkTextMark *mark;
 242
 243         logwin->hidden = FALSE;
 244
 245         if (logwin->never_shown)
 246                 gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), logwin->buffer);
 247
 248         logwin->never_shown = FALSE;
 249
 250         mark = gtk_text_buffer_get_mark(buffer, "end");
 251         gtk_text_view_scroll_mark_onscreen(text, mark);
 252
 253         gtk_widget_show(logwin->window);
 254 #ifdef MAEMO
 255         maemo_window_full_screen_if_needed(GTK_WINDOW(logwin->window));
 256         maemo_connect_key_press_to_mainwindow(GTK_WINDOW(logwin->window));
 257 #endif
 258 }
 259
 260 static void log_window_jump_to_error(LogWindow *logwin)
 261 {
 262         GtkTextIter iter;
 263         gtk_text_buffer_get_end_iter(logwin->buffer, &iter);
 264         if (!gtk_text_iter_backward_to_tag_toggle(&iter, logwin->error_tag))
 265                 return;
 266
 267         gtk_text_iter_backward_line(&iter);
 268         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(logwin->text), &iter, 0, TRUE, 0, 0);
 269 }
 270
 271 void log_window_show_error(LogWindow *logwin)
 272 {
 273         log_window_show(logwin);
 274         log_window_jump_to_error(logwin);
 275 }
 276
 277 void log_window_set_clipping(LogWindow *logwin, gboolean clip, guint clip_length)
 278 {
 279         g_return_if_fail(logwin != NULL);
 280
 281         logwin->clip = clip;
 282         logwin->clip_length = clip_length;
 283 }
 284
 285 static gboolean log_window_append(gpointer source, gpointer data)
 286 {
 287         LogText *logtext = (LogText *) source;
 288         LogWindow *logwindow = (LogWindow *) data;
 289         GtkTextView *text;
 290         GtkTextBuffer *buffer;
 291         GtkTextIter iter;
 292         gchar *head = NULL;
 293         const gchar *tag;
 294
 295         g_return_val_if_fail(logtext != NULL, TRUE);
 296         g_return_val_if_fail(logtext->text != NULL, TRUE);
 297         g_return_val_if_fail(logwindow != NULL, FALSE);
 298
 299         if (logwindow->clip && !logwindow->clip_length)
 300                 return FALSE;
 301
 302         text = GTK_TEXT_VIEW(logwindow->text);
 303         buffer = logwindow->buffer;
 304         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
 305
 306         switch (logtext->type) {
 307         case LOG_MSG:
 308                 tag = "message";
 309                 head = "* ";
 310                 break;
 311         case LOG_WARN:
 312                 tag = "warn";
 313                 head = "** ";
 314                 break;
 315         case LOG_ERROR:
 316                 tag = "error";
 317                 head = "*** ";
 318                 break;
 319         case LOG_STATUS_OK:
 320                 tag = "status_ok";
 321                 head = "> ";
 322                 break;
 323         case LOG_STATUS_NOK:
 324                 tag = "status_nok";
 325                 head = "> ";
 326                 break;
 327         case LOG_STATUS_SKIP:
 328                 tag = "status_skip";
 329                 head = "> skipped: ";
 330                 break;
 331         default:
 332                 tag = NULL;
 333                 break;
 334         }
 335
 336         if (logtext->instance == LOG_PROTOCOL) {
 337                 if (tag == NULL) {
 338                         if (strstr(logtext->text, "] POP3>")
 339                         ||  strstr(logtext->text, "] IMAP4>")
 340                         ||  strstr(logtext->text, "] SMTP>")
 341                         ||  strstr(logtext->text, "] ESMTP>")
 342                         ||  strstr(logtext->text, "] NNTP>"))
 343                                 tag = "output";
 344                         if (strstr(logtext->text, "] POP3<")
 345                         ||  strstr(logtext->text, "] IMAP4<")
 346                         ||  strstr(logtext->text, "] SMTP<")
 347                         ||  strstr(logtext->text, "] ESMTP<")
 348                         ||  strstr(logtext->text, "] NNTP<"))
 349                                 tag = "input";
 350                 }
 351         }
 352
 353         if (head)
 354                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, head, -1,
 355                                                          tag, NULL);
 356
 357         if (!g_utf8_validate(logtext->text, -1, NULL)) {
 358                 gchar * mybuf = g_malloc(strlen(logtext->text)*2 +1);
 359                 conv_localetodisp(mybuf, strlen(logtext->text)*2 +1, logtext->text);
 360                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, mybuf, -1,
 361                                                          tag, NULL);
 362                 g_free(mybuf);
 363         } else {
 364                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, logtext->text, -1,
 365                                                          tag, NULL);
 366         }
 367         gtk_text_buffer_get_start_iter(buffer, &iter);
 368
 369         if (logwindow->clip)
 370                log_window_clip (logwindow, logwindow->clip_length);
 371
 372         if (!logwindow->hidden) {
 373                 GtkAdjustment *vadj = text->vadjustment;
 374                 gfloat upper = vadj->upper - vadj->page_size;
 375                 if (vadj->value == upper ||
 376                     (upper - vadj->value < 16 && vadj->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_Escape)
 392                 gtk_widget_hide(logwin->window);
 393         else if (event && event->keyval == GDK_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         }
 419 }
 420
 421 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
 422 {
 423         GtkTextBuffer *textbuf = logwin->buffer;
 424         GtkTextIter start_iter, end_iter;
 425
 426         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 427         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
 428         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 429 }
 430
 431 static void log_window_popup_menu_extend(GtkTextView *textview,
 432                         GtkMenu *menu, LogWindow *logwin)
 433 {
 434         GtkWidget *menuitem;
 435
 436         g_return_if_fail(menu != NULL);
 437         g_return_if_fail(GTK_IS_MENU_SHELL(menu));
 438
 439         menuitem = gtk_separator_menu_item_new();
 440         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 441         gtk_widget_show(menuitem);
 442
 443         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
 444         g_signal_connect(G_OBJECT(menuitem), "activate",
 445                          G_CALLBACK(log_window_clear), logwin);
 446         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 447         gtk_widget_show(menuitem);
 448 }
 449