qgsserverexception.h

Go to the documentation of this file.

/***************************************************************************
                              qgserverexception.h
                              ------------------------
  begin                : January 11, 2017
  copyright            : (C) 2017 by David Marteau
  email                : david dot marteau at 3liz 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 QGSSERVEREXCEPTION_H
#define QGSSERVEREXCEPTION_H
 
 
#include <QString>
#include <QByteArray>
 
#include "qgsexception.h"
#include "qgis_server.h"
#include "qgis_sip.h"
#include "nlohmann/json.hpp"
 
#ifndef SIP_RUN
using namespace nlohmann;
#endif
 
 
#ifndef SIP_RUN
class SERVER_EXPORT QgsServerException : public QgsException
{
#else
class SERVER_EXPORT QgsServerException
{
#endif
  public:
    QgsServerException( const QString &message, int responseCode = 500 );
 
    int responseCode() const { return mResponseCode; }
 
    virtual QByteArray formatResponse( QString &responseFormat SIP_OUT ) const;
 
  private:
    int mResponseCode;
};
 
#ifndef SIP_RUN
class SERVER_EXPORT QgsOgcServiceException : public QgsServerException
{
#else
class SERVER_EXPORT QgsOgcServiceException
{
#endif
  public:
    QgsOgcServiceException( const QString &code, const QString &message, const QString &locator = QString(),
                            int responseCode = 200, const QString &version = QStringLiteral( "1.3.0" ) );
 
    QString message() const { return mMessage; }
 
    QString code()    const { return mCode; }
 
    QString locator() const { return mLocator; }
 
    QString version() const { return mVersion; }
 
    QByteArray formatResponse( QString &responseFormat SIP_OUT ) const override;
 
  private:
    QString mCode;
    QString mMessage;
    QString mLocator;
    QString mVersion;
};
 
#ifndef SIP_RUN
class SERVER_EXPORT QgsBadRequestException: public QgsOgcServiceException
{
  public:
 
    QgsBadRequestException( const QString &code, const QString &message, const QString &locator = QString() )
      : QgsOgcServiceException( code, message, locator, 400 )
    {}
};
#endif
 
#ifndef SIP_RUN // No API exceptions for SIP, see python/server/qgsserverexception.sip
 
class SERVER_EXPORT QgsServerApiException: public QgsServerException
{
  public:
    QgsServerApiException( const QString &code, const QString &message, const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 200 )
      : QgsServerException( message, responseCode )
      , mCode( code )
      , mMimeType( mimeType )
    {
    }
 
    QByteArray formatResponse( QString &responseFormat SIP_OUT ) const override
    {
      responseFormat = mMimeType;
      const json data
      {
        {
          { "code", mCode.toStdString() },
          { "description", what().toStdString() },
        }
      };
      if ( responseFormat == QLatin1String( "application/json" ) )
      {
        return QByteArray::fromStdString( data.dump() );
      }
      else if ( responseFormat == QLatin1String( "text/html" ) )
      {
        // TODO: template
        return QByteArray::fromStdString( data.dump() );
      }
      else
      {
        // TODO: template
        return QByteArray::fromStdString( data.dump() );
      }
    }
 
  private:
    QString mCode;
    QString mMimeType;
};
 
 
class SERVER_EXPORT QgsServerApiInternalServerError: public QgsServerApiException
{
  public:
    QgsServerApiInternalServerError( const QString &message = QStringLiteral( "Internal server error" ), const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 500 )
      : QgsServerApiException( QStringLiteral( "Internal server error" ), message, mimeType, responseCode )
    {
    }
};
 
 
class SERVER_EXPORT QgsServerApiNotFoundError: public QgsServerApiException
{
  public:
    QgsServerApiNotFoundError( const QString &message, const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 404 )
      : QgsServerApiException( QStringLiteral( "API not found error" ), message, mimeType, responseCode )
    {
    }
};
 
 
class SERVER_EXPORT QgsServerApiBadRequestException: public QgsServerApiException
{
  public:
    QgsServerApiBadRequestException( const QString &message, const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 400 )
      : QgsServerApiException( QStringLiteral( "Bad request error" ), message, mimeType, responseCode )
    {
    }
};
 
 
class SERVER_EXPORT QgsServerApiPermissionDeniedException: public QgsServerApiException
{
  public:
    QgsServerApiPermissionDeniedException( const QString &message, const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 403 )
      : QgsServerApiException( QStringLiteral( "Forbidden" ), message, mimeType, responseCode )
    {
    }
};
 
class SERVER_EXPORT QgsServerApiImproperlyConfiguredException: public QgsServerApiException
{
  public:
    QgsServerApiImproperlyConfiguredException( const QString &message, const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 500 )
      : QgsServerApiException( QStringLiteral( "Improperly configured error" ), message, mimeType, responseCode )
    {
    }
};
 
 
class SERVER_EXPORT QgsServerApiNotImplementedException: public QgsServerApiException
{
  public:
    QgsServerApiNotImplementedException( const QString &message = QStringLiteral( "Requested method is not implemented" ), const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 500 )
      : QgsServerApiException( QStringLiteral( "Not implemented error" ), message, mimeType, responseCode )
    {
    }
};
 
 
class SERVER_EXPORT QgsServerApiInvalidMimeTypeException: public QgsServerApiException
{
  public:
    QgsServerApiInvalidMimeTypeException( const QString &message = QStringLiteral( "The Accept header submitted in the request did not support any of the media types supported by the server for the requested resource" ), const QString &mimeType = QStringLiteral( "application/json" ), int responseCode = 406 )
      : QgsServerApiException( QStringLiteral( "Invalid mime-type" ), message, mimeType, responseCode )
    {
    }
};
#endif // no API exceptions for SIP
 
#endif