#1765 misc: optionally anonymize personal information in debug output

Signed-off-by: Patrizio Bekerle <patrizio@bekerle.com>

Author: pbek

CHANGELOG.md

@@ -1,7 +1,12 @@
 # QOwnNotes Changelog
 
-## 26.4.15
+## 26.4.16
 
+- Added an optional **Anonymize personal information** toggle to the
+  **Debug information** settings page and the **issue assistant**, which can
+  hide usernames in paths and anonymize note names, cloud account identifiers,
+  saved searches, and sensitive environment values in generated debug
+  information before it is shared (for [#1765](https://github.com/pbek/QOwnNotes/issues/1765))
 - Added a rememberable confirmation dialog before opening items in the file
   manager from note reveal and export actions, so accidental folder windows can
   be suppressed per action after choosing **No** once with **Don't ask again!**

src/dialogs/issueassistantdialog.cpp

@@ -18,8 +18,12 @@ IssueAssistantDialog::IssueAssistantDialog(QWidget *parent)
     : MasterDialog(parent), ui(new Ui::IssueAssistantDialog) {
     ui->setupUi(this);
     afterSetupUI();
+    const SettingsService settings;
+
     ui->backButton->setEnabled(false);
     ui->nextButton->setEnabled(false);
+    ui->debugInfoAnonymizeCheckBox->setChecked(
+        settings.value(QStringLiteral("debugInfoAnonymize")).toBool());
 
     ui->stackedWidget->setCurrentIndex(IssueAssistantPages::IssuePage);
     on_issueTypeComboBox_currentIndexChanged(ProblemIssueType);
@@ -112,8 +116,7 @@ void IssueAssistantDialog::refreshPage(int index) const {
             break;
         case DebugSettingsPage:
             if (ui->debugOutputPlainTextEdit->toPlainText().isEmpty()) {
-                ui->debugOutputPlainTextEdit->setPlainText(
-                    Utils::Misc::generateDebugInformation(true));
+                refreshDebugOutput();
             }
             break;
         case SubmitPage:
@@ -135,6 +138,11 @@ void IssueAssistantDialog::refreshLogOutput() const {
     ui->logOutputPlainTextEdit->setPlainText(mainWindow->getLogText());
 }
 
+void IssueAssistantDialog::refreshDebugOutput() const {
+    ui->debugOutputPlainTextEdit->setPlainText(
+        Utils::Misc::generateDebugInformation(true, ui->debugInfoAnonymizeCheckBox->isChecked()));
+}
+
 void IssueAssistantDialog::generateSubmitPageContent() const {
     QString title;
 
@@ -272,3 +280,9 @@ void IssueAssistantDialog::on_newIssueButton_clicked() {
     ui->stackedWidget->setCurrentIndex(IssueAssistantPages::IssuePage);
     ui->issueTypeComboBox->setCurrentIndex(QuestionIssueType);
 }
+
+void IssueAssistantDialog::on_debugInfoAnonymizeCheckBox_toggled(bool checked) {
+    SettingsService settings;
+    settings.setValue(QStringLiteral("debugInfoAnonymize"), checked);
+    refreshDebugOutput();
+}

src/dialogs/issueassistantdialog.h

@@ -46,6 +46,8 @@ class IssueAssistantDialog : public MasterDialog {
 
     void on_newIssueButton_clicked();
 
+    void on_debugInfoAnonymizeCheckBox_toggled(bool checked);
+
    private:
     Ui::IssueAssistantDialog *ui;
 
@@ -54,4 +56,6 @@ class IssueAssistantDialog : public MasterDialog {
     void generateSubmitPageContent() const;
 
     void refreshPage(int index) const;
+
+    void refreshDebugOutput() const;
 };

src/dialogs/issueassistantdialog.ui

@@ -419,6 +419,16 @@
             </property>
            </widget>
           </item>
+          <item>
+           <widget class="QCheckBox" name="debugInfoAnonymizeCheckBox">
+            <property name="toolTip">
+             <string notr="true">Hide usernames in paths and anonymize other personal identifiers in the generated debug information</string>
+            </property>
+            <property name="text">
+             <string notr="true">Anonymize personal information</string>
+            </property>
+           </widget>
+          </item>
           <item>
            <widget class="QOwnNotesMarkdownTextEdit" name="debugOutputPlainTextEdit"/>
           </item>
@@ -529,6 +539,7 @@
   <tabstop>refreshLogButton</tabstop>
   <tabstop>submitTitleLineEdit</tabstop>
   <tabstop>logOutputPlainTextEdit</tabstop>
+  <tabstop>debugInfoAnonymizeCheckBox</tabstop>
   <tabstop>debugOutputPlainTextEdit</tabstop>
   <tabstop>bodyPlainTextEdit</tabstop>
   <tabstop>postButton</tabstop>

src/dialogs/settingsdialog.cpp

@@ -1975,8 +1975,8 @@ void SettingsDialog::outputSettings() {
     // store some data for Utils::Misc::generateDebugInformation
     storeOwncloudDebugData();
 
-    QString output =
-        Utils::Misc::generateDebugInformation(ui->gitHubLineBreaksCheckBox->isChecked());
+    QString output = Utils::Misc::generateDebugInformation(
+        ui->gitHubLineBreaksCheckBox->isChecked(), ui->debugInfoAnonymizeCheckBox->isChecked());
 
     ui->debugInfoTextEdit->setPlainText(output);
 }
@@ -3565,6 +3565,12 @@ void SettingsDialog::on_gitHubLineBreaksCheckBox_toggled(bool checked) {
     outputSettings();
 }
 
+void SettingsDialog::on_debugInfoAnonymizeCheckBox_toggled(bool checked) {
+    SettingsService settings;
+    settings.setValue(QStringLiteral("debugInfoAnonymize"), checked);
+    outputSettings();
+}
+
 /**
  * Searches in the description and in the shortcut for a entered text
  *
@@ -3760,6 +3766,10 @@ bool SettingsDialog::initializePage(int index) {
             // init the debug info search frame
             ui->debugInfoTextEdit->initSearchFrame(ui->debugInfoTextEditSearchFrame);
 
+            SettingsService settings;
+            ui->debugInfoAnonymizeCheckBox->setChecked(
+                settings.value(QStringLiteral("debugInfoAnonymize")).toBool());
+
             // show the log file path
             ui->logFileLabel->setText(QDir::toNativeSeparators(Utils::Misc::logFilePath()));
         } break;

src/dialogs/settingsdialog.h

@@ -179,6 +179,8 @@ class SettingsDialog : public MasterDialog {
 
     void on_gitHubLineBreaksCheckBox_toggled(bool checked);
 
+    void on_debugInfoAnonymizeCheckBox_toggled(bool checked);
+
     void on_shortcutSearchLineEdit_textChanged(const QString &arg1);
 
     void on_settingsTreeWidget_currentItemChanged(QTreeWidgetItem *current,

src/dialogs/settingsdialog.ui

@@ -4774,6 +4774,16 @@ Just test yourself if you get sync conflicts and set a higher value if so.</stri
                   </property>
                  </widget>
                 </item>
+                <item row="6" column="0" colspan="7">
+                 <widget class="QCheckBox" name="debugInfoAnonymizeCheckBox">
+                  <property name="toolTip">
+                   <string>Hide usernames in paths and anonymize other personal identifiers in the generated debug information</string>
+                  </property>
+                  <property name="text">
+                   <string>Anonymize personal information</string>
+                  </property>
+                 </widget>
+                </item>
                 <item row="4" column="0" colspan="7">
                  <widget class="QFrame" name="debugInfoTextEditSearchFrame">
                   <property name="frameShape">
@@ -4784,7 +4794,7 @@ Just test yourself if you get sync conflicts and set a higher value if so.</stri
                   </property>
                  </widget>
                 </item>
-                <item row="6" column="0">
+                <item row="7" column="0">
                  <widget class="QPushButton" name="issueAssistantPushButton">
                   <property name="toolTip">
                    <string>This is the best way to open an issue</string>
@@ -4798,7 +4808,7 @@ Just test yourself if you get sync conflicts and set a higher value if so.</stri
                   </property>
                  </widget>
                 </item>
-                <item row="6" column="1">
+                <item row="7" column="1">
                  <widget class="QPushButton" name="copyDebugInfoButton">
                   <property name="toolTip">
                    <string>Please use this in the issue tracker</string>
@@ -4812,7 +4822,7 @@ Just test yourself if you get sync conflicts and set a higher value if so.</stri
                   </property>
                  </widget>
                 </item>
-                <item row="6" column="2">
+                <item row="7" column="2">
                  <widget class="QPushButton" name="saveDebugInfoButton">
                   <property name="toolTip">
                    <string>Please don't use this in the issue tracker</string>
@@ -4826,7 +4836,7 @@ Just test yourself if you get sync conflicts and set a higher value if so.</stri
                   </property>
                  </widget>
                 </item>
-                <item row="6" column="3" colspan="4">
+                <item row="7" column="3" colspan="4">
                  <spacer name="horizontalSpacer_14">
                   <property name="orientation">
                    <enum>Qt::Orientation::Horizontal</enum>
@@ -8241,6 +8251,7 @@ Just test yourself if you get sync conflicts and set a higher value if so.</stri
   <tabstop>exportSettingsButton</tabstop>
   <tabstop>reinitializeDatabaseButton</tabstop>
   <tabstop>gitHubLineBreaksCheckBox</tabstop>
+  <tabstop>debugInfoAnonymizeCheckBox</tabstop>
   <tabstop>debugInfoTextEdit</tabstop>
   <tabstop>noteTextEditFontLabel</tabstop>
   <tabstop>noteTextEditButton</tabstop>