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 "qgslegendsettings.h"
#include "qgsogcutils.h"
#include "qgsprojectversion.h"
#include "qgsrectangle.h"
#include "qgsserverparameters.h"
 
#include <QColor>
#include <QMap>
#include <QMetaEnum>
 
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;
      QString mExternalUri;
  };
 
  struct QgsWmsParametersExternalLayer
  {
      QString mName;
      QString mUri;
  };
 
  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;
      QColor mFrameBackgroundColor = Qt::white;
      QColor mFrameOutlineColor = Qt::black;
      double mFrameOutlineWidth = 0;
      float mFrameSize = 0;
      double mLabelRotation = 0;
      double mLabelDistance = 2; //label distance from feature in mm
      QString mHali;             //horizontal alignment
      QString mVali;             //vertical alignment
  };
 
  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,
        SHOWRULEDETAILS,
        HIGHLIGHT_GEOM,
        HIGHLIGHT_SYMBOL,
        HIGHLIGHT_LABELSTRING,
        HIGHLIGHT_LABELFONT,
        HIGHLIGHT_LABELSIZE,
        HIGHLIGHT_LABELWEIGHT,
        HIGHLIGHT_LABELCOLOR,
        HIGHLIGHT_LABELBUFFERCOLOR,
        HIGHLIGHT_LABELBUFFERSIZE,
        HIGHLIGHT_LABELFRAMEBACKGROUNDCOLOR,
        HIGHLIGHT_LABELFRAMEOUTLINECOLOR,
        HIGHLIGHT_LABELFRAMEOUTLINEWIDTH,
        HIGHLIGHT_LABELFRAMESIZE,
        HIGHLIGHT_LABEL_ROTATION,
        HIGHLIGHT_LABEL_DISTANCE,
        HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT,
        HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT,
        WMS_PRECISION,
        TRANSPARENT,
        BGCOLOR,
        DPI,
        TEMPLATE,
        EXTENT,
        ROTATION,
        GRID_INTERVAL_X,
        GRID_INTERVAL_Y,
        WITH_GEOMETRY,
        WITH_MAPTIP,
        WITH_DISPLAY_NAME,
        WMTVER,
        ATLAS_PK,
        FORMAT_OPTIONS,
        SRCWIDTH,
        SRCHEIGHT,
        TILED,
        ADDLAYERGROUPS
      };
      Q_ENUM( Name )
 
      
      QgsWmsParameter( const QgsWmsParameter::Name name = QgsWmsParameter::UNKNOWN, const QMetaType::Type type = QMetaType::Type::QString, const QVariant defaultValue = QVariant( "" ) );

      ~QgsWmsParameter() override = default;

      bool isValid() const override;

      QStringList toStyleList( const char delimiter = ',', bool skipEmptyParts = false ) const;

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

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

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

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

      QgsRectangle toRectangle() const;

      int toInt() const;

      double toDouble() const;

      QColor toColor() const;

      QUrl toUrl() const;

      QString loadUrl() const;

      void raiseError() const;

      QString name() const;

      static QString name( const QgsWmsParameter::Name );

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

      int mMapId = -1;
  };

  class QgsWmsParameters : public QgsServerParameters
  {
      Q_GADGET
 
    public:
      enum Format
      {
        NONE,
        JPG,
        PNG,
        SVG,
        PDF,
        TEXT,
        XML,
        HTML,
        GML,
        JSON
      };
      Q_ENUM( Format )
 
      
      enum DxfFormatOption
      {
        SCALE,
        MODE,
        LAYERATTRIBUTES,
        USE_TITLE_AS_LAYERNAME,
        CODEC,
        NO_MTEXT,
        FORCE_2D,
        EXPORT_LINES_WITH_ZERO_WIDTH
      };
      Q_ENUM( DxfFormatOption )
 
      enum PdfFormatOption
      {
        RASTERIZE_WHOLE_IMAGE,
        FORCE_VECTOR_OUTPUT,
        APPEND_GEOREFERENCE,
        EXPORT_METADATA,
        TEXT_RENDER_FORMAT,
        SIMPLIFY_GEOMETRY,
        WRITE_GEO_PDF,
        USE_ISO_32000_EXTENSION_FORMAT_GEOREFERENCING,
        USE_OGC_BEST_PRACTICE_FORMAT_GEOREFERENCING,
        INCLUDE_GEO_PDF_FEATURES,
        EXPORT_THEMES,
        PREDEFINED_MAP_SCALES,
        LOSSLESS_IMAGE_COMPRESSION,
        DISABLE_TILED_RASTER_RENDERING
      };
      Q_ENUM( PdfFormatOption )
 
      
      QgsWmsParameters( const QgsServerParameters &parameters );

      QgsWmsParameters();
 
      ~QgsWmsParameters() override = default;

      QgsWmsParameter operator[]( QgsWmsParameter::Name name ) const;

      void set( QgsWmsParameter::Name name, const QVariant &value );

      void dump() const;

      QString crs() const;

      QString width() const;

      int widthAsInt() const;

      QString height() const;

      int heightAsInt() const;

      bool showRuleDetailsAsBool() 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;

      static QString formatAsString( Format format );

      Format format() const;

      QString infoFormatAsString() const;

      bool infoFormatIsImage() const;

      QString imageQuality() const;

      int imageQualityAsInt() const;

      QString tiled() const;

      bool tiledAsBool() const;

      bool addLayerGroups() 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;

      QList<QgsWmsParametersExternalLayer> externalLayersParameters() 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 highlightLabelFrameBackgroundColor() const;

      QList<QColor> highlightLabelFrameBackgroundColorAsColor() const;

      QStringList highlightLabelFrameOutlineColor() const;

      QList<QColor> highlightLabelFrameOutlineColorAsColor() const;

      QStringList highlightLabelFrameOutlineWidth() const;

      QList<double> highlightLabelFrameOutlineWidthAsFloat() const;

      QStringList highlightLabelFrameSize() const;

      QList<double> highlightLabelFrameSizeAsFloat() const;

      QStringList highlightLabelBufferColor() const;

      QList<QColor> highlightLabelBufferColorAsColor() const;

      QList<double> highlightLabelRotation() const;

      QList<double> highlightLabelDistance() const;

      QStringList highlightLabelHorizontalAlignment() const;

      QStringList highlightLabelVerticalAlignment() 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;

      QString withMapTipAsString() const;

      bool withMapTip() const;

      bool htmlInfoOnlyMapTip() const;

      bool withDisplayName() const;

      QString wmtver() const;

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

      QStringList atlasPk() const;

      QStringList dxfLayerAttributes() const;

      bool dxfUseLayerTitleAsName() const;

      double dxfScale() const;

      Qgis::FeatureSymbologyExport dxfMode() const;

      QString dxfCodec() const;

      QMap<QString, QString> dimensionValues() const;

      bool noMText() const;

      bool isForce2D() const;

      bool exportLinesWithZeroWidth() const;

      bool writeGeospatialPdf() const;

      bool pdfForceVectorOutput() const;

      bool pdfAppendGeoreference() const;

      bool pdfSimplifyGeometries() const;

      bool pdfExportMetadata() const;

      Qgis::TextRenderFormat pdfTextRenderFormat() const;

      bool pdfLosslessImageCompression() const;

      bool pdfDisableTiledRasterRendering() const;

      bool pdfUseIso32000ExtensionFormatGeoreferencing() const;

      Q_DECL_DEPRECATED bool pdfUseOgcBestPracticeFormatGeoreferencing() const;

      QStringList pdfExportMapThemes() const;

      QVector<qreal> pdfPredefinedMapScales() const;
 
      QString version() const override;
 
      QString request() const override;

      template<typename T> QMap<T, QString> formatOptions() const
      {
        QMap<T, QString> options;
        const QMetaEnum metaEnum( QMetaEnum::fromType<T>() );
        const QStringList opts = mWmsParameters.value( QgsWmsParameter::FORMAT_OPTIONS ).toStringList( ';' );
 
        for ( auto it = opts.constBegin(); it != opts.constEnd(); ++it )
        {
          const int equalIdx = it->indexOf( ':' );
          if ( equalIdx > 0 && equalIdx < ( it->length() - 1 ) )
          {
            const QString name = it->left( equalIdx ).toUpper();
            int metaEnumVal = metaEnum.keyToValue( name.toStdString().c_str() );
            if ( metaEnumVal < 0 )
            {
              continue; //option for a different format
            }
            const T option = ( T ) metaEnumVal;
            const QString value = it->right( it->length() - equalIdx - 1 );
            options.insert( option, value );
          }
        }
        return options;
      }
 
    private:
      static bool isExternalLayer( const QString &name );
 
      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 char *file = __builtin_FILE(), const char *function = __builtin_FUNCTION(), int line = __builtin_LINE() ) const;
 
      QgsWmsParametersExternalLayer externalLayerParameter( const QString &name ) const;
 
      QMultiMap<QString, QgsWmsParametersFilter> layerFilters( const QStringList &layers ) const;
 
 
      QMultiMap<QgsWmsParameter::Name, QgsWmsParameter> mWmsParameters;
      QMap<QString, QMap<QString, QString>> mExternalWMSParameters;
      QList<QgsProjectVersion> mVersions;
  };
} // namespace QgsWms
 
#endif