qgsabstractgeopdfexporter.h

Go to the documentation of this file.

/***************************************************************************
                              qgsabstractgeopdfexporter.h
                             --------------------------
    begin                : August 2019
    copyright            : (C) 2019 by Nyall Dawson
    email                : nyall dot dawson 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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSABSTRACTGEOPDFEXPORTER_H
#define QGSABSTRACTGEOPDFEXPORTER_H
 
#include "qgis_core.h"
#include "qgsabstractmetadatabase.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsfeature.h"
#include "qgslayertree.h"
#include "qgspolygon.h"
 
#include <QDateTime>
#include <QList>
#include <QMutex>
#include <QPainter>
#include <QString>
#include <QTemporaryDir>
 
#define SIP_NO_FILE
 
using namespace Qt::StringLiterals;
 
 
class QgsGeospatialPdfRenderedFeatureHandler;
 

struct TreeNode
{
    QString id;
    bool initiallyVisible = false;
    QString name;
    QString mutuallyExclusiveGroupId;
    QString mapLayerId;
    std::vector< std::unique_ptr< TreeNode > > children;
    TreeNode *parent = nullptr;
    bool isRootNode = false;
 
    void addChild( std::unique_ptr< TreeNode > child )
    {
      child->parent = this;
      children.emplace_back( std::move( child ) );
    }
 
    QDomElement toElement( QDomDocument &doc ) const
    {
      QDomElement layerElement = doc.createElement( u"Layer"_s );
      layerElement.setAttribute( u"id"_s, id );
      layerElement.setAttribute( u"name"_s, name );
      layerElement.setAttribute( u"initiallyVisible"_s, initiallyVisible ? u"true"_s : u"false"_s );
      if ( !mutuallyExclusiveGroupId.isEmpty() )
        layerElement.setAttribute( u"mutuallyExclusiveGroupId"_s, mutuallyExclusiveGroupId );
 
      for ( const auto &child : children )
      {
        layerElement.appendChild( child->toElement( doc ) );
      }
 
      return layerElement;
    }
 
    void toChildrenElements( QDomDocument &doc, QDomElement &layerTreeElem ) const
    {
      for ( const auto &child : children )
      {
        layerTreeElem.appendChild( child->toElement( doc ) );
      }
    }
 
    QDomElement createIfLayerOnElement( QDomDocument &doc, QDomElement &contentElement ) const
    {
      QDomElement element = doc.createElement( u"IfLayerOn"_s );
      element.setAttribute( u"layerId"_s, id );
      contentElement.appendChild( element );
      return element;
    }
 
    QDomElement createNestedIfLayerOnElements( QDomDocument &doc, QDomElement &contentElement ) const
    {
      TreeNode *currentParent = parent;
      QDomElement finalElement = doc.createElement( u"IfLayerOn"_s );
      finalElement.setAttribute( u"layerId"_s, id );
 
      QDomElement currentElement = finalElement;
      while ( currentParent && !currentParent->isRootNode )
      {
        QDomElement ifGroupOn = doc.createElement( u"IfLayerOn"_s );
        ifGroupOn.setAttribute( u"layerId"_s, currentParent->id );
        ifGroupOn.appendChild( currentElement );
        currentElement = ifGroupOn;
        currentParent = currentParent->parent;
      }
      contentElement.appendChild( currentElement );
      return finalElement;
    }
};
 

class CORE_EXPORT QgsAbstractGeospatialPdfExporter
{
  public:
    static bool geospatialPDFCreationAvailable();

    static QString geospatialPDFAvailabilityExplanation();
 
    QgsAbstractGeospatialPdfExporter() = default;
 
    virtual ~QgsAbstractGeospatialPdfExporter() = default;

    struct RenderedFeature
    {
        RenderedFeature() = default;

        RenderedFeature( const QgsFeature &feature, const QgsGeometry &renderedBounds )
          : feature( feature )
          , renderedBounds( renderedBounds )
        {}

        QgsFeature feature;

        QgsGeometry renderedBounds;
    };

    struct CORE_EXPORT ComponentLayerDetail
    {
        QString name;

        QString mapLayerId;

        QString group;

        QString sourcePdfPath;

        QPainter::CompositionMode compositionMode = QPainter::CompositionMode_SourceOver;

        double opacity = 1.0;
    };

    struct ControlPoint
    {
        ControlPoint( const QgsPointXY &pagePoint, const QgsPointXY &geoPoint )
          : pagePoint( pagePoint )
          , geoPoint( geoPoint )
        {}

        QgsPointXY pagePoint;

        QgsPointXY geoPoint;
    };
 
    struct GeoReferencedSection
    {
        QgsRectangle pageBoundsMm;

        QgsPolygon pageBoundsPolygon;

        QgsCoordinateReferenceSystem crs;

        QList< QgsAbstractGeospatialPdfExporter::ControlPoint > controlPoints;
    };

    void pushRenderedFeature( const QString &layerId, const QgsAbstractGeospatialPdfExporter::RenderedFeature &feature, const QString &group = QString() );
 
    struct ExportDetails
    {
        QSizeF pageSizeMm;

        double dpi = 300;

        QList< QgsAbstractGeospatialPdfExporter::GeoReferencedSection > georeferencedSections;

        QString author;

        QString producer;

        QString creator;

        QDateTime creationDateTime;

        QString subject;

        QString title;

        QgsAbstractMetadataBase::KeywordMap keywords;

        bool useIso32000ExtensionFormatGeoreferencing = true;

        bool useOgcBestPracticeFormatGeoreferencing = false;

        bool includeFeatures = true;

        QMap< QString, QString > customLayerTreeGroups;

        QMap< QString, QString > layerIdToPdfLayerTreeNameMap;

        QMap< QString, bool > initialLayerVisibility;

        QStringList layerOrder;

        QStringList layerTreeGroupOrder;

        QSet< QString > mutuallyExclusiveGroups;

        bool useLayerTreeConfig = false;
    };

    bool finalize( const QList< QgsAbstractGeospatialPdfExporter::ComponentLayerDetail > &components, const QString &destinationFile, const ExportDetails &details );

    QString errorMessage() const { return mErrorMessage; }

    QString generateTemporaryFilepath( const QString &filename ) const;

    static bool compositionModeSupported( QPainter::CompositionMode mode );
 
  protected:
    struct VectorComponentDetail
    {
        QString name;

        QString mapLayerId;

        QString group;

        QString displayAttribute;

        QString sourceVectorPath;

        QString sourceVectorLayer;
    };

    static constexpr double DPI_72 = 72 SIP_SKIP;
 
  private:
    QMutex mMutex;
    QMap< QString, QMap< QString, QgsFeatureList > > mCollatedFeatures;

    virtual VectorComponentDetail componentDetailForLayerId( const QString &layerId ) = 0;

    virtual QgsLayerTree *layerTree() const = 0;
 
    QList< VectorComponentDetail > mVectorComponents;
 
    QString mErrorMessage;
    QTemporaryDir mTemporaryDir;
 
 
    bool saveTemporaryLayers();
 
    QString createCompositionXml( const QList< QgsAbstractGeospatialPdfExporter::ComponentLayerDetail > &components, const ExportDetails &details ) const;
    void createMetadataXmlSection( QDomElement &compositionElem, QDomDocument &doc, const ExportDetails &details ) const;
    void createPageDimensionXmlSection( QDomElement &pageElem, QDomDocument &doc, const double pageWidthPdfUnits, const double pageHeightPdfUnits ) const;
    void createGeoreferencingXmlSection( QDomElement &pageElem, QDomDocument &doc, const ExportDetails &details, const double pageWidthPdfUnits, const double pageHeightPdfUnits ) const;
    void createContentXmlSection(
      QDomElement &contentElem,
      QDomDocument &doc,
      const QMap< QString, TreeNode * > &groupNameToTreeNode,
      const QMap< QString, TreeNode * > &layerIdToTreeNode,
      const QList<ComponentLayerDetail> &components,
      const ExportDetails &details
    ) const;
 
    void createLayerTreeAndContentXmlSections( QDomElement &compositionElem, QDomElement &pageElem, QDomDocument &doc, const QList<ComponentLayerDetail> &components, const ExportDetails &details ) const;
    void createLayerTreeAndContentXmlSectionsFromLayerTree(
      const QgsLayerTree *layerTree, QDomElement &compositionElem, QDomElement &pageElem, QDomDocument &doc, const QList<ComponentLayerDetail> &components, const ExportDetails &details
    ) const;

    std::unique_ptr< TreeNode > createPdfTreeNodes( QMap< QString, TreeNode * > &groupNameToTreeNode, QMap< QString, TreeNode * > &layerIdToTreeNode, const QgsLayerTreeGroup *layerTreeGroup ) const;

    static QString compositionModeToString( QPainter::CompositionMode mode );
 
    friend class TestQgsLayoutGeospatialPdfExport;
    friend class TestQgsGeospatialPdfExport;
};
 
#endif //QGSABSTRACTGEOPDFEXPORTER_H