Fix crash in server VirtualErrorHandler on newer sip environments

Fixes crash in tests, and adapts these VirtualErrorHandlers to the same code used elsewhere in QGIS
qgis · Dec 18, 2024 · 6cfc34b · 6cfc34b
1 parent ad57bfa
commit 6cfc34b
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 21 deletions.
diff --git a/.ci/test_blocklist_qt6.txt b/.ci/test_blocklist_qt6.txt
@@ -58,7 +58,6 @@ PyQgsVectorLayerEditBuffer
 PyQgsLayerDefinition
 PyQgsSettings
 PyQgsSettingsEntry
-PyQgsServerApi
 PyQgsServerWMSGetFeatureInfo
 PyQgsServerWMSGetMap
 PyQgsServerAccessControlWFSTransactional

diff --git a/python/PyQt6/server/server.sip.in b/python/PyQt6/server/server.sip.in
@@ -15,39 +15,61 @@ ${DEFAULTDOCSTRINGSIGNATURE}
 %Include server_auto.sip
 
 
+
 %VirtualErrorHandler serverapi_badrequest_exception_handler
-    PyObject *type, *exception, *traceback, *pyStrException;
+    PyObject *type, *exception, *traceback;
 
     PyErr_Fetch(&type, &exception, &traceback);
-    pyStrException = PyObject_Str(exception);
-    Py_DECREF(pyStrException);
+    // check whether the object is already a unicode string
+    QString pyStrException;
+    if ( PyUnicode_Check( exception) )
+    {
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( exception ) );
+    }
+    else
+    {
+      PyObject* str = PyObject_Str( exception );
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( str ) );
+      Py_XDECREF( str );
+    }
 
     SIP_RELEASE_GIL( sipGILState );
 
     QString strException = "API bad request error";
-    if ( pyStrException && PyUnicode_Check(pyStrException) )
+    if ( !pyStrException.isEmpty() )
     {
-       strException = QString::fromUtf8( PyUnicode_AsUTF8(pyStrException) );
+       strException = pyStrException;
     }
 
     throw QgsServerApiBadRequestException( strException );
 %End
 
 
 %VirtualErrorHandler server_exception_handler
-    PyObject *type, *exception, *traceback, *pyStrException;
+    PyObject *type, *exception, *traceback;
 
     PyErr_Fetch(&type, &exception, &traceback);
-    pyStrException = PyObject_Str(exception);
-    Py_DECREF(pyStrException);
+    // check whether the object is already a unicode string
+    QString pyStrException;
+    if ( PyUnicode_Check( exception) )
+    {
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( exception ) );
+    }
+    else
+    {
+      PyObject* str = PyObject_Str( exception );
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( str ) );
+      Py_XDECREF( str );
+    }
 
     SIP_RELEASE_GIL( sipGILState );
 
     QString strException = "Server internal error";
-    if ( pyStrException && PyUnicode_Check(pyStrException) )
+    if ( !pyStrException.isEmpty() )
     {
-       strException = QString::fromUtf8( PyUnicode_AsUTF8(pyStrException) );
+       strException = pyStrException;
     }
 
     throw QgsServerException( strException );
 %End
+
diff --git a/python/server/server.sip.in b/python/server/server.sip.in
@@ -16,37 +16,57 @@ ${DEFAULTDOCSTRINGSIGNATURE}
 
 
 %VirtualErrorHandler serverapi_badrequest_exception_handler
-    PyObject *type, *exception, *traceback, *pyStrException;
+    PyObject *type, *exception, *traceback;
 
     PyErr_Fetch(&type, &exception, &traceback);
-    pyStrException = PyObject_Str(exception);
-    Py_DECREF(pyStrException);
+    // check whether the object is already a unicode string
+    QString pyStrException;
+    if ( PyUnicode_Check( exception) )
+    {
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( exception ) );
+    }
+    else
+    {
+      PyObject* str = PyObject_Str( exception );
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( str ) );
+      Py_XDECREF( str );
+    }
 
     SIP_RELEASE_GIL( sipGILState );
 
     QString strException = "API bad request error";
-    if ( pyStrException && PyUnicode_Check(pyStrException) )
+    if ( !pyStrException.isEmpty() )
     {
-       strException = QString::fromUtf8( PyUnicode_AsUTF8(pyStrException) );
+       strException = pyStrException;
     }
 
     throw QgsServerApiBadRequestException( strException );
 %End
 
 
 %VirtualErrorHandler server_exception_handler
-    PyObject *type, *exception, *traceback, *pyStrException;
+    PyObject *type, *exception, *traceback;
 
     PyErr_Fetch(&type, &exception, &traceback);
-    pyStrException = PyObject_Str(exception);
-    Py_DECREF(pyStrException);
+    // check whether the object is already a unicode string
+    QString pyStrException;
+    if ( PyUnicode_Check( exception) )
+    {
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( exception ) );
+    }
+    else
+    {
+      PyObject* str = PyObject_Str( exception );
+      pyStrException = QString::fromUtf8( PyUnicode_AsUTF8( str ) );
+      Py_XDECREF( str );
+    }
 
     SIP_RELEASE_GIL( sipGILState );
 
     QString strException = "Server internal error";
-    if ( pyStrException && PyUnicode_Check(pyStrException) )
+    if ( !pyStrException.isEmpty() )
     {
-       strException = QString::fromUtf8( PyUnicode_AsUTF8(pyStrException) );
+       strException = pyStrException;
     }
 
     throw QgsServerException( strException );