1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/debugrpt.cpp
3 // Purpose: wxDebugReport and related classes implementation
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2005 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // License: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/wxprec.h"
33 #if wxUSE_DEBUGREPORT && wxUSE_XML
35 #include "wx/debugrpt.h"
38 #include "wx/filename.h"
40 #include "wx/dynlib.h"
42 #include "wx/xml/xml.h"
45 #include "wx/stackwalk.h"
49 #include "wx/msw/crashrpt.h"
53 #include "wx/wfstream.h"
54 #include "wx/zipstrm.h"
55 #endif // wxUSE_ZIPSTREAM
57 WX_CHECK_BUILD_OPTIONS("wxQA")
59 // ----------------------------------------------------------------------------
60 // XmlStackWalker: stack walker specialization which dumps stack in XML
61 // ----------------------------------------------------------------------------
65 class XmlStackWalker
: public wxStackWalker
68 XmlStackWalker(wxXmlNode
*nodeStack
)
71 m_nodeStack
= nodeStack
;
74 bool IsOk() const { return m_isOk
; }
77 virtual void OnStackFrame(const wxStackFrame
& frame
);
79 wxXmlNode
*m_nodeStack
;
83 // ----------------------------------------------------------------------------
85 // ----------------------------------------------------------------------------
88 HexProperty(wxXmlNode
*node
, const wxChar
*name
, unsigned long value
)
90 node
->AddAttribute(name
, wxString::Format(wxT("%08lx"), value
));
94 NumProperty(wxXmlNode
*node
, const wxChar
*name
, unsigned long value
)
96 node
->AddAttribute(name
, wxString::Format(wxT("%lu"), value
));
100 TextElement(wxXmlNode
*node
, const wxChar
*name
, const wxString
& value
)
102 wxXmlNode
*nodeChild
= new wxXmlNode(wxXML_ELEMENT_NODE
, name
);
103 node
->AddChild(nodeChild
);
104 nodeChild
->AddChild(new wxXmlNode(wxXML_TEXT_NODE
, wxEmptyString
, value
));
107 #if wxUSE_CRASHREPORT && defined(__INTEL__)
110 HexElement(wxXmlNode
*node
, const wxChar
*name
, unsigned long value
)
112 TextElement(node
, name
, wxString::Format(wxT("%08lx"), value
));
115 #endif // wxUSE_CRASHREPORT
117 // ============================================================================
118 // XmlStackWalker implementation
119 // ============================================================================
121 void XmlStackWalker::OnStackFrame(const wxStackFrame
& frame
)
125 wxXmlNode
*nodeFrame
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("frame"));
126 m_nodeStack
->AddChild(nodeFrame
);
128 NumProperty(nodeFrame
, wxT("level"), frame
.GetLevel());
129 wxString func
= frame
.GetName();
132 nodeFrame
->AddAttribute(wxT("function"), func
);
133 HexProperty(nodeFrame
, wxT("offset"), frame
.GetOffset());
136 if ( frame
.HasSourceLocation() )
138 nodeFrame
->AddAttribute(wxT("file"), frame
.GetFileName());
139 NumProperty(nodeFrame
, wxT("line"), frame
.GetLine());
142 const size_t nParams
= frame
.GetParamCount();
145 wxXmlNode
*nodeParams
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("parameters"));
146 nodeFrame
->AddChild(nodeParams
);
148 for ( size_t n
= 0; n
< nParams
; n
++ )
151 nodeParam
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("parameter"));
152 nodeParams
->AddChild(nodeParam
);
154 NumProperty(nodeParam
, wxT("number"), n
);
156 wxString type
, name
, value
;
157 if ( !frame
.GetParam(n
, &type
, &name
, &value
) )
161 TextElement(nodeParam
, wxT("type"), type
);
164 TextElement(nodeParam
, wxT("name"), name
);
166 if ( !value
.empty() )
167 TextElement(nodeParam
, wxT("value"), value
);
172 #endif // wxUSE_STACKWALKER
174 // ============================================================================
175 // wxDebugReport implementation
176 // ============================================================================
178 // ----------------------------------------------------------------------------
179 // initialization and cleanup
180 // ----------------------------------------------------------------------------
182 wxDebugReport::wxDebugReport()
184 // get a temporary directory name
185 wxString appname
= GetReportName();
187 // we can't use CreateTempFileName() because it creates a file, not a
188 // directory, so do our best to create a unique name ourselves
190 // of course, this doesn't protect us against malicious users...
192 fn
.AssignTempFileName(appname
);
194 m_dir
.Printf(wxT("%s%c%s_dbgrpt-%lu-%s"),
195 fn
.GetPath().c_str(), wxFILE_SEP_PATH
, appname
.c_str(),
197 wxDateTime::Now().Format(wxT("%Y%m%dT%H%M%S")).c_str());
199 m_dir
.Printf(wxT("%s%c%s_dbgrpt-%lu"),
200 fn
.GetPath().c_str(), wxFILE_SEP_PATH
, appname
.c_str(),
204 // as we are going to save the process state there use restrictive
206 if ( !wxMkdir(m_dir
, 0700) )
208 wxLogSysError(_("Failed to create directory \"%s\""), m_dir
.c_str());
209 wxLogError(_("Debug report couldn't be created."));
215 wxDebugReport::~wxDebugReport()
217 if ( !m_dir
.empty() )
219 // remove all files in this directory
222 for ( bool cont
= dir
.GetFirst(&file
); cont
; cont
= dir
.GetNext(&file
) )
224 if ( wxRemove(wxFileName(m_dir
, file
).GetFullPath()) != 0 )
226 wxLogSysError(_("Failed to remove debug report file \"%s\""),
234 if ( !m_dir
.empty() )
236 // Temp fix: what should this be? eVC++ doesn't like wxRmDir
238 if ( wxRmdir(m_dir
.fn_str()) != 0 )
240 if ( wxRmDir(m_dir
.fn_str()) != 0 )
243 wxLogSysError(_("Failed to clean up debug report directory \"%s\""),
249 // ----------------------------------------------------------------------------
251 // ----------------------------------------------------------------------------
253 wxString
wxDebugReport::GetReportName() const
256 return wxTheApp
->GetAppName();
262 wxDebugReport::AddFile(const wxString
& filename
, const wxString
& description
)
265 wxFileName
fn(filename
);
266 if ( fn
.IsAbsolute() )
268 // we need to copy the file to the debug report directory: give it the
270 name
= fn
.GetFullName();
271 wxCopyFile(fn
.GetFullPath(),
272 wxFileName(GetDirectory(), name
).GetFullPath());
274 else // file relative to the report directory
278 wxASSERT_MSG( wxFileName(GetDirectory(), name
).FileExists(),
279 wxT("file should exist in debug report directory") );
283 m_descriptions
.Add(description
);
287 wxDebugReport::AddText(const wxString
& filename
,
288 const wxString
& text
,
289 const wxString
& description
)
291 wxASSERT_MSG( !wxFileName(filename
).IsAbsolute(),
292 wxT("filename should be relative to debug report directory") );
294 wxFileName
fn(GetDirectory(), filename
);
295 wxFFile
file(fn
.GetFullPath(), wxT("w"));
296 if ( !file
.IsOpened() || !file
.Write(text
) )
299 AddFile(filename
, description
);
304 void wxDebugReport::RemoveFile(const wxString
& name
)
306 const int n
= m_files
.Index(name
);
307 wxCHECK_RET( n
!= wxNOT_FOUND
, wxT("No such file in wxDebugReport") );
310 m_descriptions
.RemoveAt(n
);
312 wxRemove(wxFileName(GetDirectory(), name
).GetFullPath());
315 bool wxDebugReport::GetFile(size_t n
, wxString
*name
, wxString
*desc
) const
317 if ( n
>= m_files
.GetCount() )
323 *desc
= m_descriptions
[n
];
328 void wxDebugReport::AddAll(Context context
)
330 #if wxUSE_STACKWALKER
332 #endif // wxUSE_STACKWALKER
334 #if wxUSE_CRASHREPORT
336 #endif // wxUSE_CRASHREPORT
338 #if !wxUSE_STACKWALKER && !wxUSE_CRASHREPORT
339 wxUnusedVar(context
);
343 // ----------------------------------------------------------------------------
344 // adding basic text information about current context
345 // ----------------------------------------------------------------------------
347 #if wxUSE_STACKWALKER
349 bool wxDebugReport::DoAddSystemInfo(wxXmlNode
*nodeSystemInfo
)
351 nodeSystemInfo
->AddAttribute(wxT("description"), wxGetOsDescription());
356 bool wxDebugReport::DoAddLoadedModules(wxXmlNode
*nodeModules
)
358 wxDynamicLibraryDetailsArray
modules(wxDynamicLibrary::ListLoaded());
359 const size_t count
= modules
.GetCount();
363 for ( size_t n
= 0; n
< count
; n
++ )
365 const wxDynamicLibraryDetails
& info
= modules
[n
];
367 wxXmlNode
*nodeModule
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("module"));
368 nodeModules
->AddChild(nodeModule
);
370 wxString path
= info
.GetPath();
372 path
= info
.GetName();
374 nodeModule
->AddAttribute(wxT("path"), path
);
378 if ( info
.GetAddress(&addr
, &len
) )
380 HexProperty(nodeModule
, wxT("address"), wxPtrToUInt(addr
));
381 HexProperty(nodeModule
, wxT("size"), len
);
384 wxString ver
= info
.GetVersion();
387 nodeModule
->AddAttribute(wxT("version"), ver
);
394 bool wxDebugReport::DoAddExceptionInfo(wxXmlNode
*nodeContext
)
396 #if wxUSE_CRASHREPORT
401 wxXmlNode
*nodeExc
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("exception"));
402 nodeContext
->AddChild(nodeExc
);
404 HexProperty(nodeExc
, wxT("code"), c
.code
);
405 nodeExc
->AddAttribute(wxT("name"), c
.GetExceptionString());
406 HexProperty(nodeExc
, wxT("address"), wxPtrToUInt(c
.addr
));
409 wxXmlNode
*nodeRegs
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("registers"));
410 nodeContext
->AddChild(nodeRegs
);
411 HexElement(nodeRegs
, wxT("eax"), c
.regs
.eax
);
412 HexElement(nodeRegs
, wxT("ebx"), c
.regs
.ebx
);
413 HexElement(nodeRegs
, wxT("ecx"), c
.regs
.edx
);
414 HexElement(nodeRegs
, wxT("edx"), c
.regs
.edx
);
415 HexElement(nodeRegs
, wxT("esi"), c
.regs
.esi
);
416 HexElement(nodeRegs
, wxT("edi"), c
.regs
.edi
);
418 HexElement(nodeRegs
, wxT("ebp"), c
.regs
.ebp
);
419 HexElement(nodeRegs
, wxT("esp"), c
.regs
.esp
);
420 HexElement(nodeRegs
, wxT("eip"), c
.regs
.eip
);
422 HexElement(nodeRegs
, wxT("cs"), c
.regs
.cs
);
423 HexElement(nodeRegs
, wxT("ds"), c
.regs
.ds
);
424 HexElement(nodeRegs
, wxT("es"), c
.regs
.es
);
425 HexElement(nodeRegs
, wxT("fs"), c
.regs
.fs
);
426 HexElement(nodeRegs
, wxT("gs"), c
.regs
.gs
);
427 HexElement(nodeRegs
, wxT("ss"), c
.regs
.ss
);
429 HexElement(nodeRegs
, wxT("flags"), c
.regs
.flags
);
433 #else // !wxUSE_CRASHREPORT
434 wxUnusedVar(nodeContext
);
437 #endif // wxUSE_CRASHREPORT/!wxUSE_CRASHREPORT
440 bool wxDebugReport::AddContext(wxDebugReport::Context ctx
)
442 wxCHECK_MSG( IsOk(), false, wxT("use IsOk() first") );
444 // create XML dump of current context
445 wxXmlDocument xmldoc
;
446 wxXmlNode
*nodeRoot
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("report"));
447 xmldoc
.SetRoot(nodeRoot
);
448 nodeRoot
->AddAttribute(wxT("version"), wxT("1.0"));
449 nodeRoot
->AddAttribute(wxT("kind"), ctx
== Context_Current
? wxT("user")
452 // add system information
453 wxXmlNode
*nodeSystemInfo
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("system"));
454 if ( DoAddSystemInfo(nodeSystemInfo
) )
455 nodeRoot
->AddChild(nodeSystemInfo
);
457 delete nodeSystemInfo
;
459 // add information about the loaded modules
460 wxXmlNode
*nodeModules
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("modules"));
461 if ( DoAddLoadedModules(nodeModules
) )
462 nodeRoot
->AddChild(nodeModules
);
466 // add CPU context information: this only makes sense for exceptions as our
467 // current context is not very interesting otherwise
468 if ( ctx
== Context_Exception
)
470 wxXmlNode
*nodeContext
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("context"));
471 if ( DoAddExceptionInfo(nodeContext
) )
472 nodeRoot
->AddChild(nodeContext
);
477 // add stack traceback
478 #if wxUSE_STACKWALKER
479 wxXmlNode
*nodeStack
= new wxXmlNode(wxXML_ELEMENT_NODE
, wxT("stack"));
480 XmlStackWalker
sw(nodeStack
);
481 #if wxUSE_ON_FATAL_EXCEPTION
482 if ( ctx
== Context_Exception
)
484 sw
.WalkFromException();
486 else // Context_Current
487 #endif // wxUSE_ON_FATAL_EXCEPTION
493 nodeRoot
->AddChild(nodeStack
);
496 #endif // wxUSE_STACKWALKER
498 // finally let the user add any extra information he needs
499 DoAddCustomContext(nodeRoot
);
502 // save the entire context dump in a file
503 wxFileName
fn(m_dir
, GetReportName(), wxT("xml"));
505 if ( !xmldoc
.Save(fn
.GetFullPath()) )
508 AddFile(fn
.GetFullName(), _("process context description"));
513 #endif // wxUSE_STACKWALKER
515 // ----------------------------------------------------------------------------
517 // ----------------------------------------------------------------------------
519 #if wxUSE_CRASHREPORT
521 bool wxDebugReport::AddDump(Context ctx
)
523 wxCHECK_MSG( IsOk(), false, wxT("use IsOk() first") );
525 wxFileName
fn(m_dir
, GetReportName(), wxT("dmp"));
526 wxCrashReport::SetFileName(fn
.GetFullPath());
528 if ( !(ctx
== Context_Exception
? wxCrashReport::Generate()
529 : wxCrashReport::GenerateNow()) )
532 AddFile(fn
.GetFullName(), _("dump of the process state (binary)"));
537 #endif // wxUSE_CRASHREPORT
539 // ----------------------------------------------------------------------------
541 // ----------------------------------------------------------------------------
543 bool wxDebugReport::Process()
545 if ( !GetFilesCount() )
547 wxLogError(_("Debug report generation has failed."));
554 wxLogError(_("Processing debug report has failed, leaving the files in \"%s\" directory."),
555 GetDirectory().c_str());
565 bool wxDebugReport::DoProcess()
567 wxString
msg(_("A debug report has been generated. It can be found in"));
569 wxT("\t") << GetDirectory() << wxT("\n\n")
570 << _("And includes the following files:\n");
573 const size_t count
= GetFilesCount();
574 for ( size_t n
= 0; n
< count
; n
++ )
576 GetFile(n
, &name
, &desc
);
577 msg
+= wxString::Format("\t%s: %s\n", name
, desc
);
580 msg
+= _("\nPlease send this report to the program maintainer, thank you!\n");
582 wxLogMessage(wxT("%s"), msg
.c_str());
584 // we have to do this or the report would be deleted, and we don't even
585 // have any way to ask the user if he wants to keep it from here
591 // ============================================================================
592 // wxDebugReport-derived classes
593 // ============================================================================
597 // ----------------------------------------------------------------------------
598 // wxDebugReportCompress
599 // ----------------------------------------------------------------------------
601 bool wxDebugReportCompress::DoProcess()
603 const size_t count
= GetFilesCount();
607 // create the streams
608 wxFileName
fn(GetDirectory(), GetReportName(), wxT("zip"));
609 wxFFileOutputStream
os(fn
.GetFullPath(), wxT("wb"));
610 wxZipOutputStream
zos(os
, 9);
612 // add all files to the ZIP one
614 for ( size_t n
= 0; n
< count
; n
++ )
616 GetFile(n
, &name
, &desc
);
618 wxZipEntry
*ze
= new wxZipEntry(name
);
619 ze
->SetComment(desc
);
621 if ( !zos
.PutNextEntry(ze
) )
624 wxFileName
filename(fn
.GetPath(), name
);
625 wxFFileInputStream
is(filename
.GetFullPath());
626 if ( !is
.IsOk() || !zos
.Write(is
).IsOk() )
633 m_zipfile
= fn
.GetFullPath();
638 // ----------------------------------------------------------------------------
639 // wxDebugReportUpload
640 // ----------------------------------------------------------------------------
642 wxDebugReportUpload::wxDebugReportUpload(const wxString
& url
,
643 const wxString
& input
,
644 const wxString
& action
,
645 const wxString
& curl
)
650 if ( m_uploadURL
.Last() != wxT('/') )
651 m_uploadURL
+= wxT('/');
652 m_uploadURL
+= action
;
655 bool wxDebugReportUpload::DoProcess()
657 if ( !wxDebugReportCompress::DoProcess() )
661 wxArrayString output
, errors
;
662 int rc
= wxExecute(wxString::Format
664 wxT("%s -F %s=@\"%s\" %s"),
666 m_inputField
.c_str(),
667 GetCompressedFileName().c_str(),
674 wxLogError(_("Failed to execute curl, please install it in PATH."));
678 const size_t count
= errors
.GetCount();
681 for ( size_t n
= 0; n
< count
; n
++ )
683 wxLogWarning(wxT("%s"), errors
[n
].c_str());
687 wxLogError(_("Failed to upload the debug report (error code %d)."), rc
);
691 if ( OnServerReply(output
) )
698 #endif // wxUSE_ZIPSTREAM
700 #endif // wxUSE_DEBUGREPORT