qgswms.cpp

Go to the documentation of this file.

/***************************************************************************
                              qgswms.cpp
                              -------------------------
  begin                : December 20 , 2016
  copyright            : (C) 2007 by Marco Hugentobler  ( parts from qgswmshandler)
                         (C) 2014 by Alessandro Pasotti ( parts from qgswmshandler)
                         (C) 2016 by David Marteau
  email                : marco dot hugentobler at karto dot baug dot ethz dot ch
                         a dot pasotti at itopen dot it
                         david dot marteau at 3liz dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsdxfwriter.h"
#include "qgsmodule.h"
#include "qgspdfwriter.h"
#include "qgswmsdescribelayer.h"
#include "qgswmsgetcapabilities.h"
#include "qgswmsgetcontext.h"
#include "qgswmsgetfeatureinfo.h"
#include "qgswmsgetlegendgraphics.h"
#include "qgswmsgetmap.h"
#include "qgswmsgetprint.h"
#include "qgswmsgetschemaextension.h"
#include "qgswmsgetstyles.h"
#include "qgswmsparameters.h"
#include "qgswmsrequest.h"
#include "qgswmsserviceexception.h"
#include "qgswmsutils.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
#define QSTR_COMPARE( str, lit ) \
  ( str.compare( QLatin1String( lit ), Qt::CaseInsensitive ) == 0 )
 
namespace QgsWms
{

  class Service : public QgsService
  {
    public:
      Service( const QString &version, QgsServerInterface *serverIface )
        : mVersion( version )
        , mServerIface( serverIface )
      {}
 
      QString name() const override { return u"WMS"_s; }
      QString version() const override { return mVersion; }
 
      void executeRequest( const QgsServerRequest &request, QgsServerResponse &response, const QgsProject *project ) override
      {
        // Get the request
        const QgsWmsRequest wmsRequest( request );
        const QString req = wmsRequest.wmsParameters().request();
 
        if ( req.isEmpty() )
        {
          throw QgsServiceException( QgsServiceException::OGC_OperationNotSupported, u"Please add or check the value of the REQUEST parameter"_s, 501 );
        }
 
        if ( QSTR_COMPARE( req, "GetCapabilities" ) )
        {
          writeGetCapabilities( mServerIface, project, wmsRequest, response );
        }
        else if ( QSTR_COMPARE( req, "GetProjectSettings" ) )
        {
          writeGetCapabilities( mServerIface, project, request, response, true );
        }
        else if ( QSTR_COMPARE( req, "GetMap" ) )
        {
          if QSTR_COMPARE ( wmsRequest.wmsParameters().formatAsString(), "application/dxf" )
          {
            writeAsDxf( mServerIface, project, request, response );
          }
          else if QSTR_COMPARE ( wmsRequest.wmsParameters().formatAsString(), "application/pdf" )
          {
            writeAsPdf( mServerIface, project, request, response );
          }
          else
          {
            writeGetMap( mServerIface, project, request, response );
          }
        }
        else if ( QSTR_COMPARE( req, "GetFeatureInfo" ) )
        {
          writeGetFeatureInfo( mServerIface, project, request, response );
        }
        else if ( QSTR_COMPARE( req, "GetContext" ) )
        {
          writeGetContext( mServerIface, project, request, response );
        }
        else if ( QSTR_COMPARE( req, "GetSchemaExtension" ) )
        {
          writeGetSchemaExtension( response );
        }
        else if ( QSTR_COMPARE( req, "GetStyle" ) || QSTR_COMPARE( req, "GetStyles" ) )
        {
          writeGetStyles( mServerIface, project, request, response );
        }
        else if ( QSTR_COMPARE( req, "DescribeLayer" ) )
        {
          writeDescribeLayer( mServerIface, project, request, response );
        }
        else if ( QSTR_COMPARE( req, "GetLegendGraphic" ) || QSTR_COMPARE( req, "GetLegendGraphics" ) )
        {
          writeGetLegendGraphics( mServerIface, project, request, response );
        }
        else if ( QSTR_COMPARE( req, "GetPrint" ) )
        {
          if ( mServerIface->serverSettings() && mServerIface->serverSettings()->getPrintDisabled() )
          {
            // GetPrint has been disabled
            QgsDebugError( u"WMS GetPrint request called, but it has been disabled."_s );
            throw QgsServiceException( QgsServiceException::OGC_OperationNotSupported, u"Request %1 is not supported"_s.arg( req ), 501 );
          }
          writeGetPrint( mServerIface, project, request, response );
        }
        else
        {
          // Operation not supported
          throw QgsServiceException( QgsServiceException::OGC_OperationNotSupported, u"Request %1 is not supported"_s.arg( req ), 501 );
        }
      }
 
    private:
      QString mVersion;
      QgsServerInterface *mServerIface = nullptr;
  };
} // namespace QgsWms

class QgsWmsModule : public QgsServiceModule
{
  public:
    void registerSelf( QgsServiceRegistry &registry, QgsServerInterface *serverIface ) override
    {
      QgsDebugMsgLevel( u"WMSModule::registerSelf called"_s, 2 );
      registry.registerService( new QgsWms::Service( QgsWms::implementationVersion(), serverIface ) ); // 1.3.0 default version
      registry.registerService( new QgsWms::Service( u"1.1.1"_s, serverIface ) );                      // second supported version
    }
};
 
 
// Entry points
QGISEXTERN QgsServiceModule *QGS_ServiceModule_Init()
{
  static QgsWmsModule sModule;
  return &sModule;
}
QGISEXTERN void QGS_ServiceModule_Exit( QgsServiceModule * )
{
  // Nothing to do
}