[FEATURE] Add "Save Log to File" action for network logger

Comes with a big warning to users that the log is sensitive and should be treated as confidential
qgis · Mar 31, 2020 · 48952cd · 48952cd
1 parent 16dc169
commit 48952cd
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 0 deletions.
diff --git a/src/app/devtools/networklogger/qgsnetworklogger.cpp b/src/app/devtools/networklogger/qgsnetworklogger.cpp
@@ -206,6 +206,11 @@ void QgsNetworkLogger::removeRows( const QList<int> &rows )
   }
 }
 
+QgsNetworkLoggerRootNode *QgsNetworkLogger::rootGroup()
+{
+  return mRootNode.get();
+}
+
 int QgsNetworkLogger::rowCount( const QModelIndex &parent ) const
 {
   QgsNetworkLoggerNode *n = index2node( parent );

diff --git a/src/app/devtools/networklogger/qgsnetworklogger.h b/src/app/devtools/networklogger/qgsnetworklogger.h
@@ -81,6 +81,11 @@ class QgsNetworkLogger : public QAbstractItemModel
     */
     void removeRows( const QList< int > &rows );
 
+    /**
+     * Returns the root node of the log.
+     */
+    QgsNetworkLoggerRootNode *rootGroup();
+
     static constexpr int MAX_LOGGED_REQUESTS = 1000;
 
   public slots:

diff --git a/src/app/devtools/networklogger/qgsnetworkloggerpanelwidget.cpp b/src/app/devtools/networklogger/qgsnetworkloggerpanelwidget.cpp
@@ -18,9 +18,13 @@
 #include "qgsnetworklogger.h"
 #include "qgssettings.h"
 #include "qgsnetworkloggernode.h"
+#include "qgsjsonutils.h"
 #include <QFontDatabase>
 #include <QMenu>
 #include <QScrollBar>
+#include <QFileDialog>
+#include <QMessageBox>
+#include <nlohmann/json.hpp>
 
 //
 // QgsNetworkLoggerTreeView
@@ -172,4 +176,28 @@ QgsNetworkLoggerPanelWidget::QgsNetworkLoggerPanelWidget( QgsNetworkLogger *logg
     QgsSettings().setValue( QStringLiteral( "logNetworkRequests" ), enabled, QgsSettings::App );
     mLogger->enableLogging( enabled );
   } );
+  connect( mActionSaveLog, &QAction::triggered, this, [ = ]()
+  {
+    if ( QMessageBox::warning( this, tr( "Save Network Log" ),
+                               tr( "Security warning: network logs may contain sensitive data including usernames or passwords. Treat this log as confidential and be careful who you share it with. Continue?" ), QMessageBox::Yes | QMessageBox::No ) == QMessageBox::No )
+      return;
+
+    QString saveFilePath = QFileDialog::getSaveFileName( this, tr( "Save Network Log" ), QDir::homePath(), tr( "Log files" ) + " (*.json)" );
+    if ( saveFilePath.isEmpty() )
+    {
+      return;
+    }
+
+    QFile exportFile( saveFilePath );
+    if ( !exportFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
+    {
+      return;
+    }
+    QTextStream fout( &exportFile );
+
+    const QVariant value = mLogger->rootGroup()->toVariant();
+    const QString json = QString::fromStdString( QgsJsonUtils::jsonFromVariant( value ).dump( 2 ) );
+
+    fout << json;
+  } );
 }
diff --git a/src/ui/qgsnetworkloggerpanelbase.ui b/src/ui/qgsnetworkloggerpanelbase.ui
@@ -41,6 +41,8 @@
      <addaction name="mActionClear"/>
      <addaction name="mActionShowSuccessful"/>
      <addaction name="mActionShowTimeouts"/>
+     <addaction name="separator"/>
+     <addaction name="mActionSaveLog"/>
     </widget>
    </item>
    <item>
@@ -103,6 +105,15 @@
     <string>Show Timeouts</string>
    </property>
   </action>
+  <action name="mActionSaveLog">
+   <property name="icon">
+    <iconset resource="../../images/images.qrc">
+     <normaloff>:/images/themes/default/mActionFileSave.svg</normaloff>:/images/themes/default/mActionFileSave.svg</iconset>
+   </property>
+   <property name="text">
+    <string>Save Log…</string>
+   </property>
+  </action>
  </widget>
  <customwidgets>
   <customwidget>