src/gtk/logwindow.c

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2019 the Claws Mail team and Hiroyuki Yamamoto
   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 #ifdef HAVE_CONFIG_H
  20 #  include "config.h"
  21 #include "claws-features.h"
  22 #endif
  23
  24 #include <glib.h>
  25 #include <glib/gi18n.h>
  26 #include <gdk/gdkkeysyms.h>
  27 #include <gtk/gtk.h>
  28
  29 #include "logwindow.h"
  30 #include "utils.h"
  31 #include "gtkutils.h"
  32 #include "log.h"
  33 #include "hooks.h"
  34 #include "prefs_common.h"
  35
  36 static void hide_cb                             (GtkWidget      *widget,
  37                                                  LogWindow      *logwin);
  38 static gboolean key_pressed                     (GtkWidget      *widget,
  39                                                  GdkEventKey    *event,
  40                                                  LogWindow      *logwin);
  41 static void size_allocate_cb    (GtkWidget *widget,
  42                                          GtkAllocation *allocation,
  43                                          gpointer data);
  44 static gboolean log_window_append               (gpointer        source,
  45                                                  gpointer        data);
  46 static void log_window_clip                     (LogWindow      *logwin,
  47                                                  guint           glip_length);
  48 static void log_window_clear                    (GtkWidget      *widget,
  49                                                  LogWindow      *logwin);
  50 static void log_window_popup_menu_extend        (GtkTextView    *textview,
  51                                                  GtkMenu        *menu,
  52                                                  LogWindow      *logwin);
  53
  54 /*!
  55  *\brief        Save Gtk object size to prefs dataset
  56  */
  57 static void size_allocate_cb(GtkWidget *widget,
  58                                          GtkAllocation *allocation,
  59                                          gpointer data)
  60 {
  61         gint *prefs_logwin_width = NULL;
  62         gint *prefs_logwin_height = NULL;
  63         LogInstance instance = GPOINTER_TO_INT(data);
  64
  65         cm_return_if_fail(allocation != NULL);
  66
  67         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
  68         cm_return_if_fail(prefs_logwin_width != NULL);
  69         cm_return_if_fail(prefs_logwin_height != NULL);
  70
  71         gtk_window_get_size(GTK_WINDOW(widget),
  72                 prefs_logwin_width, prefs_logwin_height);
  73 }
  74
  75 LogWindow *log_window_create(LogInstance instance)
  76 {
  77         LogWindow *logwin;
  78         GtkWidget *window;
  79         GtkWidget *scrolledwin;
  80         GtkWidget *text;
  81         GtkTextBuffer *buffer;
  82         GtkTextIter iter;
  83         static GdkGeometry geometry;
  84         gint *prefs_logwin_width = NULL;
  85         gint *prefs_logwin_height = NULL;
  86
  87         debug_print("Creating log window...\n");
  88
  89         get_log_prefs(instance, &prefs_logwin_width, &prefs_logwin_height);
  90         cm_return_val_if_fail(prefs_logwin_width != NULL, NULL);
  91         cm_return_val_if_fail(prefs_logwin_height != NULL, NULL);
  92
  93         logwin = g_new0(LogWindow, 1);
  94
  95         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "logwindow");
  96         gtk_window_set_title(GTK_WINDOW(window), get_log_title(instance));
  97         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
  98         gtk_window_set_type_hint(GTK_WINDOW(window), GDK_WINDOW_TYPE_HINT_DIALOG);
  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_window_set_default_size(GTK_WINDOW(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         logwin->has_error_capability = get_log_error_capability(instance);
 151
 152         return logwin;
 153 }
 154
 155 #define LOG_COLORS 8
 156
 157 void log_window_init(LogWindow *logwin)
 158 {
 159         GtkTextBuffer *buffer;
 160
 161         logwin->msg_color = &prefs_common.color[COL_LOG_MSG];
 162         logwin->warn_color = &prefs_common.color[COL_LOG_WARN];
 163         logwin->error_color = &prefs_common.color[COL_LOG_ERROR];
 164         logwin->in_color = &prefs_common.color[COL_LOG_IN];
 165         logwin->out_color = &prefs_common.color[COL_LOG_OUT];
 166         logwin->status_ok_color = &prefs_common.color[COL_LOG_STATUS_OK];
 167         logwin->status_nok_color = &prefs_common.color[COL_LOG_STATUS_NOK];
 168         logwin->status_skip_color = &prefs_common.color[COL_LOG_STATUS_SKIP];
 169
 170         buffer = logwin->buffer;
 171         gtk_text_buffer_create_tag(buffer, "message",
 172                                    "foreground-rgba", logwin->msg_color,
 173                                    NULL);
 174         gtk_text_buffer_create_tag(buffer, "warn",
 175                                    "foreground-rgba", logwin->warn_color,
 176                                    NULL);
 177         logwin->error_tag = gtk_text_buffer_create_tag(buffer, "error",
 178                                    "foreground-rgba", logwin->error_color,
 179                                    NULL);
 180         gtk_text_buffer_create_tag(buffer, "input",
 181                                    "foreground-rgba", logwin->in_color,
 182                                    NULL);
 183         gtk_text_buffer_create_tag(buffer, "output",
 184                                    "foreground-rgba", logwin->out_color,
 185                                    NULL);
 186         gtk_text_buffer_create_tag(buffer, "status_ok",
 187                                    "foreground-rgba", logwin->status_ok_color,
 188                                    NULL);
 189         gtk_text_buffer_create_tag(buffer, "status_nok",
 190                                    "foreground-rgba", logwin->status_nok_color,
 191                                    NULL);
 192         gtk_text_buffer_create_tag(buffer, "status_skip",
 193                                    "foreground-rgba", logwin->status_skip_color,
 194                                    NULL);
 195 }
 196
 197 #undef LOG_COLORS
 198
 199 void log_window_show(LogWindow *logwin)
 200 {
 201         GtkTextView *text = GTK_TEXT_VIEW(logwin->text);
 202         GtkTextBuffer *buffer = logwin->buffer;
 203         GtkTextMark *mark;
 204
 205         logwin->hidden = FALSE;
 206
 207         if (logwin->never_shown)
 208                 gtk_text_view_set_buffer(GTK_TEXT_VIEW(logwin->text), logwin->buffer);
 209
 210         logwin->never_shown = FALSE;
 211
 212         mark = gtk_text_buffer_get_mark(buffer, "end");
 213         gtk_text_view_scroll_mark_onscreen(text, mark);
 214
 215         gtk_window_deiconify(GTK_WINDOW(logwin->window));
 216         gtk_widget_show(logwin->window);
 217         gtk_window_present(GTK_WINDOW(logwin->window));
 218 }
 219
 220 static void log_window_jump_to_error(LogWindow *logwin)
 221 {
 222         GtkTextIter iter;
 223         gtk_text_buffer_get_end_iter(logwin->buffer, &iter);
 224         if (!gtk_text_iter_backward_to_tag_toggle(&iter, logwin->error_tag))
 225                 return;
 226
 227         gtk_text_iter_backward_line(&iter);
 228         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(logwin->text), &iter, 0, TRUE, 0, 0);
 229 }
 230
 231 void log_window_show_error(LogWindow *logwin)
 232 {
 233         log_window_show(logwin);
 234         log_window_jump_to_error(logwin);
 235 }
 236
 237 void log_window_set_clipping(LogWindow *logwin, gboolean clip, guint clip_length)
 238 {
 239         cm_return_if_fail(logwin != NULL);
 240
 241         logwin->clip = clip;
 242         logwin->clip_length = clip_length;
 243 }
 244
 245 static gboolean log_window_append(gpointer source, gpointer data)
 246 {
 247         LogText *logtext = (LogText *) source;
 248         LogWindow *logwindow = (LogWindow *) data;
 249         GtkTextView *text;
 250         GtkTextBuffer *buffer;
 251         GtkTextIter iter;
 252         gchar *head = NULL;
 253         const gchar *tag;
 254
 255         cm_return_val_if_fail(logtext != NULL, TRUE);
 256         cm_return_val_if_fail(logtext->text != NULL, TRUE);
 257         cm_return_val_if_fail(logwindow != NULL, FALSE);
 258
 259         if (logwindow->clip && !logwindow->clip_length)
 260                 return FALSE;
 261
 262         text = GTK_TEXT_VIEW(logwindow->text);
 263         buffer = logwindow->buffer;
 264         gtk_text_buffer_get_iter_at_offset(buffer, &iter, -1);
 265
 266         switch (logtext->type) {
 267         case LOG_MSG:
 268                 tag = "message";
 269                 head = "* ";
 270                 break;
 271         case LOG_WARN:
 272                 tag = "warn";
 273                 head = "** ";
 274                 break;
 275         case LOG_ERROR:
 276                 tag = "error";
 277                 head = "*** ";
 278                 logwindow->has_error = TRUE;
 279                 break;
 280         case LOG_STATUS_OK:
 281                 tag = "status_ok";
 282                 head = "> ";
 283                 break;
 284         case LOG_STATUS_NOK:
 285                 tag = "status_nok";
 286                 head = "> ";
 287                 break;
 288         case LOG_STATUS_SKIP:
 289                 tag = "status_skip";
 290                 head = "> skipped: ";
 291                 break;
 292         default:
 293                 tag = NULL;
 294                 break;
 295         }
 296
 297         if (logtext->instance == LOG_PROTOCOL) {
 298                 if (tag == NULL) {
 299                         if (strstr(logtext->text, "] POP>")
 300                         ||  strstr(logtext->text, "] IMAP>")
 301                         ||  strstr(logtext->text, "] SMTP>")
 302                         ||  strstr(logtext->text, "] ESMTP>")
 303                         ||  strstr(logtext->text, "] NNTP>"))
 304                                 tag = "output";
 305                         if (strstr(logtext->text, "] POP<")
 306                         ||  strstr(logtext->text, "] IMAP<")
 307                         ||  strstr(logtext->text, "] SMTP<")
 308                         ||  strstr(logtext->text, "] ESMTP<")
 309                         ||  strstr(logtext->text, "] NNTP<"))
 310                                 tag = "input";
 311                 }
 312         }
 313
 314         if (head)
 315                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, head, -1,
 316                                                          tag, NULL);
 317
 318         if (!g_utf8_validate(logtext->text, -1, NULL)) {
 319                 gchar * mybuf = g_malloc(strlen(logtext->text)*2 +1);
 320                 conv_localetodisp(mybuf, strlen(logtext->text)*2 +1, logtext->text);
 321                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, mybuf, -1,
 322                                                          tag, NULL);
 323                 g_free(mybuf);
 324         } else {
 325                 gtk_text_buffer_insert_with_tags_by_name(buffer, &iter, logtext->text, -1,
 326                                                          tag, NULL);
 327         }
 328         gtk_text_buffer_get_start_iter(buffer, &iter);
 329
 330         if (logwindow->clip)
 331                log_window_clip (logwindow, logwindow->clip_length);
 332
 333         if (!logwindow->hidden) {
 334                 GtkAdjustment *vadj = gtk_scrollable_get_vadjustment(GTK_SCROLLABLE(text));
 335                 gfloat upper = gtk_adjustment_get_upper(vadj) -
 336                     gtk_adjustment_get_page_size(vadj);
 337                 gfloat value = gtk_adjustment_get_value(vadj);
 338                 if (value == upper ||
 339                     (upper - value < 16 && value < 8))
 340                         gtk_text_view_scroll_mark_onscreen(text, logwindow->end_mark);
 341         }
 342
 343         return FALSE;
 344 }
 345
 346 static void hide_cb(GtkWidget *widget, LogWindow *logwin)
 347 {
 348         logwin->hidden = TRUE;
 349 }
 350
 351 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
 352                         LogWindow *logwin)
 353 {
 354         if (event && event->keyval == GDK_KEY_Escape)
 355                 gtk_widget_hide(logwin->window);
 356         else if (event && event->keyval == GDK_KEY_Delete)
 357                 log_window_clear(NULL, logwin);
 358
 359         return FALSE;
 360 }
 361
 362 static void log_window_clip(LogWindow *logwin, guint clip_length)
 363 {
 364         guint length;
 365         guint point;
 366         GtkTextBuffer *textbuf = logwin->buffer;
 367         GtkTextIter start_iter, end_iter;
 368
 369         length = gtk_text_buffer_get_line_count(textbuf);
 370         /* debug_print("Log window length: %u\n", length); */
 371
 372         if (length > clip_length) {
 373                 /* find the end of the first line after the cut off
 374                  * point */
 375                 point = length - clip_length;
 376                 gtk_text_buffer_get_iter_at_line(textbuf, &end_iter, point);
 377                 if (!gtk_text_iter_forward_to_line_end(&end_iter))
 378                         return;
 379                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 380                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 381                 if (logwin->has_error) {
 382                         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 383                         if (mainwindow_get_mainwindow() && !gtk_text_iter_forward_to_tag_toggle(&start_iter, logwin->error_tag)) {
 384                                 mainwindow_clear_error(mainwindow_get_mainwindow());
 385                                 logwin->has_error = FALSE;
 386                         }
 387                 }
 388         }
 389 }
 390
 391 static void log_window_clear(GtkWidget *widget, LogWindow *logwin)
 392 {
 393         GtkTextBuffer *textbuf = logwin->buffer;
 394         GtkTextIter start_iter, end_iter;
 395
 396         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
 397         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
 398         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
 399 }
 400
 401 static void log_window_go_to_last_error(GtkWidget *widget, LogWindow *logwin)
 402 {
 403         log_window_jump_to_error(logwin);
 404 }
 405
 406 static void log_window_popup_menu_extend(GtkTextView *textview,
 407                         GtkMenu *menu, LogWindow *logwin)
 408 {
 409         GtkWidget *menuitem;
 410
 411         cm_return_if_fail(menu != NULL);
 412         cm_return_if_fail(GTK_IS_MENU_SHELL(menu));
 413
 414         menuitem = gtk_separator_menu_item_new();
 415         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 416         gtk_widget_show(menuitem);
 417
 418         if (logwin->has_error_capability) {
 419                 menuitem = gtk_menu_item_new_with_mnemonic(_("_Go to last error"));
 420                 g_signal_connect(G_OBJECT(menuitem), "activate",
 421                                  G_CALLBACK(log_window_go_to_last_error), logwin);
 422                 gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 423                 gtk_widget_show(menuitem);
 424         }
 425
 426         menuitem = gtk_menu_item_new_with_mnemonic(_("Clear _Log"));
 427         g_signal_connect(G_OBJECT(menuitem), "activate",
 428                          G_CALLBACK(log_window_clear), logwin);
 429         gtk_menu_shell_prepend(GTK_MENU_SHELL(menu), menuitem);
 430         gtk_widget_show(menuitem);
 431 }
 432