qgswmsparameters.h

Go to the documentation of this file.

/***************************************************************************
                              qgswmsparameters.h
                              ------------------
  begin                : March 17, 2017
  copyright            : (C) 2017 by Paul Blottiere
  email                : paul dot blottiere at oslandia 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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSWMSPARAMETERS_H
#define QGSWMSPARAMETERS_H

#include <QMap>
#include <QObject>
#include <QMetaEnum>
#include <QColor>

#include "qgsrectangle.h"
#include "qgswmsserviceexception.h"
#include "qgsserverrequest.h"
#include "qgslegendsettings.h"
#include "qgsprojectversion.h"
#include "qgsogcutils.h"
#include "qgsserverparameters.h"

namespace QgsWms
{
  struct QgsWmsParametersFilter
  {
    enum Type
    {
      UNKNOWN,
      SQL,
      OGC_FE
    };

    QString mFilter;
    QgsWmsParametersFilter::Type mType = QgsWmsParametersFilter::UNKNOWN;
    QgsOgcUtils::FilterVersion mVersion = QgsOgcUtils::FILTER_OGC_1_0; // only if FE
  };

  struct QgsWmsParametersLayer
  {
    QString mNickname; // name, id or short name
    int mOpacity = -1;
    QList<QgsWmsParametersFilter> mFilter; // list of filter
    QStringList mSelection; // list of string fid
    QString mStyle;
  };

  struct QgsWmsParametersHighlightLayer
  {
    QString mName;
    QgsGeometry mGeom;
    QString mSld;
    QString mLabel;
    QColor mColor;
    int mSize = 0;
    int mWeight = 0;
    QString mFont;
    float mBufferSize = 0;
    QColor mBufferColor;
  };

  struct QgsWmsParametersComposerMap
  {
    int mId = 0; // composer map id
    bool mHasExtent = false; // does the request contains extent for this composer map
    QgsRectangle mExtent; // the request extent for this composer map
    float mScale = -1;
    float mRotation = 0;
    float mGridX = 0;
    float mGridY = 0;
    QList<QgsWmsParametersLayer> mLayers; // list of layers for this composer map
    QList<QgsWmsParametersHighlightLayer> mHighlightLayers; // list of highlight layers for this composer map
  };

  class QgsWmsParameter : public QgsServerParameterDefinition
  {
      Q_GADGET

    public:
      enum Name
      {
        UNKNOWN,
        BOXSPACE,
        CRS,
        SRS,
        WIDTH,
        HEIGHT,
        BBOX,
        ICONLABELSPACE,
        IMAGE_QUALITY,
        ITEMFONTFAMILY,
        ITEMFONTBOLD,
        ITEMFONTITALIC,
        ITEMFONTSIZE,
        ITEMFONTCOLOR,
        LAYER,
        LAYERFONTFAMILY,
        LAYERFONTBOLD,
        LAYERFONTITALIC,
        LAYERFONTSIZE,
        LAYERFONTCOLOR,
        LAYERTITLE,
        LAYERS,
        LAYERSPACE,
        LAYERTITLESPACE,
        QUERY_LAYERS,
        FEATURE_COUNT,
        SHOWFEATURECOUNT,
        STYLE,
        STYLES,
        SYMBOLSPACE,
        SYMBOLHEIGHT,
        SYMBOLWIDTH,
        OPACITIES,
        SLD,
        SLD_BODY,
        FI_POLYGON_TOLERANCE,
        FI_LINE_TOLERANCE,
        FI_POINT_TOLERANCE,
        FILTER,
        FILTER_GEOM,
        FORMAT,
        INFO_FORMAT,
        I,
        J,
        X,
        Y,
        RULE,
        RULELABEL,
        SCALE,
        SELECTION,
        HIGHLIGHT_GEOM,
        HIGHLIGHT_SYMBOL,
        HIGHLIGHT_LABELSTRING,
        HIGHLIGHT_LABELFONT,
        HIGHLIGHT_LABELSIZE,
        HIGHLIGHT_LABELWEIGHT,
        HIGHLIGHT_LABELCOLOR,
        HIGHLIGHT_LABELBUFFERCOLOR,
        HIGHLIGHT_LABELBUFFERSIZE,
        WMS_PRECISION,
        TRANSPARENT,
        BGCOLOR,
        DPI,
        TEMPLATE,
        EXTENT,
        ROTATION,
        GRID_INTERVAL_X,
        GRID_INTERVAL_Y,
        WITH_GEOMETRY,
        WITH_MAPTIP,
        WMTVER,
        SRCWIDTH,
        SRCHEIGHT
      };
      Q_ENUM( Name )

      
      QgsWmsParameter( const QgsWmsParameter::Name name = QgsWmsParameter::UNKNOWN,
                       const QVariant::Type type = QVariant::String,
                       const QVariant defaultValue = QVariant( "" ) );

      virtual ~QgsWmsParameter() override = default;

      bool isValid() const override;

      QStringList toStyleList( const char delimiter = ',' ) const;

      QList<QgsGeometry> toGeomList( const char delimiter = ',' ) const;

      QList<int> toIntList( const char delimiter = ',' ) const;

      QList<double> toDoubleList( const char delimiter = ',' ) const;

      QList<QColor> toColorList( const char delimiter = ',' ) const;

      QgsRectangle toRectangle() const;

      int toInt() const;

      double toDouble() const;

      QColor toColor() const;

      QUrl toUrl() const;

      QString loadUrl() const;

      void raiseError() const;

      static QString name( const QgsWmsParameter::Name );

      static QgsWmsParameter::Name name( const QString &name );

      QgsWmsParameter::Name mName;
      int mId = -1;
  };

  class QgsWmsParameters : public QgsServerParameters
  {
      Q_GADGET

    public:

      enum Format
      {
        NONE,
        JPG,
        PNG,
        TEXT,
        XML,
        HTML,
        GML
      };

      QgsWmsParameters( const QgsServerParameters &parameters );

      QgsWmsParameters();

      virtual ~QgsWmsParameters() override = default;

      void dump() const;

      QString crs() const;

      QString width() const;

      int widthAsInt() const;

      QString height() const;

      int heightAsInt() const;

      QString srcWidth() const;

      int srcWidthAsInt() const;

      QString srcHeight() const;

      int srcHeightAsInt() const;

      QgsProjectVersion versionAsNumber() const;

      bool versionIsValid( const QString version ) const;

      QString bbox() const;

      QgsRectangle bboxAsRectangle() const;

      QString sldBody() const;

      QStringList selections() const;

      QStringList filters() const;

      QString filterGeom() const;

      QStringList opacities() const;

      QList<int> opacitiesAsInt() const;

      QStringList allLayersNickname() const;

      QStringList queryLayersNickname() const;

      QStringList allStyles() const;

      QList<QgsWmsParametersLayer> layersParameters() const;

      QString polygonTolerance() const;

      QString lineTolerance() const;

      QString pointTolerance() const;

      int polygonToleranceAsInt() const;

      int lineToleranceAsInt() const;

      int pointToleranceAsInt() const;

      QString formatAsString() const;

      Format format() const;

      QString infoFormatAsString() const;

      bool infoFormatIsImage() const;

      QString imageQuality() const;

      int imageQualityAsInt() const;

      Format infoFormat() const;

      int infoFormatVersion() const;

      QString i() const;

      int iAsInt() const;

      QString j() const;

      int jAsInt() const;

      QString x() const;

      int xAsInt() const;

      QString y() const;

      int yAsInt() const;

      QString rule() const;

      QString ruleLabel() const;

      bool ruleLabelAsBool() const;

      QString showFeatureCount() const;

      bool showFeatureCountAsBool() const;

      QString featureCount() const;

      int featureCountAsInt() const;

      QString scale() const;

      double scaleAsDouble() const;

      QString boxSpace() const;

      double boxSpaceAsDouble() const;

      QString layerSpace() const;

      double layerSpaceAsDouble() const;

      QString layerTitleSpace() const;

      double layerTitleSpaceAsDouble() const;

      QString symbolSpace() const;

      double symbolSpaceAsDouble() const;

      QString iconLabelSpace() const;

      double iconLabelSpaceAsDouble() const;

      QString symbolWidth() const;

      double symbolWidthAsDouble() const;

      QString symbolHeight() const;

      double symbolHeightAsDouble() const;

      QFont layerFont() const;

      QString layerFontFamily() const;

      QString layerFontBold() const;

      bool layerFontBoldAsBool() const;

      QString layerFontItalic() const;

      bool layerFontItalicAsBool() const;

      QString layerFontSize() const;

      double layerFontSizeAsDouble() const;

      QString layerFontColor() const;

      QColor layerFontColorAsColor() const;

      QFont itemFont() const;

      QString itemFontFamily() const;

      QString itemFontBold() const;

      bool itemFontBoldAsBool() const;

      QString itemFontItalic() const;

      bool itemFontItalicAsBool() const;

      QString itemFontSize() const;

      double itemFontSizeAsDouble() const;

      QString itemFontColor() const;

      QColor itemFontColorAsColor() const;

      QString layerTitle() const;

      bool layerTitleAsBool() const;

      QgsLegendSettings legendSettings() const;

      QList<QgsWmsParametersHighlightLayer> highlightLayersParameters() const;

      QStringList highlightGeom() const;

      QList<QgsGeometry> highlightGeomAsGeom() const;

      QStringList highlightSymbol() const;

      QStringList highlightLabelString() const;

      QStringList highlightLabelColor() const;

      QList<QColor> highlightLabelColorAsColor() const;

      QStringList highlightLabelSize() const;

      QList<int> highlightLabelSizeAsInt() const;

      QStringList highlightLabelWeight() const;

      QList<int> highlightLabelWeightAsInt() const;

      QStringList highlightLabelFont() const;

      QStringList highlightLabelBufferSize() const;

      QList<double> highlightLabelBufferSizeAsFloat() const;

      QStringList highlightLabelBufferColor() const;

      QList<QColor> highlightLabelBufferColorAsColor() const;

      QString wmsPrecision() const;

      int wmsPrecisionAsInt() const;

      QString transparent() const;

      bool transparentAsBool() const;

      QString backgroundColor() const;

      QColor backgroundColorAsColor() const;

      QString dpi() const;

      double dpiAsDouble() const;

      QString composerTemplate() const;

      QgsWmsParametersComposerMap composerMapParameters( int mapId ) const;

      QString externalWMSUri( const QString &id ) const;

      bool withGeometry() const;

      bool withMapTip() const;

      QString wmtver() const;

      QString layoutParameter( const QString &id, bool &ok ) const;

    private:
      bool loadParameter( const QString &name, const QString &value ) override;

      void save( const QgsWmsParameter &parameter, bool multi = false );

      QgsWmsParameter idParameter( QgsWmsParameter::Name name, int id ) const;

      void raiseError( const QString &msg ) const;
      void log( const QString &msg ) const;

      QMultiMap<QString, QgsWmsParametersFilter> layerFilters( const QStringList &layers ) const;

      QMap<QgsWmsParameter::Name, QgsWmsParameter> mWmsParameters;
      QMap<QString, QMap<QString, QString> > mExternalWMSParameters;
      QList<QgsProjectVersion> mVersions;

      // Temporary workaround to be able to set defaults for SRCHEIGHT and SRCWIDTH in case of
      // contextual (BBOX) GetLegendGraphics, not necessary from 3.8
      friend class QgsRenderer;
  };
}

#endif