/
qgslayerdefinition.cpp
432 lines (379 loc) · 14 KB
/
qgslayerdefinition.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
/***************************************************************************
qgslayerdefinition.cpp
---------------------
begin : January 2015
copyright : (C) 2015 by Nathan Woodrow
email : woodrow dot nathan at gmail 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. *
* *
***************************************************************************/
#include <QFileInfo>
#include <QFile>
#include <QDir>
#include <QTextStream>
#include "qgslayerdefinition.h"
#include "qgslayertree.h"
#include "qgslogger.h"
#include "qgsmaplayer.h"
#include "qgspathresolver.h"
#include "qgspluginlayer.h"
#include "qgspluginlayerregistry.h"
#include "qgsproject.h"
#include "qgsrasterlayer.h"
#include "qgsreadwritecontext.h"
#include "qgsvectorlayer.h"
#include "qgsapplication.h"
bool QgsLayerDefinition::loadLayerDefinition( const QString &path, QgsProject *project, QgsLayerTreeGroup *rootGroup, QString &errorMessage )
{
QFile file( path );
if ( !file.open( QIODevice::ReadOnly ) )
{
errorMessage = QStringLiteral( "Can not open file" );
return false;
}
QDomDocument doc;
QString message;
if ( !doc.setContent( &file, &message ) )
{
errorMessage = message;
return false;
}
QFileInfo fileinfo( file );
QDir::setCurrent( fileinfo.absoluteDir().path() );
QgsReadWriteContext context;
context.setPathResolver( QgsPathResolver( path ) );
context.setProjectTranslator( project );
return loadLayerDefinition( doc, project, rootGroup, errorMessage, context );
}
bool QgsLayerDefinition::loadLayerDefinition( QDomDocument doc, QgsProject *project, QgsLayerTreeGroup *rootGroup, QString &errorMessage, QgsReadWriteContext &context )
{
Q_UNUSED( errorMessage );
QgsLayerTreeGroup *root = new QgsLayerTreeGroup();
// reorder maplayer nodes based on dependencies
// dependencies have to be resolved before IDs get changed
DependencySorter depSorter( doc );
if ( !depSorter.hasMissingDependency() )
{
QVector<QDomNode> sortedLayerNodes = depSorter.sortedLayerNodes();
QVector<QDomNode> clonedSorted;
const auto constSortedLayerNodes = sortedLayerNodes;
for ( const QDomNode &node : constSortedLayerNodes )
{
clonedSorted << node.cloneNode();
}
QDomNode layersNode = doc.elementsByTagName( QStringLiteral( "maplayers" ) ).at( 0 );
// replace old children with new ones
QDomNodeList childNodes = layersNode.childNodes();
for ( int i = 0; i < childNodes.size(); i++ )
{
layersNode.replaceChild( clonedSorted.at( i ), childNodes.at( i ) );
}
}
// if a dependency is missing, we still try to load layers, since dependencies may already be loaded
// IDs of layers should be changed otherwise we may have more then one layer with the same id
// We have to replace the IDs before we load them because it's too late once they are loaded
QDomNodeList ids = doc.elementsByTagName( QStringLiteral( "id" ) );
for ( int i = 0; i < ids.size(); ++i )
{
QDomNode idnode = ids.at( i );
QDomElement idElem = idnode.toElement();
QString oldid = idElem.text();
// Strip the date part because we will replace it.
QString layername = oldid.left( oldid.length() - 17 );
QDateTime dt = QDateTime::currentDateTime();
QString newid = layername + dt.toString( QStringLiteral( "yyyyMMddhhmmsszzz" ) ) + QString::number( qrand() );
idElem.firstChild().setNodeValue( newid );
QDomNodeList treeLayerNodes = doc.elementsByTagName( QStringLiteral( "layer-tree-layer" ) );
for ( int i = 0; i < treeLayerNodes.count(); ++i )
{
QDomNode layerNode = treeLayerNodes.at( i );
QDomElement layerElem = layerNode.toElement();
if ( layerElem.attribute( QStringLiteral( "id" ) ) == oldid )
{
layerNode.toElement().setAttribute( QStringLiteral( "id" ), newid );
}
}
// change layer IDs for vector joins
QDomNodeList vectorJoinNodes = doc.elementsByTagName( QStringLiteral( "join" ) ); // TODO: Find a better way of searching for vectorjoins, there might be other <join> elements within the project.
for ( int j = 0; j < vectorJoinNodes.size(); ++j )
{
QDomNode joinNode = vectorJoinNodes.at( j );
QDomElement joinElement = joinNode.toElement();
if ( joinElement.attribute( QStringLiteral( "joinLayerId" ) ) == oldid )
{
joinNode.toElement().setAttribute( QStringLiteral( "joinLayerId" ), newid );
}
}
// change IDs of dependencies
QDomNodeList dataDeps = doc.elementsByTagName( QStringLiteral( "dataDependencies" ) );
for ( int i = 0; i < dataDeps.size(); i++ )
{
QDomNodeList layers = dataDeps.at( i ).childNodes();
for ( int j = 0; j < layers.size(); j++ )
{
QDomElement elt = layers.at( j ).toElement();
if ( elt.attribute( QStringLiteral( "id" ) ) == oldid )
{
elt.setAttribute( QStringLiteral( "id" ), newid );
}
}
}
}
QDomElement layerTreeElem = doc.documentElement().firstChildElement( QStringLiteral( "layer-tree-group" ) );
bool loadInLegend = true;
if ( !layerTreeElem.isNull() )
{
root->readChildrenFromXml( layerTreeElem, context );
loadInLegend = false;
}
QList<QgsMapLayer *> layers = QgsLayerDefinition::loadLayerDefinitionLayers( doc, context );
project->addMapLayers( layers, loadInLegend );
// Now that all layers are loaded, refresh the vectorjoins to get the joined fields
const auto constLayers = layers;
for ( QgsMapLayer *layer : constLayers )
{
if ( QgsVectorLayer *vlayer = qobject_cast< QgsVectorLayer * >( layer ) )
{
vlayer->resolveReferences( project );
}
}
root->resolveReferences( project );
QList<QgsLayerTreeNode *> nodes = root->children();
const auto constNodes = nodes;
for ( QgsLayerTreeNode *node : constNodes )
root->takeChild( node );
delete root;
rootGroup->insertChildNodes( -1, nodes );
return true;
}
bool QgsLayerDefinition::exportLayerDefinition( QString path, const QList<QgsLayerTreeNode *> &selectedTreeNodes, QString &errorMessage )
{
if ( !path.endsWith( QLatin1String( ".qlr" ) ) )
path = path.append( ".qlr" );
QFile file( path );
if ( !file.open( QFile::WriteOnly | QFile::Truncate ) )
{
errorMessage = file.errorString();
return false;
}
QgsReadWriteContext context;
context.setPathResolver( QgsPathResolver( path ) );
QDomDocument doc( QStringLiteral( "qgis-layer-definition" ) );
if ( !exportLayerDefinition( doc, selectedTreeNodes, errorMessage, context ) )
return false;
QTextStream qlayerstream( &file );
doc.save( qlayerstream, 2 );
return true;
}
bool QgsLayerDefinition::exportLayerDefinition( QDomDocument doc, const QList<QgsLayerTreeNode *> &selectedTreeNodes, QString &errorMessage, const QgsReadWriteContext &context )
{
Q_UNUSED( errorMessage );
QDomElement qgiselm = doc.createElement( QStringLiteral( "qlr" ) );
doc.appendChild( qgiselm );
QList<QgsLayerTreeNode *> nodes = selectedTreeNodes;
QgsLayerTreeGroup *root = new QgsLayerTreeGroup;
const auto constNodes = nodes;
for ( QgsLayerTreeNode *node : constNodes )
{
QgsLayerTreeNode *newnode = node->clone();
root->addChildNode( newnode );
}
root->writeXml( qgiselm, context );
QDomElement layerselm = doc.createElement( QStringLiteral( "maplayers" ) );
QList<QgsLayerTreeLayer *> layers = root->findLayers();
const auto constLayers = layers;
for ( QgsLayerTreeLayer *layer : constLayers )
{
if ( ! layer->layer() )
{
QgsDebugMsgLevel( QStringLiteral( "Not a valid map layer: skipping %1" ).arg( layer->name( ) ), 4 );
continue;
}
QDomElement layerelm = doc.createElement( QStringLiteral( "maplayer" ) );
layer->layer()->writeLayerXml( layerelm, doc, context );
layerselm.appendChild( layerelm );
}
qgiselm.appendChild( layerselm );
return true;
}
QDomDocument QgsLayerDefinition::exportLayerDefinitionLayers( const QList<QgsMapLayer *> &layers, const QgsReadWriteContext &context )
{
QDomDocument doc( QStringLiteral( "qgis-layer-definition" ) );
QDomElement qgiselm = doc.createElement( QStringLiteral( "qlr" ) );
doc.appendChild( qgiselm );
QDomElement layerselm = doc.createElement( QStringLiteral( "maplayers" ) );
const auto constLayers = layers;
for ( QgsMapLayer *layer : constLayers )
{
QDomElement layerelm = doc.createElement( QStringLiteral( "maplayer" ) );
layer->writeLayerXml( layerelm, doc, context );
layerselm.appendChild( layerelm );
}
qgiselm.appendChild( layerselm );
return doc;
}
QList<QgsMapLayer *> QgsLayerDefinition::loadLayerDefinitionLayers( QDomDocument &document, QgsReadWriteContext &context )
{
QList<QgsMapLayer *> layers;
QDomNodeList layernodes = document.elementsByTagName( QStringLiteral( "maplayer" ) );
for ( int i = 0; i < layernodes.size(); ++i )
{
QDomNode layernode = layernodes.at( i );
QDomElement layerElem = layernode.toElement();
QString type = layerElem.attribute( QStringLiteral( "type" ) );
QgsDebugMsg( type );
QgsMapLayer *layer = nullptr;
if ( type == QLatin1String( "vector" ) )
{
const QgsVectorLayer::LayerOptions options { QgsCoordinateTransformContext() };
layer = new QgsVectorLayer( options );
}
else if ( type == QLatin1String( "raster" ) )
{
layer = new QgsRasterLayer;
}
else if ( type == QLatin1String( "plugin" ) )
{
QString typeName = layerElem.attribute( QStringLiteral( "name" ) );
layer = QgsApplication::pluginLayerRegistry()->createLayer( typeName );
}
if ( !layer )
continue;
if ( layer->readLayerXml( layerElem, context ) )
{
layers << layer;
}
}
return layers;
}
QList<QgsMapLayer *> QgsLayerDefinition::loadLayerDefinitionLayers( const QString &qlrfile )
{
QFile file( qlrfile );
if ( !file.open( QIODevice::ReadOnly ) )
{
QgsDebugMsg( QStringLiteral( "Can't open file" ) );
return QList<QgsMapLayer *>();
}
QDomDocument doc;
if ( !doc.setContent( &file ) )
{
QgsDebugMsg( QStringLiteral( "Can't set content" ) );
return QList<QgsMapLayer *>();
}
QgsReadWriteContext context;
context.setPathResolver( QgsPathResolver( qlrfile ) );
//no project translator defined here
return QgsLayerDefinition::loadLayerDefinitionLayers( doc, context );
}
void QgsLayerDefinition::DependencySorter::init( const QDomDocument &doc )
{
// Determine a loading order of layers based on a graph of dependencies
QMap< QString, QVector< QString > > dependencies;
QStringList sortedLayers;
QList< QPair<QString, QDomNode> > layersToSort;
QStringList layerIds;
QDomNodeList nl = doc.elementsByTagName( QStringLiteral( "maplayer" ) );
layerIds.reserve( nl.count() );
QVector<QString> deps; //avoid expensive allocation for list for every iteration
for ( int i = 0; i < nl.count(); i++ )
{
deps.resize( 0 ); // preserve capacity - don't use clear
QDomNode node = nl.item( i );
QString id = node.namedItem( QStringLiteral( "id" ) ).toElement().text();
layerIds << id;
// dependencies for this layer
QDomElement layerDependenciesElem = node.firstChildElement( QStringLiteral( "layerDependencies" ) );
if ( !layerDependenciesElem.isNull() )
{
QDomNodeList dependencyList = layerDependenciesElem.elementsByTagName( QStringLiteral( "layer" ) );
for ( int j = 0; j < dependencyList.size(); ++j )
{
QDomElement depElem = dependencyList.at( j ).toElement();
deps << depElem.attribute( QStringLiteral( "id" ) );
}
}
dependencies[id] = deps;
if ( deps.empty() )
{
sortedLayers << id;
mSortedLayerNodes << node;
mSortedLayerIds << id;
}
else
layersToSort << qMakePair( id, node );
}
// check that all dependencies are present
const auto constDependencies = dependencies;
for ( const QVector< QString > &ids : constDependencies )
{
const auto constIds = ids;
for ( const QString &depId : constIds )
{
if ( !dependencies.contains( depId ) )
{
// some dependencies are not satisfied
mHasMissingDependency = true;
for ( int i = 0; i < nl.size(); i++ )
mSortedLayerNodes << nl.at( i );
mSortedLayerIds = layerIds;
return;
}
}
}
// cycles should be very rare, since layers with cyclic dependencies may only be created by
// manually modifying the project file
mHasCycle = false;
while ( !layersToSort.empty() && !mHasCycle )
{
QList< QPair<QString, QDomNode> >::iterator it = layersToSort.begin();
while ( it != layersToSort.end() )
{
QString idToSort = it->first;
QDomNode node = it->second;
mHasCycle = true;
bool resolved = true;
const auto deps { dependencies.value( idToSort ) };
for ( const QString &dep : deps )
{
if ( !sortedLayers.contains( dep ) )
{
resolved = false;
break;
}
}
if ( resolved ) // dependencies for this layer are resolved
{
sortedLayers << idToSort;
mSortedLayerNodes << node;
mSortedLayerIds << idToSort;
it = layersToSort.erase( it ); // erase and go to the next
mHasCycle = false;
}
else
{
++it;
}
}
}
}
QgsLayerDefinition::DependencySorter::DependencySorter( const QDomDocument &doc )
: mHasCycle( false )
, mHasMissingDependency( false )
{
init( doc );
}
QgsLayerDefinition::DependencySorter::DependencySorter( const QString &fileName )
: mHasCycle( false )
, mHasMissingDependency( false )
{
QDomDocument doc;
QFile pFile( fileName );
( void )pFile.open( QIODevice::ReadOnly );
( void )doc.setContent( &pFile );
init( doc );
}