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_init();
 152         prefs_common_read_config();
 153
 154         crash_dialog_show(text, output->str);
 155         g_string_free(output, TRUE);
 156         g_free(text);
 157         g_strfreev(tokens);
 158 #endif /* CRASH_DIALOG */
 159 }
 160
 161 /*!
 162  *\brief        show crash dialog
 163  *
 164  *\param        text Description
 165  *\param        debug_output Output text by gdb
 166  *
 167  *\return       GtkWidget * Dialog widget
 168  */
 169 static GtkWidget *crash_dialog_show(const gchar *text, const gchar *debug_output)
 170 {
 171         GtkWidget *window1;
 172         GtkWidget *vbox1;
 173         GtkWidget *hbox1;
 174         GtkWidget *label1;
 175         GtkWidget *frame1;
 176         GtkWidget *scrolledwindow1;
 177         GtkWidget *text1;
 178         GtkWidget *hbuttonbox3;
 179         GtkWidget *hbuttonbox4;
 180         GtkWidget *button3;
 181         GtkWidget *button4;
 182         GtkWidget *button5;
 183         gchar     *crash_report;
 184
 185         window1 = gtk_window_new(GTK_WINDOW_TOPLEVEL);
 186         gtk_container_set_border_width(GTK_CONTAINER(window1), 5);
 187         gtk_window_set_title(GTK_WINDOW(window1), _("Sylpheed has crashed"));
 188         gtk_window_set_position(GTK_WINDOW(window1), GTK_WIN_POS_CENTER);
 189         gtk_window_set_modal(GTK_WINDOW(window1), TRUE);
 190         gtk_window_set_default_size(GTK_WINDOW(window1), 460, 272);
 191
 192
 193         vbox1 = gtk_vbox_new(FALSE, 2);
 194         gtk_widget_show(vbox1);
 195         gtk_container_add(GTK_CONTAINER(window1), vbox1);
 196
 197         hbox1 = gtk_hbox_new(FALSE, 4);
 198         gtk_widget_show(hbox1);
 199         gtk_box_pack_start(GTK_BOX(vbox1), hbox1, FALSE, TRUE, 0);
 200         gtk_container_set_border_width(GTK_CONTAINER(hbox1), 4);
 201
 202         label1 = gtk_label_new
 203             (g_strdup_printf(_("%s.\nPlease file a bug report and include the information below."), text));
 204         gtk_widget_show(label1);
 205         gtk_box_pack_start(GTK_BOX(hbox1), label1, TRUE, TRUE, 0);
 206         gtk_misc_set_alignment(GTK_MISC(label1), 7.45058e-09, 0.5);
 207
 208         frame1 = gtk_frame_new(_("Debug log"));
 209         gtk_widget_show(frame1);
 210         gtk_box_pack_start(GTK_BOX(vbox1), frame1, TRUE, TRUE, 0);
 211
 212         scrolledwindow1 = gtk_scrolled_window_new(NULL, NULL);
 213         gtk_widget_show(scrolledwindow1);
 214         gtk_container_add(GTK_CONTAINER(frame1), scrolledwindow1);
 215         gtk_container_set_border_width(GTK_CONTAINER(scrolledwindow1), 3);
 216         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwindow1),
 217                                        GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 218
 219         text1 = gtk_text_new(NULL, NULL);
 220         gtk_text_set_editable((text1), FALSE);
 221         gtk_widget_show(text1);
 222         gtk_container_add(GTK_CONTAINER(scrolledwindow1), text1);
 223
 224         crash_report = g_strdup_printf(
 225                 "Sylpheed version %s\nGTK+ version %d.%d.%d\nFeatures:%s\nOperating system: %s\nC Library: %s\n--\n%s",
 226                 VERSION,
 227                 gtk_major_version, gtk_minor_version, gtk_micro_version,
 228                 get_compiled_in_features(),
 229                 get_operating_system(),
 230                 get_lib_version(),
 231                 debug_output);
 232
 233         gtk_text_insert((text1), NULL, NULL, NULL, crash_report, -1);
 234
 235         hbuttonbox3 = gtk_hbutton_box_new();
 236         gtk_widget_show(hbuttonbox3);
 237         gtk_box_pack_start(GTK_BOX(vbox1), hbuttonbox3, FALSE, FALSE, 0);
 238
 239         hbuttonbox4 = gtk_hbutton_box_new();
 240         gtk_widget_show(hbuttonbox4);
 241         gtk_box_pack_start(GTK_BOX(vbox1), hbuttonbox4, FALSE, FALSE, 0);
 242
 243         button3 = gtk_button_new_with_label(_("Close"));
 244         gtk_widget_show(button3);
 245         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button3);
 246         GTK_WIDGET_SET_FLAGS(button3, GTK_CAN_DEFAULT);
 247
 248         button4 = gtk_button_new_with_label(_("Save..."));
 249         gtk_widget_show(button4);
 250         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button4);
 251         GTK_WIDGET_SET_FLAGS(button4, GTK_CAN_DEFAULT);
 252
 253         button5 = gtk_button_new_with_label(_("Create bug report"));
 254         gtk_widget_show(button5);
 255         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button5);
 256         GTK_WIDGET_SET_FLAGS(button5, GTK_CAN_DEFAULT);
 257
 258         g_signal_connect(G_OBJECT(window1), "delete_event",
 259                          G_CALLBACK(gtk_main_quit), NULL);
 260         g_signal_connect(G_OBJECT(button3),   "clicked",
 261                          G_CALLBACK(gtk_main_quit), NULL);
 262         g_signal_connect(G_OBJECT(button4), "clicked",
 263                          G_CALLBACK(crash_save_crash_log), crash_report);
 264         g_signal_connect(G_OBJECT(button5), "clicked",
 265                          G_CALLBACK(crash_create_bug_report), NULL);
 266
 267         gtk_widget_show(window1);
 268
 269         gtk_main();
 270         return window1;
 271 }
 272
 273
 274 /*!
 275  *\brief        create debugger script file in sylpheed directory.
 276  *              all the other options (creating temp files) looked too
 277  *              convoluted.
 278  */
 279 static void crash_create_debugger_file(void)
 280 {
 281         gchar *filespec = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, DEBUGGERRC, NULL);
 282
 283         str_write_to_file(DEBUG_SCRIPT, filespec);
 284         g_free(filespec);
 285 }
 286
 287 /*!
 288  *\brief        saves crash log to a file
 289  */
 290 static void crash_save_crash_log(GtkButton *button, const gchar *text)
 291 {
 292         time_t timer;
 293         struct tm *lt;
 294         char buf[100];
 295         gchar *filename;
 296
 297         timer = time(NULL);
 298         lt = localtime(&timer);
 299         strftime(buf, sizeof buf, "sylpheed-crash-log-%Y-%m-%d-%H-%M-%S.txt", lt);
 300         if (NULL != (filename = filesel_select_file_save(_("Save crash information"), buf))
 301         &&  *filename)
 302                 str_write_to_file(text, filename);
 303         g_free(filename);
 304 }
 305
 306 /*!
 307  *\brief        create bug report (goes to Sylpheed Claws bug tracker)
 308  */
 309 static void crash_create_bug_report(GtkButton *button, const gchar *data)
 310 {
 311         open_uri(CLAWS_BUGZILLA_URI, prefs_common.uri_cmd);
 312 }
 313
 314 /*!
 315  *\brief        launches debugger and attaches it to crashed sylpheed
 316  */
 317 static void crash_debug(unsigned long crash_pid,
 318                         gchar *exe_image,
 319                         GString *debug_output)
 320 {
 321         int choutput[2];
 322         pid_t pid;
 323
 324         pipe(choutput);
 325
 326         if (0 == (pid = fork())) {
 327                 char *argp[10];
 328                 char **argptr = argp;
 329                 gchar *filespec = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, DEBUGGERRC, NULL);
 330
 331                 setgid(getgid());
 332                 setuid(getuid());
 333
 334                 /*
 335                  * setup debugger to attach to crashed sylpheed
 336                  */
 337                 *argptr++ = "gdb";
 338                 *argptr++ = "--nw";
 339                 *argptr++ = "--nx";
 340                 *argptr++ = "--quiet";
 341                 *argptr++ = "--batch";
 342                 *argptr++ = "-x";
 343                 *argptr++ = filespec;
 344                 *argptr++ = exe_image;
 345                 *argptr++ = g_strdup_printf("%ld", crash_pid);
 346                 *argptr   = NULL;
 347
 348                 /*
 349                  * redirect output to write end of pipe
 350                  */
 351                 close(1);
 352                 dup(choutput[1]);
 353                 close(choutput[0]);
 354                 if (-1 == execvp("gdb", argp))
 355                         puts("error execvp\n");
 356         } else {
 357                 char buf[100];
 358                 int r;
 359
 360                 waitpid(pid, NULL, 0);
 361
 362                 /*
 363                  * make it non blocking
 364                  */
 365                 if (-1 == fcntl(choutput[0], F_SETFL, O_NONBLOCK))
 366                         puts("set to non blocking failed\n");
 367
 368                 /*
 369                  * get the output
 370                  */
 371                 do {
 372                         r = read(choutput[0], buf, sizeof buf - 1);
 373                         if (r > 0) {
 374                                 buf[r] = 0;
 375                                 g_string_append(debug_output, buf);
 376                         }
 377                 } while (r > 0);
 378
 379                 close(choutput[0]);
 380                 close(choutput[1]);
 381
 382                 /*
 383                  * kill the process we attached to
 384                  */
 385                 kill(crash_pid, SIGCONT);
 386         }
 387 }
 388
 389 /***/
 390
 391 /*!
 392  *\brief        features
 393  */
 394 static const gchar *get_compiled_in_features(void)
 395 {
 396         return g_strdup_printf("%s",
 397 #if USE_THREADS
 398                    " gthread"
 399 #endif
 400 #if INET6
 401                    " IPv6"
 402 #endif
 403 #if HAVE_LIBCOMPFACE
 404                    " libcompface"
 405 #endif
 406 #if HAVE_LIBJCONV
 407                    " libjconv"
 408 #endif
 409 #if USE_OPENSSL
 410                    " OpenSSL"
 411 #endif
 412 #if USE_LDAP
 413                    " LDAP"
 414 #endif
 415 #if USE_JPILOT
 416                    " JPilot"
 417 #endif
 418 #if USE_ASPELL
 419                    " GNU/aspell"
 420 #endif
 421         "");
 422 }
 423
 424 /***/
 425
 426 /*!
 427  *\brief        library version
 428  */
 429 static const gchar *get_lib_version(void)
 430 {
 431 #if defined(__GNU_LIBRARY__)
 432         return g_strdup_printf("GNU libc %s", gnu_get_libc_version());
 433 #else
 434         return g_strdup(_("Unknown"));
 435 #endif
 436 }
 437
 438 /***/
 439
 440 /*!
 441  *\brief        operating system
 442  */
 443 static const gchar *get_operating_system(void)
 444 {
 445 #if HAVE_SYS_UTSNAME_H
 446         struct utsname utsbuf;
 447         uname(&utsbuf);
 448         return g_strdup_printf("%s %s (%s)",
 449                                utsbuf.sysname,
 450                                utsbuf.release,
 451                                utsbuf.machine);
 452 #else
 453         return g_strdup(_("Unknown"));
 454
 455 #endif
 456 }
 457
 458 /***/
 459
 460 /*!
 461  *\brief        see if the crash dialog is allowed (because some
 462  *              developers may prefer to run sylpheed under gdb...)
 463  */
 464 static gboolean is_crash_dialog_allowed(void)
 465 {
 466         return !getenv("SYLPHEED_NO_CRASH");
 467 }
 468
 469 /*!
 470  *\brief        this handler will probably evolve into
 471  *              something better.
 472  */
 473 static void crash_handler(int sig)
 474 {
 475         pid_t pid;
 476         static volatile unsigned long crashed_ = 0;
 477
 478         /*
 479          * let's hope argv0 aren't trashed.
 480          * both are defined in main.c.
 481          */
 482         extern gchar *argv0;
 483
 484
 485         /*
 486          * besides guarding entrancy it's probably also better
 487          * to mask off signals
 488          */
 489         if (crashed_) return;
 490
 491         crashed_++;
 492
 493 #ifdef SIGTERM
 494         if (sig == SIGTERM)
 495                 clean_quit(NULL);
 496 #endif
 497
 498         /*
 499          * gnome ungrabs focus, and flushes gdk. mmmh, good idea.
 500          */
 501         gdk_pointer_ungrab(GDK_CURRENT_TIME);
 502         gdk_keyboard_ungrab(GDK_CURRENT_TIME);
 503         gdk_flush();
 504
 505         if (0 == (pid = fork())) {
 506                 char buf[50];
 507                 char *args[5];
 508
 509                 /*
 510                  * probably also some other parameters (like GTK+ ones).
 511                  * also we pass the full startup dir and the real command
 512                  * line typed in (argv0)
 513                  */
 514                 args[0] = argv0;
 515                 args[1] = "--debug";
 516                 args[2] = "--crash";
 517                 sprintf(buf, "%d,%d,%s", getppid(), sig, argv0);
 518                 args[3] = buf;
 519                 args[4] = NULL;
 520
 521                 chdir(sylpheed_get_startup_dir());
 522                 setgid(getgid());
 523                 setuid(getuid());
 524                 execvp(argv0, args);
 525         } else {
 526                 waitpid(pid, NULL, 0);
 527                 crash_cleanup_exit();
 528                 _exit(253);
 529         }
 530
 531         _exit(253);
 532 }
 533
 534 /*!
 535  *\brief        put all the things here we can do before
 536  *              letting the program die
 537  */
 538 static void crash_cleanup_exit(void)
 539 {
 540         extern gchar *get_socket_name(void);
 541         const char *filename = get_socket_name();
 542         unlink(filename);
 543 }
 544
 545 #endif