├── example ├── bug.png ├── example.qrc ├── CMakeLists.txt ├── example.hpp └── example.cpp ├── lib ├── locale │ ├── locale.pro │ └── GdbCrashHandler_de.ts ├── GdbCrashHandler.pc.in ├── CMakeLists.txt ├── GdbCrashHandler.hpp ├── GdbCrashHandlerDialog.hpp ├── GdbCrashHandler.cpp ├── GdbCrashHandlerDialog.cpp └── GdbCrashHandlerDialog.ui ├── CMakeLists.txt ├── README.md ├── service └── report.php └── COPYING /example/bug.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/manisandro/GdbCrashHandler/HEAD/example/bug.png -------------------------------------------------------------------------------- /lib/locale/locale.pro: -------------------------------------------------------------------------------- 1 | SOURCES += ../*.cpp 2 | FORMS += ../*.ui 3 | 4 | TRANSLATIONS += \ 5 | GdbCrashHandler_de.ts 6 | -------------------------------------------------------------------------------- /example/example.qrc: -------------------------------------------------------------------------------- 1 | 2 | 3 | bug.png 4 | 5 | 6 | -------------------------------------------------------------------------------- /lib/GdbCrashHandler.pc.in: -------------------------------------------------------------------------------- 1 | prefix=@CMAKE_INSTALL_PREFIX@ 2 | libdir=${prefix}/@PC_LIB_DIR@ 3 | includedir=${prefix}/@PC_INCLUDE_DIR@/ 4 | 5 | Name: GdbCrashHandler 6 | Description: A crash handler for Qt based applications using gdb 7 | Version: @SVG2SVGT@ 8 | Libs: -L${libdir} -lGdbCrashHandler 9 | Cflags: -I${includedir} 10 | -------------------------------------------------------------------------------- /example/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | set(SRCS 2 | example.cpp 3 | ) 4 | 5 | set(HDRS 6 | example.hpp 7 | ) 8 | 9 | set(RESOURCES 10 | example.qrc 11 | ) 12 | 13 | qt5_add_resources(RESOURCES_RCC ${RESOURCES}) 14 | 15 | include_directories(${CMAKE_SOURCE_DIR}/lib) 16 | 17 | add_executable(example ${SRCS} ${HDRS} ${RESOURCES_RCC}) 18 | target_link_libraries(example Qt5::Widgets GdbCrashHandler) 19 | -------------------------------------------------------------------------------- /example/example.hpp: -------------------------------------------------------------------------------- 1 | /* 2 | * example.hpp 3 | * Copyright (C) 2017 Sandro Mani 4 | * 5 | * This program is free software: you can redistribute it and/or modify it 6 | * under the terms of the GNU General Public License as published by the 7 | * Free Software Foundation, either version 3 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, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | * See the GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License along 16 | * with this program. If not, see . 17 | */ 18 | 19 | #include 20 | 21 | class QPlainTextEdit; 22 | 23 | class CrashExample : public QDialog { 24 | Q_OBJECT 25 | public: 26 | CrashExample(const QString& fileName, QWidget* parent = 0); 27 | QString crashSave() const; 28 | 29 | private: 30 | QPlainTextEdit* mTextEdit; 31 | 32 | private slots: 33 | void crash(); 34 | void crashInThread(); 35 | }; 36 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 2.8.11) 2 | 3 | # Project properties 4 | project(GdbCrashHandler) 5 | set(GDBCH_VERSION 0.3.0) 6 | 7 | 8 | # Soname 9 | # MAJOR is incremented when symbols are removed or changed in an incompatible way 10 | # MINOR is incremented when new symbols are added 11 | set(GDBCH_LIB_MAJOR 1) 12 | set(GDBCH_LIB_MINOR 0) 13 | 14 | 15 | # Variables 16 | set(LIB_INSTALL_DIR lib${LIB_SUFFIX} CACHE PATH "Library installation dir") 17 | set(INCLUDE_INSTALL_DIR include CACHE PATH "Header installation dir") 18 | 19 | string(REGEX REPLACE "^${CMAKE_INSTALL_PREFIX}/" "" PC_INCLUDE_DIR ${INCLUDE_INSTALL_DIR}) 20 | string(REGEX REPLACE "^${CMAKE_INSTALL_PREFIX}/" "" PC_LIB_DIR ${LIB_INSTALL_DIR} ) 21 | 22 | 23 | # Dependencies 24 | find_package(Qt5Widgets REQUIRED) 25 | find_package(Qt5Network REQUIRED) 26 | find_package(Qt5LinguistTools REQUIRED) 27 | find_package(QuaZip-Qt5 REQUIRED) 28 | set(CMAKE_AUTOMOC ON) 29 | 30 | string(TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE_TOLOWER) 31 | if(NOT CMAKE_BUILD_TYPE_TOLOWER MATCHES "debug") 32 | add_definitions(-DQT_NO_DEBUG_OUTPUT) 33 | endif() 34 | 35 | 36 | # Subdirectories 37 | add_subdirectory(lib) 38 | add_subdirectory(example) 39 | 40 | # Dist 41 | ADD_CUSTOM_TARGET(dist 42 | COMMAND git archive --format=tar --prefix=${CMAKE_PROJECT_NAME}-${GDBCH_VERSION}/ HEAD | xz > ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}-${GDBCH_VERSION}.tar.xz 43 | WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} 44 | ) 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | GdbCrashHandler 2 | =============== 3 | 4 | A [CrashRpt](http://crashrpt.sourceforge.net/) inspired CrashHandler for Qt 5 | based applications which attaches gdb to the dying process, collects a 6 | stacktrace and submits it to a web service. 7 | 8 | It works by spawing a `QProcess` in the signal handler, re-starting the 9 | application with arguments `--crashhandle `, at which point 10 | `GdbCrashHandler` takes over. 11 | 12 | ![screenshot](https://raw.githubusercontent.com/manisandro/GdbCrashHandler/gh-pages/GdbCrashHandler.png) 13 | 14 | Usage: 15 | ------ 16 | 17 | Initialize the crash handler just after the `QApplication` instance has been created: 18 | 19 | GdbCrashHandler::Configuration config; 20 | config.applicationName = "CrashExample"; 21 | config.applicationVersion = "1.0"; 22 | config.applicationIcon = ":/icons/bug.png"; 23 | config.submitMethod = GdbCrashHandler::Configuration::SubmitService; 24 | config.submitAddress = "http://127.0.0.1/report.php"; 25 | GdbCrashHandler::init(config, /*optional*/ fileSaveCallback); 26 | 27 | See [example/example.cpp](https://github.com/manisandro/GdbCrashHandler/blob/master/example/example.cpp). 28 | 29 | Submit service: 30 | --------------- 31 | 32 | `GdbCrashHandler` submits the reports to a web service, using the same format as 33 | [CrashRpt](http://crashrpt.sourceforge.net/docs/html/sending_error_reports.html), 34 | see [service/report.php](https://github.com/manisandro/GdbCrashHandler/blob/master/service/report.php). 35 | -------------------------------------------------------------------------------- /lib/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | set(GDBCH_LIB_VERSION ${GDBCH_LIB_MAJOR}.${GDBCH_LIB_MINOR}.0) 2 | SET(GDBCH_SO_VERSION ${GDBCH_LIB_MAJOR}) 3 | 4 | set(SRCS 5 | GdbCrashHandlerDialog.cpp 6 | GdbCrashHandler.cpp 7 | ) 8 | 9 | set(HDRS 10 | GdbCrashHandlerDialog.hpp 11 | GdbCrashHandler.hpp 12 | ) 13 | 14 | set(FORMS 15 | GdbCrashHandlerDialog.ui 16 | ) 17 | 18 | qt5_wrap_ui(FORM_HEADERS ${FORMS}) 19 | 20 | add_definitions(-DGDBCRASHHANDLER_LIBRARY) 21 | 22 | include_directories(${CMAKE_CURRENT_BINARY_DIR}) 23 | 24 | add_library(GdbCrashHandler SHARED ${SRCS} ${HDRS} ${FORM_HEADERS}) 25 | set_target_properties(GdbCrashHandler PROPERTIES 26 | VERSION ${GDBCH_LIB_VERSION} 27 | SOVERSION ${GDBCH_SO_VERSION} 28 | ) 29 | if(WIN32) 30 | set_target_properties(GdbCrashHandler PROPERTIES SUFFIX "-${GDBCH_SO_VERSION}${CMAKE_SHARED_LIBRARY_SUFFIX}") 31 | endif(WIN32) 32 | target_link_libraries(GdbCrashHandler Qt5::Widgets Qt5::Network QuaZip::QuaZip) 33 | 34 | install(TARGETS GdbCrashHandler 35 | RUNTIME DESTINATION bin COMPONENT libraries 36 | ARCHIVE DESTINATION ${LIB_INSTALL_DIR} COMPONENT libraries 37 | LIBRARY DESTINATION ${LIB_INSTALL_DIR} COMPONENT libraries 38 | ) 39 | install(FILES GdbCrashHandler.hpp DESTINATION ${INCLUDE_INSTALL_DIR}/GdbCrashHandler/) 40 | 41 | file(GLOB TS locale/*.ts) 42 | qt5_add_translation(QM ${TS}) 43 | add_custom_target(translations ALL DEPENDS ${QM}) 44 | install(FILES ${QM} DESTINATION share/GdbCrashHandler) 45 | 46 | configure_file(GdbCrashHandler.pc.in GdbCrashHandler.pc @ONLY) 47 | install(FILES ${CMAKE_CURRENT_BINARY_DIR}/GdbCrashHandler.pc DESTINATION ${LIB_INSTALL_DIR}/pkgconfig) 48 | -------------------------------------------------------------------------------- /lib/GdbCrashHandler.hpp: -------------------------------------------------------------------------------- 1 | /* 2 | * GdbCrashHandler.hpp 3 | * Copyright (C) 2017 Sandro Mani 4 | * 5 | * This program is free software: you can redistribute it and/or modify it 6 | * under the terms of the GNU General Public License as published by the 7 | * Free Software Foundation, either version 3 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, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | * See the GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License along 16 | * with this program. If not, see . 17 | */ 18 | 19 | #ifndef GDBCRASHHANDLER_HPP 20 | #define GDBCRASHHANDLER_HPP 21 | 22 | #include 23 | #include 24 | 25 | #if defined(GDBCRASHHANDLER_LIBRARY) 26 | # define GDBCRASHHANDLER_API Q_DECL_EXPORT 27 | #else 28 | # define GDBCRASHHANDLER_API Q_DECL_IMPORT 29 | #endif 30 | 31 | namespace GdbCrashHandler { 32 | 33 | struct GDBCRASHHANDLER_API Configuration { 34 | QString applicationName; 35 | QString applicationVersion; 36 | QString applicationIcon; 37 | enum SubmitMethod {SubmitService} submitMethod; 38 | QString submitAddress; 39 | QString gdbBacktraceCommand; // if empty, uses "thread apply all bt" 40 | }; 41 | typedef std::function saveCallback_t; 42 | 43 | void GDBCRASHHANDLER_API init(const Configuration& config, saveCallback_t saveCallback = nullptr); 44 | void GDBCRASHHANDLER_API setSaveCallback(saveCallback_t saveCallback); 45 | 46 | } 47 | 48 | #endif // GDBCRASHHANDLER_HPP 49 | -------------------------------------------------------------------------------- /lib/GdbCrashHandlerDialog.hpp: -------------------------------------------------------------------------------- 1 | /* 2 | * GdbCrashHandlerDialog.hpp 3 | * Copyright (C) 2017 Sandro Mani 4 | * 5 | * This program is free software: you can redistribute it and/or modify it 6 | * under the terms of the GNU General Public License as published by the 7 | * Free Software Foundation, either version 3 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, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | * See the GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License along 16 | * with this program. If not, see . 17 | */ 18 | 19 | #ifndef GDBCRASHHANDLERDIALOG_HPP 20 | #define GDBCRASHHANDLERDIALOG_HPP 21 | 22 | #include "GdbCrashHandler.hpp" 23 | #include "ui_GdbCrashHandlerDialog.h" 24 | #include 25 | 26 | class GdbCrashHandlerDialog : public QDialog { 27 | Q_OBJECT 28 | 29 | public: 30 | explicit GdbCrashHandlerDialog(const GdbCrashHandler::Configuration& config, int pid, const QString& savefile, QWidget *parent = 0); 31 | bool restartApplication() const{ return ui.checkBoxRestart->isChecked(); } 32 | 33 | private: 34 | Ui::GdbCrashHandlerDialog ui; 35 | GdbCrashHandler::Configuration mConfig; 36 | int mPid; 37 | QProcess mGdbProcess; 38 | QPushButton* mSendButton = nullptr; 39 | 40 | void closeEvent(QCloseEvent *) override; 41 | 42 | private slots: 43 | void appendGdbOutput(); 44 | void handleGdbFinished(int exitCode, QProcess::ExitStatus exitStatus); 45 | void regenerateBacktrace(); 46 | void sendReport(); 47 | void killGdb(); 48 | }; 49 | 50 | #endif // GDBCRASHHANDLERDIALOG_HPP 51 | -------------------------------------------------------------------------------- /service/report.php: -------------------------------------------------------------------------------- 1 | 98 | -------------------------------------------------------------------------------- /example/example.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * example.cpp 3 | * Copyright (C) 2017 Sandro Mani 4 | * 5 | * This program is free software: you can redistribute it and/or modify it 6 | * under the terms of the GNU General Public License as published by the 7 | * Free Software Foundation, either version 3 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, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | * See the GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License along 16 | * with this program. If not, see . 17 | */ 18 | 19 | #include "example.hpp" 20 | 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | 33 | class CrashThread : public QThread { 34 | private: 35 | void run() { 36 | QTextStream(stdout) << (*((int*)0)) << endl; 37 | } 38 | }; 39 | 40 | 41 | CrashExample::CrashExample(const QString& fileName, QWidget *parent) 42 | : QDialog(parent) 43 | { 44 | setWindowIcon(QIcon(":/icons/bug.png")); 45 | setWindowTitle("Crash Example"); 46 | setLayout(new QVBoxLayout()); 47 | mTextEdit = new QPlainTextEdit(); 48 | QFile file; 49 | if(!fileName.isEmpty()) { 50 | file.setFileName(fileName); 51 | if(file.open(QIODevice::ReadOnly)) { 52 | mTextEdit->setPlainText(file.readAll()); 53 | } 54 | } 55 | layout()->addWidget(mTextEdit); 56 | layout()->addWidget(new QLabel("Press \"Crash\" to make the application crash.")); 57 | QDialogButtonBox* bbox = new QDialogButtonBox(); 58 | QPushButton* crashButton = bbox->addButton("Crash", QDialogButtonBox::ActionRole); 59 | connect(crashButton, &QPushButton::clicked, this, &CrashExample::crash); 60 | QPushButton* crashThreadButton = bbox->addButton("Crash in thread", QDialogButtonBox::ActionRole); 61 | connect(crashThreadButton, &QPushButton::clicked, this, &CrashExample::crashInThread); 62 | layout()->addWidget(bbox); 63 | } 64 | 65 | void CrashExample::crash() 66 | { 67 | QTextStream(stdout) << (*((int*)0)) << endl; 68 | } 69 | 70 | void CrashExample::crashInThread() 71 | { 72 | CrashThread thread; 73 | thread.start(); 74 | thread.wait(); 75 | } 76 | 77 | QString CrashExample::crashSave() const 78 | { 79 | QTemporaryFile file(QDir::home().absoluteFilePath("crashSave_XXXXXX.txt")); 80 | file.setAutoRemove(false); 81 | if(file.open()) { 82 | file.write(mTextEdit->toPlainText().toLocal8Bit()); 83 | return file.fileName(); 84 | } 85 | return QString(); 86 | } 87 | 88 | int main(int argc, char* argv[]) 89 | { 90 | QApplication app(argc, argv); 91 | 92 | GdbCrashHandler::Configuration config; 93 | config.applicationName = "CrashExample"; 94 | config.applicationVersion = "1.0"; 95 | config.applicationIcon = ":/icons/bug.png"; 96 | config.submitMethod = GdbCrashHandler::Configuration::SubmitService; 97 | config.submitAddress = "http://127.0.0.1/report.php"; 98 | GdbCrashHandler::init(config); 99 | 100 | CrashExample example(argc > 1 ? argv[1] : ""); 101 | GdbCrashHandler::setSaveCallback(std::bind(&CrashExample::crashSave, &example)); 102 | example.show(); 103 | return app.exec(); 104 | } 105 | -------------------------------------------------------------------------------- /lib/locale/GdbCrashHandler_de.ts: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | GdbCrashHandlerDialog 6 | 7 | 8 | Error Report 9 | Fehlerbericht 10 | 11 | 12 | 13 | <html><head/><body><p><span style=" font-size:16pt;">%1 has stopped working</span></p></body></html> 14 | <html><head/><body><p><span style=" font-size:16pt;">%1 funktioniert nicht mehr</span></p></body></html> 15 | 16 | 17 | 18 | Please send us this report to help fix the problem and improve this software. 19 | Bitte schicken Sie diesen Bericht, sodass der Fehler korrigiert werden kann. 20 | 21 | 22 | 23 | Show report contents 24 | Berichtsinhalt anzeigen 25 | 26 | 27 | 28 | Regenerate stacktrace 29 | Stracktrace neugenerieren 30 | 31 | 32 | 33 | Provide additional info about the problem (recommended) 34 | Mehr Informationen zum Problem angeben (empfohlen) 35 | 36 | 37 | 38 | What were you doing when the crash occurred? 39 | Was waren Sie am machen, als diesen Fehler auftrat? 40 | 41 | 42 | 43 | Contact for additional information (optional): 44 | Kontakt für mehr Informationen (optional): 45 | 46 | 47 | 48 | Restart the application 49 | Anwendung neustarten 50 | 51 | 52 | 53 | <b>Your work was saved to <i>%1</i>.</b> 54 | <b>Ihre Arbeit wurde in <i>%1</i> gespeichert.</b> 55 | 56 | 57 | 58 | Send report 59 | Bericht schicken 60 | 61 | 62 | 63 | Don't send report 64 | Bericht nicht schicken 65 | 66 | 67 | 68 | Failed to obtain backtrace. Is gdb installed? 69 | Stacktrace konnte nicht erzeugt werden. Ist gdb installiert? 70 | 71 | 72 | 73 | 74 | 75 | Submit failed 76 | Sendefehler 77 | 78 | 79 | 80 | The attempt to submit the report timed out. 81 | Timeout beim Senden des Berichts. 82 | 83 | 84 | 85 | The attempt to submit the report failed: %1 86 | Fehler beim Senden des Breichts: %1 87 | 88 | 89 | 90 | No submit method was configured by the application. 91 | Kein Sendedienst wurde von der Applikation konfiguriert. 92 | 93 | 94 | 95 | -------------------------------------------------------------------------------- /lib/GdbCrashHandler.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * GdbCrashHandler.cpp 3 | * Copyright (C) 2017 Sandro Mani 4 | * 5 | * This program is free software: you can redistribute it and/or modify it 6 | * under the terms of the GNU General Public License as published by the 7 | * Free Software Foundation, either version 3 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, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | * See the GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License along 16 | * with this program. If not, see . 17 | */ 18 | 19 | #include "GdbCrashHandler.hpp" 20 | #include "GdbCrashHandlerDialog.hpp" 21 | 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #ifdef Q_OS_LINUX 28 | #include 29 | #endif 30 | #ifdef Q_OS_WIN 31 | #include 32 | #endif 33 | 34 | namespace GdbCrashHandler { 35 | 36 | static saveCallback_t gSaveCallback = nullptr; 37 | static bool gInitialized = true; 38 | 39 | static void signalHandler(int signal) { 40 | std::signal(signal, nullptr); 41 | QProcess process; 42 | QStringList args = QApplication::arguments(); 43 | args.removeFirst(); // Remove program path 44 | if(gSaveCallback) { 45 | QString fileName = gSaveCallback(); 46 | args << "--crashsavefile" << fileName; 47 | } 48 | args << "--crashhandle" << QString::number(QApplication::applicationPid()); 49 | process.start(QApplication::applicationFilePath(), args); 50 | #ifdef Q_OS_LINUX 51 | // Allow crash handler spawned debugger to attach to the crashed process 52 | prctl(PR_SET_PTRACER, process.pid(), 0, 0, 0); 53 | #endif 54 | process.waitForFinished(-1); 55 | std::exit(0); 56 | } 57 | 58 | #ifndef __ARMEL__ 59 | static void terminateHandler() { 60 | std::set_terminate(nullptr); 61 | std::exception_ptr exptr = std::current_exception(); 62 | if (exptr != 0) { 63 | try { 64 | std::rethrow_exception(exptr); 65 | } catch (std::exception &ex) { 66 | std::cerr << "Terminated due to exception: " << ex.what() << std::endl; 67 | } catch (...) { 68 | std::cerr << "Terminated due to unknown exception" << std::endl; 69 | } 70 | } else { 71 | std::cerr << "Terminated due to unknown reason" << std::endl; 72 | } 73 | signalHandler(SIGABRT); 74 | } 75 | #endif 76 | 77 | #ifdef Q_OS_WIN 78 | extern "C" { 79 | BOOL APIENTRY DllMain(HANDLE hModule, DWORD dwReason, LPVOID /*lpReserved*/) 80 | { 81 | if(gInitialized) { 82 | if(dwReason==DLL_THREAD_ATTACH) 83 | { 84 | std::signal(SIGSEGV, signalHandler); 85 | std::signal(SIGABRT, signalHandler); 86 | std::signal(SIGILL, signalHandler); 87 | std::signal(SIGFPE, signalHandler); 88 | #ifndef __ARMEL__ 89 | std::set_terminate(terminateHandler); 90 | #endif 91 | std::set_unexpected(terminateHandler); 92 | } 93 | else if(dwReason==DLL_THREAD_DETACH) 94 | { 95 | std::signal(SIGSEGV, 0); 96 | std::signal(SIGABRT, 0); 97 | std::signal(SIGILL, 0); 98 | std::signal(SIGFPE, 0); 99 | #ifndef __ARMEL__ 100 | std::set_terminate(0); 101 | #endif 102 | std::set_unexpected(0); 103 | } 104 | } 105 | 106 | return TRUE; 107 | } 108 | } 109 | #endif 110 | 111 | void GDBCRASHHANDLER_API init(const Configuration& config, saveCallback_t saveCallback) 112 | { 113 | QCommandLineParser parser; 114 | QCommandLineOption crashHandleOption("crashhandle"); 115 | crashHandleOption.setValueName("pid"); 116 | parser.addOption(crashHandleOption); 117 | QCommandLineOption saveFileOption("crashsavefile"); 118 | saveFileOption.setValueName("path"); 119 | parser.addOption(saveFileOption); 120 | parser.parse(qApp->arguments()); 121 | 122 | if(parser.isSet(crashHandleOption)) { 123 | std::signal(SIGSEGV, signalHandler); 124 | int pid = parser.value(crashHandleOption).toInt(); 125 | QString saveFile; 126 | if(parser.isSet(saveFileOption)) { 127 | saveFile = parser.value(saveFileOption); 128 | } 129 | GdbCrashHandlerDialog dialog(config, pid, saveFile); 130 | dialog.show(); 131 | int status = qApp->exec(); 132 | if(dialog.restartApplication()) { 133 | QStringList arguments = qApp->arguments(); 134 | arguments.removeFirst(); // Remove program path 135 | int pos = arguments.indexOf("--crashhandle"); 136 | // Remove both key and value 137 | arguments.removeAt(pos); 138 | arguments.removeAt(pos); 139 | pos = arguments.indexOf("--crashsavefile"); 140 | if(pos != -1) { 141 | arguments.removeAt(pos); 142 | arguments.removeAt(pos); 143 | } 144 | QProcess::startDetached(QApplication::applicationFilePath(), arguments); 145 | } 146 | std::exit(status); 147 | } else { 148 | gSaveCallback = saveCallback; 149 | std::signal(SIGSEGV, signalHandler); 150 | std::signal(SIGABRT, signalHandler); 151 | std::signal(SIGILL, signalHandler); 152 | std::signal(SIGFPE, signalHandler); 153 | #ifndef __ARMEL__ 154 | std::set_terminate(terminateHandler); 155 | #endif 156 | std::set_unexpected(terminateHandler); 157 | gInitialized = true; 158 | } 159 | } 160 | 161 | void GDBCRASHHANDLER_API setSaveCallback(saveCallback_t saveCallback) 162 | { 163 | gSaveCallback = saveCallback; 164 | } 165 | 166 | } 167 | -------------------------------------------------------------------------------- /lib/GdbCrashHandlerDialog.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * GdbGdbCrashHandlerDialog.cpp 3 | * Copyright (C) 2017 Sandro Mani 4 | * 5 | * This program is free software: you can redistribute it and/or modify it 6 | * under the terms of the GNU General Public License as published by the 7 | * Free Software Foundation, either version 3 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, but 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | * See the GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License along 16 | * with this program. If not, see . 17 | */ 18 | 19 | #include "GdbCrashHandlerDialog.hpp" 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | 35 | GdbCrashHandlerDialog::GdbCrashHandlerDialog(const GdbCrashHandler::Configuration& config, int pid, const QString& savefile, QWidget *parent) 36 | : QDialog(parent) 37 | , mConfig(config) 38 | , mPid(pid) 39 | { 40 | ui.setupUi(this); 41 | setWindowIcon(QIcon(config.applicationIcon)); 42 | 43 | if(!savefile.isEmpty()) { 44 | ui.labelAutosave->setText(tr("Your work was saved to %1.").arg(savefile)); 45 | } 46 | 47 | ui.labelIcon->setPixmap(QPixmap(config.applicationIcon)); 48 | ui.labelIcon->setScaledContents(true); 49 | ui.labelTitle->setText(ui.labelTitle->text().arg(config.applicationName)); 50 | 51 | ui.frameDetails->setVisible(false); 52 | ui.frameInfo->setVisible(false); 53 | 54 | connect(ui.checkBoxDetails, &QCheckBox::toggled, ui.frameDetails, &QFrame::setVisible); 55 | connect(ui.checkBoxInfo, &QCheckBox::toggled, ui.frameInfo, &QFrame::setVisible); 56 | connect(ui.buttonBox, &QDialogButtonBox::accepted, this, &QDialog::accept); 57 | connect(ui.buttonBox, &QDialogButtonBox::rejected, this, &QDialog::reject); 58 | connect(ui.buttonBox, &QDialogButtonBox::rejected, this, &GdbCrashHandlerDialog::killGdb); 59 | 60 | mSendButton = ui.buttonBox->addButton(tr("Send report"), QDialogButtonBox::ActionRole); 61 | connect(mSendButton, &QPushButton::clicked, this, &GdbCrashHandlerDialog::sendReport); 62 | ui.buttonBox->addButton(tr("Don't send report"), QDialogButtonBox::RejectRole); 63 | 64 | connect(ui.pushButtonRegenerate, &QPushButton::clicked, this, &GdbCrashHandlerDialog::regenerateBacktrace); 65 | 66 | mGdbProcess.setProcessChannelMode(QProcess::SeparateChannels); 67 | connect(&mGdbProcess, &QProcess::readyReadStandardOutput, this, &GdbCrashHandlerDialog::appendGdbOutput); 68 | connect(&mGdbProcess, SIGNAL(finished(int,QProcess::ExitStatus)), this, SLOT(handleGdbFinished(int,QProcess::ExitStatus))); 69 | 70 | regenerateBacktrace(); 71 | mSendButton->setDefault(true); 72 | 73 | resize(QSize(width(), sizeHint().height())); 74 | } 75 | 76 | void GdbCrashHandlerDialog::closeEvent(QCloseEvent *) { 77 | mGdbProcess.kill(); 78 | } 79 | 80 | void GdbCrashHandlerDialog::appendGdbOutput() { 81 | ui.plainTextEditBacktrace->appendPlainText(mGdbProcess.readAllStandardOutput()); 82 | } 83 | 84 | void GdbCrashHandlerDialog::handleGdbFinished(int exitCode, QProcess::ExitStatus exitStatus) { 85 | ui.widgetBusy->setVisible(false); 86 | ui.labelBusyText->setText(""); 87 | ui.progressBarBacktrace->setVisible(false); 88 | ui.pushButtonRegenerate->setVisible(true); 89 | if(exitCode != 0 || exitStatus != QProcess::NormalExit) { 90 | ui.plainTextEditBacktrace->appendPlainText(tr("Failed to obtain backtrace. Is gdb installed?")); 91 | } else { 92 | QStringList lines = ui.plainTextEditBacktrace->toPlainText().split("\n", QString::SkipEmptyParts); 93 | ui.plainTextEditBacktrace->setPlainText(lines[0]); 94 | ui.plainTextEditBacktrace->appendPlainText("\n"); 95 | for(int i = 1, n = lines.length(); i < n; ++i) { 96 | if(lines[i].startsWith("Thread")) { 97 | ui.plainTextEditBacktrace->appendPlainText("\n"); 98 | ui.plainTextEditBacktrace->appendPlainText(lines[i]); 99 | } else if(lines[i].startsWith('#')) { 100 | ui.plainTextEditBacktrace->appendPlainText(lines[i]); 101 | } 102 | } 103 | } 104 | QTextCursor c = ui.plainTextEditBacktrace->textCursor(); 105 | c.movePosition(QTextCursor::Start); 106 | ui.plainTextEditBacktrace->setTextCursor(c); 107 | ui.plainTextEditBacktrace->ensureCursorVisible(); 108 | } 109 | 110 | void GdbCrashHandlerDialog::regenerateBacktrace() { 111 | ui.pushButtonRegenerate->setVisible(false); 112 | ui.progressBarBacktrace->setVisible(true); 113 | ui.labelBusyText->setText(tr("Gathering information...")); 114 | ui.widgetBusy->setVisible(true); 115 | ui.plainTextEditBacktrace->clear(); 116 | 117 | mGdbProcess.start("gdb", QStringList() << "-p" << QString::number(mPid)); 118 | mGdbProcess.write("set pagination off\n"); 119 | mGdbProcess.write(mConfig.gdbBacktraceCommand.isEmpty() ? "thread apply all bt\n" : mConfig.gdbBacktraceCommand.toLocal8Bit()); 120 | mGdbProcess.write("quit\n"); 121 | } 122 | 123 | static void addDataPart(QHttpMultiPart* multiPart, const QByteArray& name, const QByteArray& data) 124 | { 125 | QHttpPart dataPart; 126 | dataPart.setHeader(QNetworkRequest::ContentDispositionHeader, QVariant("form-data; name=\"" + name + "\"")); 127 | dataPart.setBody(data); 128 | multiPart->append(dataPart); 129 | } 130 | 131 | void GdbCrashHandlerDialog::sendReport() 132 | { 133 | setEnabled(false); 134 | setCursor(Qt::WaitCursor); 135 | if(mGdbProcess.state() != QProcess::NotRunning) { 136 | // wait for gdb to finish 137 | QEventLoop evLoop; 138 | connect(&mGdbProcess, SIGNAL(finished(int)), &evLoop, SLOT(quit())); 139 | evLoop.exec(QEventLoop::ExcludeUserInputEvents); 140 | } 141 | ui.labelBusyText->setText(tr("Sending report...")); 142 | ui.widgetBusy->setVisible(true); 143 | if(mConfig.submitMethod == GdbCrashHandler::Configuration::SubmitService && !mConfig.submitAddress.isEmpty()) { 144 | QByteArray report; 145 | QBuffer buf(&report); 146 | QuaZip quazip(&buf); 147 | quazip.open(QuaZip::mdCreate); 148 | QuaZipFile quazipfile(&quazip); 149 | QuaZipNewInfo info("stacktrace.txt"); 150 | info.setPermissions( QFile::ReadOwner | QFile::ReadUser | QFile::ReadGroup | QFile::ReadOther ); 151 | quazipfile.open(QIODevice::WriteOnly, info); 152 | quazipfile.write(ui.plainTextEditBacktrace->toPlainText().toLocal8Bit()); 153 | quazipfile.close(); 154 | quazip.close(); 155 | 156 | QCryptographicHash crypt(QCryptographicHash::Md5); 157 | crypt.addData(report); 158 | 159 | QHttpMultiPart *multiPart = new QHttpMultiPart(QHttpMultiPart::FormDataType); 160 | 161 | QHttpPart filePart; 162 | filePart.setHeader(QNetworkRequest::ContentDispositionHeader, QVariant("form-data; name=\"crashrpt\"; filename=\"stacktrace.zip\"")); 163 | filePart.setHeader(QNetworkRequest::ContentTypeHeader, QVariant("application/octet-stream")); 164 | filePart.setBody(report); 165 | multiPart->append(filePart); 166 | 167 | addDataPart(multiPart, "appname", mConfig.applicationName.toLocal8Bit()); 168 | addDataPart(multiPart, "appversion", QString("%1").arg(mConfig.applicationVersion).toLocal8Bit()); 169 | addDataPart(multiPart, "emailfrom", ui.lineEditContact->text().toLocal8Bit()); 170 | addDataPart(multiPart, "emailsubject", QString("%1 %2 Error Report").arg(mConfig.applicationName).arg(mConfig.applicationVersion).toLocal8Bit()); 171 | addDataPart(multiPart, "crashguid", QUuid::createUuid().toString().mid(1, 36).toLocal8Bit()); 172 | addDataPart(multiPart, "description", ui.plainTextEditErrorDescr->toPlainText().toLocal8Bit()); 173 | addDataPart(multiPart, "crashrpt", report); 174 | addDataPart(multiPart, "md5", crypt.result().toHex()); 175 | 176 | QNetworkAccessManager nam; 177 | QEventLoop evLoop; 178 | QTimer timer; 179 | timer.setSingleShot(true); 180 | 181 | QNetworkRequest request(mConfig.submitAddress); 182 | QNetworkReply* reply = nam.post(request, multiPart); 183 | timer.start(10000); 184 | connect(reply, &QNetworkReply::finished, &evLoop, &QEventLoop::quit); 185 | connect(&timer, &QTimer::timeout, reply, &QNetworkReply::abort); 186 | evLoop.exec(); 187 | 188 | if(!timer.isActive()) { 189 | QMessageBox::critical(this, tr("Submit failed"), tr("The attempt to submit the report timed out.")); 190 | } else if(reply->error() != QNetworkReply::NoError) { 191 | QMessageBox::critical(this, tr("Submit failed"), tr("The attempt to submit the report failed: %1").arg(reply->errorString())); 192 | } else { 193 | // Success 194 | accept(); 195 | } 196 | reply->deleteLater(); 197 | } else { 198 | QMessageBox::critical(this, tr("Submit failed"), tr("No submit method was configured by the application.")); 199 | } 200 | setEnabled(true); 201 | unsetCursor(); 202 | ui.widgetBusy->setVisible(false); 203 | ui.labelBusyText->setText(""); 204 | } 205 | 206 | void GdbCrashHandlerDialog::killGdb() 207 | { 208 | mGdbProcess.kill(); 209 | } 210 | -------------------------------------------------------------------------------- /lib/GdbCrashHandlerDialog.ui: -------------------------------------------------------------------------------- 1 | 2 | 3 | GdbCrashHandlerDialog 4 | 5 | 6 | 7 | 0 8 | 0 9 | 480 10 | 522 11 | 12 | 13 | 14 | 15 | 0 16 | 0 17 | 18 | 19 | 20 | Error Report 21 | 22 | 23 | 24 | 0 25 | 26 | 27 | 0 28 | 29 | 30 | 0 31 | 32 | 33 | 0 34 | 35 | 36 | 0 37 | 38 | 39 | 40 | 41 | 42 | 0 43 | 0 44 | 45 | 46 | 47 | QWidget#widgetTitle { background: white; } 48 | 49 | 50 | 51 | 5 52 | 53 | 54 | 10 55 | 56 | 57 | 10 58 | 59 | 60 | 10 61 | 62 | 63 | 10 64 | 65 | 66 | 67 | 68 | 69 | 48 70 | 48 71 | 72 | 73 | 74 | 75 | 48 76 | 48 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | <html><head/><body><p><span style=" font-size:16pt;">%1 has stopped working</span></p></body></html> 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 0 96 | 0 97 | 98 | 99 | 100 | Qt::Horizontal 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 0 109 | 0 110 | 111 | 112 | 113 | 114 | 10 115 | 116 | 117 | 10 118 | 119 | 120 | 10 121 | 122 | 123 | 10 124 | 125 | 126 | 127 | 128 | 129 | 0 130 | 0 131 | 132 | 133 | 134 | 135 | 0 136 | 137 | 138 | 0 139 | 140 | 141 | 0 142 | 143 | 144 | 0 145 | 146 | 147 | 148 | 149 | 150 | 0 151 | 0 152 | 153 | 154 | 155 | 156 | 64 157 | 16777215 158 | 159 | 160 | 161 | 0 162 | 163 | 164 | 0 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 0 173 | 0 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 0 186 | 0 187 | 188 | 189 | 190 | QDialogButtonBox::NoButton 191 | 192 | 193 | 194 | 195 | 196 | 197 | Restart the application 198 | 199 | 200 | true 201 | 202 | 203 | 204 | 205 | 206 | 207 | QFrame::StyledPanel 208 | 209 | 210 | 211 | 212 | 213 | What were you doing when the crash occurred? 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | Contact for additional information (optional): 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | Provide additional info about the problem (recommended) 237 | 238 | 239 | 240 | 241 | 242 | 243 | Show report contents 244 | 245 | 246 | 247 | 248 | 249 | 250 | QFrame#frameDetails {background: white; } 251 | 252 | 253 | QFrame::StyledPanel 254 | 255 | 256 | 257 | 0 258 | 259 | 260 | 0 261 | 262 | 263 | 0 264 | 265 | 266 | 0 267 | 268 | 269 | 0 270 | 271 | 272 | 273 | 274 | true 275 | 276 | 277 | color: rgb(144, 144, 144); 278 | 279 | 280 | QFrame::NoFrame 281 | 282 | 283 | true 284 | 285 | 286 | 287 | 288 | 289 | 290 | Regenerate stacktrace 291 | 292 | 293 | 294 | 295 | 296 | 297 | 0 298 | 299 | 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 | 0 309 | 0 310 | 311 | 312 | 313 | 314 | 315 | 316 | 317 | 318 | 319 | 320 | 321 | 0 322 | 0 323 | 324 | 325 | 326 | Please send us this report to help fix the problem and improve this software. 327 | 328 | 329 | true 330 | 331 | 332 | true 333 | 334 | 335 | 336 | 337 | 338 | 339 | 340 | 0 341 | 0 342 | 343 | 344 | 345 | 346 | 347 | 348 | true 349 | 350 | 351 | 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------