Merge pull request #6303 from alexbruy/help-logging

alexbruy · web-flow · commit a7870afab15f · 2018-02-12T09:00:50.000+02:00
log requested help URLs
diff --git a/resources/qgis_global_settings.ini b/resources/qgis_global_settings.ini
@@ -28,3 +28,8 @@ connections-xyz\OpenStreetMap\url=http://a.tile.openstreetmap.org/{z}/{x}/{y}.pn
 connections-xyz\OpenStreetMap\username=
 connections-xyz\OpenStreetMap\zmax=19
 connections-xyz\OpenStreetMap\zmin=0
+
+[help]
+# Default help location to include
+# for now this is online version of the User Guide for latest (LTR) release
+helpSearchPath=https://docs.qgis.org/$qgis_short_version/$qgis_locale/docs/user_manual/
diff --git a/src/gui/qgshelp.cpp b/src/gui/qgshelp.cpp
@@ -19,6 +19,7 @@
 #include "qgssettings.h"
 #include "qgsapplication.h"
 #include "qgsexpressioncontext.h"
+#include "qgsmessagelog.h"
 
 #include <QUrl>
 #include <QFileInfo>
@@ -44,6 +45,7 @@ QUrl QgsHelp::helpUrl( const QString &key )
   QStringList paths = settings.value( QStringLiteral( "help/helpSearchPath" ) ).toStringList();
   if ( paths.isEmpty() )
   {
+    QgsMessageLog::logMessage( QObject::tr( "Help location is not configured!" ), QObject::tr( "QGIS Help" ) );
     return helpNotFound;
   }
 
@@ -73,6 +75,8 @@ QUrl QgsHelp::helpUrl( const QString &key )
 
     helpPath = QStringLiteral( "%1/%2" ).arg( fullPath, key );
 
+    QgsMessageLog::logMessage( QObject::tr( "Trying to open help using key '%1'. Full URI is '%2'…" ).arg( key ).arg( helpPath ), QObject::tr( "QGIS Help" ), Qgis::Info );
+
     if ( helpPath.startsWith( QStringLiteral( "http" ) ) )
     {
       if ( !QgsHelp::urlExists( helpPath ) )

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`#include "qgssettings.h"`
`20`	`20`	`#include "qgsapplication.h"`
`21`	`21`	`#include "qgsexpressioncontext.h"`
	`22`	`+#include "qgsmessagelog.h"`
`22`	`23`
`23`	`24`	`#include <QUrl>`
`24`	`25`	`#include <QFileInfo>`
`@@ -44,6 +45,7 @@ QUrl QgsHelp::helpUrl( const QString &key )`
`44`	`45`	`QStringList paths = settings.value( QStringLiteral( "help/helpSearchPath" ) ).toStringList();`
`45`	`46`	`if ( paths.isEmpty() )`
`46`	`47`	`{`
	`48`	`+ QgsMessageLog::logMessage( QObject::tr( "Help location is not configured!" ), QObject::tr( "QGIS Help" ) );`
`47`	`49`	`return helpNotFound;`
`48`	`50`	`}`
`49`	`51`
`@@ -73,6 +75,8 @@ QUrl QgsHelp::helpUrl( const QString &key )`
`73`	`75`
`74`	`76`	`helpPath = QStringLiteral( "%1/%2" ).arg( fullPath, key );`
`75`	`77`
	`78`	`+ QgsMessageLog::logMessage( QObject::tr( "Trying to open help using key '%1'. Full URI is '%2'…" ).arg( key ).arg( helpPath ), QObject::tr( "QGIS Help" ), Qgis::Info );`
	`79`	`+`
`76`	`80`	`if ( helpPath.startsWith( QStringLiteral( "http" ) ) )`
`77`	`81`	`{`
`78`	`82`	`if ( !QgsHelp::urlExists( helpPath ) )`