Page MenuHome GnuPG
Create Task
Maniphest T6072

Kleopatra: Display "gpgconf -X"
Testing, WishlistPublic
Actions

Description

Edit: This ticket was hijacked for the task of adding the output of gpgconf -X at an appropriate location in Kleopatra.

The new ticket for adding debug information to Kleopatra is T7147: Kleopatra: Add debug information / Log handling

The original text of this task was:

We were talking about a possibility to enable logging for Kleopatra in the GUI of Kleopatra: https://lists.wald.intevation.org/pipermail/gpg4win-devel/2022-July/001787.html

First, I created a mockup. There you can see checkboxes to enable logging for each component and an input field which will be filled with a default path. Another (optional) idea is to show a textarea where the content of the log file is visible. Then users would save some time because they would not have to navigate to the file first and then to open it and it would be very comfortable.

Maybe there could also be a button to delete the file from the GUI. This is not shown in the mockup.

@aheinecke what are you thinking about this?

Revisions and Commits

rKLEOPATRA Kleopatra
rKLEOPATRAa1e12b4710b6 Set window title
rKLEOPATRAac09f50c38ef Add close button
rKLEOPATRA203aab971800 Save file as .txt instead of .log
rKLEOPATRA7ded04051bdc Change action name
rKLEOPATRAae367cc50ac0 Add close button
rKLEOPATRA370e654ccb9c Set window title
rKLEOPATRAf3ae8748ad6c Change action name
rKLEOPATRA0cbb5da861cb Save file as .txt instead of .log
rKLEOPATRAaf962e0e830e Set window title
rKLEOPATRA77569dad60b7 Change action name
rKLEOPATRA4ed990f76a59 Add close button
rKLEOPATRAbb34f75d5e74 Add close button
rKLEOPATRAff1a65504bf4 Set window title
rKLEOPATRA1140b5a57903 Change action name
rKLEOPATRAa6407189a423 Save file as .txt instead of .log
rKLEOPATRA65fc5ee53141 Set window title
rKLEOPATRA4727deeee86c Add close button
rKLEOPATRA080ab085d0a8 Change action name
rKLEOPATRA49bcb6435592 Save file as .txt instead of .log
rKLEOPATRA308ce09977c5 Add debug view
rKLEOPATRAebd3590104b1 Add debug view
rKLEOPATRAcbadb8f0493d Add debug view
rKLEOPATRA58231b579f62 Add debug view
rKLEOPATRA9b676c51f539 Add debug view
rKLEOPATRAe05efc0448cd Add debug view
rKLEOPATRA2cbb80ccc498 Add debug view
rKLEOPATRA8b52befbecb7 Add debug view

Related Objects
Search...

StatusAssignedTask
 OpenNoneT7366 Logging related issues
 Testing• TobiasFellaT6072 Kleopatra: Display "gpgconf -X"

Event Timeline

cklassen created this task.Jul 11 2022, 10:08 AM
cklassen added a subscriber: bernhard.
• ikloecker added a subscriber: • ikloecker.Jul 11 2022, 1:28 PM

We have KWatchGnuPG for watching the log files.

• aheinecke triaged this task as Wishlist priority.Jul 18 2022, 9:05 AM

@ikloecker KWatchGnuPG does not work on Windows. And this also does not work with Kleopatra logging and GPGME logging, Kleopatra logging needs Dbgview on Windows, which can be spammed by other software and GPGME logging requires an enviornment variable. So having this in a logging view would be good for support.

I am not sure about the Logging output Window because you need to do actions with Kleopatra when logging is active and not have the settings open. I rather tend towards a file like for our other logs. This also helps with support the most. Especially with GPGME debugging the log output view would scroll by so fast as to be useless. GPGME logging needs to be searched and filtered before becoming useful as it is very verbose regarding IO operations.

cklassen added a comment.Jul 25 2022, 3:45 PM

For documentation purposes: Werner suggested to use a TCP socket on Windows for logging (on the mailing list).

• werner added a subscriber: • werner.Jan 30 2023, 10:16 AM

What I need in particular is a way to get the output of gpgconf -X.

