9b33bb839f2b2d6f40a38ba22aa083577a240eb8
[claws.git] / 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 <glib.h>
27 #include <gtk/gtk.h>
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <signal.h>
31 #include <time.h>
32 #include <sys/types.h>
33 #include <sys/wait.h>
34
35 #include <errno.h>
36 #include <fcntl.h>
37
38 #if HAVE_SYS_UTSNAME_H
39 #       include <sys/utsname.h>
40 #endif
41
42 #if defined(__GNU_LIBRARY__)
43 #       include <gnu/libc-version.h>
44 #endif
45
46 #ifdef SIGTERM
47 #include "main.h"
48 #endif
49 #include "intl.h"
50 #include "crash.h"
51 #include "utils.h"
52 #include "filesel.h"
53 #include "version.h"
54 #include "prefs_common.h"
55
56 /*
57  * NOTE: the crash dialog is called when sylpheed is not 
58  * initialized, so do not assume settings are available.
59  * for example, loading / creating pixmaps seems not 
60  * to be possible.
61  */
62
63 /***/
64
65 static GtkWidget        *crash_dialog_show              (const gchar *text, 
66                                                          const gchar *debug_output);
67 static void              crash_create_debugger_file     (void);
68 static void              crash_save_crash_log           (GtkButton *, const gchar *);
69 static void              crash_create_bug_report        (GtkButton *, const gchar *);
70 static void              crash_debug                    (unsigned long crash_pid, 
71                                                          gchar   *exe_image,
72                                                          GString *debug_output);
73 static const gchar      *get_compiled_in_features       (void);
74 static const gchar      *get_lib_version                (void);
75 static const gchar      *get_operating_system           (void);
76 static gboolean          is_crash_dialog_allowed        (void);
77 static void              crash_handler                  (int sig);
78 static void              crash_cleanup_exit             (void);
79
80 /***/
81
82 static const gchar *DEBUG_SCRIPT = "bt\nkill\nq";
83
84 /***/
85
86 /*!
87  *\brief        install crash handlers
88  */
89 void crash_install_handlers(void)
90 {
91 #if CRASH_DIALOG 
92         sigset_t mask;
93
94         if (!is_crash_dialog_allowed()) return;
95
96         sigemptyset(&mask);
97
98 #ifdef SIGSEGV
99         signal(SIGSEGV, crash_handler);
100         sigaddset(&mask, SIGSEGV);
101 #endif
102         
103 #ifdef SIGFPE
104         signal(SIGFPE, crash_handler);
105         sigaddset(&mask, SIGFPE);
106 #endif
107
108 #ifdef SIGILL
109         signal(SIGILL, crash_handler);
110         sigaddset(&mask, SIGILL);
111 #endif
112
113 #ifdef SIGABRT
114         signal(SIGABRT, crash_handler);
115         sigaddset(&mask, SIGABRT);
116 #endif
117
118         sigprocmask(SIG_UNBLOCK, &mask, 0);
119 #endif /* CRASH_DIALOG */       
120 }
121
122 /***/
123
124 /*!
125  *\brief        crash dialog entry point 
126  */
127 void crash_main(const char *arg) 
128 {
129 #if CRASH_DIALOG 
130         gchar *text;
131         gchar **tokens;
132         unsigned long pid;
133         GString *output;
134
135         crash_create_debugger_file();
136         tokens = g_strsplit(arg, ",", 0);
137
138         pid = atol(tokens[0]);
139         text = g_strdup_printf(_("Sylpheed process (%ld) received signal %ld"),
140                                pid, atol(tokens[1]));
141
142         output = g_string_new("");     
143         crash_debug(pid, tokens[2], output);
144
145         /*
146          * try to get the settings
147          */
148         prefs_common_init();
149         prefs_common_read_config();
150
151         crash_dialog_show(text, output->str);
152         g_string_free(output, TRUE);
153         g_free(text);
154         g_strfreev(tokens);
155 #endif /* CRASH_DIALOG */       
156 }
157
158 /*!
159  *\brief        show crash dialog
160  *
161  *\param        text Description
162  *\param        debug_output Output text by gdb
163  *
164  *\return       GtkWidget * Dialog widget
165  */
166 static GtkWidget *crash_dialog_show(const gchar *text, const gchar *debug_output)
167 {
168         GtkWidget *window1;
169         GtkWidget *vbox1;
170         GtkWidget *hbox1;
171         GtkWidget *label1;
172         GtkWidget *frame1;
173         GtkWidget *scrolledwindow1;
174         GtkWidget *text1;
175         GtkWidget *hbuttonbox3;
176         GtkWidget *hbuttonbox4;
177         GtkWidget *button3;
178         GtkWidget *button4;
179         GtkWidget *button5;
180         gchar     *crash_report;
181
182         window1 = gtk_window_new(GTK_WINDOW_TOPLEVEL);
183         gtk_container_set_border_width(GTK_CONTAINER(window1), 5);
184         gtk_window_set_title(GTK_WINDOW(window1), _("Sylpheed has crashed"));
185         gtk_window_set_position(GTK_WINDOW(window1), GTK_WIN_POS_CENTER);
186         gtk_window_set_modal(GTK_WINDOW(window1), TRUE);
187         gtk_window_set_default_size(GTK_WINDOW(window1), 460, 272);
188
189
190         vbox1 = gtk_vbox_new(FALSE, 2);
191         gtk_widget_show(vbox1);
192         gtk_container_add(GTK_CONTAINER(window1), vbox1);
193
194         hbox1 = gtk_hbox_new(FALSE, 4);
195         gtk_widget_show(hbox1);
196         gtk_box_pack_start(GTK_BOX(vbox1), hbox1, FALSE, TRUE, 0);
197         gtk_container_set_border_width(GTK_CONTAINER(hbox1), 4);
198
199         label1 = gtk_label_new
200             (g_strdup_printf(_("%s.\nPlease file a bug report and include the information below."), text));
201         gtk_widget_show(label1);
202         gtk_box_pack_start(GTK_BOX(hbox1), label1, TRUE, TRUE, 0);
203         gtk_misc_set_alignment(GTK_MISC(label1), 7.45058e-09, 0.5);
204
205         frame1 = gtk_frame_new(_("Debug log"));
206         gtk_widget_show(frame1);
207         gtk_box_pack_start(GTK_BOX(vbox1), frame1, TRUE, TRUE, 0);
208
209         scrolledwindow1 = gtk_scrolled_window_new(NULL, NULL);
210         gtk_widget_show(scrolledwindow1);
211         gtk_container_add(GTK_CONTAINER(frame1), scrolledwindow1);
212         gtk_container_set_border_width(GTK_CONTAINER(scrolledwindow1), 3);
213         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwindow1),
214                                        GTK_POLICY_NEVER, GTK_POLICY_ALWAYS);
215
216         text1 = gtk_text_new(NULL, NULL);
217         gtk_text_set_editable(GTK_TEXT(text1), FALSE);
218         gtk_widget_show(text1);
219         gtk_container_add(GTK_CONTAINER(scrolledwindow1), text1);
220         
221         crash_report = g_strdup_printf(
222                 "Sylpheed version %s\nGTK+ version %d.%d.%d\nFeatures:%s\nOperating system: %s\nC Library: %s\n--\n%s",
223                 VERSION,
224                 gtk_major_version, gtk_minor_version, gtk_micro_version,
225                 get_compiled_in_features(),
226                 get_operating_system(),
227                 get_lib_version(),
228                 debug_output);
229
230         gtk_text_insert(GTK_TEXT(text1), NULL, NULL, NULL, crash_report, -1);
231
232         hbuttonbox3 = gtk_hbutton_box_new();
233         gtk_widget_show(hbuttonbox3);
234         gtk_box_pack_start(GTK_BOX(vbox1), hbuttonbox3, FALSE, FALSE, 0);
235
236         hbuttonbox4 = gtk_hbutton_box_new();
237         gtk_widget_show(hbuttonbox4);
238         gtk_box_pack_start(GTK_BOX(vbox1), hbuttonbox4, FALSE, FALSE, 0);
239
240         button3 = gtk_button_new_with_label(_("Close"));
241         gtk_widget_show(button3);
242         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button3);
243         GTK_WIDGET_SET_FLAGS(button3, GTK_CAN_DEFAULT);
244
245         button4 = gtk_button_new_with_label(_("Save..."));
246         gtk_widget_show(button4);
247         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button4);
248         GTK_WIDGET_SET_FLAGS(button4, GTK_CAN_DEFAULT);
249
250         button5 = gtk_button_new_with_label(_("Create bug report"));
251         gtk_widget_show(button5);
252         gtk_container_add(GTK_CONTAINER(hbuttonbox4), button5);
253         GTK_WIDGET_SET_FLAGS(button5, GTK_CAN_DEFAULT);
254         
255         gtk_signal_connect(GTK_OBJECT(window1), "delete_event",
256                            GTK_SIGNAL_FUNC(gtk_main_quit), NULL);
257         gtk_signal_connect(GTK_OBJECT(button3),   "clicked",
258                            GTK_SIGNAL_FUNC(gtk_main_quit), NULL);
259         gtk_signal_connect(GTK_OBJECT(button4), "clicked",
260                            GTK_SIGNAL_FUNC(crash_save_crash_log),
261                            crash_report);
262         gtk_signal_connect(GTK_OBJECT(button5), "clicked",
263                            GTK_SIGNAL_FUNC(crash_create_bug_report),
264                            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 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 HAVE_GDK_IMLIB
397                    " gdk_imlib"
398 #endif
399 #if HAVE_GDK_PIXBUF
400                    " gdk-pixbuf"
401 #endif
402 #if USE_THREADS
403                    " gthread"
404 #endif
405 #if INET6
406                    " IPv6"
407 #endif
408 #if HAVE_LIBCOMPFACE
409                    " libcompface"
410 #endif
411 #if HAVE_LIBJCONV
412                    " libjconv"
413 #endif
414 #if USE_GPGME
415                    " GPGME"
416 #endif
417 #if USE_OPENSSL
418                    " OpenSSL"
419 #endif
420 #if USE_LDAP
421                    " LDAP"
422 #endif
423 #if USE_JPILOT
424                    " JPilot"
425 #endif
426 #if USE_ASPELL
427                    " GNU/aspell"
428 #endif
429         "");
430 }
431
432 /***/
433
434 /*!
435  *\brief        library version
436  */
437 static const gchar *get_lib_version(void)
438 {
439 #if defined(__GNU_LIBRARY__)
440         return g_strdup_printf("GNU libc %s", gnu_get_libc_version());
441 #else
442         return g_strdup(_("Unknown"));
443 #endif
444 }
445
446 /***/
447
448 /*!
449  *\brief        operating system
450  */
451 static const gchar *get_operating_system(void)
452 {
453 #if HAVE_SYS_UTSNAME_H
454         struct utsname utsbuf;
455         uname(&utsbuf);
456         return g_strdup_printf("%s %s (%s)",
457                                utsbuf.sysname,
458                                utsbuf.release,
459                                utsbuf.machine);
460 #else
461         return g_strdup(_("Unknown"));
462         
463 #endif
464 }
465
466 /***/
467
468 /*!
469  *\brief        see if the crash dialog is allowed (because some
470  *              developers may prefer to run sylpheed under gdb...)
471  */
472 static gboolean is_crash_dialog_allowed(void)
473 {
474         return !getenv("SYLPHEED_NO_CRASH");
475 }
476
477 /*!
478  *\brief        this handler will probably evolve into 
479  *              something better.
480  */
481 static void crash_handler(int sig)
482 {
483         pid_t pid;
484         static volatile unsigned long crashed_ = 0;
485
486         /*
487          * let's hope argv0 aren't trashed.
488          * both are defined in main.c.
489          */
490         extern gchar *argv0;
491
492
493         /*
494          * besides guarding entrancy it's probably also better 
495          * to mask off signals
496          */
497         if (crashed_) return;
498
499         crashed_++;
500
501 #ifdef SIGTERM
502         if (sig == SIGTERM) 
503                 clean_quit();
504 #endif
505
506         /*
507          * gnome ungrabs focus, and flushes gdk. mmmh, good idea.
508          */
509         gdk_pointer_ungrab(GDK_CURRENT_TIME);
510         gdk_keyboard_ungrab(GDK_CURRENT_TIME);
511         gdk_flush();
512
513         if (0 == (pid = fork())) {
514                 char buf[50];
515                 char *args[5];
516         
517                 /*
518                  * probably also some other parameters (like GTK+ ones).
519                  * also we pass the full startup dir and the real command
520                  * line typed in (argv0)
521                  */
522                 args[0] = argv0; 
523                 args[1] = "--debug";
524                 args[2] = "--crash";
525                 sprintf(buf, "%d,%d,%s", getppid(), sig, argv0);
526                 args[3] = buf;
527                 args[4] = NULL;
528
529                 chdir(sylpheed_get_startup_dir());
530                 setgid(getgid());
531                 setuid(getuid());
532                 execvp(argv0, args);
533         } else {
534                 waitpid(pid, NULL, 0);
535                 crash_cleanup_exit();
536                 _exit(253);
537         }
538
539         _exit(253);
540 }
541
542 /*!
543  *\brief        put all the things here we can do before
544  *              letting the program die
545  */
546 static void crash_cleanup_exit(void)
547 {
548         extern gchar *get_socket_name(void);
549         const char *filename = get_socket_name();
550         unlink(filename);
551 }
552
553 #endif