qgsserverogcapihandler.h

Go to the documentation of this file.

/***************************************************************************
  qgsserverogcapihandler.h - QgsServerOgcApiHandler
 
 ---------------------
 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 QGSSERVEROGCAPIHANDLER_H
#define QGSSERVEROGCAPIHANDLER_H
 
#include <nlohmann/json_fwd.hpp>
 
#include "qgis_server.h"
#include "qgsserverogcapi.h"
#include "qgsserverquerystringparameter.h"
 
#include <QRegularExpression>
#include <QString>
 
using namespace Qt::StringLiterals;
 
#ifndef SIP_RUN
using namespace nlohmann;
#endif
 
class QgsServerApiContext;

class SERVER_EXPORT QgsServerOgcApiHandler
{
  public:
    virtual ~QgsServerOgcApiHandler();
 
    // /////////////////////////////////////////////
    // MAIN Section (operational)

    virtual QRegularExpression path() const = 0;

    virtual std::string operationId() const = 0;

    virtual QList<QgsServerQueryStringParameter> parameters( const QgsServerApiContext &context ) const
    {
      Q_UNUSED( context );
      return {};
    }
 
    // /////////////////////////////////////////////
    // METADATA Sections (informative)

    virtual std::string summary() const = 0;

    virtual std::string description() const = 0;

    virtual std::string linkTitle() const = 0;

    virtual QgsServerOgcApi::Rel linkType() const = 0;

    virtual QStringList tags() const { return {}; }

    virtual QgsServerOgcApi::ContentType defaultContentType() const;

    QList<QgsServerOgcApi::ContentType> contentTypes() const SIP_SKIP;

    virtual void handleRequest( const QgsServerApiContext &context ) const SIP_THROW( QgsServerApiBadRequestException ) SIP_VIRTUALERRORHANDLER( serverapi_badrequest_exception_handler );

    virtual QVariantMap values( const QgsServerApiContext &context ) const SIP_THROW( QgsServerApiBadRequestException );

    QString contentTypeForAccept( const QString &accept ) const;
 
    // /////////////////////////////////////////////////////
    // Utility methods: override should not be required
 
#ifndef SIP_RUN // Skip SIP

    void write( json &data, const QgsServerApiContext &context, const json &htmlMetadata = nullptr ) const;

    void jsonDump( json &data, const QgsServerApiContext &context, const QString &contentType = u"application/json"_s ) const;

    void htmlDump( const json &data, const QgsServerApiContext &context ) const;

    virtual json schema( const QgsServerApiContext &context ) const;

    json link(
      const QgsServerApiContext &context,
      const QgsServerOgcApi::Rel &linkType = QgsServerOgcApi::Rel::self,
      const QgsServerOgcApi::ContentType contentType = QgsServerOgcApi::ContentType::JSON,
      const std::string &title = ""
    ) const;

    json links( const QgsServerApiContext &context ) const;
 

    QgsVectorLayer *layerFromContext( const QgsServerApiContext &context ) const;
 
#endif // SIP skipped

    QString headerLink(
      const QgsServerApiContext &context,
      const QgsServerOgcApi::Rel &linkType = QgsServerOgcApi::Rel::self,
      const QgsServerOgcApi::ContentType contentType = QgsServerOgcApi::ContentType::JSON,
      const QgsServerOgcApi::Profile &profile = QgsServerOgcApi::Profile::Unset,
      const QString &title = ""
    ) const;

    void write( QVariant &data, const QgsServerApiContext &context, const QVariantMap &htmlMetadata = QVariantMap() ) const SIP_THROW( QgsServerApiBadRequestException );

    std::string href( const QgsServerApiContext &context, const QString &extraPath = QString(), const QString &extension = QString() ) const;

    virtual const QString templatePath( const QgsServerApiContext &context ) const;

    virtual const QString staticPath( const QgsServerApiContext &context ) const;

    QgsServerOgcApi::ContentType contentTypeFromRequest( const QgsServerRequest *request ) const;

    static QgsServerOgcApi::Profile profileFromString( const QString &profile, bool &ok SIP_OUT );

    QList<QgsServerOgcApi::Profile> profilesFromRequest( const QgsServerRequest *request ) const;

    static QString parentLink( const QUrl &url, int levels = 1 );

    static QgsVectorLayer *layerFromCollectionId( const QgsServerApiContext &context, const QString &collectionId );

    static json defaultResponse() SIP_SKIP;

    json jsonTags() const SIP_SKIP;
 
  protected:
    void setContentTypesInt( const QList<int> &contentTypes ) SIP_PYNAME( setContentTypes );

    void setContentTypes( const QList<QgsServerOgcApi::ContentType> &contentTypes ) SIP_SKIP;
 
  private:
    QList<QgsServerOgcApi::ContentType> mContentTypes = { QgsServerOgcApi::ContentType::JSON, QgsServerOgcApi::ContentType::HTML };
};
 
#endif // QGSSERVEROGCAPIHANDLER_H