qgswmsserviceexception.h

Go to the documentation of this file.

/***************************************************************************
                              qgsserviceexception.h
                              ------------------------
  begin                : June 13, 2006
  copyright            : (C) 2006 by Marco Hugentobler
  email                : marco dot hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSWMSSERVICEEXCEPTION_H
#define QGSWMSSERVICEEXCEPTION_H

#include <QString>
#include <QMetaEnum>

#include "qgsserverexception.h"
#include "qgswmsparameters.h"

namespace QgsWms
{

  class QgsServiceException : public QgsOgcServiceException
  {
      Q_GADGET

    public:

      enum ExceptionCode
      {
        OGC_InvalidFormat,
        OGC_InvalidSRS,
        OGC_LayerNotDefined,
        OGC_StyleNotDefined,
        OGC_LayerNotQueryable,
        OGC_CurrentUpdateSequence,
        OGC_InvalidUpdateSequence,
        OGC_MissingDimensionValue,
        OGC_InvalidDimensionValue,
        OGC_InvalidPoint, // new in WMS 1.3.0
        OGC_InvalidCRS, // new in WMS 1.3.0
        OGC_OperationNotSupported, // new in WMS 1.3.0
        QGIS_MissingParameterValue,
        QGIS_InvalidParameterValue
      };
      Q_ENUM( ExceptionCode )

      
      QgsServiceException( const QString &code, const QString &message, const QString &locator = QString(),
                           int responseCode = 200 )
        : QgsOgcServiceException( code, message, locator, responseCode, QStringLiteral( "1.3.0" ) )
      {}

      QgsServiceException( const QString &code, const QString &message, int responseCode )
        : QgsOgcServiceException( code, message, QString(), responseCode, QStringLiteral( "1.3.0" ) )
      {}

      QgsServiceException( ExceptionCode code, const QString &message, int responseCode )
        : QgsServiceException( formatCode( code ), message, QString(), responseCode )
      {}

      QgsServiceException( ExceptionCode code, const QgsWmsParameter &parameter, int responseCode )
        : QgsServiceException( formatCode( code ), formatMessage( code, parameter ), QString(), responseCode )
      {}

    private:
      static QString formatMessage( ExceptionCode code, const QgsWmsParameter &parameter )
      {
        const QString name = parameter.name();
        QString message;

        switch ( code )
        {
          case QgsServiceException::QGIS_MissingParameterValue:
          {
            message = QStringLiteral( "The %1 parameter is missing." ).arg( name );
            break;
          }
          case QGIS_InvalidParameterValue:
          {
            message = QStringLiteral( "The %1 parameter is invalid." ).arg( name );
            break;
          }
          case OGC_InvalidFormat:
          {
            message = QStringLiteral( "The format '%1' from %2 is not supported." ).arg( parameter.toString(), name );
            break;
          }
          case OGC_InvalidSRS:
          {
            message = QStringLiteral( "The SRS is not valid." );
            break;
          }
          case OGC_InvalidCRS:
          {
            message = QStringLiteral( "The CRS is not valid." );
            break;
          }
          case OGC_LayerNotDefined:
          {
            message = QStringLiteral( "The layer '%1' does not exist." ).arg( parameter.toString() );
            break;
          }
          case OGC_LayerNotQueryable:
          {
            message = QStringLiteral( "The layer '%1' is not queryable." ).arg( parameter.toString() );
            break;
          }
          case OGC_InvalidPoint:
          {
            message = QStringLiteral( "The point '%1' from '%2' is invalid." ).arg( parameter.toString(), name );
            break;
          }
          case OGC_StyleNotDefined:
          case OGC_CurrentUpdateSequence:
          case OGC_InvalidUpdateSequence:
          case OGC_MissingDimensionValue:
          case OGC_InvalidDimensionValue:
          case OGC_OperationNotSupported:
          {
            break;
          }
        }

        return message;
      }

      static QString formatCode( ExceptionCode code )
      {
        // get key as a string from enum
        const QMetaEnum metaEnum( QMetaEnum::fromType<QgsServiceException::ExceptionCode>() );
        QString key = metaEnum.valueToKey( code );

        // remove prefix
        key.replace( QStringLiteral( "OGC_" ), QString() );
        key.replace( QStringLiteral( "QGIS_" ), QString() );

        return key;
      }
  };

  class QgsSecurityException: public QgsServiceException
  {
    public:

      QgsSecurityException( const QString &message, const QString &locator = QString() )
        : QgsServiceException( QStringLiteral( "Security" ), message, locator, 403 )
      {}
  };

  class QgsBadRequestException: public QgsServiceException
  {
    public:

      QgsBadRequestException( ExceptionCode code, const QString &message )
        : QgsServiceException( code, message, 400 )
      {}

      QgsBadRequestException( ExceptionCode code, const QgsWmsParameter &parameter )
        : QgsServiceException( code, parameter, 400 )
      {}
  };
} // namespace QgsWms

#endif