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 Sylpheed-Claws 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         gtk_text_buffer_get_start_iter(buffer, &iter);
 111         gtk_text_buffer_create_mark(buffer, "end", &iter, FALSE);
 112         g_signal_connect(G_OBJECT(text), "populate-popup",
 113                          G_CALLBACK(log_window_popup_menu_extend), logwin);
 114         gtk_container_add(GTK_CONTAINER(scrolledwin), text);
 115         gtk_widget_show(text);
 116
 117         g_signal_connect(G_OBJECT(window), "size_allocate",
 118                          G_CALLBACK(size_allocate_cb), NULL);
 119
 120         if (!geometry.min_height) {
 121                 geometry.min_width = 520;
 122                 geometry.min_height = 400;
 123         }
 124
 125         gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
 126                                       GDK_HINT_MIN_SIZE);
 127         gtk_widget_set_size_request(window, prefs_common.logwin_width,
 128                                     prefs_common.logwin_height);
 129
 130         logwin->window = window;
 131         logwin->scrolledwin = scrolledwin;
 132         logwin->text = text;
 133         logwin->hook_id = hooks_register_hook(LOG_APPEND_TEXT_HOOKLIST, log_window_append, logwin);
 134
 135         return logwin;
 136 }
 137
 138 void log_window_init(LogWindow *logwin)
 139 {
 140         GtkTextBuffer *buffer;
 141         GdkColormap *colormap;
 142         GdkColor color[5];
 143         gboolean success[5];
 144         gint i;
 145
 146         gtkut_convert_int_to_gdk_color(prefs_common.log_msg_color, &color[0]);
 147         gtkut_convert_int_to_gdk_color(prefs_common.log_warn_color, &color[1]);
 148         gtkut_convert_int_to_gdk_color(prefs_common.log_error_color, &color[2]);
 149         gtkut_convert_int_to_gdk_color(prefs_common.log_in_color, &color[3]);
 150         gtkut_convert_int_to_gdk_color(prefs_common.log_out_color, &color[4]);
 151
 152         logwin->msg_color = color[0];
 153         logwin->warn_color = color[1];
 154         logwin->error_color = color[2];
 155         logwin->in_color = color[3];
 156         logwin->out_color = color[4];
 157
 158         colormap = gdk_drawable_get_colormap(logwin->window->window);
 159         gdk_colormap_alloc_colors(colormap, color, 5, FALSE, TRUE, success);
 160
 161         for (i = 0; i < 5; i++) {
 162                 if (success[i] == FALSE) {
 163                         GtkStyle *style;
 164
 165                         g_warning("LogWindow: color allocation failed\n");
 166                         style = gtk_widget_get_style(logwin->window);
 167                         logwin->msg_color = logwin->warn_color =
 168                         logwin->error_color = logwin->in_color =
 169                         logwin->out_color = style->black;
 170                         break;
 171                 }
 172         }
 173
 174         buffer = logwin->buffer;
 175         gtk_text_buffer_create_tag(buffer, "message",
 176                                    "foreground-gdk", &logwin->msg_color,
 177                                    NULL);
 178         gtk_text_buffer_create_tag(buffer, "warn",
 179                                    "foreground-gdk", &logwin->warn_color,
 180                                    NULL);
 181         gtk_text_buffer_create_tag(buffer, "error",
 182                                    "foreground-gdk", &logwin->error_color,
 183                                    NULL);
 184         gtk_text_buffer_create_tag(buffer, "input",
 185                                    "foreground-gdk", &logwin->in_color,
 186                                    NULL);
 187         gtk_text_buffer_create_tag(buffer, "output",
 188                                    "foreground-gdk", &logwin->out_color,
 189                                    NULL);
 190
 191         g_object_ref(G_OBJECT(logwin->buffer));
 192         gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), NULL);
 193         logwin->hidden = TRUE;
 194 }
 195
 196 void log_window_show(LogWindow *logwin)
 197 {
 198         GtkTextView *text = GTK_TEXT_VIEW(logwin->text);
 199         GtkTextBuffer *buffer = logwin->buffer;
 200         GtkTextMark *mark;
 201
 202         logwin->hidden = FALSE;
 203         gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), logwin->buffer);
 204
 205         mark = gtk_text_buffer_get_mark(buffer, "end");
 206         gtk_text_view_scroll_mark_onscreen(text, mark);
 207
 208         gtk_widget_show(logwin->window);
 209 }
 210
 211 void log_window_set_clipping(LogWindow *logwin, gboolean clip, guint clip_length)
 212 {
 213         g_return_if_fail(logwin != NULL);
 214
 215         logwin->clip = clip;
 216         logwin->clip_length = clip_length;
 217 }
 218
 219 static gboolean log_window_append(gpointer source, gpointer data)
 220 {
 221         LogText *logtext = (LogText *) source;
 222         LogWindow *logwindow = (LogWindow *) data;
 223         GtkTextView *text;
 224         GtkTextBuffer *buffer;
 225         GtkTextIter iter;
 226         gchar *head = NULL;
 227         const gchar *tag;
 228
 229         g_return_val_if_fail(logtext != NULL, TRUE);
 230         g_return_val_if_fail(logtext->text != NULL, TRUE);
 231         g_return_val_if_fail(logwindow != NULL, FALSE);
 232
 233         if (logwindow->clip && !logwindow->clip_length)
 234                 return FALSE;
 235
 236         text = GTK_TEXT_VIEW(logwindow->text);
 237         buffer = logwindow->buffer;
 238         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
 239
 240         switch (logtext->type) {
 241         case LOG_MSG:
 242                 tag = "message";
 243                 head = "* ";
 244                 break;
 245         case LOG_WARN:
 246                 tag = "warn";
 247                 head = "** ";
 248                 break;
 249         case LOG_ERROR:
 250                 tag = "error";
 251                 head = "*** ";
 252                 break;
 253         default:
 254                 tag = NULL;
 255                 break;
 256         }
 257
 258         if (tag == NULL) {
 259                 if (strstr(logtext->text, "] POP3>")
 260                 ||  strstr(logtext->text, "] IMAP4>")
 261                 ||  strstr(logtext->text, "] SMTP>")
 262                 ||  strstr(logtext->text, "] ESMTP>")
 263                 ||  strstr(logtext->text, "] NNTP>"))
 264                         tag = "output";
 265                 if (strstr(logtext->text, "] POP3<")
 266                 ||  strstr(logtext->text, "] IMAP4<")
 267                 ||  strstr(logtext->text, "] SMTP<")
 268                 ||  strstr(logtext->text, "] ESMTP<")
 269                 ||  strstr(logtext->text, "] NNTP<"))
 270                         tag = "input";
 271         }
 272
 273         if (head)
 274                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, head, -1,
 275                                                          tag, NULL);
 276         gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, logtext->text, -1,
 277                                                  tag, NULL);
 278
 279         gtk_text_buffer_get_start_iter(buffer, &iter);
 280
 281         if (logwindow->clip)
 282                log_window_clip (logwindow, logwindow->clip_length);
 283
 284         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
 285         if (!logwindow->hidden) {
 286                 gtk_text_view_scroll_to_iter(text, &iter, 0, TRUE, 0, 0);
 287                 gtk_text_buffer_place_cursor(buffer, &iter);
 288         }
 289
 290         return FALSE;
 291 }
 292
 293 static void hide_cb(GtkWidget *widget, LogWindow *logwin)
 294 {
 295         gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), NULL);
 296         logwin->hidden = TRUE;
 297 }
 298
 299 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
 300                         LogWindow *logwin)
 301 {
 302         if (event && event->keyval == GDK_Escape)
 303                 gtk_widget_hide(logwin->window);
 304         else if (event && event->keyval == GDK_Delete)
 305                 log_window_clear(NULL, logwin);
 306
 307         return FALSE;
 308 }
 309
 310 static void log_window_clip(LogWindow *logwin, guint clip_length)
 311 {
 312         guint length;
 313         guint point;
 314         GtkTextBuffer *textbuf = logwin->buffer;
 315         GtkTextIter start_iter, end_iter;
 316
 317         length = gtk_text_buffer_get_line_count(textbuf);
 318         /* debug_print("Log window length: %u\n", length); */
 319
 320         if (length > clip_length) {
 321                 /* find the end of the first line after the cut off
 322                  * point */
 323                 point = length - clip_length;
 324                 gtk_text_buffer_get_iter_at_line(textbuf, &end_iter, point);
 325                 if (!gtk_text_iter_forward_to_line_end(&end_iter))
 326                         return;
 327                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 328                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 329         }
 330 }
 331
 332 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
 333 {
 334         GtkTextBuffer *textbuf = logwin->buffer;
 335         GtkTextIter start_iter, end_iter;
 336
 337         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 338         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
 339         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 340 }
 341
 342 static void log_window_popup_menu_extend(GtkTextView *textview,
 343                         GtkMenu *menu, LogWindow *logwin)
 344 {
 345         GtkWidget *menuitem;
 346
 347         g_return_if_fail(menu != NULL);
 348         g_return_if_fail(GTK_IS_MENU_SHELL(menu));
 349
 350         menuitem = gtk_separator_menu_item_new();
 351         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 352         gtk_widget_show(menuitem);
 353
 354         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
 355         g_signal_connect(G_OBJECT(menuitem), "activate",
 356                          G_CALLBACK(log_window_clear), logwin);
 357         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 358         gtk_widget_show(menuitem);
 359 }
 360