35 QStringLiteral(
"Initializing 'periodic' cache strategy" ),
42 QStringLiteral(
"Initializing 'off' cache strategy" ),
49 QStringLiteral(
"Initializing 'filesystem' cache strategy" ),
62 QStringLiteral(
"Project's cache is already initialized" ),
74 qFatal(
"QgsConfigCache must be initialized before accessing QgsConfigCache instance." );
87 : mStrategy( strategy )
89 mStrategy->attach(
this );
99 if ( !mProjectCache[ path ] )
108 prj->setBadLayerHandler( badLayerHandler );
133 if ( prj->read( path, readFlags ) )
135 if ( !badLayerHandler->
badLayers().isEmpty() )
138 QStringList unrestrictedBadLayers;
140 const QStringList badLayerIds = badLayerHandler->
badLayers();
141 const QMap<QString, QString> badLayerNames = badLayerHandler->
badLayerNames();
143 for (
const QString &badLayerId : badLayerIds )
147 if ( badLayerNames.contains( badLayerId ) &&
148 resctrictedLayers.contains( badLayerNames.value( badLayerId ) ) )
152 unrestrictedBadLayers.append( badLayerId );
154 if ( !unrestrictedBadLayers.isEmpty() )
160 QStringLiteral(
"Error, Layer(s) %1 not valid in project %2" ).arg( unrestrictedBadLayers.join( QLatin1String(
", " ) ), path ),
167 QStringLiteral(
"Warning, Layer(s) %1 not valid in project %2" ).arg( unrestrictedBadLayers.join( QLatin1String(
", " ) ), path ),
172 cacheProject( path, prj.release() );
177 QStringLiteral(
"Error when loading project file '%1': %2 " ).arg( path, prj->error() ),
182 auto entry = mProjectCache[ path ];
183 return entry ? entry->second.get() :
nullptr;
190 const auto constKeys { mProjectCache.keys() };
191 for (
const auto &path : std::as_const( constKeys ) )
193 projects << mProjectCache[path]->second.get();
199QDomDocument *QgsConfigCache::xmlDocument(
const QString &filePath )
202 QFile configFile( filePath );
203 if ( !configFile.exists() )
209 if ( !configFile.open( QIODevice::ReadOnly ) )
216 QDomDocument *xmlDoc = mXmlDocumentCache.object( filePath );
220 xmlDoc =
new QDomDocument();
223 if ( !xmlDoc->setContent( &configFile,
true, &errorMsg, &line, &column ) )
226 QStringLiteral(
"': parse error %1 at row %2, column %3" ).arg( errorMsg ).arg( line ).arg( column ), QStringLiteral(
"Server" ),
Qgis::MessageLevel::Critical );
230 mXmlDocumentCache.insert( filePath, xmlDoc );
231 xmlDoc = mXmlDocumentCache.object( filePath );
238void QgsConfigCache::cacheProject(
const QString &path,
QgsProject *project )
240 mProjectCache.insert( path,
new std::pair<QDateTime, std::unique_ptr<QgsProject> >(
project->
lastModified(), std::unique_ptr<QgsProject>(
project ) ) );
242 mStrategy->entryInserted( path );
247 mProjectCache.remove( path );
250 mXmlDocumentCache.remove( path );
252 mStrategy->entryRemoved( path );
269 const auto constKeys { mProjectCache.keys() };
270 for (
const auto &path : std::as_const( constKeys ) )
272 const auto entry = mProjectCache[ path ];
273 if ( entry && entry->first < entry->second->lastModified() )
295 mFileSystemWatcher.removePath( path );
300 mFileSystemWatcher.addPath( path );
306 : mInterval( interval )
326 if ( !mTimer.isActive() )
328 mTimer.start( mInterval );
334 if ( mTimer.isActive() )
337 mTimer.start( msec );
@ DontLoad3DViews
Skip loading 3D views.
@ DontStoreOriginalStyles
Skip the initial XML style storage for layers. Useful for minimising project load times in non-intera...
@ ForceReadOnlyLayers
Open layers in a read-only mode.
@ TrustLayerMetadata
Trust layer metadata. Improves project read time. Do not use it if layers' extent is not fixed during...
@ DontUpgradeAnnotations
Don't upgrade old annotation items to QgsAnnotationItem.
@ DontLoadLayouts
Don't load print layouts. Improves project read time if layouts are not required, and allows projects...
QFlags< ProjectCapability > ProjectCapabilities
Flags which control project capabilities.
QFlags< ProjectReadFlag > ProjectReadFlags
Project load flags.
@ Warning
Warning message.
@ Critical
Critical/error message.
@ Info
Information message.
Abstract base class for implementing cache invalidation strategy.
Cache for server configuration.
QList< QgsProject * > projects() const
Returns projects currently in cache.
QgsConfigCache(QgsServerSettings *settings)
Initialize from settings.
void removeChangedEntry(const QString &path)
Remove cache entry.
void removeEntry(const QString &path)
Removes an entry from cache.
void removeChangedEntries()
Remove all changed cache entries.
static QgsConfigCache * instance()
Returns the current instance.
static void initialize(QgsServerSettings *settings)
Initialize from settings.
void projectRemovedFromCache(const QString &path)
Emitted whenever a project is removed from the cache.
const QgsProject * project(const QString &path, const QgsServerSettings *settings=nullptr)
If the project is not cached yet, then the project is read from the path.
File system cache strategy for server configuration.
void entryInserted(const QString &path) override
Called when an entry is inserted.
QgsFileSystemCacheStrategy()
Creates a new filesystem strategy.
void entryRemoved(const QString &path) override
Called when an entry is removed from cache.
void attach(QgsConfigCache *cache) override
Attach cache to this strategy.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
Null system cache strategy for server configuration, completely disable cache invalidation invalidati...
void entryInserted(const QString &path) override
Called when an entry is inserted.
void entryRemoved(const QString &path) override
Called when an entry is removed from cache.
void attach(QgsConfigCache *owner) override
Attaches cache to this strategy.
Periodic system cache strategy for server configuration.
void entryInserted(const QString &path) override
Called when an entry is inserted.
void attach(QgsConfigCache *owner) override
Attaches cache to this strategy.
QgsPeriodicCacheStrategy(int interval=3000)
Creates a new periodic strategy.
void entryRemoved(const QString &path) override
Called when an entry is removed from cache.
void setCheckInterval(int msec)
Sets the invalidation check interval for PeriodicStrategy.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
static void setInstance(QgsProject *project)
Set the current project singleton instance to project.
QDateTime lastModified() const
Returns last modified time of the project file as returned by the file system (or other project stora...
Exception base class for server exceptions.
Provides a way to retrieve settings by prioritizing according to environment variables,...
bool getPrintDisabled() const
Returns true if WMS GetPrint request is disabled and the project's reading flag QgsProject::ReadFlag:...
int projectCacheCheckInterval() const
Returns the config cache check interval (in ms) for the 'periodic' strategy.
bool forceReadOnlyLayers() const
Returns true if the reading flag force layer read only is activated.
bool ignoreBadLayers() const
Returns true if the bad layers are ignored and false when the presence of a bad layers invalidates th...
QString projectCacheStrategy() const
Returns the project's cache strategy The default value is 'filesystem', the value can be changed by s...
bool trustLayerMetadata() const
Returns true if the reading flag trust layer metadata is activated.
Stores layer ids of bad layers.
QMap< QString, QString > badLayerNames() const
Returns names of bad layers with ids.
QStringList badLayers() const
badLayers
SERVER_EXPORT QStringList wmsRestrictedLayers(const QgsProject &project)
Returns the restricted layer name list.
QgsAbstractCacheStrategy * getStrategyFromSettings(QgsServerSettings *settings)