Expose QgsServerInterface to service modules

    * Instanciate QgsServerInterface even if HAVE_SERVER_PYTHON_PLUGINS is
      not defined
    * Pass QgsServerInterface in module registration methods.
    * Add QgsServer initialisation test

 #Please enter the commit message for your changes. Lines starting

Author: dmarteau

CMakeLists.txt

@@ -521,7 +521,8 @@ ELSE (WIN32)
     SET (QGIS_PLUGIN_SUBDIR_REV  ../../MacOS)
     SET (DEFAULT_INCLUDE_SUBDIR  include/qgis)
 
-    SET (DEFAULT_SERVER_MODULE_SUBDIR ../PlugIns/server)
+    # Set server moodules path to DEFAULT_LIBEXEC_SUBDIR+'/server' 
+    SET (DEFAULT_SERVER_MODULE_SUBDIR ${DEFAULT_LIBEXEC_SUBDIR}/server)
 
     # path for framework references when running from build directory
     # changed later to reference in-app resources upon install
@@ -547,7 +548,7 @@ ELSE (WIN32)
     SET (DEFAULT_PLUGIN_SUBDIR  lib${LIB_SUFFIX}/qgis/plugins)
     SET (DEFAULT_INCLUDE_SUBDIR include/qgis)
 
-    SET (DEFAULT_SERVER_MODULE_SUBDIR lib${LIB_SUFFIX}/qgis/server)
+    SET (DEFAULT_SERVER_MODULE_SUBDIR ${DEFAULT_LIBEXEC_SUBDIR}/qgis/server)
   ENDIF (APPLE)
 
 ENDIF (WIN32)

cmake_templates/qgsconfig.h.in

@@ -28,6 +28,8 @@
 #define CMAKE_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}"
 #define CMAKE_SOURCE_DIR "${CMAKE_SOURCE_DIR}"
 
+#define QGIS_SERVER_MODULE_SUBDIR "${QGIS_SERVER_MODULE_SUBDIR}"
+
 #define QSCINTILLA_VERSION_STR "${QSCINTILLA_VERSION_STR}"
 
 #if defined( __APPLE__ )

mac/cmake/0vars.cmake.in

@@ -34,6 +34,7 @@ SET (QGIS_PLUGIN_SUBDIR "@QGIS_PLUGIN_SUBDIR@")
 SET (QGIS_PLUGIN_SUBDIR_REV "@QGIS_PLUGIN_SUBDIR_REV@")
 SET (QGIS_DATA_SUBDIR "@QGIS_DATA_SUBDIR@")
 SET (QGIS_DATA_SUBDIR_REV "@QGIS_DATA_SUBDIR_REV@")
+SET (QGIS_SERVER_MODULE_SUBDIR "@QGIS_SERVER_MODULE_SUBDIR@")
 
 # optional components
 SET (WITH_GLOBE "@WITH_GLOBE@")

python/server/qgsserver.sip

@@ -193,9 +193,7 @@ class QgsServer
     */
 
     /** Returns a pointer to the server interface */
-%If (HAVE_SERVER_PYTHON_PLUGINS)
-     QgsServerInterface* serverInterface();
-%End
+    QgsServerInterface* serverInterface();
 
   private:
     QgsServer( const QgsServer& );

python/server/qgsserverinterface.sip

@@ -124,6 +124,12 @@ class QgsServerInterface
      */
     virtual void removeProjectLayers( const QString& path ) = 0;
 
+    /**
+     * Return the service registry 
+     * @return QgsServiceResgistry
+     */
+    virtual QgsServiceRegistry* serviceRegistry() = 0 /KeepReference/;
+
   private:
     /** Constructor */
     QgsServerInterface();

python/server/qgsservicemodule.sip

@@ -44,7 +44,8 @@ class QgsServiceModule
      * Ask module to registe all provided services
      * @param registry QgsServiceRegistry
      */
-    virtual void registerSelf( QgsServiceRegistry& registry ) = 0;
+    virtual void registerSelf( QgsServiceRegistry& registry, 
+           QgsServerInterface* serverIface = nullptr ) = 0;
 };
 
 

python/server/qgsserviceregistry.sip

@@ -78,7 +78,8 @@ class QgsServiceRegistry
      * Initialize registry, load modules and auto register services
      * @param nativeModulepath the native module path
      */
