qgscapabilitiescache.cpp

Go to the documentation of this file.

/***************************************************************************
                              qgscapabilitiescache.h
                              ----------------------
  begin                : May 11th, 2011
  copyright            : (C) 2011 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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgscapabilitiescache.h"
 
#include <QCoreApplication>
#include <QDir>
#include <QFileInfo>
#include <QString>
 
#include "moc_qgscapabilitiescache.cpp"
 
using namespace Qt::StringLiterals;
 
#if defined( Q_OS_LINUX )
#include <sys/vfs.h>
#endif
 
#include "qgslogger.h"
#include "qgsserversettings.h"
#include "qgsmessagelog.h"
 
const QString cacheKey( const QString &pathIn )
{
  // Clean the given file path so that in the case where the cache inserts/searches a path like folder\sub\filename.qgs or
  // folder/sub/filename.qgs they will both be cleaned and resolve to the same cache entry
  return QDir::cleanPath( pathIn );
}
 
 
QgsCapabilitiesCache::QgsCapabilitiesCache( int size )
  : mCacheSize( size )
{
  QObject::connect( &mFileSystemWatcher, &QFileSystemWatcher::fileChanged, this, &QgsCapabilitiesCache::removeChangedEntry );
 
#if defined( Q_OS_LINUX )
  QObject::connect( &mTimer, &QTimer::timeout, this, &QgsCapabilitiesCache::removeOutdatedEntries );
#endif
}
 
const QDomDocument *QgsCapabilitiesCache::searchCapabilitiesDocument( const QString &configFilePathIn, const QString &key )
{
  QCoreApplication::processEvents(); //get updates from file system watcher
 
  const QString configFilePath = cacheKey( configFilePathIn );
  if ( mCachedCapabilities.contains( configFilePath ) && mCachedCapabilities[configFilePath].contains( key ) )
  {
    return &mCachedCapabilities[configFilePath][key];
  }
  else
  {
    return nullptr;
  }
}
 
void QgsCapabilitiesCache::insertCapabilitiesDocument( const QString &configFilePathIn, const QString &key, const QDomDocument *doc )
{
  const QString configFilePath = cacheKey( configFilePathIn );
  if ( mCachedCapabilities.size() > mCacheSize )
  {
    //remove another cache entry to avoid memory problems
    const QHash<QString, QHash<QString, QDomDocument>>::iterator capIt = mCachedCapabilities.begin();
    mFileSystemWatcher.removePath( capIt.key() );
    mCachedCapabilities.erase( capIt );
 
    QgsMessageLog::logMessage( u"Removed cached WMS capabilities document because all %1 cache slots were taken"_s.arg( mCacheSize ), u"Server"_s );
  }
 
  if ( !mCachedCapabilities.contains( configFilePath ) )
  {
    mFileSystemWatcher.addPath( configFilePath );
    mCachedCapabilities.insert( configFilePath, QHash<QString, QDomDocument>() );
  }
 
  mCachedCapabilities[configFilePath].insert( key, doc->cloneNode().toDocument() );
 
#if defined( Q_OS_LINUX )
  struct statfs sStatFS;
  if ( statfs( configFilePath.toUtf8().constData(), &sStatFS ) == 0 && ( sStatFS.f_type == 0x6969 /* NFS */ || sStatFS.f_type == 0x517b /* SMB */ || sStatFS.f_type == 0xff534d42ul /* CIFS */ || sStatFS.f_type == 0xfe534d42ul /* CIFS */ ) )
  {
    const QFileInfo fi( configFilePath );
    mCachedCapabilitiesTimestamps[configFilePath] = fi.lastModified();
    mTimer.start( 1000 );
  }
#endif
}
 
void QgsCapabilitiesCache::removeCapabilitiesDocument( const QString &pathIn )
{
  const QString path = cacheKey( pathIn );
  mCachedCapabilities.remove( path );
  mCachedCapabilitiesTimestamps.remove( path );
  mFileSystemWatcher.removePath( path );
}
 
void QgsCapabilitiesCache::removeChangedEntry( const QString &pathIn )
{
  const QString path = cacheKey( pathIn );
  QgsDebugMsgLevel( u"Remove capabilities cache entry because file changed"_s, 2 );
  removeCapabilitiesDocument( path );
}
 
void QgsCapabilitiesCache::removeOutdatedEntries()
{
  QgsDebugMsgLevel( u"Checking for outdated entries"_s, 2 );
  for ( auto it = mCachedCapabilitiesTimestamps.constBegin(); it != mCachedCapabilitiesTimestamps.constEnd(); it++ )
  {
    const QString configFilePath = it.key();
    const QFileInfo fi( configFilePath );
    if ( !fi.exists() || it.value() < fi.lastModified() )
      removeChangedEntry( configFilePath );
  }
 
  if ( !mCachedCapabilitiesTimestamps.isEmpty() )
  {
    mTimer.start( 1000 );
  }
}