qgsserverogcapi.h

Go to the documentation of this file.

/***************************************************************************
  qgsserverogcapi.h - QgsServerOgcApi
 
 ---------------------
 begin                : 10.7.2019
 copyright            : (C) 2019 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   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 QGSSERVEROGCAPI_H
#define QGSSERVEROGCAPI_H
 
#include "qgsserverapi.h"
#include "qgis_server.h"
 
 
class QgsServerOgcApiHandler;
 
class SERVER_EXPORT QgsServerOgcApi : public QgsServerApi
{
 
    Q_GADGET
 
  public:
 
    // Note: non a scoped enum or qHash fails
    enum Rel
    {
      // The following registered link relation types are used
      alternate, 
      describedBy, 
      collection, 
      item, 
      self, 
      service_desc, 
      service_doc, 
      prev, 
      next, 
      license, 
      // In addition the following link relation types are used for which no applicable registered link relation type could be identified:
      items, 
      conformance, 
      data 
    };
    Q_ENUM( Rel )
 
    // Note: cannot be a scoped enum because qHash does not support them
    enum ContentType
    {
      GEOJSON,
      OPENAPI3, 
      JSON,
      HTML,
      XML
    };
    Q_ENUM( ContentType )
 
    
    QgsServerOgcApi( QgsServerInterface *serverIface,
                     const QString &rootPath,
                     const QString &name,
                     const QString &description = QString(),
                     const QString &version = QString() );
 
    // QgsServerApi interface
    const QString name() const override { return mName; }
    const QString description() const override { return mDescription; }
    const QString version() const override { return mVersion; }
    const QString rootPath() const override { return mRootPath ; }
 
    ~QgsServerOgcApi() override;
 
    virtual void executeRequest( const QgsServerApiContext &context ) const override SIP_THROW( QgsServerApiBadRequestException ) SIP_VIRTUALERRORHANDLER( serverapi_badrequest_exception_handler );
 
    static const QMap<QgsServerOgcApi::ContentType, QStringList> contentTypeMimes() SIP_SKIP;
 
    static const QHash<QgsServerOgcApi::ContentType, QList<QgsServerOgcApi::ContentType> > contentTypeAliases() SIP_SKIP;
 
    // Utilities
#ifndef SIP_RUN
 
    template<class T, typename... Args>
    void registerHandler( Args... args )
    {
      mHandlers.emplace_back( std::make_shared<T>( args... ) );
    }
#endif
 
    void registerHandler( QgsServerOgcApiHandler *handler SIP_TRANSFER );
 
    static QUrl sanitizeUrl( const QUrl &url );
 
    static std::string relToString( const QgsServerOgcApi::Rel &rel );
 
    static QString contentTypeToString( const QgsServerOgcApi::ContentType &ct );
 
    static std::string contentTypeToStdString( const QgsServerOgcApi::ContentType &ct );
 
    static QString contentTypeToExtension( const QgsServerOgcApi::ContentType &ct );
 
    Q_DECL_DEPRECATED static QgsServerOgcApi::ContentType contenTypeFromExtension( const std::string &extension ) SIP_DEPRECATED { return contentTypeFromExtension( extension ); } // spellok
 
    static QgsServerOgcApi::ContentType contentTypeFromExtension( const std::string &extension );
 
    static std::string mimeType( const QgsServerOgcApi::ContentType &contentType );
 
    const std::vector<std::shared_ptr<QgsServerOgcApiHandler> > handlers() const SIP_SKIP;
 
  private:
 
    QString mRootPath;
    QString mName;
    QString mDescription;
    QString mVersion;
 
    //Note: this cannot be unique because of SIP bindings
    std::vector<std::shared_ptr<QgsServerOgcApiHandler>> mHandlers;
 
    static QMap<QgsServerOgcApi::ContentType, QStringList> sContentTypeMime;
 
    static QHash<QgsServerOgcApi::ContentType, QList<QgsServerOgcApi::ContentType>> sContentTypeAliases;
 
};
 
#endif // QGSSERVEROGCAPI_H