Merge pull request #46825 from qgis/backport-46629-to-release-3_22

sbrunner · web-flow · commit e32083e5c7d3 · 2022-01-18T17:42:31.000+01:00
[Backport release-3_22] Fix headers
diff --git a/python/server/auto_generated/qgsserverrequest.sip.in b/python/server/auto_generated/qgsserverrequest.sip.in
@@ -57,6 +57,12 @@ class QgsServerRequest
       X_QGIS_WCS_SERVICE_URL,
       // The QGIS WMTS service URL
       X_QGIS_WMTS_SERVICE_URL,
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept
+      ACCEPT,
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent
+      USER_AGENT,
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
+      AUTHORIZATION,
     };
 
     QgsServerRequest();
diff --git a/src/server/qgsfcgiserverrequest.cpp b/src/server/qgsfcgiserverrequest.cpp
@@ -21,6 +21,7 @@
 #include "qgsfcgiserverrequest.h"
 #include "qgsserverlogger.h"
 #include "qgsmessagelog.h"
+#include "qgsstringutils.h"
 #include <fcgi_stdio.h>
 #include <QDebug>
 
@@ -106,11 +107,17 @@ QgsFcgiServerRequest::QgsFcgiServerRequest()
   setUrl( url );
   setMethod( method );
 
-  // Get accept header for content-type negotiation
-  const char *accept = getenv( "HTTP_ACCEPT" );
-  if ( accept )
+  // Fill the headers dictionary
+  for ( const auto &headerKey : qgsEnumMap<QgsServerRequest::RequestHeader>().values() )
   {
-    setHeader( QStringLiteral( "Accept" ), accept );
+    const QString headerName = QgsStringUtils::capitalize(
+                                 QString( headerKey ).replace( QLatin1Char( '_' ), QLatin1Char( ' ' ) ), QgsStringUtils::Capitalization::TitleCase
+                               ).replace( QLatin1Char( ' ' ), QLatin1Char( '-' ) );
+    const char *result = getenv( QStringLiteral( "HTTP_%1" ).arg( headerKey ).toStdString().c_str() );
+    if ( result && strlen( result ) > 0 )
+    {
+      setHeader( headerName, result );
+    }
   }
 
   // Output debug infos
@@ -223,41 +230,36 @@ void QgsFcgiServerRequest::printRequestInfos( const QUrl &url )
     QStringLiteral( "CONTENT_TYPE" ),
     QStringLiteral( "REQUEST_METHOD" ),
     QStringLiteral( "AUTH_TYPE" ),
-    QStringLiteral( "HTTP_ACCEPT" ),
-    QStringLiteral( "HTTP_USER_AGENT" ),
     QStringLiteral( "HTTP_PROXY" ),
     QStringLiteral( "NO_PROXY" ),
-    QStringLiteral( "HTTP_AUTHORIZATION" ),
     QStringLiteral( "QGIS_PROJECT_FILE" ),
     QStringLiteral( "QGIS_SERVER_IGNORE_BAD_LAYERS" ),
     QStringLiteral( "QGIS_SERVER_SERVICE_URL" ),
     QStringLiteral( "QGIS_SERVER_WMS_SERVICE_URL" ),
     QStringLiteral( "QGIS_SERVER_WFS_SERVICE_URL" ),
     QStringLiteral( "QGIS_SERVER_WMTS_SERVICE_URL" ),
     QStringLiteral( "QGIS_SERVER_WCS_SERVICE_URL" ),
-    QStringLiteral( "HTTP_X_QGIS_SERVICE_URL" ),
-    QStringLiteral( "HTTP_X_QGIS_WMS_SERVICE_URL" ),
-    QStringLiteral( "HTTP_X_QGIS_WFS_SERVICE_URL" ),
-    QStringLiteral( "HTTP_X_QGIS_WCS_SERVICE_URL" ),
-    QStringLiteral( "HTTP_X_QGIS_WMTS_SERVICE_URL" ),
-    QStringLiteral( "HTTP_FORWARDED" ),
-    QStringLiteral( "HTTP_X_FORWARDED_HOST" ),
-    QStringLiteral( "HTTP_X_FORWARDED_PROTO" ),
-    QStringLiteral( "HTTP_HOST" ),
     QStringLiteral( "SERVER_PROTOCOL" )
   };
 
   QgsMessageLog::logMessage( QStringLiteral( "Request URL: %2" ).arg( url.url() ), QStringLiteral( "Server" ), Qgis::MessageLevel::Info );
