Files
qelectrotech-source-mirror/sources/qetmainwindow.cpp
T
ispyisail 5dec36cb29 Add crash-time ring flush and a diagnostics export UI (discussion #644, steps 4-5)
Stacked on the steps 1-3 branch (feature-diagnostic-logging, PR #646).
Kept as its own PR rather than folded into that one, matching the
discussion's own framing: step 4 is explicitly "the highest-risk piece
... lands last, behind its own switch."

## Step 4 -- crash-time ring flush (CrashHandler)

Installs a handler for SIGSEGV/SIGABRT/SIGBUS/SIGFPE/SIGILL (POSIX) /
SetUnhandledExceptionFilter (Windows) that flushes the in-memory ring to
a fixed crash_dump.log before the process dies.

This required reworking LogRing (step 3) to be genuinely lock-free, not
just mutex-protected: a signal handler that blocks on a lock the
crashing thread (or another thread) already holds turns a clean crash
into a hang -- no ring dump *and* no core dump, worse than doing
nothing. append() now claims a slot with a single atomic fetch-add;
dumpToFd() reads the preallocated entries directly and writes them with
write(2) only, looping on EINTR/short writes. Accepted tradeoff: at most
one entry can be read torn if a crash lands mid-append into that exact
slot -- documented in logring.h, and the alternative (a seqlock to
detect and retry) wasn't judged worth the complexity for that window.

Other invariants implemented per the discussion:
- sigaltstack with a static 64 KiB buffer, SA_ONSTACK -- a stack-
  overflow SIGSEGV has no usable stack for a handler without one.
- Nothing under the actual handler touches Qt, QString or the
  allocator: the dump path and a small header (version/git/OS/Qt) are
  precomputed into fixed char buffers by install(), which runs once at
  startup in normal context.
- Atomic test-and-set so only the first crash writes a dump; a second
  concurrent/nested fault goes straight to restore-and-re-raise.
- After writing, the handler restores SIG_DFL and re-raises (POSIX) /
  returns EXCEPTION_CONTINUE_SEARCH (Windows) so the OS's own crash
  path -- core dump, Windows Error Reporting -- still runs. A handler
  that "fixed" the crash by swallowing the signal would destroy exactly
  the post-mortem evidence this whole design exists to preserve.

Tested in this environment: POSIX/Linux only, all five signals. Sent
each directly to a running process and confirmed (a) crash_dump.log is
written with the correct header and ring contents, mode 0600, and (b)
the process still terminates via the signal with the kernel's own
"core dumped" flag set (exit code 128+signal, confirmed for all five).
The Windows path is implemented per the discussion's guidance but is
untested -- no Windows build available in this sandbox.

## Step 5 -- getting the data back out

- QETApp::checkCrashDump(), called from checkBackupFiles() only when
  there's no stale project file to recover this run (so the two
  prompts never both show, per the discussion), offers an unretrieved
  crash dump via DiagnosticsReportDialog and then deletes it regardless
  of the user's choice -- offered exactly once.
- A new "Aide > Enregistrer un rapport de diagnostic..." action
  (QETMainWindow) builds the same kind of report from the *current*
  session (QetLogger::buildDiagnosticsReport(): header + this session's
  log file) for a manual "attach this to a bug report" flow, not tied
  to a crash.
- Both go through QetLogger::redact() before ever reaching the user:
  the one redaction implemented is a literal replace of the home
  directory with "~", since an absolute path under it leaks the
  account name. The discussion's fancier "optionally redact project
  filenames too" isn't attempted -- reliably telling a project path
  apart from arbitrary log text is a much fuzzier problem than a
  literal prefix match.
- DiagnosticsReportDialog shows the full (already-redacted) content
  before saving, per the discussion: "the user is about to attach this
  to a public tracker."

Verified in a real GUI session (Xvfb): triggered a SIGSEGV, relaunched,
confirmed the crash-report dialog appears with the right header/content,
confirmed it does not reappear on a second relaunch, and confirmed the
manual "Save report" action produces a correctly-formatted report and
saves it to a chosen path.

Built clean, no new warnings.

## Build systems

Registered in both: cmake/qet_compilation_vars.cmake, and
qelectrotech.pro. The .pro needed explicit globs for the new
sources/logging/ui/ subfolder -- sources/logging/*.{h,cpp} was already
globbed, but unlike the other ui/ subfolders that one had no entry of
its own, so diagnosticsreportdialog.{h,cpp} would not have been built
under qmake.
2026-08-06 23:04:27 +12:00

297 lines
9.9 KiB
C++

/*
Copyright 2006-2026 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
QElectroTech is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#include <QAction>
#include <QWhatsThis>
#include <QMenu>
#include <QMenuBar>
#include <QDragEnterEvent>
#include <QDesktopServices>
#include "qetmainwindow.h"
#include "qeticons.h"
#include "shortcutmanager.h"
#include "qetapp.h"
#include "qetdiagrameditor.h"
#include "projectview.h"
/**
Constructor
*/
QETMainWindow::QETMainWindow(QWidget *widget, Qt::WindowFlags flags) :
QMainWindow(widget, flags),
display_toolbars_(nullptr),
first_activation_(true)
{
initCommonActions();
initCommonMenus();
setAcceptDrops(true);
}
/**
Destructor
*/
QETMainWindow::~QETMainWindow()
{
}
/**
Initialize common actions.
*/
void QETMainWindow::initCommonActions()
{
QETApp *qet_app = QETApp::instance();
configure_action_ = new QAction(QET::Icons::Configure, tr("&Configurer QElectroTech"), this);
configure_action_ -> setStatusTip(tr("Permet de régler différents paramètres de QElectroTech", "status bar tip"));
connect(configure_action_, &QAction::triggered, [qet_app]()
{
qet_app->configureQET();
#if TODO_LIST
# pragma message("@TODO we use reloadOldElementPanel only to keep up to ")
# pragma message("datethe string of the folio in the old element panel.")
# pragma message("then,if user change the option")
# pragma message(" 'Use labels of folio instead of their ID' the string")
# pragma message(" of folio in the old element panel is up to date")
#endif
//TODO we use reloadOldElementPanel only to keep up to date the string of the folio in the old element panel.
//then, if user change the option "Use labels of folio instead of their ID" the string of folio in the old element panel is up to date
for (QETDiagramEditor *qde : qet_app->diagramEditors())
{
qde->reloadOldElementPanel();
for (ProjectView *pv : qde->openedProjects())
{
pv->updateAllTabsTitle();
}
}
});
fullscreen_action_ = new QAction(this);
updateFullScreenAction();
connect(fullscreen_action_, SIGNAL(triggered()), this, SLOT(toggleFullScreen()));
whatsthis_action_ = QWhatsThis::createAction(this);
about_qet_ = new QAction(QET::Icons::QETLogo, tr("À &propos de QElectroTech"), this);
about_qet_ -> setStatusTip(tr("Affiche des informations sur QElectroTech", "status bar tip"));
connect(about_qet_, SIGNAL(triggered()), qet_app, SLOT(aboutQET()));
manual_online_ = new QAction(QET::Icons::QETManual, tr("Manuel en ligne"), this);
manual_online_ -> setStatusTip(tr("Lance le navigateur par défaut vers le manuel en ligne de QElectroTech", "status bar tip"));
connect(manual_online_, &QAction::triggered, [](bool) {
QString link = "https://download.qelectrotech.org/qet/manual_0.7/build/index.html";
QDesktopServices::openUrl(QUrl(link));
});
ShortcutManager::instance().registerAction(manual_online_, "mainwindow.manual_online", tr("Général"), Qt::Key_F1);
youtube_ = new QAction(QET::Icons::QETVideo, tr("Chaine Youtube"), this);
youtube_ -> setStatusTip(tr("Lance le navigateur par défaut vers la chaine Youtube de QElectroTech", "status bar tip"));
connect(youtube_, &QAction::triggered, [](bool) {
QString link = "https://www.youtube.com/user/scorpio8101/videos";
QDesktopServices::openUrl(QUrl(link));
});
upgrade_ = new QAction(QET::Icons::QETDownload, tr("Télécharger une nouvelle version (dev)"), this);
upgrade_ -> setStatusTip(tr("Lance le navigateur par défaut vers le dépot Nightly en ligne de QElectroTech", "status bar tip"));
upgrade_M = new QAction(QET::Icons::QETDownload, tr("Télécharger une nouvelle version (dev)"), this);
upgrade_M -> setStatusTip(tr("Lance le navigateur par défaut vers le dépot Nightly en ligne de QElectroTech", "status bar tip"));
connect(upgrade_, &QAction::triggered, [](bool) {
QString link = "https://qelectrotech.org/download_windows.php";
QDesktopServices::openUrl(QUrl(link));
});
connect(upgrade_M, &QAction::triggered, [](bool) {
QString link = "https://qelectrotech.org/download_mac.php";
QDesktopServices::openUrl(QUrl(link));
});
donate_ = new QAction(QET::Icons::QETDonate, tr("Soutenir le projet par un don"), this);
donate_ -> setStatusTip(tr("Soutenir le projet QElectroTech par un don", "status bar tip"));
connect(donate_, &QAction::triggered, [](bool) {
QString link = "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZZHC9D7C3MDPC";
QDesktopServices::openUrl(QUrl(link));
});
about_qt_ = new QAction(QET::Icons::QtLogo, tr("À propos de &Qt"), this);
about_qt_ -> setStatusTip(tr("Affiche des informations sur la bibliothèque Qt", "status bar tip"));
connect(about_qt_, SIGNAL(triggered()), qApp, SLOT(aboutQt()));
diagnostics_action_ = new QAction(QET::Icons::DialogInformation, tr("Enregistrer un rapport de diagnostic..."), this);
diagnostics_action_ -> setStatusTip(tr("Génère un rapport avec les derniers messages de journalisation, pour l'inclure dans un rapport de bug", "status bar tip"));
connect(diagnostics_action_, &QAction::triggered, this, []() {
QETApp::instance()->showDiagnosticsReport();
});
}
/**
Initialize common menus.
*/
void QETMainWindow::initCommonMenus()
{
settings_menu_ = new QMenu(tr("&Configuration", "window menu"), this);
settings_menu_ -> addAction(fullscreen_action_);
settings_menu_ -> addAction(configure_action_);
connect(settings_menu_, SIGNAL(aboutToShow()), this, SLOT(checkToolbarsmenu()));
help_menu_ = new QMenu(tr("&Aide", "window menu"), this);
help_menu_ -> addAction(whatsthis_action_);
help_menu_ -> addSeparator();
help_menu_ -> addAction(manual_online_);
help_menu_ -> addAction(youtube_);
help_menu_ -> addAction(upgrade_);
help_menu_ -> addAction(upgrade_M);
help_menu_ -> addAction(donate_);
help_menu_ -> addAction(about_qt_);
help_menu_ -> addAction(about_qet_);
help_menu_ -> addSeparator();
help_menu_ -> addAction(diagnostics_action_);
#ifdef Q_OS_WIN32
upgrade_ -> setVisible(true);
#else
upgrade_ -> setVisible(false);
#endif
#ifdef Q_OS_MACOS
upgrade_M -> setVisible(true);
#else
upgrade_M -> setVisible(false);
#endif
insertMenu(nullptr, settings_menu_);
insertMenu(nullptr, help_menu_);
}
/**
Add \a menu before \a before. Unless \a customize is false, this method also
enables some common settings on the inserted menu.
*/
void QETMainWindow::insertMenu(QMenu *before, QMenu *menu, bool customize) {
if (!menu) return;
QAction *before_action = actionForMenu(before);
QAction *menu_action = menuBar() -> insertMenu(before_action, menu);
menu_actions_.insert(menu, menu_action);
if (customize) {
menu -> setTearOffEnabled(true);
}
}
/**
@return the action returned when inserting \a menu
*/
QAction *QETMainWindow::actionForMenu(QMenu *menu) {
return(menu_actions_.value(menu, nullptr));
}
/**
Toggle the window from/to full screen.
*/
void QETMainWindow::toggleFullScreen()
{
setWindowState(windowState() ^ Qt::WindowFullScreen);
}
/**
Update the look of the full screen action according to the current state of
the window.
*/
void QETMainWindow::updateFullScreenAction()
{
if (windowState() & Qt::WindowFullScreen) {
fullscreen_action_ -> setText(tr("Sortir du &mode plein écran"));
fullscreen_action_ -> setIcon(QET::Icons::FullScreenExit);
fullscreen_action_ -> setStatusTip(tr("Affiche QElectroTech en mode fenêtré", "status bar tip"));
} else {
fullscreen_action_ -> setText(tr("Passer en &mode plein écran"));
fullscreen_action_ -> setIcon(QET::Icons::FullScreenEnter);
fullscreen_action_ -> setStatusTip(tr("Affiche QElectroTech en mode plein écran", "status bar tip"));
}
ShortcutManager::instance().registerAction(fullscreen_action_, "mainwindow.fullscreen", tr("Général"), Qt::CTRL | Qt::SHIFT | Qt::Key_F);
}
/**
Check whether a sub menu dedicated to docks and toolbars can be inserted on
top of the settings menu.
*/
void QETMainWindow::checkToolbarsmenu()
{
if (display_toolbars_) return;
display_toolbars_ = createPopupMenu();
if (display_toolbars_) {
display_toolbars_ -> setTearOffEnabled(true);
display_toolbars_ -> setTitle(tr("Afficher", "menu entry"));
display_toolbars_ -> setIcon(QET::Icons::ConfigureToolbars);
settings_menu_ -> insertMenu(fullscreen_action_, display_toolbars_);
}
}
/**
Handle the \a e event.
*/
bool QETMainWindow::event(QEvent *e) {
if (e -> type() == QEvent::WindowStateChange) {
updateFullScreenAction();
} else if (first_activation_ && e -> type() == QEvent::WindowActivate) {
firstActivation(e);
first_activation_ = false;
}
return(QMainWindow::event(e));
}
/**
Base implementation of firstActivation (does nothing).
*/
void QETMainWindow::firstActivation(QEvent *) {
}
/**
Accept or refuse drag'n drop events depending on the dropped mime type;
especially, accepts only URLs to local files that we could open.
@param e le QDragEnterEvent correspondant au drag'n drop tente
*/
void QETMainWindow::dragEnterEvent(QDragEnterEvent *e) {
if (e -> mimeData() -> hasUrls()) {
if (QETApp::handledFiles(e -> mimeData() -> urls()).count()) {
e -> acceptProposedAction();
}
}
}
/**
Handle drops accepted on main windows; more specifically, open dropped files
as long as they are handled by QElectrotech.
@param e the QDropEvent describing the current drag'n drop
*/
void QETMainWindow::dropEvent(QDropEvent *e) {
if (e -> mimeData() -> hasUrls()) {
QStringList filepaths = QETApp::handledFiles(e -> mimeData() -> urls());
if (filepaths.count()) {
QETApp::instance() -> openFiles(QETArguments(filepaths));
}
}
}