-    void init( const QString& nativeModulepath );
+    // XXX Do we want this exposed to python ?
+    void init( const QString& nativeModulepath, QgsServerInterface* serverIface = nullptr );
 
     /**
      * Clean up registered service and unregister modules

src/server/CMakeLists.txt

@@ -53,7 +53,6 @@ SET ( qgis_mapserv_SRCS
   qgsserver.cpp
   qgsservice.cpp
   qgsservicemodule.cpp
-  qgsserviceloader.cpp
   qgsservicenativeloader.cpp
   qgsserviceregistry.cpp
   qgsserverrequest.cpp

src/server/qgsserver.cpp

@@ -39,9 +39,7 @@
 #include "qgsnetworkaccessmanager.h"
 #include "qgsserverlogger.h"
 #include "qgseditorwidgetregistry.h"
-#ifdef HAVE_SERVER_PYTHON_PLUGINS
 #include "qgsaccesscontrolfilter.h"
-#endif
 
 #include <QDomDocument>
 #include <QNetworkDiskCache>
@@ -61,14 +59,12 @@
 
 QString* QgsServer::sConfigFilePath = nullptr;
 QgsCapabilitiesCache* QgsServer::sCapabilitiesCache = nullptr;
-#ifdef HAVE_SERVER_PYTHON_PLUGINS
-QgsServerInterfaceImpl*QgsServer::sServerInterface = nullptr;
-#endif
+QgsServerInterfaceImpl* QgsServer::sServerInterface = nullptr;
 // Initialization must run once for all servers
 bool QgsServer::sInitialised =  false;
 bool QgsServer::sCaptureOutput = true;
 
-
+QgsServiceRegistry QgsServer::sServiceRegistry;
 
 QgsServer::QgsServer( bool captureOutput )
 {
@@ -348,9 +344,10 @@ bool QgsServer::init( )
 
   QgsEditorWidgetRegistry::initEditors();
 
-#ifdef HAVE_SERVER_PYTHON_PLUGINS
-  sServerInterface = new QgsServerInterfaceImpl( sCapabilitiesCache );
-#endif
+  sServerInterface = new QgsServerInterfaceImpl( sCapabilitiesCache, &sServiceRegistry );
+
+  // Load service modules
+  sServiceRegistry.init( QgsApplication::libexecPath() + "/server", sServerInterface );
 
   sInitialised = true;
   QgsMessageLog::logMessage( QStringLiteral( "Server initialized" ), QStringLiteral( "Server" ), QgsMessageLog::INFO );

src/server/qgsserver.h

@@ -34,14 +34,15 @@
 #include "qgscapabilitiescache.h"
 #include "qgsmapsettings.h"
 #include "qgsmessagelog.h"
+#include "qgsserviceregistry.h"
 
 #ifdef HAVE_SERVER_PYTHON_PLUGINS
 #include "qgsserverplugins.h"
 #include "qgsserverfilter.h"
-#include "qgsserverinterfaceimpl.h"
 #include "qgis_server.h"
 #endif
 
+#include "qgsserverinterfaceimpl.h"
 
 /** \ingroup server
  * The QgsServer class provides OGC web services.
@@ -59,7 +60,7 @@ class SERVER_EXPORT QgsServer
      * @param var environment variable name
      * @param val value
      * @note added in 2.14
-     */
+    / */
     void putenv( const QString &var, const QString &val );
 
     /** Handles the request. The output is normally printed trough FCGI printf
@@ -75,10 +76,10 @@ class SERVER_EXPORT QgsServer
      */
     QPair<QByteArray, QByteArray> handleRequest( const QString& queryString = QString() );
 
-#ifdef HAVE_SERVER_PYTHON_PLUGINS
     //! Returns a pointer to the server interface
     QgsServerInterfaceImpl* serverInterface() { return sServerInterface; }
 
+#ifdef HAVE_SERVER_PYTHON_PLUGINS
     //! Intialize python
     //! Note: not in python bindings
     void initPython( );
@@ -125,6 +126,10 @@ class SERVER_EXPORT QgsServer
     //! Initialization must run once for all servers
     static bool sInitialised;
     static bool sCaptureOutput;
+
+    //! service registry
+    static QgsServiceRegistry sServiceRegistry;
+    
 };
 #endif // QGSSERVER_H