+
   QgsMessageLog::logMessage( QStringLiteral( "Environment:" ), QStringLiteral( "Server" ), Qgis::MessageLevel::Info );
   QgsMessageLog::logMessage( QStringLiteral( "------------------------------------------------" ), QStringLiteral( "Server" ), Qgis::MessageLevel::Info );
-
   for ( const auto &envVar : envVars )
   {
     if ( getenv( envVar.toStdString().c_str() ) )
     {
       QgsMessageLog::logMessage( QStringLiteral( "%1: %2" ).arg( envVar ).arg( QString( getenv( envVar.toStdString().c_str() ) ) ), QStringLiteral( "Server" ), Qgis::MessageLevel::Info );
     }
   }
+
+  qDebug() << "Headers:";
+  qDebug() << "------------------------------------------------";
+  for ( const auto &headerName : headers().keys() )
+  {
+    qDebug() << headerName << ": " << headers().value( headerName );
+  }
 }
 
 QString QgsFcgiServerRequest::header( const QString &name ) const
diff --git a/src/server/qgsserverprojectutils.cpp b/src/server/qgsserverprojectutils.cpp
@@ -355,7 +355,7 @@ QString QgsServerProjectUtils::serviceUrl( const QString &service, const QgsServ
   QString proto;
   QString host;
 
-  QString  forwarded = request.header( QgsServerRequest::FORWARDED );
+  QString forwarded = request.header( QgsServerRequest::FORWARDED );
   if ( ! forwarded.isEmpty() )
   {
     forwarded = forwarded.split( QLatin1Char( ',' ) )[0];
diff --git a/src/server/qgsserverrequest.cpp b/src/server/qgsserverrequest.cpp
@@ -18,6 +18,7 @@
  ***************************************************************************/
 
 #include "qgsserverrequest.h"
+#include "qgsstringutils.h"
 #include <QUrlQuery>
 
 
@@ -32,19 +33,7 @@ QgsServerRequest::QgsServerRequest( const QUrl &url, Method method, const Header
   , mBaseUrl( url )
   , mMethod( method )
   , mHeaders( headers )
-  , mRequestHeaderConv()
-{
-  mRequestHeaderConv.insert( HOST, QStringLiteral( "Host" ) );
-  mRequestHeaderConv.insert( FORWARDED, QStringLiteral( "Forwarded" ) );
-  mRequestHeaderConv.insert( X_FORWARDED_FOR, QStringLiteral( "X-Forwarded-For" ) );
-  mRequestHeaderConv.insert( X_FORWARDED_HOST, QStringLiteral( "X-Forwarded-Host" ) );
-  mRequestHeaderConv.insert( X_FORWARDED_PROTO, QStringLiteral( "X-Forwarded-Proto" ) );
-  mRequestHeaderConv.insert( X_QGIS_SERVICE_URL, QStringLiteral( "X-Qgis-Service-Url" ) );
-  mRequestHeaderConv.insert( X_QGIS_WMS_SERVICE_URL, QStringLiteral( "X-Qgis-Wms-Service-Url" ) );
-  mRequestHeaderConv.insert( X_QGIS_WFS_SERVICE_URL, QStringLiteral( "X-Qgis-Wfs-Service-Url" ) );
-  mRequestHeaderConv.insert( X_QGIS_WCS_SERVICE_URL, QStringLiteral( "X-Qgis-Wcs-Service-Url" ) );
-  mRequestHeaderConv.insert( X_QGIS_WMTS_SERVICE_URL, QStringLiteral( "X-Qgis-Wmts-Service-Url" ) );
-
+{
   mParams.load( QUrlQuery( url ) );
 }
 
@@ -55,7 +44,6 @@ QgsServerRequest::QgsServerRequest( const QgsServerRequest &other )
   , mMethod( other.mMethod )
   , mHeaders( other.mHeaders )
   , mParams( other.mParams )
-  , mRequestHeaderConv( other.mRequestHeaderConv )
 {
 }
 
@@ -73,7 +61,11 @@ QString QgsServerRequest::header( const QString &name ) const
 
 QString QgsServerRequest::header( const QgsServerRequest::RequestHeader &headerEnum ) const
 {
-  return header( mRequestHeaderConv[ headerEnum ] );
+  const QString headerKey = QString( qgsEnumValueToKey<QgsServerRequest::RequestHeader>( headerEnum ) );
+  const QString headerName = QgsStringUtils::capitalize(
+                               QString( headerKey ).replace( QLatin1Char( '_' ), QLatin1Char( ' ' ) ), QgsStringUtils::Capitalization::TitleCase
+                             ).replace( QLatin1Char( ' ' ), QLatin1Char( '-' ) );
+  return header( headerName );
 }
 
 void QgsServerRequest::setHeader( const QString &name, const QString &value )
diff --git a/src/server/qgsserverrequest.h b/src/server/qgsserverrequest.h
@@ -84,6 +84,12 @@ class SERVER_EXPORT QgsServerRequest
       X_QGIS_WCS_SERVICE_URL,
       // The QGIS WMTS service URL
       X_QGIS_WMTS_SERVICE_URL,
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept
+      ACCEPT,
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent
+      USER_AGENT,
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
+      AUTHORIZATION,
     };
     Q_ENUM( RequestHeader )
 
@@ -270,7 +276,6 @@ class SERVER_EXPORT QgsServerRequest
     // to support lazy initialization
     mutable Headers mHeaders;
     QgsServerParameters mParams;
-    QMap<RequestHeader, QString> mRequestHeaderConv;
 };
 
 #endif
diff --git a/tests/src/python/test_qgsserver.py b/tests/src/python/test_qgsserver.py
@@ -496,9 +496,6 @@ def test_wcs_getcapabilities_url(self):
             item_found = False
             for item in str(r).split("\\n"):
                 if "OnlineResource" in item:
-                    print(item)
-                    print(header_name)
-                    print(header_value)
                     self.assertEqual(header_value in item, True)
                     item_found = True
             self.assertTrue(item_found)
diff --git a/tests/src/python/test_qgsserver_request.py b/tests/src/python/test_qgsserver_request.py
@@ -215,6 +215,33 @@ def test_add_parameters(self):
         self.assertEqual(request.parameter('FOOBAR'), 'foobar')
         self.assertEqual(request.parameter('UNKNOWN'), '')
 
+    def test_headers(self):
+        """Tests that the headers are working in Fcgi mode"""
+        for header, env, enum, value in (
+            ("Host", "HTTP_HOST", QgsServerRequest.HOST, "example.com"),
+            ("Forwarded", "HTTP_FORWARDED", QgsServerRequest.FORWARDED, "aaa"),
+            ("X-Forwarded-For", "HTTP_X_FORWARDED_FOR", QgsServerRequest.X_FORWARDED_FOR, "bbb"),
+            ("X-Forwarded-Host", "HTTP_X_FORWARDED_HOST", QgsServerRequest.X_FORWARDED_HOST, "ccc"),
+            ("X-Forwarded-Proto", "HTTP_X_FORWARDED_PROTO", QgsServerRequest.X_FORWARDED_PROTO, "ddd"),
+            ("X-Qgis-Service-Url", "HTTP_X_QGIS_SERVICE_URL", QgsServerRequest.X_QGIS_SERVICE_URL, "eee"),
+            ("X-Qgis-Wms-Service-Url", "HTTP_X_QGIS_WMS_SERVICE_URL", QgsServerRequest.X_QGIS_WMS_SERVICE_URL, "fff"),
+            ("X-Qgis-Wfs-Service-Url", "HTTP_X_QGIS_WFS_SERVICE_URL", QgsServerRequest.X_QGIS_WFS_SERVICE_URL, "ggg"),
+            ("X-Qgis-Wcs-Service-Url", "HTTP_X_QGIS_WCS_SERVICE_URL", QgsServerRequest.X_QGIS_WCS_SERVICE_URL, "hhh"),
+            ("X-Qgis-Wmts-Service-Url", "HTTP_X_QGIS_WMTS_SERVICE_URL", QgsServerRequest.X_QGIS_WMTS_SERVICE_URL, "iii"),
+            ("Accept", "HTTP_ACCEPT", QgsServerRequest.ACCEPT, "jjj"),
+            ("User-Agent", "HTTP_USER_AGENT", QgsServerRequest.USER_AGENT, "kkk"),
+            ("Authorization", "HTTP_AUTHORIZATION", QgsServerRequest.AUTHORIZATION, "lll"),
+        ):
+            try:
+                os.environ[env] = value
+                request = QgsFcgiServerRequest()
+                self.assertEquals(request.headers(), {header: value})
+                request = QgsServerRequest(request)
+                self.assertEquals(request.headers(), {header: value})
+                self.assertEquals(request.header(enum), value)
+            finally:
+                del os.environ[env]
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/tests/src/python/test_qgsserver_service_url_env.py b/tests/src/python/test_qgsserver_service_url_env.py
@@ -0,0 +1,87 @@
+# -*- coding: utf-8 -*-
+"""
+QGIS Unit tests for QgsServer with service URL defined in the environment variables
+"""
+__author__ = 'Stéphane Brunner'
+__date__ = '12/01/2021'
+__copyright__ = 'Copyright 2021, The QGIS Project'
+
+import os
+
+# Deterministic XML
+os.environ['QT_HASH_SEED'] = '1'
+
+import urllib.request
+import urllib.parse
+import urllib.error
+
+from qgis.server import QgsServer
+from qgis.core import QgsFontUtils
+from qgis.testing import unittest, start_app
+from utilities import unitTestDataPath
+
+
+start_app()
+
+
+class TestQgsServerServiceUrlEnv(unittest.TestCase):
+
+    def setUp(self):
+        """Create the server instance"""
+        self.fontFamily = QgsFontUtils.standardTestFontFamily()
+        QgsFontUtils.loadStandardTestFonts(['All'])
+
+        self.testdata_path = unitTestDataPath('qgis_server') + '/'
+        project = os.path.join(self.testdata_path, "test_project_without_urls.qgs")
+
+        del os.environ['QUERY_STRING']
+        os.environ['QGIS_PROJECT_FILE'] = project
+        # Disable landing page API to test standard legacy XML responses in case of errors
+        os.environ["QGIS_SERVER_DISABLED_APIS"] = "Landing Page"
+
+        self.server = QgsServer()
+
+    def tearDown(self):
+        """Cleanup env"""
+
+        super().tearDown()
+        for env in ["QGIS_SERVER_DISABLED_APIS", "QGIS_PROJECT_FILE"]:
+            if env in os.environ:
+                del os.environ[env]
+
+    """Tests container"""
+
+    def test_getcapabilities_url(self):
+
+        # Service URL in environment
+        for env_name, env_value, service in (
+            ("QGIS_SERVER_SERVICE_URL", "http://test1", "WMS"),
+            ("QGIS_SERVER_WMS_SERVICE_URL", "http://test2", "WMS")
+            ("QGIS_SERVER_SERVICE_URL", "http://test3", "WFS", "href="),
+            ("QGIS_SERVER_WFS_SERVICE_URL", "http://test4", "WFS", "href=")
+            ("QGIS_SERVER_SERVICE_URL", "http://test5", "WCS"),
+            ("QGIS_SERVER_WCS_SERVICE_URL", "http://test6", "WCS")
+            ("QGIS_SERVER_SERVICE_URL", "http://test7", "WMTS"),
+            ("QGIS_SERVER_WMTS_SERVICE_URL", "http://test8", "WMTS")
+        ):
+            try:
+                os.environ[env_name] = env_value
+                qs = "?" + "&".join(["%s=%s" % i for i in list({
+                    "SERVICE": service,
+                    "REQUEST": "GetCapabilities",
+                }.items())])
+
+                r, _ = self._result(self._execute_request(qs))
+
+                item_found = False
+                for item in str(r).split("\\n"):
+                    if "href=" in item:
+                        self.assertEqual(env_value in item, True)
+                        item_found = True
+                self.assertTrue(item_found)
+            finally:
+                del os.environ[env_name]
+
+
+if __name__ == '__main__':
+    unittest.main()

Original file line number	Diff line number	Diff line change
`@@ -355,7 +355,7 @@ QString QgsServerProjectUtils::serviceUrl( const QString &service, const QgsServ`
`355`	`355`	`QString proto;`
`356`	`356`	`QString host;`
`357`	`357`
`358`		`- QString forwarded = request.header( QgsServerRequest::FORWARDED );`
	`358`	`+ QString forwarded = request.header( QgsServerRequest::FORWARDED );`
`359`	`359`	`if ( ! forwarded.isEmpty() )`
`360`	`360`	`{`
`361`	`361`	`forwarded = forwarded.split( QLatin1Char( ',' ) )[0];`