1 /////////////////////////////////////////////////////////////////////////////// 2 // Name: wx/debugrpt.h 3 // Purpose: declaration of wxDebugReport class 4 // Author: Vadim Zeitlin 5 // Created: 2005-01-17 6 // RCS-ID: $Id: debugrpt.h 61872 2009-09-09 22:37:05Z VZ $ 7 // Copyright: (c) 2005 Vadim Zeitlin <vadim@wxwindows.org> 8 // Licence: wxWindows licence 9 /////////////////////////////////////////////////////////////////////////////// 10 11 #ifndef _WX_DEBUGRPT_H_ 12 #define _WX_DEBUGRPT_H_ 13 14 #include "wx/defs.h" 15 16 #if wxUSE_DEBUGREPORT && wxUSE_XML 17 18 #include "wx/string.h" 19 #include "wx/arrstr.h" 20 21 class WXDLLIMPEXP_FWD_XML wxXmlNode; 22 23 // ---------------------------------------------------------------------------- 24 // wxDebugReport: generate a debug report, processing is done in derived class 25 // ---------------------------------------------------------------------------- 26 27 class WXDLLIMPEXP_QA wxDebugReport 28 { 29 public: 30 // this is used for the functions which may report either the current state 31 // or the state during the last (fatal) exception 32 enum Context { Context_Current, Context_Exception }; 33 34 35 // ctor creates a temporary directory where we create the files which will 36 // be included in the report, use IsOk() to check for errors 37 wxDebugReport(); 38 39 // dtor normally destroys the temporary directory created in the ctor (with 40 // all the files it contains), call Reset() to prevent this from happening 41 virtual ~wxDebugReport(); 42 43 // return the name of the directory used for this report GetDirectory()44 const wxString& GetDirectory() const { return m_dir; } 45 46 // return true if the object was successfully initialized IsOk()47 bool IsOk() const { return !GetDirectory().empty(); } 48 49 // reset the directory name we use, the object can't be used any more after 50 // this as it becomes invalid/uninitialized Reset()51 void Reset() { m_dir.clear(); } 52 53 54 // add another file to the report: the file must already exist, its name 55 // can be either absolute in which case it is copied to the debug report 56 // directory or relative to GetDirectory() 57 // 58 // description is shown to the user in the report summary 59 virtual void AddFile(const wxString& filename, const wxString& description); 60 61 // convenience function: write the given text to a file with the given name 62 // and then add it to the report (the difference with AddFile() is that the 63 // file will be created by this function and doesn't have to already exist) 64 bool AddText(const wxString& filename, 65 const wxString& text, 66 const wxString& description); 67 68 #if wxUSE_STACKWALKER 69 // add an XML file containing the current or exception context and the 70 // stack trace AddCurrentContext()71 bool AddCurrentContext() { return AddContext(Context_Current); } AddExceptionContext()72 bool AddExceptionContext() { return AddContext(Context_Exception); } 73 virtual bool AddContext(Context ctx); 74 #endif 75 76 #if wxUSE_CRASHREPORT 77 // add a file with crash report AddCurrentDump()78 bool AddCurrentDump() { return AddDump(Context_Current); } AddExceptionDump()79 bool AddExceptionDump() { return AddDump(Context_Exception); } 80 virtual bool AddDump(Context ctx); 81 #endif // wxUSE_CRASHREPORT 82 83 // add all available information to the report 84 void AddAll(Context context = Context_Exception); 85 86 87 // process this report: the base class simply notifies the user that the 88 // report has been generated, this is usually not enough -- instead you 89 // should override this method to do something more useful to you 90 bool Process(); 91 92 // get the name used as base name for various files, by default 93 // wxApp::GetName() 94 virtual wxString GetReportName() const; 95 96 // get the files in this report GetFilesCount()97 size_t GetFilesCount() const { return m_files.GetCount(); } 98 bool GetFile(size_t n, wxString *name, wxString *desc) const; 99 100 // remove the file from report: this is used by wxDebugReportPreview to 101 // allow the user to remove files potentially containing private 102 // information from the report 103 void RemoveFile(const wxString& name); 104 105 protected: 106 #if wxUSE_STACKWALKER 107 // used by AddContext() 108 virtual bool DoAddSystemInfo(wxXmlNode *nodeSystemInfo); 109 virtual bool DoAddLoadedModules(wxXmlNode *nodeModules); 110 virtual bool DoAddExceptionInfo(wxXmlNode *nodeContext); DoAddCustomContext(wxXmlNode * WXUNUSED (nodeRoot))111 virtual void DoAddCustomContext(wxXmlNode * WXUNUSED(nodeRoot)) { } 112 #endif 113 114 // used by Process() 115 virtual bool DoProcess(); 116 117 private: 118 // name of the report directory 119 wxString m_dir; 120 121 // the arrays of files in this report and their descriptions 122 wxArrayString m_files, 123 m_descriptions; 124 }; 125 126 #if wxUSE_ZIPSTREAM 127 128 // ---------------------------------------------------------------------------- 129 // wxDebugReportCompress: compress all files of this debug report in a .ZIP 130 // ---------------------------------------------------------------------------- 131 132 class WXDLLIMPEXP_QA wxDebugReportCompress : public wxDebugReport 133 { 134 public: wxDebugReportCompress()135 wxDebugReportCompress() { } 136 137 // returns the full path of the compressed file (empty if creation failed) GetCompressedFileName()138 const wxString& GetCompressedFileName() const { return m_zipfile; } 139 140 protected: 141 virtual bool DoProcess(); 142 143 private: 144 // full path to the ZIP file we created 145 wxString m_zipfile; 146 }; 147 148 // ---------------------------------------------------------------------------- 149 // wxDebugReportUploader: uploads compressed file using HTTP POST request 150 // ---------------------------------------------------------------------------- 151 152 class WXDLLIMPEXP_QA wxDebugReportUpload : public wxDebugReportCompress 153 { 154 public: 155 // this class will upload the compressed file created by its base class to 156 // an HTML multipart/form-data form at the specified address 157 // 158 // the URL is the base address, input is the name of the "type=file" 159 // control on the form used for the file name and action is the value of 160 // the form action field 161 wxDebugReportUpload(const wxString& url, 162 const wxString& input, 163 const wxString& action, 164 const wxString& curl = wxT("curl")); 165 166 protected: 167 virtual bool DoProcess(); 168 169 // this function may be overridden in a derived class to show the output 170 // from curl: this may be an HTML page or anything else that the server 171 // returned 172 // 173 // return value becomes the return value of Process() OnServerReply(const wxArrayString & WXUNUSED (reply))174 virtual bool OnServerReply(const wxArrayString& WXUNUSED(reply)) 175 { 176 return true; 177 } 178 179 private: 180 // the full URL to use with HTTP POST request 181 wxString m_uploadURL; 182 183 // the name of the input field containing the file name in the form at 184 // above URL 185 wxString m_inputField; 186 187 // the curl command (by default it is just "curl" but could be full path to 188 // curl or a wrapper script with curl-compatible syntax) 189 wxString m_curlCmd; 190 }; 191 192 #endif // wxUSE_ZIPSTREAM 193 194 195 // ---------------------------------------------------------------------------- 196 // wxDebugReportPreview: presents the debug report to the user and allows him 197 // to veto report entirely or remove some parts of it 198 // ---------------------------------------------------------------------------- 199 200 class WXDLLIMPEXP_QA wxDebugReportPreview 201 { 202 public: 203 // ctor is trivial wxDebugReportPreview()204 wxDebugReportPreview() { } 205 206 // present the report to the user and allow him to modify it by removing 207 // some or all of the files and, potentially, adding some notes 208 // 209 // return true if the report should be processed or false if the user chose 210 // to cancel report generation or removed all files from it 211 virtual bool Show(wxDebugReport& dbgrpt) const = 0; 212 213 // dtor is trivial as well but should be virtual for a base class ~wxDebugReportPreview()214 virtual ~wxDebugReportPreview() { } 215 }; 216 217 #if wxUSE_GUI 218 219 // ---------------------------------------------------------------------------- 220 // wxDebugReportPreviewStd: standard debug report preview window 221 // ---------------------------------------------------------------------------- 222 223 class WXDLLIMPEXP_QA wxDebugReportPreviewStd : public wxDebugReportPreview 224 { 225 public: wxDebugReportPreviewStd()226 wxDebugReportPreviewStd() { } 227 228 virtual bool Show(wxDebugReport& dbgrpt) const; 229 }; 230 231 #endif // wxUSE_GUI 232 233 #endif // wxUSE_DEBUGREPORT && wxUSE_XML 234 235 #endif // _WX_DEBUGRPT_H_ 236