qgshttpheaders.h

Go to the documentation of this file.

/***************************************************************************
                       qgshttpheaders.h
  This class implements simple http header management.
 
                              -------------------
          begin                : 2021-09-09
          copyright            : (C) 2021 B. De Mezzo
          email                : benoit dot de dot mezzo at oslandia 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 QGSHTTPHEADERS_H
#define QGSHTTPHEADERS_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QMap>
#include <QVariant>
 
class QNetworkRequest;
class QUrlQuery;
class QDomElement;
class QgsSettings;

class CORE_EXPORT QgsHttpHeaders
{
  public:
#ifndef SIP_RUN

    static const QString PATH_PREFIX;

    static const QString KEY_REFERER;

    static const QString PARAM_PREFIX;
 
#endif

    QgsHttpHeaders( const QVariantMap &headers );
 
    QgsHttpHeaders();

    Q_DECL_DEPRECATED QgsHttpHeaders( const QgsSettings &settings, const QString &key = QString() ) SIP_DEPRECATED;

    QgsHttpHeaders( const QString &key );

    QgsHttpHeaders( const QDomElement &element );

    virtual ~QgsHttpHeaders();

    QVariantMap headers() const { return mHeaders; }

    Q_DECL_DEPRECATED bool updateSettings( QgsSettings &settings, const QString &key = QString() ) const SIP_DEPRECATED;

    bool updateNetworkRequest( QNetworkRequest &request ) const;

    bool updateUrlQuery( QUrlQuery &uri ) const;

    bool updateMap( QVariantMap &map ) const;

    Q_DECL_DEPRECATED bool updateDomElement( QDomElement &el ) const SIP_DEPRECATED;

    bool updateDomElement( QDomElement &el, QMap<QString, QString> &namespaceDeclarations ) const SIP_SKIP;

    void setFromSettings( const QgsSettings &settings, const QString &key = QString() );

    void setFromUrlQuery( const QUrlQuery &uri );

    void setFromMap( const QVariantMap &map );

    void setFromDomElement( const QDomElement &element );

    QString sanitizeKey( const QString &key ) const;

    QVariant &operator[]( const QString &key );
 
    QgsHttpHeaders &operator=( const QMap<QString, QVariant> &headers ) SIP_SKIP;
 
    bool operator==( const QgsHttpHeaders &other ) const;
    bool operator!=( const QgsHttpHeaders &other ) const;

    void insert( const QString &key, const QVariant &value );

    QList<QString> keys() const;

    QString toSpacedString() const;
 
#ifndef SIP_RUN

    const QVariant operator[]( const QString &key ) const;
#endif
 
  private:
    QMap<QString, QVariant> mHeaders;
};
 
#endif // QGSHTTPHEADERS_H