qgsconfigcache.h

Go to the documentation of this file.

/***************************************************************************
                              qgsconfigcache.h
                              ----------------
  begin                : July 24th, 2010
  copyright            : (C) 2010 by Marco Hugentobler
  email                : marco dot hugentobler at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSCONFIGCACHE_H
#define QGSCONFIGCACHE_H
 
#include "qgsconfig.h"
 
#include "qgis_server.h"
#include "qgis_sip.h"
#include "qgsproject.h"
#include "qgsserversettings.h"
 
#include <QCache>
#include <QDomDocument>
#include <QFileSystemWatcher>
#include <QObject>
#include <QString>
#include <QTimer>
 
using namespace Qt::StringLiterals;
 
#ifndef SIP_RUN
 
class QgsConfigCache;

class SERVER_EXPORT QgsAbstractCacheStrategy
{
  public:
    virtual QString name() const = 0;

    virtual void entryRemoved( const QString &path ) = 0;

    virtual void entryInserted( const QString &path ) = 0;

    virtual void attach( QgsConfigCache *cache ) = 0;
 
    virtual ~QgsAbstractCacheStrategy() = default;
};
 
#endif // SIP_RUN

class SERVER_EXPORT QgsConfigCache : public QObject
{
    Q_OBJECT
  public:
    static void initialize( QgsServerSettings *settings );

    static QgsConfigCache *instance();

    void removeEntry( const QString &path );

    const QgsProject *project( const QString &path, const QgsServerSettings *settings = nullptr );

    QString strategyName() const { return mStrategy->name(); }

    QList<QgsProject *> projects() const;
 
  public:
    QgsConfigCache( QgsServerSettings *settings );

    QgsConfigCache( QgsAbstractCacheStrategy *strategy ) SIP_SKIP;
 
  signals:

    void projectRemovedFromCache( const QString &path );
 
  private:
    // SIP require this
    QgsConfigCache() SIP_FORCE;
 
  private:
    QDomDocument *xmlDocument( const QString &filePath );
 
    QCache<QString, QDomDocument> mXmlDocumentCache;
    QCache<QString, std::pair<QDateTime, std::unique_ptr<QgsProject>>> mProjectCache;
 
    std::unique_ptr<QgsAbstractCacheStrategy> mStrategy;
 
  private:
    void cacheProject( const QString &path, QgsProject *project );
 
    static QgsConfigCache *sInstance;
 
  public slots:
    void removeChangedEntry( const QString &path );

    void removeChangedEntries();
};
 
 
#ifndef SIP_RUN

class SERVER_EXPORT QgsFileSystemCacheStrategy : public QgsAbstractCacheStrategy
{
  public:
    QgsFileSystemCacheStrategy();

    QString name() const override { return u"filesystem"_s; };

    void attach( QgsConfigCache *cache ) override;

    void entryRemoved( const QString &path ) override;

    void entryInserted( const QString &path ) override;
 
  private:
    QFileSystemWatcher mFileSystemWatcher;
};
 

class SERVER_EXPORT QgsPeriodicCacheStrategy : public QgsAbstractCacheStrategy
{
  public:
    QgsPeriodicCacheStrategy( int interval = 3000 );

    QString name() const override { return u"periodic"_s; };

    void setCheckInterval( int msec );

    int checkInterval() const { return mInterval; }

    void attach( QgsConfigCache *owner ) override;

    void entryRemoved( const QString &path ) override;

    void entryInserted( const QString &path ) override;
 
  private:
    QTimer mTimer;

    int mInterval;
};

class SERVER_EXPORT QgsNullCacheStrategy : public QgsAbstractCacheStrategy
{
  public:
    QgsNullCacheStrategy() = default;

    QString name() const override { return u"off"_s; };

    void attach( QgsConfigCache *owner ) override;

    void entryRemoved( const QString &path ) override;

    void entryInserted( const QString &path ) override;
};
 
#endif // SIP_RUN
 
#endif // QGSCONFIGCACHE_H