• aheinecke added a project: Restricted Project.Jan 30 2023, 10:20 AM

I am adding gpgcom, as a tag, the first minimal task would be to create such a page with the debug output from gpgconf -X with options to copy / or save them to a file. Not sure if that should be a subtask, because on the other hand this would be a start of this "Debug Tab"

• aheinecke added a comment.Feb 10 2023, 4:28 PM

Output of --show-configs should also be added as a button or directly visible when the selftest of Kleopatra fails.

• TobiasFella added a commit: rKLEOPATRA8b52befbecb7: Add debug view.May 2 2024, 4:51 PM
• TobiasFella claimed this task.May 2 2024, 4:51 PM
• TobiasFella moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.
• TobiasFella added a commit: rKLEOPATRA2cbb80ccc498: Add debug view.May 10 2024, 12:55 PM
• TobiasFella added a commit: rKLEOPATRAe05efc0448cd: Add debug view.May 13 2024, 11:42 AM
• TobiasFella added a commit: rKLEOPATRA9b676c51f539: Add debug view.May 14 2024, 3:42 PM
• TobiasFella added a commit: rKLEOPATRA58231b579f62: Add debug view.May 23 2024, 9:03 AM
• TobiasFella added a commit: rKLEOPATRAcbadb8f0493d: Add debug view.May 23 2024, 9:05 AM
• ebo added a project: vsd33.May 23 2024, 10:07 AM
• TobiasFella added a commit: rKLEOPATRAebd3590104b1: Add debug view.May 23 2024, 10:33 AM
• TobiasFella added a commit: rKLEOPATRA308ce09977c5: Add debug view.
• ikloecker added a comment.Jun 7 2024, 12:30 PM

The changes where backported for VSD33, but they have little to do with the original request. They only address https://dev.gnupg.org/T6072#167392

• ikloecker moved this task from Backlog to WiP on the vsd33 board.Jun 7 2024, 2:53 PM
• aheinecke added a comment.EditedJun 11 2024, 10:30 AM

I've talked to ebo about this and yes she will create subtasks for at least GPGME log an qDebug logging the GnuPG Logs can already disabled in the config so we dont really need it. Currently it looks like this and I find it rather confusing:



As this is static output which does not say much to users I do not think it is necessary to show at all. Just a "File save as" dialog for gpgconf -x in an entry "Additional support information" maybe in the about dialog would be better IMO.

For a View I would expect rather dynamic / autoscroling infos so that second level support or so might just see some issue and the user can see if anything is happening in the background. And the menu entry "GnuPG Log Viewer" does not exist so "Debug View" is the first menu item under "Tools" or "Extras.

So I do not even think that we have a decent solution for werners request:

In T6072#167392, @werner wrote:

What I need in particular is a way to get the output of gpgconf -X.

Because if we ship the current dialog as a "Debug View" with the single item dropdown and And I would personally advice for hiding the menu entry for now. If we just keep gpgconf -X it should be under help since only support will ask for this.

• ebo mentioned this in T7147: Kleopatra: Add debug information / Log handling.Jun 11 2024, 11:31 AM
• ebo renamed this task from Debug Tab in Kleopatra to Kleopatra: Display "gpgconf -X" .Jun 11 2024, 1:33 PM
• ebo updated the task description. (Show Details)
• ebo added a subscriber: • ebo.Jun 11 2024, 4:14 PM

Tested with Gpg4win-4.3.2-beta25

It works in principle.

I'm not sure if its better to show gpgconf -X output below Tools or Help. But I'm definitively against calling it "Debug View". "Debug Tools" would seem fitting for the tools menu. Although currently it is only a view of the configuration files. Like it is now I would name this something like "GnuPG configuration dump".

