qgsserverrequest.h

Go to the documentation of this file.

/***************************************************************************
                          qgsserverrequest.h
 
  Define request class for getting request contents
  -------------------
  begin                : 2016-12-05
  copyright            : (C) 2016 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 QGSSERVERREQUEST_H
#define QGSSERVERREQUEST_H
 
#include <QUrl>
#include <QMap>
#include "qgis_server.h"
#include "qgsserverparameters.h"
 
// Note about design: this interface must be passed along to Python and thus signatures methods must be
// compatible with pyQGIS/pyQT api and rules.
 
class SERVER_EXPORT QgsServerRequest
{
    Q_GADGET
 
  public:
 
    typedef QMap<QString, QString> Parameters;
    typedef QMap<QString, QString> Headers;
 
    enum Method
    {
      HeadMethod,
      PutMethod,
      GetMethod,
      PostMethod,
      DeleteMethod,
      PatchMethod
    };
    Q_ENUM( Method )
 
    
    enum RequestHeader
    {
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Host
      HOST,
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded
      // https://tools.ietf.org/html/rfc7239
      FORWARDED,
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For
      X_FORWARDED_FOR,
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host
      X_FORWARDED_HOST,
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto
      X_FORWARDED_PROTO,
      // The QGIS service URL
      X_QGIS_SERVICE_URL,
      // The QGIS WMS service URL
      X_QGIS_WMS_SERVICE_URL,
      // The QGIS WFS service URL
      X_QGIS_WFS_SERVICE_URL,
      // The QGIS WCS service URL
      X_QGIS_WCS_SERVICE_URL,
      // The QGIS WMTS service URL
      X_QGIS_WMTS_SERVICE_URL,
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept
      ACCEPT,
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent
      USER_AGENT,
      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization
      AUTHORIZATION,
    };
    Q_ENUM( RequestHeader )
 
    
    QgsServerRequest() = default;
 
    QgsServerRequest( const QString &url, QgsServerRequest::Method method = QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers = QgsServerRequest::Headers() );
 
    QgsServerRequest( const QUrl &url, QgsServerRequest::Method method = QgsServerRequest::GetMethod, const QgsServerRequest::Headers &headers = QgsServerRequest::Headers() );
 
    QgsServerRequest( const QgsServerRequest &other );
 
    QgsServerRequest &operator=( const QgsServerRequest & ) = default;
 
    virtual ~QgsServerRequest() = default;
 
    static QString methodToString( const Method &method );
 
 
    QUrl url() const;
 
    QgsServerRequest::Method method() const;
 
    QgsServerRequest::Parameters parameters() const;
 
    QgsServerParameters serverParameters() const;
 
    virtual void setParameter( const QString &key, const QString &value );
 
    QString parameter( const QString &key, const QString &defaultValue = QString() ) const;
 
    virtual void removeParameter( const QString &key );
 
    virtual QString header( const QString &name ) const;
 
    virtual QString header( const RequestHeader &headerEnum ) const;
 
    void setHeader( const QString &name, const QString &value );
 
    QMap<QString, QString> headers() const;
 
    void removeHeader( const QString &name );
 
    virtual QByteArray data() const;
 
    virtual void setUrl( const QUrl &url );
 
    QUrl originalUrl() const;
 
    QUrl baseUrl() const;
 
    void setMethod( QgsServerRequest::Method method );
 
    const QString queryParameter( const QString &name, const QString &defaultValue = QString( ) ) const;
 
  protected:
 
    void setOriginalUrl( const QUrl &url );
 
    void setBaseUrl( const QUrl &url );
 
  private:
    // Url as seen by QGIS server after web server rewrite
    QUrl       mUrl;
    // Unrewritten url as seen by the web server
    QUrl       mOriginalUrl;
    QUrl       mBaseUrl;
    Method     mMethod = GetMethod;
    // We mark as mutable in order
    // to support lazy initialization
    mutable Headers mHeaders;
    QgsServerParameters mParams;
};
 
#endif