QGIS API Documentation  2.99.0-Master (cd0ba91)
qgsprojectfiletransform.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsprojectfiletransform.cpp - description
3  -------------------
4  begin : Sun 15 dec 2007
5  copyright : (C) 2007 by Magnus Homann
6  email : magnus at homann.se
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 
20 #include "qgsprojectversion.h"
21 #include "qgslogger.h"
22 #include "qgsrasterlayer.h"
23 #include "qgsreadwritecontext.h"
24 #include "qgsvectordataprovider.h"
25 #include "qgsvectorlayer.h"
26 #include <QTextStream>
27 #include <QDomDocument>
28 #include <QPrinter> //to find out screen resolution
29 #include <cstdlib>
30 #include "qgspathresolver.h"
31 #include "qgsproject.h"
32 #include "qgsprojectproperty.h"
33 #include "qgsrasterbandstats.h"
34 #include "qgsrasterdataprovider.h"
35 #include "qgsxmlutils.h"
36 
38 
39 
40 QgsProjectFileTransform::TransformItem QgsProjectFileTransform::sTransformers[] =
41 {
42  {PFV( 0, 8, 0 ), PFV( 0, 8, 1 ), &QgsProjectFileTransform::transformNull},
43  {PFV( 0, 8, 1 ), PFV( 0, 9, 0 ), &QgsProjectFileTransform::transform081to090},
44  {PFV( 0, 9, 0 ), PFV( 0, 9, 1 ), &QgsProjectFileTransform::transformNull},
45  {PFV( 0, 9, 1 ), PFV( 0, 10, 0 ), &QgsProjectFileTransform::transform091to0100},
46  // Following line is a hack that takes us straight from 0.9.2 to 0.11.0
47  // due to an unknown bug in migrating 0.9.2 files which we didn't pursue (TS & GS)
48  {PFV( 0, 9, 2 ), PFV( 0, 11, 0 ), &QgsProjectFileTransform::transformNull},
49  {PFV( 0, 10, 0 ), PFV( 0, 11, 0 ), &QgsProjectFileTransform::transform0100to0110},
50  {PFV( 0, 11, 0 ), PFV( 1, 0, 0 ), &QgsProjectFileTransform::transform0110to1000},
51  {PFV( 1, 0, 0 ), PFV( 1, 1, 0 ), &QgsProjectFileTransform::transformNull},
52  {PFV( 1, 0, 2 ), PFV( 1, 1, 0 ), &QgsProjectFileTransform::transformNull},
53  {PFV( 1, 1, 0 ), PFV( 1, 2, 0 ), &QgsProjectFileTransform::transform1100to1200},
54  {PFV( 1, 2, 0 ), PFV( 1, 3, 0 ), &QgsProjectFileTransform::transformNull},
55  {PFV( 1, 3, 0 ), PFV( 1, 4, 0 ), &QgsProjectFileTransform::transformNull},
56  {PFV( 1, 4, 0 ), PFV( 1, 5, 0 ), &QgsProjectFileTransform::transform1400to1500},
57  {PFV( 1, 5, 0 ), PFV( 1, 6, 0 ), &QgsProjectFileTransform::transformNull},
58  {PFV( 1, 6, 0 ), PFV( 1, 7, 0 ), &QgsProjectFileTransform::transformNull},
59  {PFV( 1, 7, 0 ), PFV( 1, 8, 0 ), &QgsProjectFileTransform::transformNull},
60  {PFV( 1, 8, 0 ), PFV( 1, 9, 0 ), &QgsProjectFileTransform::transform1800to1900},
61  {PFV( 1, 9, 0 ), PFV( 2, 0, 0 ), &QgsProjectFileTransform::transformNull},
62  {PFV( 2, 0, 0 ), PFV( 2, 1, 0 ), &QgsProjectFileTransform::transformNull},
63  {PFV( 2, 1, 0 ), PFV( 2, 2, 0 ), &QgsProjectFileTransform::transformNull},
64  {PFV( 2, 2, 0 ), PFV( 2, 3, 0 ), &QgsProjectFileTransform::transform2200to2300},
65  // A transformer with a NULL from version means that it should be run when upgrading
66  // from any version and will take care that it's not going to cause trouble if it's
67  // run several times on the same file.
68  {PFV(), PFV( 2, 99, 0 ), &QgsProjectFileTransform::transform2990},
69 };
70 
72 {
73  Q_UNUSED( newVersion );
74  bool returnValue = false;
75 
76  if ( !mDom.isNull() )
77  {
78  for ( std::size_t i = 0; i < sizeof( sTransformers ) / sizeof( TransformItem ); i++ )
79  {
80  const TransformItem &transformer = sTransformers[i];
81  if ( transformer.from == mCurrentVersion || transformer.from.isNull() )
82  {
83  // Run the transformer, and update the revision in every case
84  ( this->*( transformer.transformFunc ) )();
85  mCurrentVersion = transformer.to;
86  returnValue = true;
87  }
88  }
89  }
90  return returnValue;
91 }
92 
94 {
95  QgsDebugMsg( QString( "Current project file version is %1.%2.%3" )
96  .arg( mCurrentVersion.majorVersion() )
97  .arg( mCurrentVersion.minorVersion() )
98  .arg( mCurrentVersion.subVersion() ) );
99 #ifdef QGISDEBUG
100  // Using QgsDebugMsg() didn't print the entire mDom...
101  std::cout << mDom.toString( 2 ).toLatin1().constData(); // OK
102 #endif
103 }
104 
105 /*
106  * Transformers below!
107  */
108 
109 void QgsProjectFileTransform::transform081to090()
110 {
111  QgsDebugMsg( "Entering..." );
112  if ( ! mDom.isNull() )
113  {
114  // Start with inserting a mapcanvas element and populate it
115 
116  QDomElement mapCanvas; // A null element.
117 
118  // there should only be one <qgis>
119  QDomNode qgis = mDom.firstChildElement( QStringLiteral( "qgis" ) );
120  if ( ! qgis.isNull() )
121  {
122  QgsDebugMsg( "Populating new mapcanvas" );
123 
124  // Create a mapcanvas
125  mapCanvas = mDom.createElement( QStringLiteral( "mapcanvas" ) );
126  // Append mapcanvas to parent 'qgis'.
127  qgis.appendChild( mapCanvas );
128  // Re-parent units
129  mapCanvas.appendChild( qgis.namedItem( QStringLiteral( "units" ) ) );
130  // Re-parent extent
131  mapCanvas.appendChild( qgis.namedItem( QStringLiteral( "extent" ) ) );
132 
133  // See if we can find if projection is on.
134 
135  QDomElement properties = qgis.firstChildElement( QStringLiteral( "properties" ) );
136  QDomElement spatial = properties.firstChildElement( QStringLiteral( "SpatialRefSys" ) );
137  QDomElement hasCrsTransformEnabled = spatial.firstChildElement( QStringLiteral( "ProjectionsEnabled" ) );
138  // Type is 'int', and '1' if on.
139  // Create an element
140  QDomElement projection = mDom.createElement( QStringLiteral( "projections" ) );
141  QgsDebugMsg( QString( "Projection flag: " ) + hasCrsTransformEnabled.text() );
142  // Set flag from ProjectionsEnabled
143  projection.appendChild( mDom.createTextNode( hasCrsTransformEnabled.text() ) );
144  // Set new element as child of <mapcanvas>
145  mapCanvas.appendChild( projection );
146 
147  }
148 
149 
150  // Transforming coordinate-transforms
151  // Create a list of all map layers
152  QDomNodeList mapLayers = mDom.elementsByTagName( QStringLiteral( "maplayer" ) );
153  bool doneDestination = false;
154  for ( int i = 0; i < mapLayers.count(); i++ )
155  {
156  QDomNode mapLayer = mapLayers.item( i );
157  // Find the coordinatetransform
158  QDomNode coordinateTransform = mapLayer.namedItem( QStringLiteral( "coordinatetransform" ) );
159  // Find the sourcesrs
160  QDomNode sourceCrs = coordinateTransform.namedItem( QStringLiteral( "sourcesrs" ) );
161  // Rename to srs
162  sourceCrs.toElement().setTagName( QStringLiteral( "srs" ) );
163  // Re-parent to maplayer
164  mapLayer.appendChild( sourceCrs );
165  // Re-move coordinatetransform
166  // Take the destination CRS of the first layer and use for mapcanvas projection
167  if ( ! doneDestination )
168  {
169  // Use destination CRS from the last layer
170  QDomNode destinationCRS = coordinateTransform.namedItem( QStringLiteral( "destinationsrs" ) );
171  // Re-parent the destination CRS to the mapcanvas
172  // If mapcanvas wasn't set, nothing will happen.
173  mapCanvas.appendChild( destinationCRS );
174  // Only do this once
175  doneDestination = true;
176  }
177  mapLayer.removeChild( coordinateTransform );
178  //QDomNode id = mapLayer.namedItem("id");
179  //QgsDebugMsg(QString("Found maplayer ") + id.toElement().text());
180 
181  }
182 
183  // Set the flag 'visible' to match the status of 'checked'
184  QDomNodeList legendLayerFiles = mDom.elementsByTagName( QStringLiteral( "legendlayerfile" ) );
185  QgsDebugMsg( QString( "Legend layer file entries: " ) + QString::number( legendLayerFiles.count() ) );
186  for ( int i = 0; i < mapLayers.count(); i++ )
187  {
188  // Get one maplayer element from list
189  QDomElement mapLayer = mapLayers.item( i ).toElement();
190  // Find it's id.
191  QString id = mapLayer.firstChildElement( QStringLiteral( "id" ) ).text();
192  QgsDebugMsg( QString( "Handling layer " + id ) );
193  // Now, look it up in legend
194  for ( int j = 0; j < legendLayerFiles.count(); j++ )
195  {
196  QDomElement legendLayerFile = legendLayerFiles.item( j ).toElement();
197  if ( id == legendLayerFile.attribute( QStringLiteral( "layerid" ) ) )
198  {
199  // Found a the legend layer that matches the maplayer
200  QgsDebugMsg( "Found matching id" );
201 
202  // Set visible flag from maplayer to legendlayer
203  legendLayerFile.setAttribute( QStringLiteral( "visible" ), mapLayer.attribute( QStringLiteral( "visible" ) ) );
204 
205  // Set overview flag from maplayer to legendlayer
206  legendLayerFile.setAttribute( QStringLiteral( "isInOverview" ), mapLayer.attribute( QStringLiteral( "showInOverviewFlag" ) ) );
207  }
208  }
209  }
210  }
211 }
212 
213 void QgsProjectFileTransform::transform091to0100()
214 {
215  if ( ! mDom.isNull() )
216  {
217  // Insert transforms here!
218  QDomNodeList rasterPropertyList = mDom.elementsByTagName( QStringLiteral( "rasterproperties" ) );
219  QgsDebugMsg( QString( "Raster properties file entries: " ) + QString::number( rasterPropertyList.count() ) );
220  for ( int i = 0; i < rasterPropertyList.count(); i++ )
221  {
222  // Get one rasterproperty element from list, and rename the sub-properties.
223  QDomNode rasterProperty = rasterPropertyList.item( i );
224  // rasterProperty.namedItem("").toElement().setTagName("");
225 
226  rasterProperty.namedItem( QStringLiteral( "stdDevsToPlotDouble" ) ).toElement().setTagName( QStringLiteral( "mStandardDeviations" ) );
227 
228  rasterProperty.namedItem( QStringLiteral( "invertHistogramFlag" ) ).toElement().setTagName( QStringLiteral( "mInvertPixelsFlag" ) );
229  rasterProperty.namedItem( QStringLiteral( "showDebugOverLayFlag" ) ).toElement().setTagName( QStringLiteral( "mDebugOverLayFlag" ) );
230 
231  rasterProperty.namedItem( QStringLiteral( "redBandNameQString" ) ).toElement().setTagName( QStringLiteral( "mRedBandName" ) );
232  rasterProperty.namedItem( QStringLiteral( "blueBandNameQString" ) ).toElement().setTagName( QStringLiteral( "mBlueBandName" ) );
233  rasterProperty.namedItem( QStringLiteral( "greenBandNameQString" ) ).toElement().setTagName( QStringLiteral( "mGreenBandName" ) );
234  rasterProperty.namedItem( QStringLiteral( "grayBandNameQString" ) ).toElement().setTagName( QStringLiteral( "mGrayBandName" ) );
235  }
236 
237  // Changing symbol size for hard: symbols
238  QDomNodeList symbolPropertyList = mDom.elementsByTagName( QStringLiteral( "symbol" ) );
239  for ( int i = 0; i < symbolPropertyList.count(); i++ )
240  {
241  // Get the <poinmtsymbol> to check for 'hard:' for each <symbol>
242  QDomNode symbolProperty = symbolPropertyList.item( i );
243 
244  QDomElement pointSymbol = symbolProperty.firstChildElement( QStringLiteral( "pointsymbol" ) );
245  if ( pointSymbol.text().startsWith( QLatin1String( "hard:" ) ) )
246  {
247  // Get pointsize and line width
248  int lineWidth = symbolProperty.firstChildElement( QStringLiteral( "outlinewidth" ) ).text().toInt();
249  int pointSize = symbolProperty.firstChildElement( QStringLiteral( "pointsize" ) ).text().toInt();
250  // Just a precaution, checking for 0
251  if ( pointSize != 0 )
252  {
253  // int r = (s-2*lw)/2-1 --> 2r = (s-2*lw)-2 --> 2r+2 = s-2*lw
254  // --> 2r+2+2*lw = s
255  // where '2r' is the old size.
256  pointSize = pointSize + 2 + 2 * lineWidth;
257  QgsDebugMsg( QString( "Setting point size to %1" ).arg( pointSize ) );
258  QDomElement newPointSizeProperty = mDom.createElement( QStringLiteral( "pointsize" ) );
259  QDomText newPointSizeTxt = mDom.createTextNode( QString::number( pointSize ) );
260  newPointSizeProperty.appendChild( newPointSizeTxt );
261  symbolProperty.replaceChild( newPointSizeProperty, pointSymbol );
262  }
263  }
264  }
265 
266  }
267 }
268 
269 void QgsProjectFileTransform::transform0100to0110()
270 {
271  if ( ! mDom.isNull() )
272  {
273 #ifndef QT_NO_PRINTER
274  //Change 'outlinewidth' in QgsSymbol
275  QPrinter myPrinter( QPrinter::ScreenResolution );
276  int screenDpi = myPrinter.resolution();
277  double widthScaleFactor = 25.4 / screenDpi;
278 
279  QDomNodeList outlineWidthList = mDom.elementsByTagName( QStringLiteral( "outlinewidth" ) );
280  for ( int i = 0; i < outlineWidthList.size(); ++i )
281  {
282  //calculate new width
283  QDomElement currentOutlineElem = outlineWidthList.at( i ).toElement();
284  double outlineWidth = currentOutlineElem.text().toDouble();
285  outlineWidth *= widthScaleFactor;
286 
287  //replace old text node
288  QDomNode outlineTextNode = currentOutlineElem.firstChild();
289  QDomText newOutlineText = mDom.createTextNode( QString::number( outlineWidth ) );
290  currentOutlineElem.replaceChild( newOutlineText, outlineTextNode );
291 
292  }
293 
294  //Change 'pointsize' in QgsSymbol
295  QDomNodeList pointSizeList = mDom.elementsByTagName( QStringLiteral( "pointsize" ) );
296  for ( int i = 0; i < pointSizeList.size(); ++i )
297  {
298  //calculate new size
299  QDomElement currentPointSizeElem = pointSizeList.at( i ).toElement();
300  double pointSize = currentPointSizeElem.text().toDouble();
301  pointSize *= widthScaleFactor;
302 
303  //replace old text node
304  QDomNode pointSizeTextNode = currentPointSizeElem.firstChild();
305  QDomText newPointSizeText = mDom.createTextNode( QString::number( static_cast< int >( pointSize ) ) );
306  currentPointSizeElem.replaceChild( newPointSizeText, pointSizeTextNode );
307  }
308 #endif
309  }
310 }
311 
312 void QgsProjectFileTransform::transform0110to1000()
313 {
314  if ( ! mDom.isNull() )
315  {
316  QDomNodeList layerList = mDom.elementsByTagName( QStringLiteral( "maplayer" ) );
317  for ( int i = 0; i < layerList.size(); ++i )
318  {
319  QDomElement layerElem = layerList.at( i ).toElement();
320  QString typeString = layerElem.attribute( QStringLiteral( "type" ) );
321  if ( typeString != QLatin1String( "vector" ) )
322  {
323  continue;
324  }
325 
326  //datasource
327  QDomNode dataSourceNode = layerElem.namedItem( QStringLiteral( "datasource" ) );
328  if ( dataSourceNode.isNull() )
329  {
330  return;
331  }
332  QString dataSource = dataSourceNode.toElement().text();
333 
334  //provider key
335  QDomNode providerNode = layerElem.namedItem( QStringLiteral( "provider" ) );
336  if ( providerNode.isNull() )
337  {
338  return;
339  }
340  QString providerKey = providerNode.toElement().text();
341 
342  //create the layer to get the provider for int->fieldName conversion
344  options.loadDefaultStyle = false;
345  QgsVectorLayer *layer = new QgsVectorLayer( dataSource, QLatin1String( "" ), providerKey, options );
346  if ( !layer->isValid() )
347  {
348  delete layer;
349  return;
350  }
351 
352  QgsVectorDataProvider *provider = layer->dataProvider();
353  if ( !provider )
354  {
355  return;
356  }
357  QgsFields fields = provider->fields();
358 
359  //read classificationfield
360  QDomNodeList classificationFieldList = layerElem.elementsByTagName( QStringLiteral( "classificationfield" ) );
361  for ( int j = 0; j < classificationFieldList.size(); ++j )
362  {
363  QDomElement classificationFieldElem = classificationFieldList.at( j ).toElement();
364  int fieldNumber = classificationFieldElem.text().toInt();
365  if ( fieldNumber >= 0 && fieldNumber < fields.count() )
366  {
367  QDomText fieldName = mDom.createTextNode( fields.at( fieldNumber ).name() );
368  QDomNode nameNode = classificationFieldElem.firstChild();
369  classificationFieldElem.replaceChild( fieldName, nameNode );
370  }
371  }
372 
373  }
374  }
375 }
376 
377 void QgsProjectFileTransform::transform1100to1200()
378 {
379  QgsDebugMsg( "Entering..." );
380  if ( mDom.isNull() )
381  return;
382 
383  QDomNode qgis = mDom.firstChildElement( QStringLiteral( "qgis" ) );
384  if ( qgis.isNull() )
385  return;
386 
387  QDomElement properties = qgis.firstChildElement( QStringLiteral( "properties" ) );
388  if ( properties.isNull() )
389  return;
390 
391  QDomElement digitizing = properties.firstChildElement( QStringLiteral( "Digitizing" ) );
392  if ( digitizing.isNull() )
393  return;
394 
395  QDomElement tolList = digitizing.firstChildElement( QStringLiteral( "LayerSnappingToleranceList" ) );
396  if ( tolList.isNull() )
397  return;
398 
399  QDomElement tolUnitList = digitizing.firstChildElement( QStringLiteral( "LayerSnappingToleranceUnitList" ) );
400  if ( !tolUnitList.isNull() )
401  return;
402 
403  QStringList units;
404  for ( int i = 0; i < tolList.childNodes().count(); i++ )
405  units << QStringLiteral( "0" );
406 
407  QgsProjectPropertyValue value( units );
408  value.writeXml( QStringLiteral( "LayerSnappingToleranceUnitList" ), digitizing, mDom );
409 }
410 
411 void QgsProjectFileTransform::transform1400to1500()
412 {
413  //Adapt the XML description of the composer legend model to version 1.5
414  if ( mDom.isNull() )
415  {
416  return;
417  }
418  //Add layer id to <VectorClassificationItem>
419  QDomNodeList layerItemList = mDom.elementsByTagName( QStringLiteral( "LayerItem" ) );
420  QDomElement currentLayerItemElem;
421  QString currentLayerId;
422 
423  for ( int i = 0; i < layerItemList.size(); ++i )
424  {
425  currentLayerItemElem = layerItemList.at( i ).toElement();
426  if ( currentLayerItemElem.isNull() )
427  {
428  continue;
429  }
430  currentLayerId = currentLayerItemElem.attribute( QStringLiteral( "layerId" ) );
431 
432  QDomNodeList vectorClassificationList = currentLayerItemElem.elementsByTagName( QStringLiteral( "VectorClassificationItem" ) );
433  QDomElement currentClassificationElem;
434  for ( int j = 0; j < vectorClassificationList.size(); ++j )
435  {
436  currentClassificationElem = vectorClassificationList.at( j ).toElement();
437  if ( !currentClassificationElem.isNull() )
438  {
439  currentClassificationElem.setAttribute( QStringLiteral( "layerId" ), currentLayerId );
440  }
441  }
442 
443  //replace the text items with VectorClassification or RasterClassification items
444  QDomNodeList textItemList = currentLayerItemElem.elementsByTagName( QStringLiteral( "TextItem" ) );
445  QDomElement currentTextItem;
446 
447  for ( int j = 0; j < textItemList.size(); ++j )
448  {
449  currentTextItem = textItemList.at( j ).toElement();
450  if ( currentTextItem.isNull() )
451  {
452  continue;
453  }
454 
455  QDomElement classificationElement;
456  if ( !vectorClassificationList.isEmpty() ) //we guess it is a vector layer
457  {
458  classificationElement = mDom.createElement( QStringLiteral( "VectorClassificationItem" ) );
459  }
460  else
461  {
462  classificationElement = mDom.createElement( QStringLiteral( "RasterClassificationItem" ) );
463  }
464 
465  classificationElement.setAttribute( QStringLiteral( "layerId" ), currentLayerId );
466  classificationElement.setAttribute( QStringLiteral( "text" ), currentTextItem.attribute( QStringLiteral( "text" ) ) );
467  currentLayerItemElem.replaceChild( classificationElement, currentTextItem );
468  }
469  }
470 }
471 
472 void QgsProjectFileTransform::transform1800to1900()
473 {
474  if ( mDom.isNull() )
475  {
476  return;
477  }
478 
479  QgsReadWriteContext context;
480  context.setPathResolver( QgsProject::instance()->pathResolver() );
481 
482  QDomNodeList layerItemList = mDom.elementsByTagName( QStringLiteral( "rasterproperties" ) );
483  for ( int i = 0; i < layerItemList.size(); ++i )
484  {
485  QDomElement rasterPropertiesElem = layerItemList.at( i ).toElement();
486  QDomNode layerNode = rasterPropertiesElem.parentNode();
487  QDomElement dataSourceElem = layerNode.firstChildElement( QStringLiteral( "datasource" ) );
488  QDomElement layerNameElem = layerNode.firstChildElement( QStringLiteral( "layername" ) );
489  QgsRasterLayer rasterLayer;
490  // TODO: We have to use more data from project file to read the layer it correctly,
491  // OTOH, we should not read it until it was converted
492  rasterLayer.readLayerXml( layerNode.toElement(), context );
493  convertRasterProperties( mDom, layerNode, rasterPropertiesElem, &rasterLayer );
494  }
495 
496  //composer: replace mGridAnnotationPosition with mLeftGridAnnotationPosition & co.
497  // and mGridAnnotationDirection with mLeftGridAnnotationDirection & co.
498  QDomNodeList composerMapList = mDom.elementsByTagName( QStringLiteral( "ComposerMap" ) );
499  for ( int i = 0; i < composerMapList.size(); ++i )
500  {
501  QDomNodeList gridList = composerMapList.at( i ).toElement().elementsByTagName( QStringLiteral( "Grid" ) );
502  for ( int j = 0; j < gridList.size(); ++j )
503  {
504  QDomNodeList annotationList = gridList.at( j ).toElement().elementsByTagName( QStringLiteral( "Annotation" ) );
505  for ( int k = 0; k < annotationList.size(); ++k )
506  {
507  QDomElement annotationElem = annotationList.at( k ).toElement();
508 
509  //position
510  if ( annotationElem.hasAttribute( QStringLiteral( "position" ) ) )
511  {
512  int pos = annotationElem.attribute( QStringLiteral( "position" ) ).toInt();
513  annotationElem.setAttribute( QStringLiteral( "leftPosition" ), pos );
514  annotationElem.setAttribute( QStringLiteral( "rightPosition" ), pos );
515  annotationElem.setAttribute( QStringLiteral( "topPosition" ), pos );
516  annotationElem.setAttribute( QStringLiteral( "bottomPosition" ), pos );
517  annotationElem.removeAttribute( QStringLiteral( "position" ) );
518  }
519 
520  //direction
521  if ( annotationElem.hasAttribute( QStringLiteral( "direction" ) ) )
522  {
523  int dir = annotationElem.attribute( QStringLiteral( "direction" ) ).toInt();
524  if ( dir == 2 )
525  {
526  annotationElem.setAttribute( QStringLiteral( "leftDirection" ), 0 );
527  annotationElem.setAttribute( QStringLiteral( "rightDirection" ), 0 );
528  annotationElem.setAttribute( QStringLiteral( "topDirection" ), 1 );
529  annotationElem.setAttribute( QStringLiteral( "bottomDirection" ), 1 );
530  }
531  else if ( dir == 3 )
532  {
533  annotationElem.setAttribute( QStringLiteral( "leftDirection" ), 1 );
534  annotationElem.setAttribute( QStringLiteral( "rightDirection" ), 1 );
535  annotationElem.setAttribute( QStringLiteral( "topDirection" ), 0 );
536  annotationElem.setAttribute( QStringLiteral( "bottomDirection" ), 0 );
537  }
538  else
539  {
540  annotationElem.setAttribute( QStringLiteral( "leftDirection" ), dir );
541  annotationElem.setAttribute( QStringLiteral( "rightDirection" ), dir );
542  annotationElem.setAttribute( QStringLiteral( "topDirection" ), dir );
543  annotationElem.setAttribute( QStringLiteral( "bottomDirection" ), dir );
544  }
545  annotationElem.removeAttribute( QStringLiteral( "direction" ) );
546  }
547  }
548  }
549  }
550 
551  //Composer: move all items under Composition element
552  QDomNodeList composerList = mDom.elementsByTagName( QStringLiteral( "Composer" ) );
553  for ( int i = 0; i < composerList.size(); ++i )
554  {
555  QDomElement composerElem = composerList.at( i ).toElement();
556 
557  //find <QgsComposition element
558  QDomElement compositionElem = composerElem.firstChildElement( QStringLiteral( "Composition" ) );
559  if ( compositionElem.isNull() )
560  {
561  continue;
562  }
563 
564  QDomNodeList composerChildren = composerElem.childNodes();
565 
566  if ( composerChildren.size() < 1 )
567  {
568  continue;
569  }
570 
571  for ( int j = composerChildren.size() - 1; j >= 0; --j )
572  {
573  QDomElement childElem = composerChildren.at( j ).toElement();
574  if ( childElem.tagName() == QLatin1String( "Composition" ) )
575  {
576  continue;
577  }
578 
579  composerElem.removeChild( childElem );
580  compositionElem.appendChild( childElem );
581 
582  }
583  }
584 
585  // SimpleFill symbol layer v2: avoid double transparency
586  // replacing alpha value of symbol layer's color with 255 (the
587  // transparency value is already stored as symbol transparency).
588  QDomNodeList rendererList = mDom.elementsByTagName( QStringLiteral( "renderer-v2" ) );
589  for ( int i = 0; i < rendererList.size(); ++i )
590  {
591  QDomNodeList layerList = rendererList.at( i ).toElement().elementsByTagName( QStringLiteral( "layer" ) );
592  for ( int j = 0; j < layerList.size(); ++j )
593  {
594  QDomElement layerElem = layerList.at( j ).toElement();
595  if ( layerElem.attribute( QStringLiteral( "class" ) ) == QLatin1String( "SimpleFill" ) )
596  {
597  QDomNodeList propList = layerElem.elementsByTagName( QStringLiteral( "prop" ) );
598  for ( int k = 0; k < propList.size(); ++k )
599  {
600  QDomElement propElem = propList.at( k ).toElement();
601  if ( propElem.attribute( QStringLiteral( "k" ) ) == QLatin1String( "color" ) || propElem.attribute( QStringLiteral( "k" ) ) == QLatin1String( "color_border" ) )
602  {
603  propElem.setAttribute( QStringLiteral( "v" ), propElem.attribute( QStringLiteral( "v" ) ).section( ',', 0, 2 ) + ",255" );
604  }
605  }
606  }
607  }
608  }
609 
610  QgsDebugMsg( mDom.toString() );
611 }
612 
613 void QgsProjectFileTransform::transform2200to2300()
614 {
615  //composer: set placement for all picture items to middle, to mimic <=2.2 behavior
616  QDomNodeList composerPictureList = mDom.elementsByTagName( QStringLiteral( "ComposerPicture" ) );
617  for ( int i = 0; i < composerPictureList.size(); ++i )
618  {
619  QDomElement picture = composerPictureList.at( i ).toElement();
620  picture.setAttribute( QStringLiteral( "anchorPoint" ), QString::number( 4 ) );
621  }
622 }
623 
624 void QgsProjectFileTransform::transform2990()
625 {
626  // transform OTF off to "no projection" for project
627  QDomElement propsElem = mDom.firstChildElement( QStringLiteral( "qgis" ) ).toElement().firstChildElement( QStringLiteral( "properties" ) );
628  QDomNodeList srsNodes = propsElem.elementsByTagName( QStringLiteral( "SpatialRefSys" ) );
629  QDomElement srsElem;
630  QDomElement projElem;
631  if ( srsNodes.count() > 0 )
632  {
633  srsElem = srsNodes.at( 0 ).toElement();
634  QDomNodeList projNodes = srsElem.elementsByTagName( QStringLiteral( "ProjectionsEnabled" ) );
635  if ( projNodes.count() == 0 )
636  {
637  projElem = mDom.createElement( QStringLiteral( "ProjectionsEnabled" ) );
638  projElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "int" ) );
639  QDomText projText = mDom.createTextNode( QStringLiteral( "0" ) );
640  projElem.appendChild( projText );
641  srsElem.appendChild( projElem );
642  }
643  }
644  else
645  {
646  srsElem = mDom.createElement( QStringLiteral( "SpatialRefSys" ) );
647  projElem = mDom.createElement( QStringLiteral( "ProjectionsEnabled" ) );
648  projElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "int" ) );
649  QDomText projText = mDom.createTextNode( QStringLiteral( "0" ) );
650  projElem.appendChild( projText );
651  srsElem.appendChild( projElem );
652  propsElem.appendChild( srsElem );
653  }
654  // transform map canvas CRS to project CRS - this is because project CRS was inconsistently used
655  // prior to 3.0. In >= 3.0 main canvas CRS is forced to match project CRS, so we need to make
656  // sure we can read the project CRS correctly
657  QDomNodeList canvasNodes = mDom.elementsByTagName( QStringLiteral( "mapcanvas" ) );
658  if ( canvasNodes.count() > 0 )
659  {
660  QDomElement canvasElem = canvasNodes.at( 0 ).toElement();
661  QDomNodeList canvasSrsNodes = canvasElem.elementsByTagName( QStringLiteral( "spatialrefsys" ) );
662  if ( canvasSrsNodes.count() > 0 )
663  {
664  QDomElement canvasSrsElem = canvasSrsNodes.at( 0 ).toElement();
665  QString proj;
666  QString authid;
667  QString srsid;
668 
669  QDomNodeList proj4Nodes = canvasSrsElem.elementsByTagName( QStringLiteral( "proj4" ) );
670  if ( proj4Nodes.count() > 0 )
671  {
672  QDomElement proj4Node = proj4Nodes.at( 0 ).toElement();
673  proj = proj4Node.text();
674  }
675  QDomNodeList authidNodes = canvasSrsElem.elementsByTagName( QStringLiteral( "authid" ) );
676  if ( authidNodes.count() > 0 )
677  {
678  QDomElement authidNode = authidNodes.at( 0 ).toElement();
679  authid = authidNode.text();
680  }
681  QDomNodeList srsidNodes = canvasSrsElem.elementsByTagName( QStringLiteral( "srsid" ) );
682  if ( srsidNodes.count() > 0 )
683  {
684  QDomElement srsidNode = srsidNodes.at( 0 ).toElement();
685  srsid = srsidNode.text();
686  }
687 
688  // clear existing project CRS nodes
689  QDomNodeList oldProjectProj4Nodes = srsElem.elementsByTagName( QStringLiteral( "ProjectCRSProj4String" ) );
690  for ( int i = oldProjectProj4Nodes.count(); i >= 0; --i )
691  {
692  srsElem.removeChild( oldProjectProj4Nodes.at( i ) );
693  }
694  QDomNodeList oldProjectCrsNodes = srsElem.elementsByTagName( QStringLiteral( "ProjectCrs" ) );
695  for ( int i = oldProjectCrsNodes.count(); i >= 0; --i )
696  {
697  srsElem.removeChild( oldProjectCrsNodes.at( i ) );
698  }
699  QDomNodeList oldProjectCrsIdNodes = srsElem.elementsByTagName( QStringLiteral( "ProjectCRSID" ) );
700  for ( int i = oldProjectCrsIdNodes.count(); i >= 0; --i )
701  {
702  srsElem.removeChild( oldProjectCrsIdNodes.at( i ) );
703  }
704  QDomNodeList projectionsEnabledNodes = srsElem.elementsByTagName( QStringLiteral( "ProjectionsEnabled" ) );
705  for ( int i = projectionsEnabledNodes.count(); i >= 0; --i )
706  {
707  srsElem.removeChild( projectionsEnabledNodes.at( i ) );
708  }
709 
710  QDomElement proj4Elem = mDom.createElement( QStringLiteral( "ProjectCRSProj4String" ) );
711  proj4Elem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "QString" ) );
712  QDomText proj4Text = mDom.createTextNode( proj );
713  proj4Elem.appendChild( proj4Text );
714  QDomElement projectCrsElem = mDom.createElement( QStringLiteral( "ProjectCrs" ) );
715  projectCrsElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "QString" ) );
716  QDomText projectCrsText = mDom.createTextNode( authid );
717  projectCrsElem.appendChild( projectCrsText );
718  QDomElement projectCrsIdElem = mDom.createElement( QStringLiteral( "ProjectCRSID" ) );
719  projectCrsIdElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "int" ) );
720  QDomText srsidText = mDom.createTextNode( srsid );
721  projectCrsIdElem.appendChild( srsidText );
722  QDomElement projectionsEnabledElem = mDom.createElement( QStringLiteral( "ProjectionsEnabled" ) );
723  projectionsEnabledElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "int" ) );
724  QDomText projectionsEnabledText = mDom.createTextNode( QStringLiteral( "1" ) );
725  projectionsEnabledElem.appendChild( projectionsEnabledText );
726  srsElem.appendChild( proj4Elem );
727  srsElem.appendChild( projectCrsElem );
728  srsElem.appendChild( projectCrsIdElem );
729  srsElem.appendChild( projectionsEnabledElem );
730 
731  QDomNodeList srsNodes = propsElem.elementsByTagName( QStringLiteral( "SpatialRefSys" ) );
732  for ( int i = srsNodes.count(); i >= 0; --i )
733  {
734  propsElem.removeChild( srsNodes.at( i ) );
735  }
736  propsElem.appendChild( srsElem );
737  }
738  }
739 
740 
741  QDomNodeList mapLayers = mDom.elementsByTagName( QStringLiteral( "maplayer" ) );
742 
743  for ( int mapLayerIndex = 0; mapLayerIndex < mapLayers.count(); ++mapLayerIndex )
744  {
745  QDomElement layerElem = mapLayers.at( mapLayerIndex ).toElement();
746 
747  // The newly added fieldConfiguration element
748  QDomElement fieldConfigurationElement = mDom.createElement( QStringLiteral( "fieldConfiguration" ) );
749  layerElem.appendChild( fieldConfigurationElement );
750 
751  QDomNodeList editTypeNodes = layerElem.namedItem( QStringLiteral( "edittypes" ) ).childNodes();
752  QDomElement constraintExpressionsElem = mDom.createElement( QStringLiteral( "constraintExpressions" ) );
753  layerElem.appendChild( constraintExpressionsElem );
754 
755  for ( int i = 0; i < editTypeNodes.size(); ++i )
756  {
757  QDomNode editTypeNode = editTypeNodes.at( i );
758  QDomElement editTypeElement = editTypeNode.toElement();
759 
760  QDomElement fieldElement = mDom.createElement( QStringLiteral( "field" ) );
761  fieldConfigurationElement.appendChild( fieldElement );
762 
763  QString name = editTypeElement.attribute( QStringLiteral( "name" ) );
764  fieldElement.setAttribute( QStringLiteral( "name" ), name );
765  QDomElement constraintExpressionElem = mDom.createElement( QStringLiteral( "constraint" ) );
766  constraintExpressionElem.setAttribute( QStringLiteral( "field" ), name );
767  constraintExpressionsElem.appendChild( constraintExpressionElem );
768 
769  QDomElement editWidgetElement = mDom.createElement( QStringLiteral( "editWidget" ) );
770  fieldElement.appendChild( editWidgetElement );
771 
772  QString ewv2Type = editTypeElement.attribute( QStringLiteral( "widgetv2type" ) );
773  editWidgetElement.setAttribute( QStringLiteral( "type" ), ewv2Type );
774 
775  QDomElement ewv2CfgElem = editTypeElement.namedItem( QStringLiteral( "widgetv2config" ) ).toElement();
776 
777  if ( !ewv2CfgElem.isNull() )
778  {
779  QDomElement editWidgetConfigElement = mDom.createElement( QStringLiteral( "config" ) );
780  editWidgetElement.appendChild( editWidgetConfigElement );
781 
782  QVariantMap editWidgetConfiguration;
783 
784  QDomNamedNodeMap configAttrs = ewv2CfgElem.attributes();
785  for ( int configIndex = 0; configIndex < configAttrs.count(); ++configIndex )
786  {
787  QDomAttr configAttr = configAttrs.item( configIndex ).toAttr();
788  if ( configAttr.name() == QStringLiteral( "fieldEditable" ) )
789  {
790  editWidgetConfigElement.setAttribute( QStringLiteral( "fieldEditable" ), configAttr.value() );
791  }
792  else if ( configAttr.name() == QStringLiteral( "labelOnTop" ) )
793  {
794  editWidgetConfigElement.setAttribute( QStringLiteral( "labelOnTop" ), configAttr.value() );
795  }
796  else if ( configAttr.name() == QStringLiteral( "notNull" ) )
797  {
798  editWidgetConfigElement.setAttribute( QStringLiteral( "notNull" ), configAttr.value() );
799  }
800  else if ( configAttr.name() == QStringLiteral( "constraint" ) )
801  {
802  constraintExpressionElem.setAttribute( QStringLiteral( "exp" ), configAttr.value() );
803  }
804  else if ( configAttr.name() == QStringLiteral( "constraintDescription" ) )
805  {
806  constraintExpressionElem.setAttribute( QStringLiteral( "desc" ), configAttr.value() );
807  }
808  else
809  {
810  editWidgetConfiguration.insert( configAttr.name(), configAttr.value() );
811  }
812  }
813 
814  if ( ewv2Type == QStringLiteral( "ValueMap" ) )
815  {
816  QDomNodeList configElements = ewv2CfgElem.childNodes();
817  QVariantMap map;
818  for ( int configIndex = 0; configIndex < configElements.count(); ++configIndex )
819  {
820  QDomElement configElem = configElements.at( configIndex ).toElement();
821  map.insert( configElem.attribute( QStringLiteral( "key" ) ), configElem.attribute( QStringLiteral( "value" ) ) );
822  }
823  editWidgetConfiguration.insert( QStringLiteral( "map" ), map );
824  }
825  else if ( ewv2Type == QStringLiteral( "Photo" ) )
826  {
827  editWidgetElement.setAttribute( QStringLiteral( "type" ), QStringLiteral( "ExternalResource" ) );
828 
829  editWidgetConfiguration.insert( QStringLiteral( "DocumentViewer" ), 1 );
830  editWidgetConfiguration.insert( QStringLiteral( "DocumentViewerHeight" ), editWidgetConfiguration.value( QStringLiteral( "Height" ) ) );
831  editWidgetConfiguration.insert( QStringLiteral( "DocumentViewerWidth" ), editWidgetConfiguration.value( QStringLiteral( "Width" ) ) );
832  editWidgetConfiguration.insert( QStringLiteral( "RelativeStorage" ), 1 );
833  }
834  else if ( ewv2Type == QStringLiteral( "FileName" ) )
835  {
836  editWidgetElement.setAttribute( QStringLiteral( "type" ), QStringLiteral( "ExternalResource" ) );
837 
838  editWidgetConfiguration.insert( QStringLiteral( "RelativeStorage" ), 1 );
839  }
840  else if ( ewv2Type == QStringLiteral( "WebView" ) )
841  {
842  editWidgetElement.setAttribute( QStringLiteral( "type" ), QStringLiteral( "ExternalResource" ) );
843 
844  editWidgetConfiguration.insert( QStringLiteral( "DocumentViewerHeight" ), editWidgetConfiguration.value( QStringLiteral( "Height" ) ) );
845  editWidgetConfiguration.insert( QStringLiteral( "DocumentViewerWidth" ), editWidgetConfiguration.value( QStringLiteral( "Width" ) ) );
846  editWidgetConfiguration.insert( QStringLiteral( "RelativeStorage" ), 1 );
847  }
848 
849  editWidgetConfigElement.appendChild( QgsXmlUtils::writeVariant( editWidgetConfiguration, mDom ) );
850  }
851  }
852  }
853 }
854 
855 void QgsProjectFileTransform::convertRasterProperties( QDomDocument &doc, QDomNode &parentNode,
856  QDomElement &rasterPropertiesElem, QgsRasterLayer *rlayer )
857 {
858  //no data
859  //TODO: We would need to set no data on all bands, but we don't know number of bands here
860  QDomNode noDataNode = rasterPropertiesElem.namedItem( QStringLiteral( "mNoDataValue" ) );
861  QDomElement noDataElement = noDataNode.toElement();
862  if ( !noDataElement.text().isEmpty() )
863  {
864  QgsDebugMsg( "mNoDataValue = " + noDataElement.text() );
865  QDomElement noDataElem = doc.createElement( QStringLiteral( "noData" ) );
866 
867  QDomElement noDataRangeList = doc.createElement( QStringLiteral( "noDataRangeList" ) );
868  noDataRangeList.setAttribute( QStringLiteral( "bandNo" ), 1 );
869 
870  QDomElement noDataRange = doc.createElement( QStringLiteral( "noDataRange" ) );
871  noDataRange.setAttribute( QStringLiteral( "min" ), noDataElement.text() );
872  noDataRange.setAttribute( QStringLiteral( "max" ), noDataElement.text() );
873  noDataRangeList.appendChild( noDataRange );
874 
875  noDataElem.appendChild( noDataRangeList );
876 
877  parentNode.appendChild( noDataElem );
878  }
879 
880  QDomElement rasterRendererElem = doc.createElement( QStringLiteral( "rasterrenderer" ) );
881  //convert general properties
882 
883  //invert color
884  rasterRendererElem.setAttribute( QStringLiteral( "invertColor" ), QStringLiteral( "0" ) );
885  QDomElement invertColorElem = rasterPropertiesElem.firstChildElement( QStringLiteral( "mInvertColor" ) );
886  if ( !invertColorElem.isNull() )
887  {
888  if ( invertColorElem.text() == QLatin1String( "true" ) )
889  {
890  rasterRendererElem.setAttribute( QStringLiteral( "invertColor" ), QStringLiteral( "1" ) );
891  }
892  }
893 
894  //opacity
895  rasterRendererElem.setAttribute( QStringLiteral( "opacity" ), QStringLiteral( "1" ) );
896  QDomElement transparencyElem = parentNode.firstChildElement( QStringLiteral( "transparencyLevelInt" ) );
897  if ( !transparencyElem.isNull() )
898  {
899  double transparency = transparencyElem.text().toInt();
900  rasterRendererElem.setAttribute( QStringLiteral( "opacity" ), QString::number( transparency / 255.0 ) );
901  }
902 
903  //alphaBand was not saved until now (bug)
904  rasterRendererElem.setAttribute( QStringLiteral( "alphaBand" ), -1 );
905 
906  //gray band is used for several renderers
907  int grayBand = rasterBandNumber( rasterPropertiesElem, QStringLiteral( "mGrayBandName" ), rlayer );
908 
909  //convert renderer specific properties
910  QString drawingStyle = rasterPropertiesElem.firstChildElement( QStringLiteral( "mDrawingStyle" ) ).text();
911 
912  // While PalettedColor should normally contain only integer values, usually
913  // color palette 0-255, it may happen (Tim, issue #7023) that it contains
914  // colormap classification with double values and text labels
915  // (which should normally only appear in SingleBandPseudoColor drawingStyle)
916  // => we have to check first the values and change drawingStyle if necessary
917  if ( drawingStyle == QLatin1String( "PalettedColor" ) )
918  {
919  QDomElement customColorRampElem = rasterPropertiesElem.firstChildElement( QStringLiteral( "customColorRamp" ) );
920  QDomNodeList colorRampEntryList = customColorRampElem.elementsByTagName( QStringLiteral( "colorRampEntry" ) );
921 
922  for ( int i = 0; i < colorRampEntryList.size(); ++i )
923  {
924  QDomElement colorRampEntryElem = colorRampEntryList.at( i ).toElement();
925  QString strValue = colorRampEntryElem.attribute( QStringLiteral( "value" ) );
926  double value = strValue.toDouble();
927  if ( value < 0 || value > 10000 || !qgsDoubleNear( value, static_cast< int >( value ) ) )
928  {
929  QgsDebugMsg( QString( "forcing SingleBandPseudoColor value = %1" ).arg( value ) );
930  drawingStyle = QStringLiteral( "SingleBandPseudoColor" );
931  break;
932  }
933  }
934  }
935 
936  if ( drawingStyle == QLatin1String( "SingleBandGray" ) )
937  {
938  rasterRendererElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "singlebandgray" ) );
939  rasterRendererElem.setAttribute( QStringLiteral( "grayBand" ), grayBand );
940  transformContrastEnhancement( doc, rasterPropertiesElem, rasterRendererElem );
941  }
942  else if ( drawingStyle == QLatin1String( "SingleBandPseudoColor" ) )
943  {
944  rasterRendererElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "singlebandpseudocolor" ) );
945  rasterRendererElem.setAttribute( QStringLiteral( "band" ), grayBand );
946  QDomElement newRasterShaderElem = doc.createElement( QStringLiteral( "rastershader" ) );
947  QDomElement newColorRampShaderElem = doc.createElement( QStringLiteral( "colorrampshader" ) );
948  newRasterShaderElem.appendChild( newColorRampShaderElem );
949  rasterRendererElem.appendChild( newRasterShaderElem );
950 
951  //switch depending on mColorShadingAlgorithm
952  QString colorShadingAlgorithm = rasterPropertiesElem.firstChildElement( QStringLiteral( "mColorShadingAlgorithm" ) ).text();
953  if ( colorShadingAlgorithm == QLatin1String( "PseudoColorShader" ) || colorShadingAlgorithm == QLatin1String( "FreakOutShader" ) )
954  {
955  newColorRampShaderElem.setAttribute( QStringLiteral( "colorRampType" ), QStringLiteral( "INTERPOLATED" ) );
956 
957  //get minmax from rasterlayer
958  QgsRasterBandStats rasterBandStats = rlayer->dataProvider()->bandStatistics( grayBand );
959  double minValue = rasterBandStats.minimumValue;
960  double maxValue = rasterBandStats.maximumValue;
961  double breakSize = ( maxValue - minValue ) / 3;
962 
963  QStringList colorList;
964  if ( colorShadingAlgorithm == QLatin1String( "FreakOutShader" ) )
965  {
966  colorList << QStringLiteral( "#ff00ff" ) << QStringLiteral( "#00ffff" ) << QStringLiteral( "#ff0000" ) << QStringLiteral( "#00ff00" );
967  }
968  else //pseudocolor
969  {
970  colorList << QStringLiteral( "#0000ff" ) << QStringLiteral( "#00ffff" ) << QStringLiteral( "#ffff00" ) << QStringLiteral( "#ff0000" );
971  }
972  QStringList::const_iterator colorIt = colorList.constBegin();
973  double boundValue = minValue;
974  for ( ; colorIt != colorList.constEnd(); ++colorIt )
975  {
976  QDomElement newItemElem = doc.createElement( QStringLiteral( "item" ) );
977  newItemElem.setAttribute( QStringLiteral( "value" ), QString::number( boundValue ) );
978  newItemElem.setAttribute( QStringLiteral( "label" ), QString::number( boundValue ) );
979  newItemElem.setAttribute( QStringLiteral( "color" ), *colorIt );
980  newColorRampShaderElem.appendChild( newItemElem );
981  boundValue += breakSize;
982  }
983  }
984  else if ( colorShadingAlgorithm == QLatin1String( "ColorRampShader" ) )
985  {
986  QDomElement customColorRampElem = rasterPropertiesElem.firstChildElement( QStringLiteral( "customColorRamp" ) );
987  QString type = customColorRampElem.firstChildElement( QStringLiteral( "colorRampType" ) ).text();
988  newColorRampShaderElem.setAttribute( QStringLiteral( "colorRampType" ), type );
989  QDomNodeList colorNodeList = customColorRampElem.elementsByTagName( QStringLiteral( "colorRampEntry" ) );
990 
991  QString value, label;
992  QColor newColor;
993  int red, green, blue;
994  QDomElement currentItemElem;
995  for ( int i = 0; i < colorNodeList.size(); ++i )
996  {
997  currentItemElem = colorNodeList.at( i ).toElement();
998  value = currentItemElem.attribute( QStringLiteral( "value" ) );
999  label = currentItemElem.attribute( QStringLiteral( "label" ) );
1000  red = currentItemElem.attribute( QStringLiteral( "red" ) ).toInt();
1001  green = currentItemElem.attribute( QStringLiteral( "green" ) ).toInt();
1002  blue = currentItemElem.attribute( QStringLiteral( "blue" ) ).toInt();
1003  newColor = QColor( red, green, blue );
1004  QDomElement newItemElem = doc.createElement( QStringLiteral( "item" ) );
1005  newItemElem.setAttribute( QStringLiteral( "value" ), value );
1006  newItemElem.setAttribute( QStringLiteral( "label" ), label );
1007  newItemElem.setAttribute( QStringLiteral( "color" ), newColor.name() );
1008  newColorRampShaderElem.appendChild( newItemElem );
1009  }
1010  }
1011  }
1012  else if ( drawingStyle == QLatin1String( "PalettedColor" ) )
1013  {
1014  rasterRendererElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "paletted" ) );
1015  rasterRendererElem.setAttribute( QStringLiteral( "band" ), grayBand );
1016  QDomElement customColorRampElem = rasterPropertiesElem.firstChildElement( QStringLiteral( "customColorRamp" ) );
1017  QDomNodeList colorRampEntryList = customColorRampElem.elementsByTagName( QStringLiteral( "colorRampEntry" ) );
1018  QDomElement newColorPaletteElem = doc.createElement( QStringLiteral( "colorPalette" ) );
1019 
1020  int red = 0;
1021  int green = 0;
1022  int blue = 0;
1023  int value = 0;
1024  QDomElement colorRampEntryElem;
1025  for ( int i = 0; i < colorRampEntryList.size(); ++i )
1026  {
1027  colorRampEntryElem = colorRampEntryList.at( i ).toElement();
1028  QDomElement newPaletteElem = doc.createElement( QStringLiteral( "paletteEntry" ) );
1029  value = static_cast< int >( colorRampEntryElem.attribute( QStringLiteral( "value" ) ).toDouble() );
1030  newPaletteElem.setAttribute( QStringLiteral( "value" ), value );
1031  red = colorRampEntryElem.attribute( QStringLiteral( "red" ) ).toInt();
1032  green = colorRampEntryElem.attribute( QStringLiteral( "green" ) ).toInt();
1033  blue = colorRampEntryElem.attribute( QStringLiteral( "blue" ) ).toInt();
1034  newPaletteElem.setAttribute( QStringLiteral( "color" ), QColor( red, green, blue ).name() );
1035  QString label = colorRampEntryElem.attribute( QStringLiteral( "label" ) );
1036  if ( !label.isEmpty() )
1037  {
1038  newPaletteElem.setAttribute( QStringLiteral( "label" ), label );
1039  }
1040  newColorPaletteElem.appendChild( newPaletteElem );
1041  }
1042  rasterRendererElem.appendChild( newColorPaletteElem );
1043  }
1044  else if ( drawingStyle == QLatin1String( "MultiBandColor" ) )
1045  {
1046  rasterRendererElem.setAttribute( QStringLiteral( "type" ), QStringLiteral( "multibandcolor" ) );
1047 
1048  //red band, green band, blue band
1049  int redBand = rasterBandNumber( rasterPropertiesElem, QStringLiteral( "mRedBandName" ), rlayer );
1050  int greenBand = rasterBandNumber( rasterPropertiesElem, QStringLiteral( "mGreenBandName" ), rlayer );
1051  int blueBand = rasterBandNumber( rasterPropertiesElem, QStringLiteral( "mBlueBandName" ), rlayer );
1052  rasterRendererElem.setAttribute( QStringLiteral( "redBand" ), redBand );
1053  rasterRendererElem.setAttribute( QStringLiteral( "greenBand" ), greenBand );
1054  rasterRendererElem.setAttribute( QStringLiteral( "blueBand" ), blueBand );
1055 
1056  transformContrastEnhancement( doc, rasterPropertiesElem, rasterRendererElem );
1057  }
1058  else
1059  {
1060  return;
1061  }
1062 
1063  //replace rasterproperties element with rasterrenderer element
1064  if ( !parentNode.isNull() )
1065  {
1066  parentNode.replaceChild( rasterRendererElem, rasterPropertiesElem );
1067  }
1068 }
1069 
1070 int QgsProjectFileTransform::rasterBandNumber( const QDomElement &rasterPropertiesElem, const QString &bandName,
1071  QgsRasterLayer *rlayer )
1072 {
1073  if ( !rlayer )
1074  {
1075  return -1;
1076  }
1077 
1078  int band = -1;
1079  QDomElement rasterBandElem = rasterPropertiesElem.firstChildElement( bandName );
1080  if ( !rasterBandElem.isNull() )
1081  {
1082  QRegExp re( "(\\d+)" );
1083 
1084  if ( re.indexIn( rasterBandElem.text() ) >= 0 )
1085  {
1086  return re.cap( 1 ).toInt();
1087  }
1088  }
1089  return band;
1090 }
1091 
1092 void QgsProjectFileTransform::transformContrastEnhancement( QDomDocument &doc, const QDomElement &rasterproperties, QDomElement &rendererElem )
1093 {
1094  if ( rasterproperties.isNull() || rendererElem.isNull() )
1095  {
1096  return;
1097  }
1098 
1099  double minimumValue = 0;
1100  double maximumValue = 0;
1101  QDomElement contrastMinMaxElem = rasterproperties.firstChildElement( QStringLiteral( "contrastEnhancementMinMaxValues" ) );
1102  if ( contrastMinMaxElem.isNull() )
1103  {
1104  return;
1105  }
1106 
1107  QDomElement contrastEnhancementAlgorithmElem = rasterproperties.firstChildElement( QStringLiteral( "mContrastEnhancementAlgorithm" ) );
1108  if ( contrastEnhancementAlgorithmElem.isNull() )
1109  {
1110  return;
1111  }
1112 
1113  //convert enhancement name to enumeration
1114  int algorithmEnum = 0;
1115  QString algorithmString = contrastEnhancementAlgorithmElem.text();
1116  if ( algorithmString == QLatin1String( "StretchToMinimumMaximum" ) )
1117  {
1118  algorithmEnum = 1;
1119  }
1120  else if ( algorithmString == QLatin1String( "StretchAndClipToMinimumMaximum" ) )
1121  {
1122  algorithmEnum = 2;
1123  }
1124  else if ( algorithmString == QLatin1String( "ClipToMinimumMaximum" ) )
1125  {
1126  algorithmEnum = 3;
1127  }
1128  else if ( algorithmString == QLatin1String( "UserDefinedEnhancement" ) )
1129  {
1130  algorithmEnum = 4;
1131  }
1132 
1133  QDomNodeList minMaxEntryList = contrastMinMaxElem.elementsByTagName( QStringLiteral( "minMaxEntry" ) );
1134  QStringList enhancementNameList;
1135  if ( minMaxEntryList.size() == 1 )
1136  {
1137  enhancementNameList << QStringLiteral( "contrastEnhancement" );
1138  }
1139  if ( minMaxEntryList.size() == 3 )
1140  {
1141  enhancementNameList << QStringLiteral( "redContrastEnhancement" ) << QStringLiteral( "greenContrastEnhancement" ) << QStringLiteral( "blueContrastEnhancement" );
1142  }
1143  if ( minMaxEntryList.size() > enhancementNameList.size() )
1144  {
1145  return;
1146  }
1147 
1148  QDomElement minMaxEntryElem;
1149  for ( int i = 0; i < minMaxEntryList.size(); ++i )
1150  {
1151  minMaxEntryElem = minMaxEntryList.at( i ).toElement();
1152  QDomElement minElem = minMaxEntryElem.firstChildElement( QStringLiteral( "min" ) );
1153  if ( minElem.isNull() )
1154  {
1155  return;
1156  }
1157  minimumValue = minElem.text().toDouble();
1158 
1159  QDomElement maxElem = minMaxEntryElem.firstChildElement( QStringLiteral( "max" ) );
1160  if ( maxElem.isNull() )
1161  {
1162  return;
1163  }
1164  maximumValue = maxElem.text().toDouble();
1165 
1166  QDomElement newContrastEnhancementElem = doc.createElement( enhancementNameList.at( i ) );
1167  QDomElement newMinValElem = doc.createElement( QStringLiteral( "minValue" ) );
1168  QDomText minText = doc.createTextNode( QString::number( minimumValue ) );
1169  newMinValElem.appendChild( minText );
1170  newContrastEnhancementElem.appendChild( newMinValElem );
1171  QDomElement newMaxValElem = doc.createElement( QStringLiteral( "maxValue" ) );
1172  QDomText maxText = doc.createTextNode( QString::number( maximumValue ) );
1173  newMaxValElem.appendChild( maxText );
1174  newContrastEnhancementElem.appendChild( newMaxValElem );
1175 
1176  QDomElement newAlgorithmElem = doc.createElement( QStringLiteral( "algorithm" ) );
1177  QDomText newAlgorithmText = doc.createTextNode( QString::number( algorithmEnum ) );
1178  newAlgorithmElem.appendChild( newAlgorithmText );
1179  newContrastEnhancementElem.appendChild( newAlgorithmElem );
1180 
1181  rendererElem.appendChild( newContrastEnhancementElem );
1182  }
1183 }
1184 
1185 void QgsProjectFileTransform::transformRasterTransparency( QDomDocument &doc, const QDomElement &orig, QDomElement &rendererElem )
1186 {
1187  //soon...
1188  Q_UNUSED( doc );
1189  Q_UNUSED( orig );
1190  Q_UNUSED( rendererElem );
1191 }
1192 
static void convertRasterProperties(QDomDocument &doc, QDomNode &parentNode, QDomElement &rasterPropertiesElem, QgsRasterLayer *rlayer)
QgsProjectVersion PFV
The class is used as a container of context for various read/write operations on other objects...
bool loadDefaultStyle
Set to true if the default layer style should be loaded.
void setPathResolver(const QgsPathResolver &resolver)
Sets up path resolver for conversion between relative and absolute paths.
void dump()
Prints the contents via QgsDebugMsg()
QString name
Definition: qgsfield.h:56
Setting options for loading vector layers.
#define QgsDebugMsg(str)
Definition: qgslogger.h:37
This class provides qgis with the ability to render raster datasets onto the mapcanvas.
bool updateRevision(const QgsProjectVersion &version)
double maximumValue
The maximum cell value in the raster band.
Container of fields for a vector layer.
Definition: qgsfields.h:42
bool isValid() const
Return the status of the layer.
virtual QgsFields fields() const override=0
Returns the fields associated with this data provider.
bool isNull() const
Returns true if this is a NULL project version.
int count() const
Return number of items.
Definition: qgsfields.cpp:115
Project property value node, contains a QgsProjectPropertyKey&#39;s value.
bool qgsDoubleNear(double a, double b, double epsilon=4 *DBL_EPSILON)
Compare two doubles (but allow some difference)
Definition: qgis.h:227
QgsField at(int i) const
Get field at particular index (must be in range 0..N-1)
Definition: qgsfields.cpp:145
QgsRasterDataProvider * dataProvider() override
The RasterBandStats struct is a container for statistics about a single raster band.
A class to describe the version of a project.
bool readLayerXml(const QDomElement &layerElement, const QgsReadWriteContext &context)
Sets state from Dom document.
virtual QgsRasterBandStats bandStatistics(int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
Get band statistics.
bool writeXml(const QString &nodeName, QDomElement &element, QDomDocument &document) override
Writes the property hierarchy to a specified DOM element.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:383
QgsVectorDataProvider * dataProvider() override
Returns the layer&#39;s data provider.
double minimumValue
The minimum cell value in the raster band.
This is the base class for vector data providers.
Represents a vector layer which manages a vector based data sets.
static QDomElement writeVariant(const QVariant &value, QDomDocument &doc)
Write a QVariant to a QDomElement.