And when saving it, do not suggest I filename ending with .log, it is no log. Just use .txt (or .org but I'd prefer the former).
There is no Close button. Currently the only possibility is closing the window via the title bar.
Apropos: There is no text in the title bar except "Kleopatra". I think there is an additional string describing the window missing. Like "Configuration Dump".

And a better default location for the saved file on Windows might be Documents. But I can live with the current default of the users home directory.

• ebo moved this task from WiP to Backlog on the vsd33 board.Jun 11 2024, 4:19 PM
• TobiasFella added a commit: rKLEOPATRA49bcb6435592: Save file as .txt instead of .log.Aug 1 2024, 10:40 AM
• TobiasFella added a commit: rKLEOPATRA080ab085d0a8: Change action name.
• TobiasFella added a commit: rKLEOPATRA4727deeee86c: Add close button.
• TobiasFella added a commit: rKLEOPATRA65fc5ee53141: Set window title.
• TobiasFella added a commit: rKLEOPATRAa6407189a423: Save file as .txt instead of .log.
• TobiasFella added a commit: rKLEOPATRA1140b5a57903: Change action name.
• TobiasFella added a commit: rKLEOPATRAbb34f75d5e74: Add close button.
• TobiasFella added a commit: rKLEOPATRAff1a65504bf4: Set window title.
• TobiasFella added a comment.Aug 1 2024, 10:42 AM

https://invent.kde.org/pim/kleopatra/-/merge_requests/262

  • Rename to "GnuPG Configuration Dump"
  • Change file extension to .txt
  • Add Close button
  • Set window title
• TobiasFella added a commit: rKLEOPATRA4ed990f76a59: Add close button.Aug 1 2024, 1:56 PM
• TobiasFella added a commit: rKLEOPATRA77569dad60b7: Change action name.
• TobiasFella added a commit: rKLEOPATRAaf962e0e830e: Set window title.
• TobiasFella added a commit: rKLEOPATRA0cbb5da861cb: Save file as .txt instead of .log.Aug 2 2024, 10:03 AM
• TobiasFella added a commit: rKLEOPATRAf3ae8748ad6c: Change action name.
• TobiasFella added a commit: rKLEOPATRA370e654ccb9c: Set window title.
• TobiasFella added a commit: rKLEOPATRAae367cc50ac0: Add close button.
• TobiasFella changed the task status from Open to Testing.Aug 5 2024, 11:35 AM
• ikloecker added a commit: rKLEOPATRA203aab971800: Save file as .txt instead of .log.Aug 7 2024, 5:38 PM
• ikloecker added a commit: rKLEOPATRA7ded04051bdc: Change action name.
• ikloecker added a commit: rKLEOPATRAac09f50c38ef: Add close button.
• ikloecker added a commit: rKLEOPATRAa1e12b4710b6: Set window title.
• ikloecker moved this task from Backlog to WiP on the vsd33 board.Aug 8 2024, 10:11 AM

The additional changes have been backported for VSD 3.3

• ebo moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Oct 1 2024, 3:55 PM
• ebo mentioned this in T7331: Kleopatra: Improvements for debug dialog.Oct 16 2024, 4:39 PM
• ebo added a parent task: T7366: Logging related issues.Oct 31 2024, 3:55 PM
• ebo added a comment.Oct 31 2024, 4:15 PM

Gpg4win-Beta-70:

  • Name is now: "Show GnuPG Configuration"
  • When I choose that, the window which opens has a title and a close button, the file extension on saving is .txt

But as of now there are no commands to run.
I guess the configuration for that is still missing.

• TobiasFella added a comment.Oct 31 2024, 4:17 PM

right. the installer needs to install kleopatradebugcommandsrc next to libkleopatrarc

• ikloecker added a comment.Oct 31 2024, 6:56 PM

@TobiasFella prepared the installation in https://dev.gnupg.org/rW9218ebfb7c01478a6fa7b2892fec4d9fd83ba273 . I left some comments on this commit.

• ebo moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Mon, Nov 4, 2:57 PM
• ebo moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Fri, Nov 8, 2:09 PM
• ikloecker mentioned this in T7395: Prepare Release Notes for Gpg4win 4.4.0 for Kleopatra.Wed, Nov 13, 5:04 PM
• ebo moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Thu, Nov 14, 11:13 AM

Gpg4win-Beta-75:

Name of the window is now "GnuPG Configuration Overview" and "gpgconf -X" is preselected and executed in the window.