qgsserverparameters.h

Go to the documentation of this file.

/***************************************************************************
                              qgsserverparameters.h
                              ------------------
  begin                : Jun 27, 2018
  copyright            : (C) 2018 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 QGSSERVERPARAMETERS_H
#define QGSSERVERPARAMETERS_H

#include <QMap>
#include <QMetaEnum>
#include <QUrlQuery>
#include <QColor>
#include "qgsgeometry.h"
#include "qgis_server.h"

class SERVER_EXPORT QgsServerParameterDefinition
{
  public:

    QgsServerParameterDefinition( const QVariant::Type type = QVariant::String,
                                  const QVariant defaultValue = QVariant( "" ) );

    virtual ~QgsServerParameterDefinition() = default;

    QString typeName() const;

    virtual bool isValid() const;

    QString toString( bool defaultValue = false ) const;

    QStringList toStringList( char delimiter = ',', bool skipEmptyParts = true ) const;

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

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

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

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

    QgsRectangle toRectangle( bool &ok ) const;

    int toInt( bool &ok ) const;

    double toDouble( bool &ok ) const;

    bool toBool() const;

    QColor toColor( bool &ok ) const;

    QUrl toUrl( bool &ok ) const;

    QString loadUrl( bool &ok ) const;

    static void raiseError( const QString &msg );

    QVariant::Type mType;
    QVariant mValue;
    QVariant mDefaultValue;
};

class SERVER_EXPORT QgsServerParameter : public QgsServerParameterDefinition
{
    Q_GADGET

  public:
    enum Name
    {
      UNKNOWN,
      SERVICE,
      VERSION_SERVICE, // conflict with #define VERSION
      REQUEST,
      MAP,
      FILE_NAME
    };
    Q_ENUM( Name )

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

    void raiseError() const;

    static QString name( const QgsServerParameter::Name name );

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

    QgsServerParameter::Name mName;
};

class SERVER_EXPORT QgsServerParameters
{
    Q_GADGET

  public:

    QgsServerParameters();

    QgsServerParameters( const QUrlQuery &query );

    virtual ~QgsServerParameters() = default;

    void load( const QUrlQuery &query );

    void clear();

    void add( const QString &key, const QString &value );

    void remove( const QString &key );

    void remove( QgsServerParameter::Name name );

    QString value( const QString &key ) const;

    QUrlQuery urlQuery() const;

    QMap<QString, QString> toMap() const;

    QString service() const;

    QString request() const;

    QString map() const;

    QString fileName() const;

    QString version() const;

  protected:

    virtual bool loadParameter( const QString &name, const QString &value );

    QMap<QString, QString> mUnmanagedParameters;

  private:
    void save( const QgsServerParameter &parameter );
    QVariant value( QgsServerParameter::Name name ) const;

    QMap<QgsServerParameter::Name, QgsServerParameter> mParameters;
    QUrlQuery mUrlQuery;
};

#endif