qgswmsrendercontext.h

Go to the documentation of this file.

/***************************************************************************
                              qgswmsrendercontext.h
                              ---------------------
  begin                : March 22, 2019
  copyright            : (C) 2019 by Paul Blottiere
  email                : paul.blottiere@oslandia.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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSWMSRENDERCONTEXT_H
#define QGSWMSRENDERCONTEXT_H
 
#include "qgsproject.h"
#include "qgsserverinterface.h"
#include "qgswmsparameters.h"
 
namespace QgsWms
{

  class QgsWmsRenderContext
  {
    public:
      enum Flag
      {
        UseScaleDenominator = 0x01,
        UseOpacity = 0x02,
        UseFilter = 0x04,
        UseSelection = 0x08,
        AddHighlightLayers = 0x10,
        UpdateExtent = 0x20,
        SetAccessControl = 0x40,
        AddQueryLayers = 0x80,
        UseWfsLayersOnly = 0x100,
        AddExternalLayers = 0x200,
        UseSrcWidthHeight = 0x400,
        UseTileBuffer = 0x800,
        AddAllLayers = 0x1000 
      };
      Q_DECLARE_FLAGS( Flags, Flag )
 
      ~QgsWmsRenderContext();

      QgsWmsRenderContext( const QgsProject *project, QgsServerInterface *interface );

      void setParameters( const QgsWmsParameters &parameters );

      QgsWmsParameters parameters() const;

      const QgsServerSettings &settings() const;

      const QgsProject *project() const;

      void setFlag( Flag flag, bool on = true );

      bool testFlag( Flag flag ) const;

      QList<QgsMapLayer *> layers() const;

      QHash<const QgsMapLayer *, QStringList> acceptableLayersToRender() const;

      QList<QgsMapLayer *> layersToRender() const;

      QDomElement sld( const QgsMapLayer &layer ) const;

      QString style( const QgsMapLayer &layer ) const;

      double scaleDenominator() const;

      void setScaleDenominator( double scaleDenominator );

      bool updateExtent() const;

      QgsWmsParametersLayer parameters( const QgsMapLayer &layer ) const;

      int imageQuality() const;

      int tileBuffer() const;

      bool renderMapTiles() const;

      int precision() const;

      QString layerNickname( const QgsMapLayer &layer ) const;

      QgsMapLayer *layer( const QString &nickname ) const;

      bool isValidLayer( const QString &nickname ) const;

      QList<QgsMapLayer *> layersFromGroup( const QString &nickname ) const;

      bool isValidGroup( const QString &name ) const;

      qreal dotsPerMm() const;

      QStringList flattenedQueryLayers( const QStringList &layerNames ) const;
 
#ifdef HAVE_SERVER_PYTHON_PLUGINS

      QgsAccessControl *accessControl() const;
#endif

      QMap<QString, QList<QgsMapLayer *>> layerGroups() const;

      double mapTileBuffer( int mapWidth ) const;

      QSize mapSize( bool aspectRatio = true ) const;

      bool isValidWidthHeight() const;

      bool isValidWidthHeight( int width, int height ) const;

      int mapWidth() const;

      int mapHeight() const;

      bool isExternalLayer( const QString &name ) const;

      void setSocketFeedback( QgsFeedback *feedback );

      QgsFeedback *socketFeedback() const;
 
      QHash<QgsMapLayer *, QgsDateTimeRange> perLayerTemporalRange() const { return mPerLayerTemporalRange; }
 
    private:
      void initNicknameLayers();
      void initRestrictedLayers();
      void initLayerGroupsRecursive( const QgsLayerTreeGroup *group, const QString &groupName );

      void initPerLayerTemporalRange( const QgsLayerTreeGroup *group, const QString &groupName );
 
      void searchLayersToRender();
      void searchLayersToRenderSld();
      void searchLayersToRenderStyle();
      void removeUnwantedLayers();
      QHash<const QgsMapLayer *, QStringList> acceptableLayers( const QStringList &requestedLayerNames ) const;

      bool addLayerToRender( QgsMapLayer *layer );

      bool checkLayerReadPermissions( QgsMapLayer *layer ) const;
 
      bool layerScaleVisibility( const QString &name ) const;
 
      const QgsProject *mProject = nullptr;
      QgsServerInterface *mInterface = nullptr;
      QgsWmsParameters mParameters;
      Flags mFlags = Flags();
      double mScaleDenominator = -1.0;
 
      // nickname of all layers defined within the project
      QMultiMap<QString, QgsMapLayer *> mNicknameLayers;
 
      // map of layers to use for rendering
      QList<QgsMapLayer *> mLayersToRender;
 
      // map of layers that can be rendered and for each a list of the layer names, group names, etc. requesting it
      QHash<const QgsMapLayer *, QStringList> mAcceptableLayersToRender;
 
      QHash<QgsMapLayer *, QgsDateTimeRange> mPerLayerTemporalRange;
 
      // list of layers which are not usable
      QStringList mRestrictedLayers;
 
      QMap<QString, QList<QgsMapLayer *>> mLayerGroups;
 
      QMap<QString, QDomElement> mSlds;
      QMap<QString, QString> mStyles;
 
      // list for external layers
      QList<QgsMapLayer *> mExternalLayers;
 
      QgsFeedback *mSocketFeedback = nullptr;
  };
}; // namespace QgsWms
 
#endif