qgsservercachemanager.h

Go to the documentation of this file.

/***************************************************************************
                        qgsservercachemanager.h
                        -----------------------
 
  begin                : 2018-07-05
  copyright            : (C) 2018 by René-Luc D'Hont
  email                : rldhont 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 QGSSERVERCACHEMANAGER_H
#define QGSSERVERCACHEMANAGER_H
 
#include "qgis_server.h"
#include "qgis_sip.h"
#include "qgsaccesscontrol.h"
#include "qgsservercachefilter.h"
#include "qgsserverrequest.h"
#include "qgsserversettings.h"
 
#include <QDomDocument>
 
class QgsProject;
 
SIP_IF_MODULE( HAVE_SERVER_PYTHON_PLUGINS )
 

class SERVER_EXPORT QgsServerCacheManager
{
#ifdef SIP_RUN
#include "qgsservercachefilter.h"
#endif
 
  public:
    QgsServerCacheManager( const QgsServerSettings &settings = QgsServerSettings() );
 
    QgsServerCacheManager( const QgsServerCacheManager &copy );
    QgsServerCacheManager &operator=( const QgsServerCacheManager &copy );
    ~QgsServerCacheManager();

    bool getCachedDocument( QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;

    bool setCachedDocument( const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;

    bool deleteCachedDocument( const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;

    bool deleteCachedDocuments( const QgsProject *project ) const;

    QByteArray getCachedImage( const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;

    bool setCachedImage( const QByteArray *img, const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;

    bool deleteCachedImage( const QgsProject *project, const QgsServerRequest &request, QgsAccessControl *accessControl ) const;

    bool deleteCachedImages( const QgsProject *project ) const;

    void registerServerCache( QgsServerCacheFilter *serverCache, int priority = 0 );
 
  private:
    QString getCacheKey( bool &cache, QgsAccessControl *accessControl, const QgsServerRequest &request ) const;
    std::unique_ptr<QgsServerCacheFilterMap> mPluginsServerCaches = nullptr;
    const QgsServerSettings &mSettings;
};
 
#endif