samples/debugrpt/debugrpt.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        debugrpt.cpp
   3 // Purpose:     minimal sample showing wxDebugReport and related classes
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     2005-01-20
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2005 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ----------------------------------------------------------------------------
  13 // headers
  14 // ----------------------------------------------------------------------------
  15
  16 #include "wx/app.h"
  17 #include "wx/log.h"
  18 #include "wx/frame.h"
  19 #include "wx/icon.h"
  20 #include "wx/menu.h"
  21 #include "wx/msgdlg.h"
  22 #include "wx/button.h"
  23 #include "wx/dcclient.h"
  24
  25 #include "wx/datetime.h"
  26 #include "wx/ffile.h"
  27 #include "wx/filename.h"
  28 #include "wx/debugrpt.h"
  29
  30 #if !wxUSE_DEBUGREPORT
  31     #error "This sample can't be built without wxUSE_DEBUGREPORT"
  32 #endif // wxUSE_DEBUGREPORT
  33
  34 #if !wxUSE_ON_FATAL_EXCEPTION
  35     #error "This sample can't be built without wxUSE_ON_FATAL_EXCEPTION"
  36 #endif // wxUSE_ON_FATAL_EXCEPTION
  37
  38 #if !defined(__WXMSW__) && !defined(__WXPM__)
  39     #include "../sample.xpm"
  40 #endif
  41
  42 // ----------------------------------------------------------------------------
  43 // custom debug reporting class
  44 // ----------------------------------------------------------------------------
  45
  46 // this is your custom debug reporter: it will use curl program (which should
  47 // be available) to upload the crash report to the given URL (which should be
  48 // set up by you)
  49 class MyDebugReport : public wxDebugReportUpload
  50 {
  51 public:
  52     MyDebugReport() : wxDebugReportUpload
  53                        (
  54                         wxT("http://your.url.here/"),
  55                         wxT("report:file"),
  56                         wxT("action")
  57                        )
  58     {
  59     }
  60
  61 protected:
  62     // this is called with the contents of the server response: you will
  63     // probably want to parse the XML document in OnServerReply() instead of
  64     // just dumping it as I do
  65     virtual bool OnServerReply(const wxArrayString& reply)
  66     {
  67         if ( reply.IsEmpty() )
  68         {
  69             wxLogError(wxT("Didn't receive the expected server reply."));
  70             return false;
  71         }
  72
  73         wxString s(wxT("Server replied:\n"));
  74
  75         const size_t count = reply.GetCount();
  76         for ( size_t n = 0; n < count; n++ )
  77         {
  78             s << wxT('\t') << reply[n] << wxT('\n');
  79         }
  80
  81         wxLogMessage(wxT("%s"), s.c_str());
  82
  83         return true;
  84     }
  85 };
  86
  87 // another possibility would be to build email library from contrib and use
  88 // this class, after uncommenting it:
  89 #if 0
  90
  91 #include "wx/net/email.h"
  92
  93 class MyDebugReport : public wxDebugReportCompress
  94 {
  95 public:
  96     virtual bool DoProcess()
  97     {
  98         if ( !wxDebugReportCompress::DoProcess() )
  99             return false;
 100         wxMailMessage msg(GetReportName() + wxT(" crash report"),
 101                           wxT("vadim@wxwindows.org"),
 102                           wxEmptyString, // mail body
 103                           wxEmptyString, // from address
 104                           GetCompressedFileName(),
 105                           wxT("crashreport.zip"));
 106
 107         return wxEmail::Send(msg);
 108     }
 109 };
 110
 111 #endif // 0
 112
 113 // ----------------------------------------------------------------------------
 114 // helper functions
 115 // ----------------------------------------------------------------------------
 116
 117 // just some functions to get a slightly deeper stack trace
 118 static void bar(const char *p)
 119 {
 120     char *pc = 0;
 121     *pc = *p;
 122
 123     printf("bar: %s\n", p);
 124 }
 125
 126 void baz(const wxString& s)
 127 {
 128     printf("baz: %s\n", (const char*)s.c_str());
 129 }
 130
 131 void foo(int n)
 132 {
 133     if ( n % 2 )
 134         baz("odd");
 135     else
 136         bar("even");
 137 }
 138
 139 // ----------------------------------------------------------------------------
 140 // main window
 141 // ----------------------------------------------------------------------------
 142
 143 enum
 144 {
 145     DebugRpt_Quit = wxID_EXIT,
 146     DebugRpt_Crash = 100,
 147     DebugRpt_Current,
 148     DebugRpt_Paint,
 149     DebugRpt_Upload,
 150     DebugRpt_About = wxID_ABOUT
 151 };
 152
 153 class MyFrame : public wxFrame
 154 {
 155 public:
 156     MyFrame();
 157
 158 private:
 159     void OnQuit(wxCommandEvent& event);
 160     void OnReportForCrash(wxCommandEvent& event);
 161     void OnReportForCurrent(wxCommandEvent& event);
 162     void OnReportPaint(wxCommandEvent& event);
 163     void OnReportUpload(wxCommandEvent& event);
 164     void OnAbout(wxCommandEvent& event);
 165
 166     void OnPaint(wxPaintEvent& event);
 167
 168
 169     // number of lines drawn in OnPaint()
 170     int m_numLines;
 171
 172     wxDECLARE_NO_COPY_CLASS(MyFrame);
 173     DECLARE_EVENT_TABLE()
 174 };
 175
 176 // ----------------------------------------------------------------------------
 177 // application class
 178 // ----------------------------------------------------------------------------
 179
 180 // this is a usual application class modified to work with debug reporter
 181 //
 182 // basically just 2 things are necessary: call wxHandleFatalExceptions() as
 183 // early as possible and override OnFatalException() to create the report there
 184 class MyApp : public wxApp
 185 {
 186 public:
 187     // call wxHandleFatalExceptions here
 188     MyApp();
 189
 190     // create our main window here
 191     virtual bool OnInit();
 192
 193     // called when a crash occurs in this application
 194     virtual void OnFatalException();
 195
 196     // this is where we really generate the debug report
 197     void GenerateReport(wxDebugReport::Context ctx);
 198
 199     // if this function is called, we'll use MyDebugReport which would try to
 200     // upload the (next) generated debug report to its URL, otherwise we just
 201     // generate the debug report and leave it in a local file
 202     void UploadReport(bool doIt) { m_uploadReport = doIt; }
 203
 204 private:
 205     bool m_uploadReport;
 206
 207     wxDECLARE_NO_COPY_CLASS(MyApp);
 208 };
 209
 210 IMPLEMENT_APP(MyApp)
 211
 212 // ============================================================================
 213 // implementation
 214 // ============================================================================
 215
 216 // ----------------------------------------------------------------------------
 217 // MyFrame
 218 // ----------------------------------------------------------------------------
 219
 220 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 221     EVT_MENU(DebugRpt_Quit, MyFrame::OnQuit)
 222     EVT_MENU(DebugRpt_Crash, MyFrame::OnReportForCrash)
 223     EVT_MENU(DebugRpt_Current, MyFrame::OnReportForCurrent)
 224     EVT_MENU(DebugRpt_Paint, MyFrame::OnReportPaint)
 225     EVT_MENU(DebugRpt_Upload, MyFrame::OnReportUpload)
 226     EVT_MENU(DebugRpt_About, MyFrame::OnAbout)
 227
 228     EVT_PAINT(MyFrame::OnPaint)
 229 END_EVENT_TABLE()
 230
 231 MyFrame::MyFrame()
 232        : wxFrame(NULL, wxID_ANY, wxT("wxWidgets Debug Report Sample"),
 233                  wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE|wxDEFAULT_FRAME_STYLE)
 234 {
 235     m_numLines = 10;
 236
 237     SetIcon(wxICON(sample));
 238
 239     wxMenu *menuFile = new wxMenu;
 240     menuFile->Append(DebugRpt_Quit, wxT("E&xit\tAlt-X"));
 241
 242     wxMenu *menuReport = new wxMenu;
 243     menuReport->Append(DebugRpt_Crash, wxT("Report for &crash\tCtrl-C"),
 244                        wxT("Provoke a crash inside the program and create report for it"));
 245     menuReport->Append(DebugRpt_Current, wxT("Report for c&urrent context\tCtrl-U"),
 246                        wxT("Create report for the current program context"));
 247     menuReport->Append(DebugRpt_Paint, wxT("Report for &paint handler\tCtrl-P"),
 248                        wxT("Provoke a repeatable crash in wxEVT_PAINT handler"));
 249     menuReport->AppendSeparator();
 250     menuReport->AppendCheckItem(DebugRpt_Upload, wxT("Up&load debug report"),
 251                        wxT("You need to configure a web server accepting debug report uploads to use this function"));
 252
 253     wxMenu *menuHelp = new wxMenu;
 254     menuHelp->Append(DebugRpt_About, wxT("&About\tF1"));
 255
 256     wxMenuBar *mbar = new wxMenuBar();
 257     mbar->Append(menuFile, wxT("&File"));
 258     mbar->Append(menuReport, wxT("&Report"));
 259     mbar->Append(menuHelp, wxT("&Help"));
 260     SetMenuBar(mbar);
 261
 262     CreateStatusBar();
 263
 264     Show();
 265 }
 266
 267 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 268 {
 269     Close(true);
 270 }
 271
 272 void MyFrame::OnReportForCrash(wxCommandEvent& WXUNUSED(event))
 273 {
 274     // this call is going to crash
 275     foo(32);
 276     foo(17);
 277 }
 278
 279 void MyFrame::OnReportForCurrent(wxCommandEvent& WXUNUSED(event))
 280 {
 281     // example of manually generated report, this could be also
 282     // used in wxApp::OnAssert()
 283     wxGetApp().GenerateReport(wxDebugReport::Context_Current);
 284 }
 285
 286 void MyFrame::OnReportPaint(wxCommandEvent& WXUNUSED(event))
 287 {
 288     // this will result in a crash in OnPaint()
 289     m_numLines = 0;
 290
 291     // ensure it's called immediately
 292     Refresh();
 293 }
 294
 295 void MyFrame::OnReportUpload(wxCommandEvent& event)
 296 {
 297     wxGetApp().UploadReport(event.IsChecked());
 298 }
 299
 300 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 301 {
 302     wxMessageBox
 303     (
 304         wxT("wxDebugReport sample\n(c) 2005 Vadim Zeitlin <vadim@wxwindows.org>"),
 305         wxT("wxWidgets Debug Report Sample"),
 306         wxOK | wxICON_INFORMATION,
 307         this
 308     );
 309 }
 310
 311 void MyFrame::OnPaint(wxPaintEvent& WXUNUSED(event))
 312 {
 313     wxPaintDC dc(this);
 314     const wxSize size = GetClientSize();
 315     for ( wxCoord x = 0; x < size.x; x += size.x/m_numLines )
 316         dc.DrawLine(x, 0, x, size.y);
 317 }
 318
 319 // ----------------------------------------------------------------------------
 320 // MyApp
 321 // ----------------------------------------------------------------------------
 322
 323 MyApp::MyApp()
 324 {
 325     // user needs to explicitly enable this
 326     m_uploadReport = false;
 327
 328     // call this to tell the library to call our OnFatalException()
 329     wxHandleFatalExceptions();
 330 }
 331
 332 bool MyApp::OnInit()
 333 {
 334     if ( !wxApp::OnInit() )
 335         return false;
 336
 337     new MyFrame;
 338
 339     return true;
 340 }
 341
 342 void MyApp::OnFatalException()
 343 {
 344     GenerateReport(wxDebugReport::Context_Exception);
 345 }
 346
 347 void MyApp::GenerateReport(wxDebugReport::Context ctx)
 348 {
 349     wxDebugReportCompress *report = m_uploadReport ? new MyDebugReport
 350                                                    : new wxDebugReportCompress;
 351
 352     // add all standard files: currently this means just a minidump and an
 353     // XML file with system info and stack trace
 354     report->AddAll(ctx);
 355
 356     // you can also call report->AddFile(...) with your own log files, files
 357     // created using wxRegKey::Export() and so on, here we just add a test
 358     // file containing the date of the crash
 359     wxFileName fn(report->GetDirectory(), wxT("timestamp.my"));
 360     wxFFile file(fn.GetFullPath(), wxT("w"));
 361     if ( file.IsOpened() )
 362     {
 363         wxDateTime dt = wxDateTime::Now();
 364         file.Write(dt.FormatISODate() + wxT(' ') + dt.FormatISOTime());
 365         file.Close();
 366     }
 367
 368     report->AddFile(fn.GetFullName(), wxT("timestamp of this report"));
 369
 370     // can also add an existing file directly, it will be copied
 371     // automatically
 372 #ifdef __WXMSW__
 373     report->AddFile(wxT("c:\\autoexec.bat"), wxT("DOS startup file"));
 374 #else
 375     report->AddFile(wxT("/etc/motd"), wxT("Message of the day"));
 376 #endif
 377
 378     // calling Show() is not mandatory, but is more polite
 379     if ( wxDebugReportPreviewStd().Show(*report) )
 380     {
 381         if ( report->Process() )
 382         {
 383             if ( m_uploadReport )
 384             {
 385                 wxLogMessage(wxT("Report successfully uploaded."));
 386             }
 387             else
 388             {
 389                 wxLogMessage(wxT("Report generated in \"%s\"."),
 390                              report->GetCompressedFileName().c_str());
 391                 report->Reset();
 392             }
 393         }
 394     }
 395     //else: user cancelled the report
 396
 397     delete report;
 398 }
 399