src/crash.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2002 by the Sylpheed Claws 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 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #       include <config.h>
  22 #endif
  23
  24 #ifdef CRASH_DIALOG
  25
  26 #include "defs.h"
  27
  28 #include <glib.h>
  29 #include <glib/gi18n.h>
  30 #include <gtk/gtk.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <signal.h>
  34 #include <time.h>
  35 #include <sys/types.h>
  36 #include <sys/wait.h>
  37
  38 #include <errno.h>
  39 #include <fcntl.h>
  40
  41 #if HAVE_SYS_UTSNAME_H
  42 #       include <sys/utsname.h>
  43 #endif
  44
  45 #if defined(__GNU_LIBRARY__)
  46 #       include <gnu/libc-version.h>
  47 #endif
  48
  49 #ifdef SIGTERM
  50 #include "main.h"
  51 #endif
  52 #include "sylpheed.h"
  53 #include "crash.h"
  54 #include "utils.h"
  55 #include "filesel.h"
  56 #include "version.h"
  57 #include "prefs_common.h"
  58
  59 /*
  60  * NOTE: the crash dialog is called when sylpheed is not
  61  * initialized, so do not assume settings are available.
  62  * for example, loading / creating pixmaps seems not
  63  * to be possible.
  64  */
  65
  66 /***/
  67
  68 static GtkWidget        *crash_dialog_show              (const gchar *text,
  69                                                          const gchar *debug_output);
  70 static void              crash_create_debugger_file     (void);
  71 static void              crash_save_crash_log           (GtkButton *, const gchar *);
  72 static void              crash_create_bug_report        (GtkButton *, const gchar *);
  73 static void              crash_debug                    (unsigned long crash_pid,
  74                                                          gchar   *exe_image,
  75                                                          GString *debug_output);
  76 static const gchar      *get_compiled_in_features       (void);
  77 static const gchar      *get_lib_version                (void);
  78 static const gchar      *get_operating_system           (void);
  79 static gboolean          is_crash_dialog_allowed        (void);
  80 static void              crash_handler                  (int sig);
  81 static void              crash_cleanup_exit             (void);
  82
  83 /***/
  84
  85 static const gchar *DEBUG_SCRIPT = "bt\nkill\nq";
  86
  87 /***/
  88
  89 /*!
  90  *\brief        install crash handlers
  91  */
  92 void crash_install_handlers(void)
  93 {
  94 #if CRASH_DIALOG
  95         sigset_t mask;
  96
  97         if (!is_crash_dialog_allowed()) return;
  98
  99         sigemptyset(&mask);
 100
 101 #ifdef SIGSEGV
 102         signal(SIGSEGV, crash_handler);
 103         sigaddset(&mask, SIGSEGV);
 104 #endif
 105
 106 #ifdef SIGFPE
 107         signal(SIGFPE, crash_handler);
 108         sigaddset(&mask, SIGFPE);
 109 #endif
 110
 111 #ifdef SIGILL
 112         signal(SIGILL, crash_handler);
 113         sigaddset(&mask, SIGILL);
 114 #endif
 115
 116 #ifdef SIGABRT
 117         signal(SIGABRT, crash_handler);
 118         sigaddset(&mask, SIGABRT);
 119 #endif
 120
 121         sigprocmask(SIG_UNBLOCK, &mask, 0);
 122 #endif /* CRASH_DIALOG */
 123 }
 124
 125 /***/
 126
 127 /*!
 128  *\brief        crash dialog entry point
 129  */
 130 void crash_main(const char *arg)
 131 {
 132 #if CRASH_DIALOG
 133         gchar *text;
 134         gchar **tokens;
 135         unsigned long pid;
 136         GString *output;
 137
 138         crash_create_debugger_file();
 139         tokens = g_strsplit(arg, ",", 0);
 140
 141         pid = atol(tokens[0]);
 142         text = g_strdup_printf(_("Sylpheed process (%ld) received signal %ld"),
 143                                pid, atol(tokens[1]));
 144
 145         output = g_string_new("");
 146         crash_debug(pid, tokens[2], output);
 147
 148         /*
 149          * try to get the settings
 150          */
 151         prefs_common_read_config();
 152
 153         crash_dialog_show(text, output->str);
 154         g_string_free(output, TRUE);
 155         g_free(text);
 156         g_strfreev(tokens);
 157 #endif /* CRASH_DIALOG */
 158 }
 159
 160 /*!
 161  *\brief        show crash dialog
 162  *
 163  *\param        text Description
 164  *\param        debug_output Output text by gdb
 165  *
 166  *\return       GtkWidget * Dialog widget
 167  */
 168 static GtkWidget *crash_dialog_show(const gchar *text, const gchar *debug_output)
 169 {
 170         GtkWidget *window1;
 171         GtkWidget *vbox1;
 172         GtkWidget *hbox1;
 173         GtkWidget *label1;
 174         GtkWidget *frame1;
 175         GtkWidget *scrolledwindow1;
 176         GtkWidget *text1;
 177         GtkWidget *hbuttonbox3;
 178         GtkWidget *hbuttonbox4;
 179         GtkWidget *button3;
 180         GtkWidget *button4;
 181         GtkWidget *button5;
 182         gchar     *crash_report;
 183
 184         window1 = gtk_window_new(GTK_WINDOW_TOPLEVEL);
 185         gtk_container_set_border_width(GTK_CONTAINER(window1), 5);
 186         gtk_window_set_title(GTK_WINDOW(window1), _("Sylpheed has crashed"));
 187         gtk_window_set_position(GTK_WINDOW(window1), GTK_WIN_POS_CENTER);
 188         gtk_window_set_modal(GTK_WINDOW(window1), TRUE);
 189         gtk_window_set_default_size(GTK_WINDOW(window1), 460, 272);
 190
 191
 192         vbox1 = gtk_vbox_new(FALSE, 2);
 193         gtk_widget_show(vbox1);
 194         gtk_container_add(GTK_CONTAINER(window1), vbox1);
 195
 196         hbox1 = gtk_hbox_new(FALSE, 4);
 197         gtk_widget_show(hbox1);
 198         gtk_box_pack_start(GTK_BOX(vbox1), hbox1, FALSE, TRUE, 0);
 199         gtk_container_set_border_width(GTK_CONTAINER(hbox1), 4);
 200
 201         label1 = gtk_label_new
 202             (g_strdup_printf(_("%s.\nPlease file a bug report and include the information below."), text));
 203         gtk_widget_show(label1);
 204         gtk_box_pack_start(GTK_BOX(hbox1), label1, TRUE, TRUE, 0);
 205         gtk_misc_set_alignment(GTK_MISC(label1), 7.45058e-09, 0.5);
 206
 207         frame1 = gtk_frame_new(_("Debug log"));
 208         gtk_widget_show(frame1);
 209         gtk_box_pack_start(GTK_BOX(vbox1), frame1, TRUE, TRUE, 0);
 210
 211         scrolledwindow1 = gtk_scrolled_window_new(NULL, NULL);
 212         gtk_widget_show(scrolledwindow1);
 213         gtk_container_add(GTK_CONTAINER(frame1), scrolledwindow1);
 214         gtk_container_set_border_width(GTK_CONTAINER(scrolledwindow1), 3);
 215         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwindow1),
 216                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 217
 218         text1 = gtk_text_new(NULL, NULL);
 219         gtk_text_set_editable((text1), FALSE);
 220         gtk_widget_show(text1);
 221         gtk_container_add(GTK_CONTAINER(scrolledwindow1), text1);
 222
 223         crash_report = g_strdup_printf(
 224                 "Sylpheed version %s\nGTK+ version %d.%d.%d\nFeatures:%s\nOperating system: %s\nC Library: %s\n--\n%s",
 225                 VERSION,
 226                 gtk_major_version, gtk_minor_version, gtk_micro_version,
 227                 get_compiled_in_features(),
 228                 get_operating_system(),
 229                 get_lib_version(),
 230                 debug_output);
 231
 232         gtk_text_insert((text1), NULL, NULL, NULL, crash_report, -1);
 233
 234         hbuttonbox3 = gtk_hbutton_box_new();
 235         gtk_widget_show(hbuttonbox3);
 236         gtk_box_pack_start(GTK_BOX(vbox1), hbuttonbox3, FALSE, FALSE, 0);
 237
 238         hbuttonbox4 = gtk_hbutton_box_new();
 239         gtk_widget_show(hbuttonbox4);
 240         gtk_box_pack_start(GTK_BOX(vbox1), hbuttonbox4, FALSE, FALSE, 0);
 241
 242         button3 = gtk_button_new_with_label(_("Close"));
 243         gtk_widget_show(button3);
 244         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button3);
 245         GTK_WIDGET_SET_FLAGS(button3, GTK_CAN_DEFAULT);
 246
 247         button4 = gtk_button_new_with_label(_("Save..."));
 248         gtk_widget_show(button4);
 249         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button4);
 250         GTK_WIDGET_SET_FLAGS(button4, GTK_CAN_DEFAULT);
 251
 252         button5 = gtk_button_new_with_label(_("Create bug report"));
 253         gtk_widget_show(button5);
 254         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button5);
 255         GTK_WIDGET_SET_FLAGS(button5, GTK_CAN_DEFAULT);
 256
 257         g_signal_connect(G_OBJECT(window1), "delete_event",
 258                          G_CALLBACK(gtk_main_quit), NULL);
 259         g_signal_connect(G_OBJECT(button3),   "clicked",
 260                          G_CALLBACK(gtk_main_quit), NULL);
 261         g_signal_connect(G_OBJECT(button4), "clicked",
 262                          G_CALLBACK(crash_save_crash_log), crash_report);
 263         g_signal_connect(G_OBJECT(button5), "clicked",
 264                          G_CALLBACK(crash_create_bug_report), NULL);
 265
 266         gtk_widget_show(window1);
 267
 268         gtk_main();
 269         return window1;
 270 }
 271
 272
 273 /*!
 274  *\brief        create debugger script file in sylpheed directory.
 275  *              all the other options (creating temp files) looked too
 276  *              convoluted.
 277  */
 278 static void crash_create_debugger_file(void)
 279 {
 280         gchar *filespec = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, DEBUGGERRC, NULL);
 281
 282         str_write_to_file(DEBUG_SCRIPT, filespec);
 283         g_free(filespec);
 284 }
 285
 286 /*!
 287  *\brief        saves crash log to a file
 288  */
 289 static void crash_save_crash_log(GtkButton *button, const gchar *text)
 290 {
 291         time_t timer;
 292         struct tm *lt;
 293         char buf[100];
 294         gchar *filename;
 295
 296         timer = time(NULL);
 297         lt = localtime(&timer);
 298         strftime(buf, sizeof buf, "sylpheed-crash-log-%Y-%m-%d-%H-%M-%S.txt", lt);
 299         if (NULL != (filename = filesel_select_file_save(_("Save crash information"), buf))
 300         &&  *filename)
 301                 str_write_to_file(text, filename);
 302         g_free(filename);
 303 }
 304
 305 /*!
 306  *\brief        create bug report (goes to Sylpheed Claws bug tracker)
 307  */
 308 static void crash_create_bug_report(GtkButton *button, const gchar *data)
 309 {
 310         open_uri(CLAWS_BUGZILLA_URI, prefs_common.uri_cmd);
 311 }
 312
 313 /*!
 314  *\brief        launches debugger and attaches it to crashed sylpheed
 315  */
 316 static void crash_debug(unsigned long crash_pid,
 317                         gchar *exe_image,
 318                         GString *debug_output)
 319 {
 320         int choutput[2];
 321         pid_t pid;
 322
 323         pipe(choutput);
 324
 325         if (0 == (pid = fork())) {
 326                 char *argp[10];
 327                 char **argptr = argp;
 328                 gchar *filespec = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, DEBUGGERRC, NULL);
 329
 330                 setgid(getgid());
 331                 setuid(getuid());
 332
 333                 /*
 334                  * setup debugger to attach to crashed sylpheed
 335                  */
 336                 *argptr++ = "gdb";
 337                 *argptr++ = "--nw";
 338                 *argptr++ = "--nx";
 339                 *argptr++ = "--quiet";
 340                 *argptr++ = "--batch";
 341                 *argptr++ = "-x";
 342                 *argptr++ = filespec;
 343                 *argptr++ = exe_image;
 344                 *argptr++ = g_strdup_printf("%ld", crash_pid);
 345                 *argptr   = NULL;
 346
 347                 /*
 348                  * redirect output to write end of pipe
 349                  */
 350                 close(1);
 351                 dup(choutput[1]);
 352                 close(choutput[0]);
 353                 if (-1 == execvp("gdb", argp))
 354                         puts("error execvp\n");
 355         } else {
 356                 char buf[100];
 357                 int r;
 358
 359                 waitpid(pid, NULL, 0);
 360
 361                 /*
 362                  * make it non blocking
 363                  */
 364                 if (-1 == fcntl(choutput[0], F_SETFL, O_NONBLOCK))
 365                         puts("set to non blocking failed\n");
 366
 367                 /*
 368                  * get the output
 369                  */
 370                 do {
 371                         r = read(choutput[0], buf, sizeof buf - 1);
 372                         if (r > 0) {
 373                                 buf[r] = 0;
 374                                 g_string_append(debug_output, buf);
 375                         }
 376                 } while (r > 0);
 377
 378                 close(choutput[0]);
 379                 close(choutput[1]);
 380
 381                 /*
 382                  * kill the process we attached to
 383                  */
 384                 kill(crash_pid, SIGCONT);
 385         }
 386 }
 387
 388 /***/
 389
 390 /*!
 391  *\brief        features
 392  */
 393 static const gchar *get_compiled_in_features(void)
 394 {
 395         return g_strdup_printf("%s",
 396 #if USE_THREADS
 397                    " gthread"
 398 #endif
 399 #if INET6
 400                    " IPv6"
 401 #endif
 402 #if HAVE_LIBCOMPFACE
 403                    " libcompface"
 404 #endif
 405 #if HAVE_LIBJCONV
 406                    " libjconv"
 407 #endif
 408 #if USE_OPENSSL
 409                    " OpenSSL"
 410 #endif
 411 #if USE_LDAP
 412                    " LDAP"
 413 #endif
 414 #if USE_JPILOT
 415                    " JPilot"
 416 #endif
 417 #if USE_ASPELL
 418                    " GNU/aspell"
 419 #endif
 420         "");
 421 }
 422
 423 /***/
 424
 425 /*!
 426  *\brief        library version
 427  */
 428 static const gchar *get_lib_version(void)
 429 {
 430 #if defined(__GNU_LIBRARY__)
 431         return g_strdup_printf("GNU libc %s", gnu_get_libc_version());
 432 #else
 433         return g_strdup(_("Unknown"));
 434 #endif
 435 }
 436
 437 /***/
 438
 439 /*!
 440  *\brief        operating system
 441  */
 442 static const gchar *get_operating_system(void)
 443 {
 444 #if HAVE_SYS_UTSNAME_H
 445         struct utsname utsbuf;
 446         uname(&utsbuf);
 447         return g_strdup_printf("%s %s (%s)",
 448                                utsbuf.sysname,
 449                                utsbuf.release,
 450                                utsbuf.machine);
 451 #else
 452         return g_strdup(_("Unknown"));
 453
 454 #endif
 455 }
 456
 457 /***/
 458
 459 /*!
 460  *\brief        see if the crash dialog is allowed (because some
 461  *              developers may prefer to run sylpheed under gdb...)
 462  */
 463 static gboolean is_crash_dialog_allowed(void)
 464 {
 465         return !getenv("SYLPHEED_NO_CRASH");
 466 }
 467
 468 /*!
 469  *\brief        this handler will probably evolve into
 470  *              something better.
 471  */
 472 static void crash_handler(int sig)
 473 {
 474         pid_t pid;
 475         static volatile unsigned long crashed_ = 0;
 476
 477         /*
 478          * let's hope argv0 aren't trashed.
 479          * both are defined in main.c.
 480          */
 481         extern gchar *argv0;
 482
 483
 484         /*
 485          * besides guarding entrancy it's probably also better
 486          * to mask off signals
 487          */
 488         if (crashed_) return;
 489
 490         crashed_++;
 491
 492 #ifdef SIGTERM
 493         if (sig == SIGTERM)
 494                 clean_quit(NULL);
 495 #endif
 496
 497         /*
 498          * gnome ungrabs focus, and flushes gdk. mmmh, good idea.
 499          */
 500         gdk_pointer_ungrab(GDK_CURRENT_TIME);
 501         gdk_keyboard_ungrab(GDK_CURRENT_TIME);
 502         gdk_flush();
 503
 504         if (0 == (pid = fork())) {
 505                 char buf[50];
 506                 char *args[5];
 507
 508                 /*
 509                  * probably also some other parameters (like GTK+ ones).
 510                  * also we pass the full startup dir and the real command
 511                  * line typed in (argv0)
 512                  */
 513                 args[0] = argv0;
 514                 args[1] = "--debug";
 515                 args[2] = "--crash";
 516                 sprintf(buf, "%d,%d,%s", getppid(), sig, argv0);
 517                 args[3] = buf;
 518                 args[4] = NULL;
 519
 520                 chdir(sylpheed_get_startup_dir());
 521                 setgid(getgid());
 522                 setuid(getuid());
 523                 execvp(argv0, args);
 524         } else {
 525                 waitpid(pid, NULL, 0);
 526                 crash_cleanup_exit();
 527                 _exit(253);
 528         }
 529
 530         _exit(253);
 531 }
 532
 533 /*!
 534  *\brief        put all the things here we can do before
 535  *              letting the program die
 536  */
 537 static void crash_cleanup_exit(void)
 538 {
 539         extern gchar *get_socket_name(void);
 540         const char *filename = get_socket_name();
 541         unlink(filename);
 542 }
 543
 544 #endif