src/gtk/logwindow.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2006 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 static gboolean log_window_append               (gpointer        source,
  51                                                  gpointer        data);
  52 static void log_window_clip                     (LogWindow      *logwin,
  53                                                  guint           glip_length);
  54 static void log_window_clear                    (GtkWidget      *widget,
  55                                                  LogWindow      *logwin);
  56 static void log_window_popup_menu_extend        (GtkTextView    *textview,
  57                                                  GtkMenu        *menu,
  58                                                  LogWindow      *logwin);
  59
  60 /*!
  61  *\brief        Save Gtk object size to prefs dataset
  62  */
  63 static void size_allocate_cb(GtkWidget *widget,
  64                                          GtkAllocation *allocation)
  65 {
  66         g_return_if_fail(allocation != NULL);
  67
  68         prefs_common.logwin_width = allocation->width;
  69         prefs_common.logwin_height = allocation->height;
  70 }
  71
  72 LogWindow *log_window_create(void)
  73 {
  74         LogWindow *logwin;
  75         GtkWidget *window;
  76         GtkWidget *scrolledwin;
  77         GtkWidget *text;
  78         GtkTextBuffer *buffer;
  79         GtkTextIter iter;
  80         static GdkGeometry geometry;
  81
  82         debug_print("Creating log window...\n");
  83
  84         logwin = g_new0(LogWindow, 1);
  85
  86         window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
  87         gtk_window_set_title(GTK_WINDOW(window), _("Protocol log"));
  88         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
  89         g_signal_connect(G_OBJECT(window), "delete_event",
  90                          G_CALLBACK(gtk_widget_hide_on_delete), NULL);
  91         g_signal_connect(G_OBJECT(window), "key_press_event",
  92                          G_CALLBACK(key_pressed), logwin);
  93         g_signal_connect_after(G_OBJECT(window), "hide",
  94                          G_CALLBACK(hide_cb), logwin);
  95         gtk_widget_realize(window);
  96
  97         scrolledwin = gtk_scrolled_window_new(NULL, NULL);
  98         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwin),
  99                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 100         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwin),
 101                                             GTK_SHADOW_IN);
 102         gtk_container_add(GTK_CONTAINER(window), scrolledwin);
 103         gtk_widget_show(scrolledwin);
 104
 105         text = gtk_text_view_new();
 106         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
 107         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(text), GTK_WRAP_WORD);
 108         logwin->buffer = buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 109
 110         g_object_ref(G_OBJECT(logwin->buffer));
 111         gtk_text_view_set_buffer(GTK_TEXT_VIEW(text), NULL);
 112         logwin->hidden = TRUE;
 113
 114         gtk_text_buffer_get_start_iter(buffer, &iter);
 115         logwin->end_mark = gtk_text_buffer_create_mark(buffer, "end", &iter, FALSE);
 116
 117         g_signal_connect(G_OBJECT(text), "populate-popup",
 118                          G_CALLBACK(log_window_popup_menu_extend), logwin);
 119         gtk_container_add(GTK_CONTAINER(scrolledwin), text);
 120         gtk_widget_show(text);
 121
 122         g_signal_connect(G_OBJECT(window), "size_allocate",
 123                          G_CALLBACK(size_allocate_cb), NULL);
 124
 125         if (!geometry.min_height) {
 126                 geometry.min_width = 520;
 127                 geometry.min_height = 400;
 128         }
 129
 130         gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
 131                                       GDK_HINT_MIN_SIZE);
 132         gtk_widget_set_size_request(window, prefs_common.logwin_width,
 133                                     prefs_common.logwin_height);
 134
 135         logwin->window = window;
 136         logwin->scrolledwin = scrolledwin;
 137         logwin->text = text;
 138         logwin->hook_id = hooks_register_hook(LOG_APPEND_TEXT_HOOKLIST, log_window_append, logwin);
 139
 140         return logwin;
 141 }
 142
 143 void log_window_init(LogWindow *logwin)
 144 {
 145         GtkTextBuffer *buffer;
 146         GdkColormap *colormap;
 147         GdkColor color[5];
 148         gboolean success[5];
 149         gint i;
 150
 151         gtkut_convert_int_to_gdk_color(prefs_common.log_msg_color, &color[0]);
 152         gtkut_convert_int_to_gdk_color(prefs_common.log_warn_color, &color[1]);
 153         gtkut_convert_int_to_gdk_color(prefs_common.log_error_color, &color[2]);
 154         gtkut_convert_int_to_gdk_color(prefs_common.log_in_color, &color[3]);
 155         gtkut_convert_int_to_gdk_color(prefs_common.log_out_color, &color[4]);
 156
 157         logwin->msg_color = color[0];
 158         logwin->warn_color = color[1];
 159         logwin->error_color = color[2];
 160         logwin->in_color = color[3];
 161         logwin->out_color = color[4];
 162
 163         colormap = gdk_drawable_get_colormap(logwin->window->window);
 164         gdk_colormap_alloc_colors(colormap, color, 5, FALSE, TRUE, success);
 165
 166         for (i = 0; i < 5; i++) {
 167                 if (success[i] == FALSE) {
 168                         GtkStyle *style;
 169
 170                         g_warning("LogWindow: color allocation failed\n");
 171                         style = gtk_widget_get_style(logwin->window);
 172                         logwin->msg_color = logwin->warn_color =
 173                         logwin->error_color = logwin->in_color =
 174                         logwin->out_color = style->black;
 175                         break;
 176                 }
 177         }
 178
 179         buffer = logwin->buffer;
 180         gtk_text_buffer_create_tag(buffer, "message",
 181                                    "foreground-gdk", &logwin->msg_color,
 182                                    NULL);
 183         gtk_text_buffer_create_tag(buffer, "warn",
 184                                    "foreground-gdk", &logwin->warn_color,
 185                                    NULL);
 186         logwin->error_tag = gtk_text_buffer_create_tag(buffer, "error",
 187                                    "foreground-gdk", &logwin->error_color,
 188                                    NULL);
 189         gtk_text_buffer_create_tag(buffer, "input",
 190                                    "foreground-gdk", &logwin->in_color,
 191                                    NULL);
 192         gtk_text_buffer_create_tag(buffer, "output",
 193                                    "foreground-gdk", &logwin->out_color,
 194                                    NULL);
 195 }
 196
 197 void log_window_show(LogWindow *logwin)
 198 {
 199         GtkTextView *text = GTK_TEXT_VIEW(logwin->text);
 200         GtkTextBuffer *buffer = logwin->buffer;
 201         GtkTextMark *mark;
 202
 203         logwin->hidden = FALSE;
 204         gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), logwin->buffer);
 205
 206         mark = gtk_text_buffer_get_mark(buffer, "end");
 207         gtk_text_view_scroll_mark_onscreen(text, mark);
 208
 209         gtk_widget_show(logwin->window);
 210 }
 211
 212 static void log_window_jump_to_error(LogWindow *logwin)
 213 {
 214         GtkTextIter iter;
 215         gtk_text_buffer_get_end_iter(logwin->buffer, &iter);
 216         if (!gtk_text_iter_backward_to_tag_toggle(&iter, logwin->error_tag))
 217                 return;
 218
 219         gtk_text_iter_backward_line(&iter);
 220         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(logwin->text), &iter, 0, TRUE, 0, 0);
 221 }
 222
 223 void log_window_show_error(LogWindow *logwin)
 224 {
 225         log_window_show(logwin);
 226         log_window_jump_to_error(logwin);
 227 }
 228
 229 void log_window_set_clipping(LogWindow *logwin, gboolean clip, guint clip_length)
 230 {
 231         g_return_if_fail(logwin != NULL);
 232
 233         logwin->clip = clip;
 234         logwin->clip_length = clip_length;
 235 }
 236
 237 static gboolean log_window_append(gpointer source, gpointer data)
 238 {
 239         LogText *logtext = (LogText *) source;
 240         LogWindow *logwindow = (LogWindow *) data;
 241         GtkTextView *text;
 242         GtkTextBuffer *buffer;
 243         GtkTextIter iter;
 244         gchar *head = NULL;
 245         const gchar *tag;
 246
 247         g_return_val_if_fail(logtext != NULL, TRUE);
 248         g_return_val_if_fail(logtext->text != NULL, TRUE);
 249         g_return_val_if_fail(logwindow != NULL, FALSE);
 250
 251         if (logwindow->clip && !logwindow->clip_length)
 252                 return FALSE;
 253
 254         text = GTK_TEXT_VIEW(logwindow->text);
 255         buffer = logwindow->buffer;
 256         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
 257
 258         switch (logtext->type) {
 259         case LOG_MSG:
 260                 tag = "message";
 261                 head = "* ";
 262                 break;
 263         case LOG_WARN:
 264                 tag = "warn";
 265                 head = "** ";
 266                 break;
 267         case LOG_ERROR:
 268                 tag = "error";
 269                 head = "*** ";
 270                 break;
 271         default:
 272                 tag = NULL;
 273                 break;
 274         }
 275
 276         if (tag == NULL) {
 277                 if (strstr(logtext->text, "] POP3>")
 278                 ||  strstr(logtext->text, "] IMAP4>")
 279                 ||  strstr(logtext->text, "] SMTP>")
 280                 ||  strstr(logtext->text, "] ESMTP>")
 281                 ||  strstr(logtext->text, "] NNTP>"))
 282                         tag = "output";
 283                 if (strstr(logtext->text, "] POP3<")
 284                 ||  strstr(logtext->text, "] IMAP4<")
 285                 ||  strstr(logtext->text, "] SMTP<")
 286                 ||  strstr(logtext->text, "] ESMTP<")
 287                 ||  strstr(logtext->text, "] NNTP<"))
 288                         tag = "input";
 289         }
 290
 291         if (head)
 292                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, head, -1,
 293                                                          tag, NULL);
 294         gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, logtext->text, -1,
 295                                                  tag, NULL);
 296
 297         gtk_text_buffer_get_start_iter(buffer, &iter);
 298
 299         if (logwindow->clip)
 300                log_window_clip (logwindow, logwindow->clip_length);
 301
 302         if (!logwindow->hidden) {
 303                 GtkAdjustment *vadj = text->vadjustment;
 304                 gfloat upper = vadj->upper - vadj->page_size;
 305                 if (vadj->value == upper)
 306                         gtk_text_view_scroll_mark_onscreen(text, logwindow->end_mark);
 307         }
 308
 309         return FALSE;
 310 }
 311
 312 static void hide_cb(GtkWidget *widget, LogWindow *logwin)
 313 {
 314         gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), NULL);
 315         logwin->hidden = TRUE;
 316 }
 317
 318 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
 319                         LogWindow *logwin)
 320 {
 321         if (event && event->keyval == GDK_Escape)
 322                 gtk_widget_hide(logwin->window);
 323         else if (event && event->keyval == GDK_Delete)
 324                 log_window_clear(NULL, logwin);
 325
 326         return FALSE;
 327 }
 328
 329 static void log_window_clip(LogWindow *logwin, guint clip_length)
 330 {
 331         guint length;
 332         guint point;
 333         GtkTextBuffer *textbuf = logwin->buffer;
 334         GtkTextIter start_iter, end_iter;
 335
 336         length = gtk_text_buffer_get_line_count(textbuf);
 337         /* debug_print("Log window length: %u\n", length); */
 338
 339         if (length > clip_length) {
 340                 /* find the end of the first line after the cut off
 341                  * point */
 342                 point = length - clip_length;
 343                 gtk_text_buffer_get_iter_at_line(textbuf, &end_iter, point);
 344                 if (!gtk_text_iter_forward_to_line_end(&end_iter))
 345                         return;
 346                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 347                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 348         }
 349 }
 350
 351 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
 352 {
 353         GtkTextBuffer *textbuf = logwin->buffer;
 354         GtkTextIter start_iter, end_iter;
 355
 356         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 357         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
 358         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 359 }
 360
 361 static void log_window_popup_menu_extend(GtkTextView *textview,
 362                         GtkMenu *menu, LogWindow *logwin)
 363 {
 364         GtkWidget *menuitem;
 365
 366         g_return_if_fail(menu != NULL);
 367         g_return_if_fail(GTK_IS_MENU_SHELL(menu));
 368
 369         menuitem = gtk_separator_menu_item_new();
 370         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 371         gtk_widget_show(menuitem);
 372
 373         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
 374         g_signal_connect(G_OBJECT(menuitem), "activate",
 375                          G_CALLBACK(log_window_clear), logwin);
 376         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 377         gtk_widget_show(menuitem);
 378 }
 379